glances/man/glances.1

99 lines
2.4 KiB
Groff
Raw Normal View History

2012-11-03 17:45:20 +04:00
.TH glances 1 "November, 2012" "version 1.5" "USER COMMANDS"
2011-12-14 00:57:51 +04:00
.SH NAME
glances \- CLI curses based monitoring tool
.SH SYNOPSIS
.B glances
2012-11-03 17:45:20 +04:00
[\-bdhmnsv] [\-t refresh] [\-B bind] [\-c server] [\-p port] [\-o output] [\-f file]
2011-12-14 00:57:51 +04:00
.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
2012-09-22 17:24:32 +04:00
displayed information depending on the terminal size.
2011-12-14 00:57:51 +04:00
.PP
2012-02-16 14:16:00 +04:00
This tool is written in Python and uses PsUtil to fetch the statistical values from key elements.
2011-12-14 00:57:51 +04:00
.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
2012-11-03 17:45:20 +04:00
.PP
'b' to switch between bit/s or byte/s for network IO
2011-12-14 00:57:51 +04:00
.PP
'c' the processes list is sorted by CPU consomption
2011-12-26 00:35:46 +04:00
.PP
'd' Disable or enable the disk IO stats
.PP
'f' Disable or enable the file system stats
2012-01-04 17:24:07 +04:00
.PP
'h' Hide or show the help message
2012-01-31 17:37:56 +04:00
.PP
'l' Hide or show the logs
2011-12-14 00:57:51 +04:00
.PP
'm' the processes list is sorted by process size
2011-12-26 00:35:46 +04:00
.PP
'n' Disable or enable the network interfaces stats
2012-11-03 17:45:20 +04:00
.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
2011-12-14 00:57:51 +04:00
.PP
'q' Exit
2012-11-03 17:45:20 +04:00
.PP
'1' Switch between global CPU and per core stats
2011-12-14 00:57:51 +04:00
.PP
The current version grab the following stats: CPU, Load, Memory, Network rate, Disk IO, file system,
2011-12-14 00:57:51 +04:00
process number and details.
.SH OPTIONS
.TP
.TP
2012-09-22 17:24:32 +04:00
\-b
Display network rate in Byte per second
.TP
2012-11-03 17:45:20 +04:00
\-B bind
Bind server to the given IP or host NAME
.TP
\-c server
Connect to a Glances server (IP address or hostname)
.TP
2012-09-22 17:24:32 +04:00
\-d
Disable disk I/O module
.TP
\-f file
Set the output folder (HTML) or file (CSV)
.TP
2011-12-14 00:57:51 +04:00
\-h
Display the syntax and exit
.TP
2012-09-22 17:24:32 +04:00
\-m
Disable mount module
.TP
\-n
Disable network module
.TP
\-o output
Define additional output (available: HTML or CSV)
.TP
2012-11-03 17:45:20 +04:00
\-p port
Define the client or server TCP port (default: 61209)
.TP
\-s
Run Glances in server mode
.TP
2012-09-22 17:24:32 +04:00
\-t sec
Set the refresh time in seconds (default: 2)
2011-12-14 00:57:51 +04:00
.TP
2012-09-22 17:24:32 +04:00
\-v
2011-12-14 00:57:51 +04:00
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).
2011-12-14 00:57:51 +04:00
.SH AUTHOR
Glances is written by Nicolargo (contact@nicolargo.com).