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