summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--debian/netdata.1142
1 files changed, 114 insertions, 28 deletions
diff --git a/debian/netdata.1 b/debian/netdata.1
index 3069d2d2d..19c4256b6 100644
--- a/debian/netdata.1
+++ b/debian/netdata.1
@@ -1,33 +1,119 @@
-.TH NETDATA "1" "April 2016" "" "User Commands"
+.TH NETDATA 1 2018\-12\-31 1.11.1 "real\-time performance monitoring"
+
.SH NAME
-netdata \- real-time charts for system monitoring
+\fBnetdata\fR \- real\-time performance monitoring
+
+.SH SYNOPSIS
+\fBnetdata\fR [\-c \fIOPTIONS\fR] [\-D|\-d] [\-P \fIFILENAME\fR] [\-i \fIIP\fR] [\-p \fIPORT\fR] [\-s \fIPATH\fR] [\-t \fISECONDS\fR] [\-u \fIUSERNAME\fR]
+.PP
+\fBnetdata\fR \-h
+\fBnetdata\fR \-v|\-V
+
.SH DESCRIPTION
-This manual page documents briefly the
-.B netdata
-command.
+\fBnetdata\fR is distributed, real\-time, performance and health monitoring for
+systems and applications. It provides insights of everything happening on the
+systems it runs using interactive web dashboards.
.PP
-The netdata daemon is usually started by an initscript or a systemd service.
-.SH USAGE
-\fI\,/usr/sbin/netdata\/\fP [\-d] [\-l LINES_TO_SAVE] [\-u UPDATE_TIMER] [\-p LISTEN_PORT] [\-dl debug log file] [\-df debug flags]
-.HP
-\fB\-c\fR CONFIG FILE the configuration file to load. Default: \fI\,/etc/netdata/netdata.conf\/\fP.
-.HP
-\fB\-l\fR LINES_TO_SAVE can be from 5 to 864000 lines in JSON data. Default: 3600.
-.HP
-\fB\-t\fR UPDATE_TIMER can be from 1 to 3600 seconds. Default: 1.
-.HP
-\fB\-p\fR LISTEN_PORT can be from 1 to 65535. Default: 19999.
-.HP
-\fB\-u\fR USERNAME can be any system username to run as. Default: none.
-.HP
-\fB\-ch\fR path to access host \fI\,/proc\/\fP and \fI\,/sys\/\fP when running in a container. Default: empty.
-.HP
-\fB\-nd\fR or \fB\-nodeamon\fR to disable forking in the background. Default: unset.
-.HP
-\fB\-df\fR FLAGS debug options. Default: 0x00000000.
-.SH "SEE ALSO"
-The full documentation for netdata is available in /usr/share/doc/netdata
+It can run autonomously without any third party components or it can be
+integrated to existing monitoring tool chains (Prometheus, Graphite,
+OpenTSDB, Kafka, Grafana, etc).
+
+.SH OPTIONS
+The \fBnetdata\fR daemon is usually started by an initscript or a systemd
+service, the following options are available:
+
+.IP "\-c \fIFILENAME\fR" 4
+Configuration file to load.
+.br
+Default: /etc/netdata/netdata.conf.
+
+.IP "\-D" 4
+Do not fork. Run in the foreground.
+.br
+Default: run in the background
+
+.IP "\-d" 4
+Fork. Run in the background.
+.br
+Default: run in the background
+
+.IP "\-h" 4
+Display this help message.
+
+.IP "\-P \fIFILENAME\fR" 4
+File to save a pid while running.
+.br
+Default: do not save pid to a file
+
+.IP "\-i \fIIP\fR" 4
+The IP address to listen to.
+.br
+Default: all IP addresses IPv4 and IPv6
+
+.IP "\-p \fIPORT\fR" 4
+API/Web port to use.
+.br
+Default: 19999
+
+.IP "\-s \fIPATH\fR" 4
+Prefix for /proc and /sys (for containers).
+.br
+Default: no prefix
+
+.IP "\-t \fISECONDS\fR" 4
+The internal clock of netdata.
+.br
+Default: 1
+
+.IP "\-u \fIUSERNAME\fR" 4
+Run as user.
+.br
+Default: netdata
+
+.IP "\-v, \-V" 4
+Print netdata version and exit.
+
+.IP "\-W \fIOPTIONS\fR" 4
+See Advanced options below.
+
+.SS ADVANCED OPTIONS
+
+.IP "\-W stacksize=\fIN\fR" 4
+Set the stacksize (in bytes).
+
+.IP "\-W debug_flags=\fIN\fR" 4
+Set runtime tracing to debug.log.
+
+.IP "\-W unittest" 4
+Run internal unittests and exit.
+
+.IP "\-W set \fISECTION\fR \fIOPTION\fR \fIVALUE\fR" 4
+set netdata.conf option from the command line.
+
+.IP "\-W simple\-pattern \fIPATTERN\fR \fISTRING\fR" 4
+Check if string matches pattern and exit.
+
+.SH SIGNALS
+
+.IP "HUP" 4
+Close and reopen log files.
+
+.IP "USR1" 4
+Save internal DB to disk.
+
+.IP "USR2" 4
+Reload health configuration.
+
+.SH FILES
+.IP "\fB/etc/netdata\fR" 4
+Configuration file.
+.IP "\fB/usr/share/doc/netdata" 4
+Upstream documentation.
+
+.SH HOMEPAGE
+More information about netdata can be found on the homepage at <\fIhttps://my-netdata.io\fR> and in the manual at <\fIhttps://docs.netdata.cloud\fR>.
+
.SH AUTHOR
-netadata was written by Costa Tsaousis <costa@tsaousis.gr>
+netdata was written by Costa Tsaousis <\fIcosta@tsaousis.gr\fR>.
.PP
-This manual page was written by Federico Ceratto <federico@debian.org> for the Debian project and may be used by others.
+This manual page was written by Federico Ceratto <\fIfederico@debian.org\fR> for the Debian project and may be used by others.