'\" t
.\"     Title: ctop
.\"    Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/02/2021
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "CTOP" "1" "01/02/2021" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ctop \- command line / text based Linux Containers monitoring tool
.SH "SYNOPSYS"
.sp
\fBctop\fR [\fIoptions\fR]
.SH "DESCRIPTION"
.sp
ctop will help you see what\(cqs going on at the container level\&. Basically, containers are a logical group of processes isolated using kernel\(cqs cgroups and namespaces\&. Recently, they have been made popular by Docker and they are also heavily used under the hood by systemd and a load of container tools like lxc, rocket, lmctfy and many others\&.
.sp
Under the hood, ctop will collect all metrics it can from cgroups in realtime and render them to instantly give you an overview of the global system health\&.
.sp
It currently collects metrics related to cpu, memory and block IO usage as well as metadata such as owning user (mostly for systemd based containers), uptime and attempts to guess the container managing technology behind\&.
.SH "OPTIONS"
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
show this help message and exit
.RE
.PP
\fB\-\-tree\fR
.RS 4
show tree view by default
.RE
.PP
\fB\-\-refresh=REFRESH\fR
.RS 4
Refresh display every <seconds>
.RE
.PP
\fB\-\-follow=FOLLOW\fR
.RS 4
Follow cgroup path
.RE
.PP
\fB\-\-fold=FOLD\fR
.RS 4
Fold cgroup sub tree
.RE
.PP
\fB\-\-columns=COLUMNS\fR
.RS 4
List of optional columns to display\&. Always includes \(oqname\(cq
.RE
.PP
\fB\-\-sort\-col=SORT_COL\fR
.RS 4
Select column to sort by initially\&. Can be changed dynamically\&.
.RE
.SH "AUTHOR"
.sp
This manual page was written by ChangZhuo Chen \fI<\fR\fIczchen@debian\&.org\fR\fI>\fR for the \fBDebian GNU/Linux system\fR (but may be used by others)\&.