2016-12-23 12:10:19 -05:00
.TH polybar 1 2016 -12-23 "polybar 2.4.2-1-g70bb6f6" "User Manual"
2016-06-23 04:08:14 -04:00
.SH NAME
2016-11-19 00:22:44 -05:00
\fB polybar\fR \- A fast and easy-to-use tool status bar.
2016-06-23 04:08:14 -04:00
.SH SYNOPSIS
.P
2016-11-19 00:22:44 -05:00
polybar \fI BAR-NAME\fR [\fB \- c\fR \fI CONFIG\fR |\fB \- l\fR \fI LOG_LEVEL\fR |\fB \- d\fR \fI PARAM\fR |\fB \f -q\fR |\fB \- r\fR |\fB \f -s\fR |\fB \- w\fR ]
2016-06-23 04:08:14 -04:00
.P
2016-11-19 00:22:44 -05:00
polybar [\fB \- h\fR | \fB \- \- help\fR ]
2016-06-23 04:08:14 -04:00
.SH DESCRIPTION
2016-12-23 12:10:19 -05:00
\fB Polybar\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.
2016-06-23 04:08:14 -04:00
.P
2016-12-23 12:10:19 -05:00
Please report issues by creating a ticket on GitHub (\fI https://github.com/jaagr/polybar\fR ).
2016-06-23 04:08:14 -04:00
.P
Mandatory arguments to long options are mandatory for short options too.
.TP
\fB \- h\fR , \fB \- \- help\fR
Show help and program options.
.TP
2016-10-18 12:40:47 -04:00
\fB \- v\fR , \fB \- \- version\fR
Print version information.
.TP
\fB \- l\fR , \fB \- \- log\fR =\fI LEVEL\fR
2016-12-23 12:10:19 -05:00
Set how verbose \fB polybar\fR 's logging is. \fI LEVEL\fR must be one of: `error`, `warning` or `info`.
2016-10-18 12:40:47 -04:00
.TP
\fB \- q\fR , \fB \- \- quiet\fR
Be quiet (will override -l).
.TP
2016-06-29 22:56:58 -04:00
\fB \- c\fR , \fB \- \- config\fR =\fI CONFIG\fR
2016-11-19 00:22:44 -05:00
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.
2016-06-23 04:08:14 -04:00
.TP
2016-10-18 12:40:47 -04:00
\fB \- r\fR , \fB \- \- reload\fR
Reload the application when the config file has been modified. (NOTE: Its recommended to only use this when setting up the bar).
2016-06-23 04:08:14 -04:00
.TP
\fB \- d\fR , \fB \- \- dump\fR =\fI PARAM\fR
2016-06-29 22:56:58 -04:00
Show the value of the specified parameter \fI PARAM\fR in the section [bar/\fI BAR-NAME\fR ] inside the configuration file.
2016-06-23 04:08:14 -04:00
.TP
\fB \- w\fR , \fB \- \- print\- wmname\fR
Print the generated \fI WM_NAME\fR .
2016-06-29 22:56:58 -04:00
.TP
2016-10-18 12:40:47 -04:00
\fB \- s\fR , \fB \- \- stdout\fR
Dump content to stdout instead of rendering an X window.
2016-06-29 22:56:58 -04:00
.RE
.SH HOMEPAGE
.sp
2016-11-19 00:22:44 -05:00
https://github.com/jaagr/polybar