From 4558893c37c5c73ad09ac914cbeea9af8ef8bfcd Mon Sep 17 00:00:00 2001 From: Michael Carlberg Date: Thu, 19 Jan 2017 18:12:39 +0100 Subject: [PATCH] docs: Update manpage --- man/polybar.1 | 62 ++++++++++++++++++++------------- src/components/command_line.cpp | 2 +- src/main.cpp | 5 +-- 3 files changed, 41 insertions(+), 28 deletions(-) diff --git a/man/polybar.1 b/man/polybar.1 index 8ac5490a..d91b73c5 100644 --- a/man/polybar.1 +++ b/man/polybar.1 @@ -1,48 +1,60 @@ -.TH polybar 1 2016-12-23 "polybar 2.4.2-1-g70bb6f6" "User Manual" +.TH polybar 1 2017-01-19 "polybar 2.5.2-11-g6d489e3" "User Manual" .SH NAME -\fBpolybar\fR \- A fast and easy-to-use tool status bar. +polybar \- A fast and easy-to-use tool status bar .SH SYNOPSIS -.P -polybar \fIBAR-NAME\fR [\fB\-c\fR \fICONFIG\fR|\fB\-l\fR \fILOG_LEVEL\fR|\fB\-d\fR \fIPARAM\fR|\fB\f-q\fR|\fB\-r\fR|\fB\-m\fR|\fB\f-s\fR|\fB\-w\fR] -.P -polybar [\fB\-h\fR | \fB\-\-help\fR] +\fBpolybar\fR [\fIOPTION\fR]... \fIBAR\fR .SH DESCRIPTION -\fBPolybar\fR aims to help users build beautiful and highly customizable status bars for their desktop environment, without the need of having a black belt in shell scripting. -.P -Please report issues by creating a ticket on GitHub (\fIhttps://github.com/jaagr/polybar\fR). -.P -Mandatory arguments to long options are mandatory for short options too. +Polybar aims to help users build beautiful and highly customizable status bars for their desktop environment, without the need of having a black belt in shell scripting. .TP \fB\-h\fR, \fB\-\-help\fR -Display help text and exit. +Display help text and exit .TP \fB\-v\fR, \fB\-\-version\fR -Display build details and exit. +Display build details and exit .TP \fB\-l\fR, \fB\-\-log\fR=\fILEVEL\fR -Set how verbose \fBpolybar\fR's logging is. \fILEVEL\fR must be one of: `error`, `warning` or `info`. +Set the logging verbosity (default: \fBWARNING\fR) +.br +\fILEVEL\fR is one of: error, warning, info, trace .TP \fB\-q\fR, \fB\-\-quiet\fR -Be quiet (will override -l). +Be quiet (will override -l) .TP -\fB\-c\fR, \fB\-\-config\fR=\fICONFIG\fR -Specify the path to the configuration file. By default, configuration files are read from \fI$XDG_CONFIG_HOME/.config/polybar\fR. When the \fI$XDG_CONFIG_HOME\fR variable is absent, then \fI~/.config/polybar\fR directory is used instead. +\fB\-c\fR, \fB\-\-config\fR=\fIFILE\fR +Specify the path to the configuration file. By default, the configuration file is loaded from: +.RS 10 +.P +\fB$XDG_CONFIG_HOME/polybar/config\fR +.br +\fB$HOME/.config/polybar/config\fR +.P +.RE .TP \fB\-r\fR, \fB\-\-reload\fR -Reload the application when the config file has been modified. +Reload the application when the config file has been modified .TP \fB\-d\fR, \fB\-\-dump\fR=\fIPARAM\fR -Print the value of the specified parameter \fIPARAM\fR in the section [bar/\fIBAR-NAME\fR] inside the configuration file and exit. +Print the value of the specified parameter \fIPARAM\fR in bar section and exit .TP \fB\-m\fR, \fB\-\-list\-monitors\fR -Print list of available monitors and exit. +Print list of available monitors and exit .TP \fB\-w\fR, \fB\-\-print\-wmname\fR -Print the generated \fIWM_NAME\fR and exit. +Print the generated \fIWM_NAME\fR and exit .TP \fB\-s\fR, \fB\-\-stdout\fR -Dump content to stdout instead of rendering an X window. -.RE -.SH HOMEPAGE +Output the data to stdout instead of drawing it to the X window +.TP +\fB\-p\fR, \fB\-\-png\fR=\fIFILE\fR +Save png snapshot to \fIFILE\fR after running for 3 seconds .sp -https://github.com/jaagr/polybar +.SH AUTHOR +Michael Carlberg +.br +Contributors can be listed on GitHub. +.SH REPORTING BUGS +Report issues on GitHub +.SH SEE ALSO +Full documentation at: +.br +Project wiki: diff --git a/src/components/command_line.cpp b/src/components/command_line.cpp index 45be7e8a..6f83eb64 100644 --- a/src/components/command_line.cpp +++ b/src/components/command_line.cpp @@ -11,7 +11,7 @@ namespace command_line { */ parser::make_type parser::make(string&& scriptname, const options&& opts) { return factory_util::unique( - "Usage: " + scriptname + " bar_name [OPTION...]", forward(opts)); + "Usage: " + scriptname + " [OPTION]... BAR", forward(opts)); } /** diff --git a/src/main.cpp b/src/main.cpp index 95e94b77..1965b6bb 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -27,10 +27,11 @@ int main(int argc, char** argv) { command_line::option{"-q", "--quiet", "Be quiet (will override -l)"}, command_line::option{"-c", "--config", "Path to the configuration file", "FILE"}, command_line::option{"-r", "--reload", "Reload when the configuration has been modified"}, - command_line::option{"-d", "--dump", "Print value of PARAM in section [bar_name] and exit", "PARAM"}, + command_line::option{"-d", "--dump", "Print value of PARAM in bar section and exit", "PARAM"}, command_line::option{"-m", "--list-monitors", "Print list of available monitors and exit"}, command_line::option{"-w", "--print-wmname", "Print the generated WM_NAME and exit"}, - command_line::option{"-s", "--stdout", "Output data to stdout instead of drawing the X window"}, + command_line::option{"-s", "--stdout", "Output data to stdout instead of drawing it to the X window"}, + command_line::option{"-p", "--png", "Save png snapshot to FILE after running for 3 seconds", "FILE"}, }; // clang-format on