Change doc for the new -r option

pull/234/head^2
Nicolas Hennion 2013-03-28 11:48:05 +01:00
parent 22677f7a99
commit 7f6953b325
3 changed files with 61 additions and 4 deletions

23
README
View File

@ -165,10 +165,27 @@ The version 1.6 introduces a optionnal password to access to the server (-P pass
## User guide
By default, stats are refreshed every second, to change this setting, you can
use the -t option. For example to set the refresh rate to 5 seconds:
Command line options are:
$ glances -t 5
-b Display network rate in Byte per second
-B @IP|host Bind server to the given IP or host NAME
-c @IP|host Connect to a Glances server
-C file Path to the configuration file
-d Disable disk I/O module
-e Enable the sensors module (Linux-only)
-f file Set the output folder (HTML) or file (CSV)
-h Display the syntax and exit
-m Disable mount module
-n Disable network module
-o output Define additional output (available: HTML or CSV)
-p PORT Define the client or server TCP port (default: 61209)
-P password Client/server password
-r Do not list processes (significant CPU use reduction)
-s Run Glances in server mode
-t sec Set the refresh time in seconds (default: 3)
-v Display the version and exit
-y Enable the hddtemp module
-z Do not use the bold color attribute
Importants stats are colored:

View File

@ -3628,13 +3628,13 @@ def printSyntax():
print(_("\t-p PORT\t\tDefine the client or server TCP port (default: %d)" %
server_port))
print(_("\t-P password\tClient/server password"))
print(_("\t-r\t\tDo not list processes (significant CPU use reduction)"))
print(_("\t-s\t\tRun Glances in server mode"))
print(_("\t-t sec\t\tSet the refresh time in seconds (default: %d)" %
refresh_time))
print(_("\t-v\t\tDisplay the version and exit"))
print(_("\t-y\t\tEnable the hddtemp module"))
print(_("\t-z\t\tDo not use the bold color attribute"))
print(_("\t-r\t\tDo not list processes (significant CPU use reduction)"))
def end():

View File

@ -12,6 +12,46 @@ It can also work in a client/server mode (for remote monitoring).
.PP
This tool is written in Python and uses PsUtil to fetch the statistical values from key elements.
.PP
The command line options are the following:
.PP
-b Display network rate in Byte per second
.PP
-B @IP|host Bind server to the given IP or host NAME
.PP
-c @IP|host Connect to a Glances server
.PP
-C file Path to the configuration file
.PP
-d Disable disk I/O module
.PP
-e Enable the sensors module (Linux-only)
.PP
-f file Set the output folder (HTML) or file (CSV)
.PP
-h Display the syntax and exit
.PP
-m Disable mount module
.PP
-n Disable network module
.PP
-o output Define additional output (available: HTML or CSV)
.PP
-p PORT Define the client or server TCP port (default: 61209)
.PP
-P password Client/server password
.PP
-r Do not list processes (significant CPU use reduction)
.PP
-s Run Glances in server mode
.PP
-t sec Set the refresh time in seconds (default: 3)
.PP
-v Display the version and exit
.PP
-y Enable the hddtemp module
.PP
-z Do not use the bold color attribute
.PP
When Glances is running, you can use the following keys:
.PP
'a' Automatic mode. The process list is sorted automatically