From 3c53750fadfdbfeba8858fc37f8aeac5597f3ee8 Mon Sep 17 00:00:00 2001 From: Federico Ceratto Date: Sun, 24 Apr 2016 09:53:05 +0100 Subject: Add manpage --- debian/netdata.1 | 33 +++++++++++++++++++++++++++++++++ debian/netdata.manpages | 1 + 2 files changed, 34 insertions(+) create mode 100644 debian/netdata.1 create mode 100644 debian/netdata.manpages diff --git a/debian/netdata.1 b/debian/netdata.1 new file mode 100644 index 000000000..3069d2d2d --- /dev/null +++ b/debian/netdata.1 @@ -0,0 +1,33 @@ +.TH NETDATA "1" "April 2016" "" "User Commands" +.SH NAME +netdata \- real-time charts for system monitoring +.SH DESCRIPTION +This manual page documents briefly the +.B netdata +command. +.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 +.SH AUTHOR +netadata was written by Costa Tsaousis +.PP +This manual page was written by Federico Ceratto for the Debian project and may be used by others. diff --git a/debian/netdata.manpages b/debian/netdata.manpages new file mode 100644 index 000000000..421a3ab88 --- /dev/null +++ b/debian/netdata.manpages @@ -0,0 +1 @@ +debian/netdata.1 -- cgit v1.2.3