Imported Upstream version 2.0.0upstream/2.0.0

1 files changed, 106 insertions, 58 deletions

diff --git a/htop.1.in b/htop.1.in
index a0e2a26..1fa88ef 100644
--- a/htop.1.in
+++ b/htop.1.in
@@ -1,4 +1,4 @@
-.TH "HTOP" "1" "2011" "@PACKAGE_STRING@" "Utils"
+.TH "HTOP" "1" "2015" "@PACKAGE_STRING@" "Utils"
 .SH "NAME"
 htop \- interactive process viewer
 .SH "SYNOPSIS"
@@ -10,7 +10,8 @@ Htop is a free (GPL) ncurses-based process viewer for Linux.
 .LP
 It is similar to top, but allows you to scroll vertically and horizontally,
 so you can see all the processes running on the system, along with their full
-command lines.
+command lines, as well as viewing them as a process tree, selecting mutiple
+processes and acting on them all at once.
 .LP
 Tasks related to processes (killing, renicing) can be done without
 entering their PIDs.
@@ -150,6 +151,9 @@ Hide user threads: on systems that represent them differently than ordinary
 processes (such as recent NPTL-based systems), this can hide threads from
 userspace processes in the process list. (This is a toggle key.)
 .TP
+.B p
+Show full paths to running programs, where applicable. (This is a toggle key.)
+.TP
 .B Ctrl-L
 Refresh: redraw screen and recalculate values.
 .TP
@@ -167,11 +171,20 @@ shown in htop's main screen, it is shown below in parenthesis.
 .LP 
 .TP 5
 .B Command
-The full command line of the process (i.e program name and arguments).
+The full command line of the process (i.e. program name and arguments).
 .TP 
 .B PID
 The process ID.
 .TP
+.B STATE (S)
+The state of the process:
+   \fBS\fR for sleeping (idle)
+   \fBR\fR for running
+   \fBD\fR for disk sleep (uninterruptible)
+   \fBZ\fR for zombie (waiting for parent to read its exit status)
+   \fBT\fR for traced or suspended (e.g by SIGTSTP)
+   \fBW\fR for paging
+.TP
 .B PPID
 The parent process ID.
 .TP
@@ -187,47 +200,32 @@ The controlling terminal of the process.
 .B TPGID
 The process ID of the foreground process group of the controlling terminal.
 .TP
-.B STATE (S)
-The state of the process:
-   \fBS\fR for sleeping (idle)
-   \fBR\fR for running
-   \fBD\fR for disk sleep (uninterruptible)
-   \fBZ\fR for zombie (waiting for parent to read its exit status)
-   \fBT\fR for traced or suspended (e.g by SIGTSTP)
-   \fBW\fR for paging
+.B MINFLT
+The number of page faults happening in the main memory.
 .TP
-.B PROCESSOR (CPU)
-The ID of the CPU the process last executed on.
+.B CMINFLT
+The number of minor faults for the process's waited-for children (see MINFLT above).
 .TP
-.B NLWP
-The number of threads in the process.
+.B MAJFLT
+The number of page faults happening out of the main memory.
 .TP
-.B NICE (NI)
-The nice value of a process, from 19 (low priority) to -20 (high priority). A
-high value means the process is being nice, letting others have a higher
-relative priority. Only root can lower the value.
-.TP
-.B PERCENT_CPU (CPU%)
-The percentage of the CPU time that the process is currently using.
+.B CMAJFLT
+The number of major faults for the process's waited-for children (see MAJFLT above).
 .TP
 .B UTIME (UTIME+)
 The user CPU time, which is the amount of time the process has spent executing
-on the CPU in user mode (i.e everything but system calls), measured in clock
+on the CPU in user mode (i.e. everything but system calls), measured in clock
 ticks.
 .TP
 .B STIME (STIME+)
 The system CPU time, which is the amount of time the kernel has spent
 executing system calls on behalf of the process, measured in clock ticks.
 .TP
-.B TIME (TIME+)
-The time, measured in clock ticks that the process has spent in user and system
-time (see UTIME, STIME above).
-.TP
-.B CUTIME
+.B CUTIME (CUTIME+)
 The children's user CPU time, which is the amount of time the process's
 waited-for children have spent executing in user mode (see UTIME above).
 .TP
-.B CSTIME
+.B CSTIME (CSTIME+)
 The children's system CPU time, which is the amount of time the kernel has spent
 executing system calls on behalf of all the process's waited-for children (see
 STIME above).
@@ -236,42 +234,73 @@ STIME above).
 The kernel's internal priority for the process, usually just its nice value
 plus twenty. Different for real-time processes.
 .TP
-.B PERCENT_MEM
-The percentage of memory the process is currently using (based on the process's
-resident memory size, see M_RESIDENT below).
+.B NICE (NI)
+The nice value of a process, from 19 (low priority) to -20 (high priority). A
+high value means the process is being nice, letting others have a higher
+relative priority. The usual OS permission restrictions for adjusting priority apply.
+.TP
+.B STARTTIME (START)
+The time the process was started.
+.TP
+.B PROCESSOR (CPU)
+The ID of the CPU the process last executed on.
 .TP
 .B M_SIZE (VIRT)
