|
 |
625261 |
From ecac3e25a416bd66b19bc3074f9583dfd965a919 Mon Sep 17 00:00:00 2001
|
|
|
625261 |
From: Andreas Gerstmayr <agerstmayr@redhat.com>
|
|
|
625261 |
Date: Wed, 22 Jun 2022 17:01:09 +0200
|
|
|
625261 |
Subject: [PATCH] add manpages
|
|
|
625261 |
|
|
|
625261 |
|
|
|
5bde66 |
diff --git a/docs/man/man1/grafana-cli.1 b/docs/man/man1/grafana-cli.1
|
|
|
5bde66 |
new file mode 100644
|
|
|
625261 |
index 0000000000..39c0d5cee0
|
|
|
5bde66 |
--- /dev/null
|
|
|
5bde66 |
+++ b/docs/man/man1/grafana-cli.1
|
|
|
625261 |
@@ -0,0 +1,63 @@
|
|
|
625261 |
+.TH GRAFANA "1" "September 2022" "Grafana cli version 9.0.9" "User Commands"
|
|
|
5bde66 |
+.SH NAME
|
|
|
5bde66 |
+grafana-cli \- command line administration for the Grafana metrics dashboard and graph editor
|
|
|
5bde66 |
+.SH DESCRIPTION
|
|
|
5bde66 |
+.SS "NAME:"
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+grafana-cli
|
|
|
5bde66 |
+.SS "USAGE:"
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+\fBgrafana\-cli\fP [\fIglobal options\fP] \fIcommand\fP [\fIcommand options\fP] [\fIarguments\fP...]
|
|
|
5bde66 |
+.SS "COMMANDS:"
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+plugins
|
|
|
5bde66 |
+Manage plugins for grafana
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+admin
|
|
|
5bde66 |
+Grafana admin commands
|
|
|
5bde66 |
+.TP
|
|
|
625261 |
+cue
|
|
|
625261 |
+Cue validation commands
|
|
|
625261 |
+.TP
|
|
|
5bde66 |
+help, h
|
|
|
5bde66 |
+Shows a list of commands or help for one command
|
|
|
5bde66 |
+.SS "GLOBAL OPTIONS:"
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-pluginsDir\fR value
|
|
|
5bde66 |
+path to the grafana plugin directory (default: "/var/lib/grafana/plugins") [$GF_PLUGIN_DIR]
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-repo\fR value
|
|
|
5bde66 |
+url to the plugin repository (default: "https://grafana.com/api/plugins") [$GF_PLUGIN_REPO]
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-pluginUrl\fR value
|
|
|
5bde66 |
+Full url to the plugin zip file instead of downloading the plugin from grafana.com/api [$GF_PLUGIN_URL]
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-insecure\fR
|
|
|
625261 |
+Skip TLS verification (insecure) (default: false)
|
|
|
5bde66 |
+.TP
|
|
|
625261 |
+\fB\-\-debug\fR
|
|
|
625261 |
+Enable debug logging (default: false)
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-configOverrides\fR value
|
|
|
5bde66 |
+Configuration options to override defaults as a string. e.g. cfg:default.paths.log=/dev/null
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-homepath\fR value
|
|
|
5bde66 |
+Path to Grafana install/home path, defaults to working directory
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-config\fR value
|
|
|
5bde66 |
+Path to config file
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-help\fR, \fB\-h\fR
|
|
|
5bde66 |
+show help
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-\-version\fR, \fB\-v\fR
|
|
|
5bde66 |
+print the version
|
|
|
5bde66 |
+.SH "SEE ALSO"
|
|
|
5bde66 |
+Additional documentation for
|
|
|
5bde66 |
+.B grafana-cli
|
|
|
5bde66 |
+is available on-line at
|
|
|
5bde66 |
+.BR http://docs.grafana.org/administration/cli/ .
|
|
|
5bde66 |
+The full documentation for
|
|
|
5bde66 |
+.B Grafana
|
|
|
5bde66 |
+is available on-line at
|
|
|
5bde66 |
+.BR http://docs.grafana.org/ .
|
|
|
5bde66 |
diff --git a/docs/man/man1/grafana-server.1 b/docs/man/man1/grafana-server.1
|
|
|
5bde66 |
new file mode 100644
|
|
|
625261 |
index 0000000000..683a2369cc
|
|
|
5bde66 |
--- /dev/null
|
|
|
5bde66 |
+++ b/docs/man/man1/grafana-server.1
|
|
|
625261 |
@@ -0,0 +1,80 @@
|
|
|
625261 |
+.TH VERSION "1" "September 2022" "Version 9.0.9" "User Commands"
|
|
|
5bde66 |
+.SH NAME
|
|
|
5bde66 |
+grafana-server \- back-end server for the Grafana metrics dashboard and graph editor
|
|
|
5bde66 |
+.SH DESCRIPTION
|
|
|
5bde66 |
+.B grafana-server
|
|
|
5bde66 |
+is the back-end server for the Grafana metrics dashboard and graph editor.
|
|
|
5bde66 |
+The
|
|
|
5bde66 |
+.B grafana-server
|
|
|
5bde66 |
+program should not normally be run from the command line,
|
|
|
5bde66 |
+except when testing or for development purposes.
|
|
|
5bde66 |
+Rather it should be managed by
|
|
|
5bde66 |
+.BR systemd .
|
|
|
5bde66 |
+After installing Grafana, the systemd service should be enabled and started as follows:
|
|
|
5bde66 |
+.P
|
|
|
5bde66 |
+.in 1i
|
|
|
5bde66 |
+.B systemctl daemon-reload
|
|
|
5bde66 |
+.br
|
|
|
5bde66 |
+.B systemctl enable grafana-server.service
|
|
|
5bde66 |
+.br
|
|
|
5bde66 |
+.B systemctl start grafana-server.service
|
|
|
5bde66 |
+.in
|
|
|
5bde66 |
+.P
|
|
|
5bde66 |
+.SH OPTIONS
|
|
|
5bde66 |
+The
|
|
|
625261 |
+.B grafana-server
|
|
|
5bde66 |
+configuration is specified in
|
|
|
5bde66 |
+.BR /etc/grafana/grafana.ini
|
|
|
5bde66 |
+and is well documented with comments.
|
|
|
5bde66 |
+The command-line options listed below override options of
|
|
|
5bde66 |
+the same (or similar) name in the configuration file.
|
|
|
5bde66 |
+.P
|
|
|
5bde66 |
+.HP
|
|
|
5bde66 |
+\fB\-config\fR string
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+path to config file
|
|
|
5bde66 |
+.HP
|
|
|
5bde66 |
+\fB\-homepath\fR string
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+path to grafana install/home path, defaults to working directory
|
|
|
5bde66 |
+.HP
|
|
|
5bde66 |
+\fB\-packaging\fR string
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+describes the way Grafana was installed (default "unknown")
|
|
|
5bde66 |
+.HP
|
|
|
5bde66 |
+\fB\-pidfile\fR string
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+path to pid file
|
|
|
5bde66 |
+.HP
|
|
|
5bde66 |
+\fB\-profile\fR
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+Turn on pprof profiling
|
|
|
5bde66 |
+.HP
|
|
|
625261 |
+\fB\-profile\-addr\fR string
|
|
|
625261 |
+.IP
|
|
|
625261 |
+Define custom address for profiling (default "localhost")
|
|
|
625261 |
+.HP
|
|
|
5bde66 |
+\fB\-profile\-port\fR uint
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+Define custom port for profiling (default 6060)
|
|
|
5bde66 |
+.HP
|
|
|
5bde66 |
+\fB\-tracing\fR
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+Turn on tracing
|
|
|
5bde66 |
+.HP
|
|
|
5bde66 |
+\fB\-tracing\-file\fR string
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+Define tracing output file (default "trace.out")
|
|
|
5bde66 |
+.TP
|
|
|
5bde66 |
+\fB\-v\fR
|
|
|
5bde66 |
+.IP
|
|
|
5bde66 |
+prints current version and exits
|
|
|
625261 |
+.TP
|
|
|
625261 |
+\fB\-vv\fR
|
|
|
625261 |
+.IP
|
|
|
625261 |
+prints current version, all dependencies and exits
|
|
|
5bde66 |
+.SH "SEE ALSO"
|
|
|
5bde66 |
+The full documentation for
|
|
|
5bde66 |
+.B Grafana
|
|
|
5bde66 |
+is available on-line at
|
|
|
5bde66 |
+.BR http://docs.grafana.org/ .
|