glances/man/glances.1
2012-11-03 14:45:20 +01:00

99 lines
2.4 KiB
Groff

.TH glances 1 "November, 2012" "version 1.5" "USER COMMANDS"
.SH NAME
glances \- CLI curses based monitoring tool
.SH SYNOPSIS
.B glances
[\-bdhmnsv] [\-t refresh] [\-B bind] [\-c server] [\-p port] [\-o output] [\-f file]
.SH DESCRIPTION
Glances is a free (LGPL) curses-based monitoring tool which aims to present a maximum of information
in a minimum of space, ideally to fit in a classical 80x24 terminal. Glances can adapt dynamicaly the
displayed information depending on the terminal size.
.PP
This tool is written in Python and uses PsUtil to fetch the statistical values from key elements.
.PP
You can use the following keys to sort the processesi list:
.PP
'a' to set the automatic mode. The process list is sorted automatically
.PP
'b' to switch between bit/s or byte/s for network IO
.PP
'c' the processes list is sorted by CPU consomption
.PP
'd' Disable or enable the disk IO stats
.PP
'f' Disable or enable the file system stats
.PP
'h' Hide or show the help message
.PP
'l' Hide or show the logs
.PP
'm' the processes list is sorted by process size
.PP
'n' Disable or enable the network interfaces stats
.PP
'p' The processes list is sorted by process name
.PP
'w' Delete finished warning logs messages
.PP
'x' Delete finished warning and critical logs
.PP
'q' Exit
.PP
'1' Switch between global CPU and per core stats
.PP
The current version grab the following stats: CPU, Load, Memory, Network rate, Disk IO, file system,
process number and details.
.SH OPTIONS
.TP
.TP
\-b
Display network rate in Byte per second
.TP
\-B bind
Bind server to the given IP or host NAME
.TP
\-c server
Connect to a Glances server (IP address or hostname)
.TP
\-d
Disable disk I/O module
.TP
\-f file
Set the output folder (HTML) or file (CSV)
.TP
\-h
Display the syntax and exit
.TP
\-m
Disable mount module
.TP
\-n
Disable network module
.TP
\-o output
Define additional output (available: HTML or CSV)
.TP
\-p port
Define the client or server TCP port (default: 61209)
.TP
\-s
Run Glances in server mode
.TP
\-t sec
Set the refresh time in seconds (default: 2)
.TP
\-v
Display the version and exit
.SH EXAMPLES
.TP
Refresh information every 5 seconds:
.B glances
\-t 5
.PP
.SH EXIT STATUS
glances returns a zero exit status if it succeeds to print/grab information.
.PP
It returns 2 if it fails to parse its options (missing arguments, invalid value, etc).
.SH AUTHOR
Glances is written by Nicolargo (contact@nicolargo.com).