-Size in memory of the total program size.
+The size of the virtual memory of the process.
 .TP
 .B M_RESIDENT (RES)
-The resident set size, i.e the size of the text and data sections, plus stack
-usage.
+The resident set size (text + data + stack) of the process (i.e. the size of the
+process's used physical memory).
 .TP
 .B M_SHARE (SHR)
-The size of the process's shared pages
+The size of the process's shared pages.
 .TP
 .B M_TRS (CODE)
-The size of the text segment of the process (i.e the size of the processes
+The text resident set size of the process (i.e. the size of the process's
 executable instructions).
 .TP
+.B M_DRS (DATA)
+The data resident set size (data + stack) of the process (i.e. the size of anything
+except the process's executable instructions).
+.TP
 .B M_LRS (LIB)
 The library size of the process.
 .TP
-.B M_DRS (DATA)
-The size of the data segment plus stack usage of the process.
-.TP
 .B M_DT (DIRTY)
 The size of the dirty pages of the process.
 .TP
 .B ST_UID (UID)
 The user ID of the process owner.
 .TP
+.B PERCENT_CPU (CPU%)
+The percentage of the CPU time that the process is currently using.
+.TP
+.B PERCENT_MEM (MEM%)
+The percentage of memory the process is currently using (based on the process's
+resident memory size, see M_RESIDENT above).
+.TP
 .B USER
 The username of the process owner, or the user ID if the name can't be
 determined.
 .TP
-.B STARTTIME
-The time the process was started.
+.B TIME (TIME+)
+The time, measured in clock ticks that the process has spent in user and system
+time (see UTIME, STIME above).
+.TP
+.B NLWP
+The number of threads in the process.
+.TP
+.B TGID
+The thread group ID.
+.TP
+.B CTID
+OpenVZ container ID, a.k.a virtual environment ID.
+.TP
+.B VPID
+OpenVZ process ID.
+.TP
+.B VXID
+VServer process ID.
 .TP
 .B RCHAR (RD_CHAR)
 The number of bytes the process has read.
@@ -291,38 +320,57 @@ Bytes of read(2) I/O for the process.
 .B WBYTES (IO_WBYTES)
 Bytes of write(2) I/O for the process.
 .TP
-.B IO_READ_RATE (IORR)
+.B CNCLWB (IO_CANCEL)
+Bytes of cancelled write(2) I/O.
+.TP
+.B IO_READ_RATE (DISK READ)
 The I/O rate of read(2) in bytes per second, for the process.
 .TP
-.B IO_WRITE_RATE (IOWR)
+.B IO_WRITE_RATE (DISK WRITE)
 The I/O rate of write(2) in bytes per second, for the process.
 .TP
-.B IO_RATE (IO)
+.B IO_RATE (DISK R/W)
 The I/O rate, IO_READ_RATE + IO_WRITE_RATE (see above).
 .TP
-.B CNCLWB (IO_CANCEL)
-Bytes of cancelled write(2) I/O.
-.TP
 .B CGROUP
 Which cgroup the process is in.
 .TP
-.B CTID
-OpenVZ container ID, a.k.a virtual environment ID.
-.TP
-.B VPID
-OpenVZ process ID.
-.TP
-.B VXID
-VServer process ID.
-.TP
 .B OOM
 OOM killer score.
 .TP
+.B IO_PRIORITY (IO)
+The I/O scheduling class followed by the priority if the class supports it:
+   \fBR\fR for Realtime
+   \fBB\fR for Best-effort
+   \fBid\fR for Idle
+.TP
 .B All other flags
 Currently unsupported (always displays '-').
 
+.SH "CONFIG FILE"
+.LP 
+By default htop reads its configuration from the XDG-compliant path
+~/.config/htop/htoprc -- the configuration file is overwritten by htop's
+in-program Setup configuration, so it should not be hand-edited. If no
+user configuration exists htop tries to read the system-wide configuration
+from @sysconfdir@/htoprc and as a last resort, falls back to its
+hard coded defaults.
+.LP
+You may override the location of the configuration file using the $HTOPRC
+environment variable (so you can have multiple configurations for different
+machines that share the same home directory, for example).
+
+.SH "MEMORY SIZES"
+.LP
+Memory sizes in htop are displayed as they are in tools from the GNU Coreutils
+(when ran with the --human-readable option). This means that sizes are printed
+in powers of 1024. (e.g., 1023M = 1072693248 Bytes)
+.LP
+The decision to use this convention was made in order to conserve screen space
+and make memory size representations consistent throughout htop.
+
 .SH "SEE ALSO"
-proc(5), top(1), free(1), ps(1), uptime(1)
+proc(5), top(1), free(1), ps(1), uptime(1), limits.conf(5)
 
 .SH "AUTHORS"
 .LP