glances/docs/cmds.rst

433 lines
7.6 KiB
ReStructuredText
Raw Normal View History

2016-03-02 15:29:19 +03:00
.. _cmds:
Command Reference
=================
Command-Line Options
--------------------
.. option:: -h, --help
show this help message and exit
.. option:: -V, --version
show program's version number and exit
.. option:: -d, --debug
2017-03-12 20:52:17 +03:00
enable debug mode
2016-03-02 15:29:19 +03:00
.. option:: -C CONF_FILE, --config CONF_FILE
path to the configuration file
.. option:: --modules-list
2016-03-02 15:29:19 +03:00
display modules (plugins & exports) list and exit
2016-03-02 15:29:19 +03:00
.. option:: --disable-plugin PLUGIN
2016-03-02 15:29:19 +03:00
2021-03-13 10:53:50 +03:00
disable PLUGIN (comma separated list)
2016-03-02 15:29:19 +03:00
.. option:: --enable-plugin PLUGIN
2021-03-13 10:53:50 +03:00
enable PLUGIN (comma separated list)
2018-02-11 13:02:16 +03:00
.. option:: --stdout PLUGINS_STATS
display stats to stdout (comma separated list of plugins/plugins.attribute)
.. option:: --export EXPORT
2016-03-02 15:29:19 +03:00
2021-03-13 10:53:50 +03:00
enable EXPORT module (comma separated list)
2016-03-02 15:29:19 +03:00
.. option:: --export-csv-file EXPORT_CSV_FILE
2016-03-02 15:29:19 +03:00
file path for CSV exporter
2016-03-02 15:29:19 +03:00
.. option:: --export-json-file EXPORT_JSON_FILE
2016-03-02 15:29:19 +03:00
file path for JSON exporter
2016-03-02 15:29:19 +03:00
2016-11-05 20:13:59 +03:00
.. option:: --disable-process
2016-03-02 15:29:19 +03:00
disable process module (reduce Glances CPU consumption)
2016-03-02 15:29:19 +03:00
2017-10-12 12:33:06 +03:00
.. option:: --disable-webui
2018-02-15 21:45:45 +03:00
disable the Web UI (only the RESTful API will respond)
2017-10-12 12:33:06 +03:00
.. option:: --light, --enable-light
light mode for Curses UI (disable all but top menu)
2016-11-05 20:13:59 +03:00
.. option:: -0, --disable-irix
2016-03-02 15:29:19 +03:00
2016-11-05 20:13:59 +03:00
task's CPU usage will be divided by the total number of CPUs
.. option:: -1, --percpu
start Glances in per CPU mode
2016-03-02 15:29:19 +03:00
.. option:: -2, --disable-left-sidebar
2017-03-12 20:52:17 +03:00
disable network, disk I/O, FS and sensors modules
2016-03-02 15:29:19 +03:00
2016-11-05 20:13:59 +03:00
.. option:: -3, --disable-quicklook
2016-03-02 15:29:19 +03:00
2016-11-05 20:13:59 +03:00
disable quick look module
2016-03-02 15:29:19 +03:00
2016-11-05 20:13:59 +03:00
.. option:: -4, --full-quicklook
2016-11-05 20:13:59 +03:00
disable all but quick look and load
2016-11-05 20:13:59 +03:00
.. option:: -5, --disable-top
2016-03-02 15:29:19 +03:00
2016-11-05 20:13:59 +03:00
disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)
.. option:: -6, --meangpu
start Glances in mean GPU mode
2016-11-05 20:13:59 +03:00
.. option:: --enable-history
2017-12-29 21:10:25 +03:00
enable the history mode
2016-03-02 15:29:19 +03:00
.. option:: --disable-bold
disable bold mode in the terminal
.. option:: --disable-bg
disable background colors in the terminal
.. option:: --enable-process-extended
enable extended stats on top process
.. option:: -c CLIENT, --client CLIENT
2017-03-15 23:39:27 +03:00
connect to a Glances server by IPv4/IPv6 address, hostname or hostname:port
2016-03-02 15:29:19 +03:00
.. option:: -s, --server
run Glances in server mode
.. option:: --browser
start the client browser (list of servers)
.. option:: --disable-autodiscover
disable autodiscover feature
.. option:: -p PORT, --port PORT
define the client/server TCP port [default: 61209]
.. option:: -B BIND_ADDRESS, --bind BIND_ADDRESS
bind server to the given IPv4/IPv6 address or hostname
.. option:: --username
define a client/server username
.. option:: --password
define a client/server password
.. option:: --snmp-community SNMP_COMMUNITY
SNMP community
.. option:: --snmp-port SNMP_PORT
SNMP port
.. option:: --snmp-version SNMP_VERSION
SNMP version (1, 2c or 3)
.. option:: --snmp-user SNMP_USER
SNMP username (only for SNMPv3)
.. option:: --snmp-auth SNMP_AUTH
SNMP authentication key (only for SNMPv3)
.. option:: --snmp-force
force SNMP mode
.. option:: -t TIME, --time TIME
set refresh time in seconds [default: 3 sec]
.. option:: -w, --webserver
run Glances in web server mode (bottle lib needed)
2016-11-05 20:13:59 +03:00
.. option:: --cached-time CACHED_TIME
set the server cache time [default: 1 sec]
.. option:: --open-web-browser
2016-11-05 20:13:59 +03:00
try to open the Web UI in the default Web browser
2016-03-02 15:29:19 +03:00
.. option:: -q, --quiet
do not display the curses interface
.. option:: -f PROCESS_FILTER, --process-filter PROCESS_FILTER
set the process filter pattern (regular expression)
.. option:: --process-short-name
force short name for processes name
.. option:: --hide-kernel-threads
hide kernel threads in process list (not available on Windows)
2016-03-02 15:29:19 +03:00
.. option:: -b, --byte
display network rate in byte per second
.. option:: --diskio-show-ramfs
show RAM FS in the DiskIO plugin
.. option:: --diskio-iops
show I/O per second in the DiskIO plugin
.. option:: --fahrenheit
display temperature in Fahrenheit (default is Celsius)
.. option:: --fs-free-space
display FS free space instead of used
.. option:: --theme-white
optimize display colors for white background
2016-11-05 20:13:59 +03:00
.. option:: --disable-check-update
disable online Glances version ckeck
2016-03-02 15:29:19 +03:00
Interactive Commands
--------------------
The following commands (key pressed) are supported while in Glances:
``ENTER``
Set the process filter
2017-03-12 20:52:17 +03:00
.. note:: On macOS please use ``CTRL-H`` to delete filter.
2016-03-02 15:29:19 +03:00
Filter is a regular expression pattern:
- ``gnome``: matches all processes starting with the ``gnome``
string
- ``.*gnome.*``: matches all processes containing the ``gnome``
string
``a``
Sort process list automatically
- If CPU ``>70%``, sort processes by CPU usage
- If MEM ``>70%``, sort processes by MEM usage
- If CPU iowait ``>60%``, sort processes by I/O read and write
``A``
Enable/disable Application Monitoring Process
2016-03-02 15:29:19 +03:00
``b``
Switch between bit/s or Byte/s for network I/O
``B``
View disk I/O counters per second
``c``
Sort processes by CPU usage
``C``
Enable/disable cloud stats
2016-03-02 15:29:19 +03:00
``d``
Show/hide disk I/O stats
``D``
Enable/disable Docker stats
``e``
Enable/disable top extended stats
``E``
Erase current process filter
``f``
Show/hide file system and folder monitoring stats
``F``
Switch between file system used and free space
``g``
Generate graphs for current history
``G``
Enable/disable GPU stats
2016-03-02 15:29:19 +03:00
``h``
Show/hide the help screen
``i``
Sort processes by I/O rate
``I``
Show/hide IP module
``+``
2022-07-10 19:42:34 +03:00
Increase selected process nice level / Lower the priority (need right) - Only in standalone mode.
``-``
2022-07-10 19:42:34 +03:00
Decrease selected process nice level / Higher the priority (need right) - Only in standalone mode.
``k``
Kill selected process (need right) - Only in standalone mode.
``K``
Show/hide TCP connections
2016-03-02 15:29:19 +03:00
``l``
Show/hide log messages
``m``
Sort processes by MEM usage
``M``
Reset processes summary min/max
``n``
Show/hide network stats
2016-12-31 20:41:58 +03:00
``N``
Show/hide current time
2016-03-02 15:29:19 +03:00
``p``
Sort processes by name
``P``
Enable/Disable ports stats
``q|ESC|CTRL-C``
2016-03-02 15:29:19 +03:00
Quit the current Glances session
``Q``
Show/hide IRQ module
2016-03-02 15:29:19 +03:00
``r``
Reset history
``R``
Show/hide RAID plugin
``s``
Show/hide sensors stats
``S``
Enable/disable spark lines
2016-03-02 15:29:19 +03:00
``t``
Sort process by CPU times (TIME+)
``T``
View network I/O as combination
``u``
Sort processes by USER
``U``
View cumulative network I/O
``w``
Delete finished warning log messages
2016-11-05 20:13:59 +03:00
``W``
Show/hide Wifi module
2016-03-02 15:29:19 +03:00
``x``
Delete finished warning and critical log messages
``z``
Show/hide processes stats
``0``
Enable/disable Irix/Solaris mode
Task's CPU usage will be divided by the total number of CPUs
``1``
Switch between global CPU and per-CPU stats
``2``
Enable/disable left sidebar
``3``
Enable/disable the quick look module
``4``
Enable/disable all but quick look and load module
``5``
Enable/disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)
2017-03-12 20:52:17 +03:00
``6``
Enable/disable mean GPU mode
``9``
Switch UI theme between black and white
2016-03-02 15:29:19 +03:00
``/``
Switch between process command line or command name
2020-11-07 11:29:50 +03:00
``F5``
Refresh stats in curses user interface
2016-03-02 15:29:19 +03:00
``LEFT``
Navigation leff through process sort
``RIGHT``
Navigation right through process sort
``UP``
Up in the processes list
``DOWN``
Down in the processes list
2016-03-02 15:29:19 +03:00
In the Glances client browser (accessible through the ``--browser``
command line argument):
``ENTER``
Run the selected server
``UP``
Up in the servers list
``DOWN``
Down in the servers list
``q|ESC``
Quit Glances