aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGöktürk Yüksek <gokturk@gentoo.org>2017-01-02 01:20:18 -0500
committerGöktürk Yüksek <gokturk@gentoo.org>2017-01-02 01:20:18 -0500
commitb21f6b1fe773a0d5b1946163eddeeacfe7ff4314 (patch)
tree96a2c0ebe132db9046d55c8983e1f4be82731187
parentclient/gentoostats-cli: add a command line option to specify the port (diff)
downloadgentoostats-b21f6b1fe773a0d5b1946163eddeeacfe7ff4314.tar.gz
gentoostats-b21f6b1fe773a0d5b1946163eddeeacfe7ff4314.tar.bz2
gentoostats-b21f6b1fe773a0d5b1946163eddeeacfe7ff4314.zip
man: add the man page for gentoostats-send
-rw-r--r--man/gentoostats-send.149
1 files changed, 49 insertions, 0 deletions
diff --git a/man/gentoostats-send.1 b/man/gentoostats-send.1
new file mode 100644
index 0000000..70e0a31
--- /dev/null
+++ b/man/gentoostats-send.1
@@ -0,0 +1,49 @@
+.TH "GENTOOSTATS-SEND" "1" "Jan 2017" "" "Gentoostats"
+.SH "NAME"
+gentoostats\-send \- Command\-line interface to submit host statistics
+to a remote gentoostats server
+.SH "SYNOPSIS"
+.TP
+\fBgentoostats\-send\fR [\fIoptions\fR]
+.SH "DESCRIPTION"
+gentoostats\-send is a utility for submitting various host and package
+statistics to a gentoostats server.
+.SH "OPTIONS"
+.TP
+.B \-s, \-\-server
+Host name of the remote gentoostats server
+.TP
+.B \-p, \-\-port
+Port number of the remote gentoostats server
+.TP
+.B \-u, \-\-url
+URL of the remote gentoostats server
+.TP
+.B \-a, \-\-auth
+Path to the authentication file
+.TP
+.B \-c, \-\-config
+Path to the configuration file
+.TP
+.B \-v, \-\-verbose
+Output the statistics being submitted on the command line in the JSON
+format
+.TP
+.B \-h, \-\-help
+Show the help message
+.SH "FILES"
+.TP
+.B /etc/gentoostats/auth.cfg
+Contains the host-specific randomly generated UUID and password to be
+transmitted to the remote gentoostats server for authentication purposes.
+.TP
+.B /etc/gentoostats/payload.cfg
+Determines what kind of information will be included in the statistics
+that is sent to a remote gentoostats server. Users should edit this
+file to suit their privacy needs.
+.SH "BUGS"
+Please report bugs via https://bugs.gentoo.org/
+.SH "AUTHOR"
+Göktürk Yüksek <gokturk@gentoo.org>
+.SH "SEE ALSO"
+\fBgentoostats\-cli\fR(1)