|
 |
d709f2 |
diff --git a/docs/man/man1/grafana-cli.1 b/docs/man/man1/grafana-cli.1
|
|
|
d709f2 |
new file mode 100644
|
|
|
d709f2 |
index 0000000000..171748fcda
|
|
|
d709f2 |
--- /dev/null
|
|
|
d709f2 |
+++ b/docs/man/man1/grafana-cli.1
|
|
|
d709f2 |
@@ -0,0 +1,51 @@
|
|
|
d709f2 |
+.TH GRAFANA "1" "February 2019" "Grafana cli version 5.4.3" "User Commands"
|
|
|
d709f2 |
+.SH NAME
|
|
|
d709f2 |
+grafana-cli \- command line administration for the Grafana metrics dashboard and graph editor
|
|
|
d709f2 |
+.SH DESCRIPTION
|
|
|
d709f2 |
+.SS "NAME:"
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+grafana-cli
|
|
|
d709f2 |
+.SS "USAGE:"
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+\fBgrafana\-cli\fP [\fIglobal options\fP] \fIcommand\fP [\fIcommand options\fP] [\fIarguments\fP...]
|
|
|
d709f2 |
+.SS "COMMANDS:"
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+plugins
|
|
|
d709f2 |
+Manage plugins for grafana
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+admin
|
|
|
d709f2 |
+Grafana admin commands
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+help, h
|
|
|
d709f2 |
+Shows a list of commands or help for one command
|
|
|
d709f2 |
+.SS "GLOBAL OPTIONS:"
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+\fB\-\-pluginsDir\fR value
|
|
|
d709f2 |
+path to the grafana plugin directory (default: "/var/lib/grafana/plugins") [$GF_PLUGIN_DIR]
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+\fB\-\-repo\fR value
|
|
|
d709f2 |
+url to the plugin repository (default: "https://grafana.com/api/plugins") [$GF_PLUGIN_REPO]
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+\fB\-\-pluginUrl\fR value
|
|
|
d709f2 |
+Full url to the plugin zip file instead of downloading the plugin from grafana.com/api [$GF_PLUGIN_URL]
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+\fB\-\-insecure\fR
|
|
|
d709f2 |
+Skip TLS verification (insecure)
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+\fB\-\-debug\fR, \fB\-d\fR
|
|
|
d709f2 |
+enable debug logging
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+\fB\-\-help\fR, \fB\-h\fR
|
|
|
d709f2 |
+show help
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+\fB\-\-version\fR, \fB\-v\fR
|
|
|
d709f2 |
+print the version
|
|
|
d709f2 |
+.SH "SEE ALSO"
|
|
|
d709f2 |
+Additional documentation for
|
|
|
d709f2 |
+.B grafana-cli
|
|
|
d709f2 |
+is available on-line at
|
|
|
d709f2 |
+.BR http://docs.grafana.org/administration/cli/ .
|
|
|
d709f2 |
+The full documentation for
|
|
|
d709f2 |
+.B Grafana
|
|
|
d709f2 |
+is available on-line at
|
|
|
d709f2 |
+.BR http://docs.grafana.org/ .
|
|
|
d709f2 |
diff --git a/docs/man/man1/grafana-server.1 b/docs/man/man1/grafana-server.1
|
|
|
d709f2 |
new file mode 100644
|
|
|
d709f2 |
index 0000000000..30b7c1306f
|
|
|
d709f2 |
--- /dev/null
|
|
|
d709f2 |
+++ b/docs/man/man1/grafana-server.1
|
|
|
d709f2 |
@@ -0,0 +1,156 @@
|
|
|
d709f2 |
+.TH VERSION "1" "February 2019" "Version 5.4.3" "User Commands"
|
|
|
d709f2 |
+.SH NAME
|
|
|
d709f2 |
+grafana-server \- back-end server for the Grafana metrics dashboard and graph editor
|
|
|
d709f2 |
+.SH DESCRIPTION
|
|
|
d709f2 |
+.B grafana-server
|
|
|
d709f2 |
+is the back-end server for the Grafana metrics dashboard and graph editor.
|
|
|
d709f2 |
+The
|
|
|
d709f2 |
+.B grafana-server
|
|
|
d709f2 |
+program should not normally be run from the command line,
|
|
|
d709f2 |
+except when testing or for development purposes.
|
|
|
d709f2 |
+Rather it should be managed by
|
|
|
d709f2 |
+.BR systemd .
|
|
|
d709f2 |
+After installing Grafana, the systemd service should be enabled and started as follows:
|
|
|
d709f2 |
+.P
|
|
|
d709f2 |
+.in 1i
|
|
|
d709f2 |
+.B systemctl daemon-reload
|
|
|
d709f2 |
+.br
|
|
|
d709f2 |
+.B systemctl enable grafana-server.service
|
|
|
d709f2 |
+.br
|
|
|
d709f2 |
+.B systemctl start grafana-server.service
|
|
|
d709f2 |
+.in
|
|
|
d709f2 |
+.P
|
|
|
d709f2 |
+.SH OPTIONS
|
|
|
d709f2 |
+The
|
|
|
d709f2 |
+.B gafana-server
|
|
|
d709f2 |
+configuration is specified in
|
|
|
d709f2 |
+.BR /etc/grafana/grafana.ini
|
|
|
d709f2 |
+and is well documented with comments.
|
|
|
d709f2 |
+The command-line options listed below override options of
|
|
|
d709f2 |
+the same (or similar) name in the configuration file and also provide
|
|
|
d709f2 |
+additional options for testing Grafana.
|
|
|
d709f2 |
+.P
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-config\fR string
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+path to config file
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-homepath\fR string
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+path to grafana install/home path, defaults to working directory
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-packaging\fR string
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+describes the way Grafana was installed (default "unknown")
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-pidfile\fR string
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+path to pid file
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-profile\fR
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+Turn on pprof profiling
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-profile\-port\fR int
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+Define custom port for profiling (default 6060)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.bench regexp
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+run only benchmarks matching regexp
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.benchmem
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+print memory allocations for benchmarks
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.benchtime d
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+run each benchmark for duration d (default 1s)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.blockprofile file
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+write a goroutine blocking profile to file
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.blockprofilerate rate
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+set blocking profile rate (see runtime.SetBlockProfileRate) (default 1)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.count n
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+run tests and benchmarks n times (default 1)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.coverprofile file
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+write a coverage profile to file
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.cpu list
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+comma\-separated list of cpu counts to run each test with
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.cpuprofile file
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+write a cpu profile to file
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.failfast
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+do not start new tests after the first test failure
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.list regexp
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+list tests, examples, and benchmarks matching regexp then exit
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.memprofile file
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+write a memory profile to file
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.memprofilerate rate
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+set memory profiling rate (see runtime.MemProfileRate)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.mutexprofile string
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+write a mutex contention profile to the named file after execution
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.mutexprofilefraction int
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+if >= 0, calls runtime.SetMutexProfileFraction() (default 1)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.outputdir dir
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+write profiles to dir
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.parallel n
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+run at most n tests in parallel (default 8)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.run regexp
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+run only tests and examples matching regexp
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.short
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+run smaller test suite to save time
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.testlogfile file
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+write test action log to file (for use only by cmd/go)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.timeout d
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+panic test binary after duration d (default 0, timeout disabled)
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.trace file
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+write an execution trace to file
|
|
|
d709f2 |
+.HP
|
|
|
d709f2 |
+\fB\-test\fR.v
|
|
|
d709f2 |
+.IP
|
|
|
d709f2 |
+verbose: print additional output
|
|
|
d709f2 |
+.TP
|
|
|
d709f2 |
+\fB\-v\fR
|
|
|
d709f2 |
+prints current version and exits
|
|
|
d709f2 |
+.SH "SEE ALSO"
|
|
|
d709f2 |
+The full documentation for
|
|
|
d709f2 |
+.B Grafana
|
|
|
d709f2 |
+is available on-line at
|
|
|
d709f2 |
+.BR http://docs.grafana.org/ .
|