Fix and update docs and man

pull/298/head
Alessio Sergi 2013-11-17 20:02:00 +01:00
parent e69c633523
commit 9f63ec9146
4 changed files with 36 additions and 30 deletions

View File

@ -123,9 +123,9 @@ td.option-group {
<div class="document" id="glances">
<h1 class="title">Glances</h1>
<p>This manual describes <em>Glances</em> version 1.7.2.</p>
<p>This manual describes <em>Glances</em> version 1.7.3.</p>
<p>Copyright © 2012-2013 Nicolas Hennion &lt;<a class="reference external" href="mailto:nicolas&#64;nicolargo.com">nicolas&#64;nicolargo.com</a>&gt;</p>
<p>September 2013</p>
<p>November 2013</p>
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
@ -221,7 +221,7 @@ just run on the server:</p>
<kbd><span class="option">-c <var>IP</var></span></kbd></td>
<td>Connect to a Glances server by IPv4/IPv6 address or hostname</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-C <var>file</var></span></kbd></td>
<kbd><span class="option">-C <var>FILE</var></span></kbd></td>
<td>Path to the configuration file</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-d</span></kbd></td>
@ -230,7 +230,7 @@ just run on the server:</p>
<kbd><span class="option">-e</span></kbd></td>
<td>Enable sensors module (requires pysensors, Linux-only)</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-f <var>file</var></span></kbd></td>
<kbd><span class="option">-f <var>FILE</var></span></kbd></td>
<td>Set the HTML output folder or CSV file</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-h</span></kbd></td>
@ -242,22 +242,25 @@ just run on the server:</p>
<kbd><span class="option">-n</span></kbd></td>
<td>Disable network module</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-o <var>output</var></span></kbd></td>
<kbd><span class="option">-o <var>OUTPUT</var></span></kbd></td>
<td>Define additional output (available: HTML or CSV)</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-p <var>PORT</var></span></kbd></td>
<td>Define the client/server TCP port (default: 61209)</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-P <var>password</var></span></kbd></td>
<kbd><span class="option">-P <var>PASSWORD</var></span></kbd></td>
<td>Define a client/server password</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--password</span></kbd></td>
<td>Define a client/server password from the prompt</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-r</span></kbd></td>
<td>Disable process list (for low CPU consumption)</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-s</span></kbd></td>
<td>Run Glances in server mode</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-t <var>seconds</var></span></kbd></td>
<kbd><span class="option">-t <var>SECONDS</var></span></kbd></td>
<td>Set refresh time in seconds (default: 3 sec)</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-v</span></kbd></td>

View File

@ -2,11 +2,11 @@
Glances
=======
This manual describes *Glances* version 1.7.2.
This manual describes *Glances* version 1.7.3.
Copyright © 2012-2013 Nicolas Hennion <nicolas@nicolargo.com>
September 2013
November 2013
.. contents:: Table of Contents
@ -81,20 +81,20 @@ Command-line options
-b Display network rate in Byte per second (default: bit per second)
-B IP Bind server to the given IPv4/IPv6 address or hostname
-c IP Connect to a Glances server by IPv4/IPv6 address or hostname
-C file Path to the configuration file
-C FILE Path to the configuration file
-d Disable disk I/O module
-e Enable sensors module (requires pysensors, Linux-only)
-f file Set the HTML output folder or CSV file
-f FILE Set the HTML output folder or CSV file
-h Display the help and exit
-m Disable mount module
-n Disable network module
-o output Define additional output (available: HTML or CSV)
-o OUTPUT Define additional output (available: HTML or CSV)
-p PORT Define the client/server TCP port (default: 61209)
-P password Define the client/server password
or --password Define the client/server password from the prompt
-P PASSWORD Define a client/server password
--password Define a client/server password from the prompt
-r Disable process list (for low CPU consumption)
-s Run Glances in server mode
-t seconds Set refresh time in seconds (default: 3 sec)
-t SECONDS Set refresh time in seconds (default: 3 sec)
-v Display the version and exit
-y Enable hddtemp module (requires hddtemp)
-z Do not use the bold color attribute

View File

@ -19,13 +19,13 @@ The command-line options are the following:
.B \-b
Display network rate in Byte per second (default: bit per second)
.TP
.B \-B @IP|host
.B \-B @IP|HOST
Bind server to the given IPv4/IPv6 address or hostname
.TP
.B \-c @IP|host
.B \-c @IP|HOST
Connect to a Glances server by IPv4/IPv6 address or hostname
.TP
.B \-C file
.B \-C FILE
Path to the configuration file
.TP
.B \-d
@ -34,7 +34,7 @@ Disable disk I/O module
.B \-e
Enable sensors module (requires pysensors, Linux-only)
.TP
.B \-f file
.B \-f FILE
Set the HTML output folder or CSV file
.TP
.B \-h
@ -46,22 +46,25 @@ Disable mount module
.B \-n
Disable network module
.TP
.B \-o output
.B \-o OUTPUT
Define additional output (available: HTML or CSV)
.TP
.B \-p PORT
Define the client/server TCP port (default: 61209)
.TP
.B \-P password
.B \-P PASSWORD
Define a client/server password
.TP
.B\---password
Define a client/server password from the prompt
.TP
.B \-r
Disable process list (for low CPU consumption)
.TP
.B \-s
Run Glances in server mode
.TP
.B \-t seconds
.B \-t SECONDS
Set refresh time in seconds (default: 3 sec)
.TP
.B \-v

View File

@ -4257,23 +4257,23 @@ def printSyntax():
print(_("Usage: glances [options]"))
print(_("\nOptions:"))
print(_("\t-b\t\tDisplay network rate in Byte per second"))
print(_("\t-B @IP|host\tBind server to the given IPv4/IPv6 address or hostname"))
print(_("\t-c @IP|host\tConnect to a Glances server by IPv4/IPv6 address or hostname"))
print(_("\t-C file\t\tPath to the configuration file"))
print(_("\t-B @IP|HOST\tBind server to the given IPv4/IPv6 address or hostname"))
print(_("\t-c @IP|HOST\tConnect to a Glances server by IPv4/IPv6 address or hostname"))
print(_("\t-C FILE\t\tPath to the configuration file"))
print(_("\t-d\t\tDisable disk I/O module"))
print(_("\t-e\t\tEnable sensors module"))
print(_("\t-f file\t\tSet the HTML output folder or CSV file"))
print(_("\t-f FILE\t\tSet the HTML output folder or CSV file"))
print(_("\t-h\t\tDisplay the help and exit"))
print(_("\t-m\t\tDisable mount module"))
print(_("\t-n\t\tDisable network module"))
print(_("\t-o output\tDefine additional output (available: HTML or CSV)"))
print(_("\t-o OUTPUT\tDefine additional output (available: HTML or CSV)"))
print(_("\t-p PORT\t\tDefine the client/server TCP port (default: %d)" %
server_port))
print(_("\t-P password\tDefine a client/server password"))
print(_("\tor --password\tEnter the password from the command line"))
print(_("\t-P PASSWORD\tDefine a client/server password"))
print(_("\t--password\tDefine a client/server password from the prompt"))
print(_("\t-r\t\tDisable process list"))
print(_("\t-s\t\tRun Glances in server mode"))
print(_("\t-t seconds\tSet refresh time in seconds (default: %d sec)" %
print(_("\t-t SECONDS\tSet refresh time in seconds (default: %d sec)" %
refresh_time))
print(_("\t-v\t\tDisplay the version and exit"))
print(_("\t-y\t\tEnable hddtemp module"))