summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2018-07-28 14:49:34 +0200
committernicolargo <nicolas@nicolargo.com>2018-07-28 14:49:34 +0200
commitfa323bb181f1273ce005bf5e9a4c29a24527a9f6 (patch)
tree01565bc60c59e36d8ab0ce4508709269053a9fec /docs
parentfa58150db6308db183ee3d92494328129ff034e1 (diff)
Add a F.A.Q in the documentation. Add respond for encoding issue
Diffstat (limited to 'docs')
-rw-r--r--docs/faq.rst10
-rw-r--r--docs/index.rst1
-rw-r--r--docs/man/glances.118
3 files changed, 20 insertions, 9 deletions
diff --git a/docs/faq.rst b/docs/faq.rst
new file mode 100644
index 00000000..0f21b2e7
--- /dev/null
+++ b/docs/faq.rst
@@ -0,0 +1,10 @@
+.. _faq:
+
+F.A.Q
+=====
+
+*Any encoding issue ?*
+
+Try to run Glances with the following command line:
+
+ LANG=en_US.UTF-8 LC_ALL= glances
diff --git a/docs/index.rst b/docs/index.rst
index 13b3d5fd..e6515a15 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -31,4 +31,5 @@ Table of Contents
aoa/index
gw/index
api
+ faq
support
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index 0e5a4d36..00209c84 100644
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "GLANCES" "1" "Apr 02, 2018" "3.0.rc1" "Glances"
+.TH "GLANCES" "1" "Jul 28, 2018" "3.0.rc5" "Glances"
.SH NAME
glances \- An eye on your system
.
@@ -54,7 +54,7 @@ show this help message and exit
.INDENT 0.0
.TP
.B \-V, \-\-version
-show program\(aqs version number and exit
+show program’s version number and exit
.UNINDENT
.INDENT 0.0
.TP
@@ -114,7 +114,7 @@ light mode for Curses UI (disable all but top menu)
.INDENT 0.0
.TP
.B \-0, \-\-disable\-irix
-task\(aqs CPU usage will be divided by the total number of CPUs
+task’s CPU usage will be divided by the total number of CPUs
.UNINDENT
.INDENT 0.0
.TP
@@ -449,7 +449,7 @@ Show/hide processes stats
.B \fB0\fP
Enable/disable Irix/Solaris mode
.sp
-Task\(aqs CPU usage will be divided by the total number of CPUs
+Task’s CPU usage will be divided by the total number of CPUs
.TP
.B \fB1\fP
Switch between global CPU and per\-CPU stats
@@ -796,7 +796,7 @@ $ glances \-w
Monitor local machine and export stats to a CSV file:
.INDENT 0.0
.INDENT 3.5
-$ glances \-\-export csv \-\-export\-csv\-file /tmp/glances.csv
+$ glances –export csv –export\-csv\-file /tmp/glances.csv
.UNINDENT
.UNINDENT
.sp
@@ -805,14 +805,14 @@ refresh time (also possible to export to OpenTSDB, Cassandra, Statsd,
ElasticSearch, RabbitMQ and Riemann):
.INDENT 0.0
.INDENT 3.5
-$ glances \-t 5 \-\-export influxdb
+$ glances \-t 5 –export influxdb
.UNINDENT
.UNINDENT
.sp
It is also possible to export stats to multiple endpoints:
.INDENT 0.0
.INDENT 3.5
-$ glances \-t 5 \-\-export influxdb,statsd,csv
+$ glances \-t 5 –export influxdb,statsd,csv
.UNINDENT
.UNINDENT
.sp
@@ -833,14 +833,14 @@ $ glances \-c <ip_server>
Connect to a Glances server and export stats to a StatsD server:
.INDENT 0.0
.INDENT 3.5
-$ glances \-c <ip_server> \-\-export statsd
+$ glances \-c <ip_server> –export statsd
.UNINDENT
.UNINDENT
.sp
Start the client browser (browser mode):
.INDENT 0.0
.INDENT 3.5
-$ glances \-\-browser
+$ glances –browser
.UNINDENT
.UNINDENT
.SH AUTHOR