2017-01-26 15:56:29 -05:00
.TH polybar 1 2017 -01-26 "polybar 3.0.2" "User Manual"
2016-06-23 04:08:14 -04:00
.SH NAME
2017-01-19 12:12:39 -05:00
polybar \- A fast and easy-to-use tool status bar
2016-06-23 04:08:14 -04:00
.SH SYNOPSIS
2017-01-19 12:12:39 -05:00
\fB polybar\fR [\fI OPTION\fR ]... \fI BAR\fR
2016-06-23 04:08:14 -04:00
.SH DESCRIPTION
2017-01-19 12:12:39 -05:00
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.
2016-06-23 04:08:14 -04:00
.TP
\fB \- h\fR , \fB \- \- help\fR
2017-01-19 12:12:39 -05:00
Display help text and exit
2016-06-23 04:08:14 -04:00
.TP
2016-10-18 12:40:47 -04:00
\fB \- v\fR , \fB \- \- version\fR
2017-01-19 12:12:39 -05:00
Display build details and exit
2016-10-18 12:40:47 -04:00
.TP
\fB \- l\fR , \fB \- \- log\fR =\fI LEVEL\fR
2017-01-19 12:12:39 -05:00
Set the logging verbosity (default: \fB WARNING\fR )
.br
\fI LEVEL\fR is one of: error, warning, info, trace
2016-10-18 12:40:47 -04:00
.TP
\fB \- q\fR , \fB \- \- quiet\fR
2017-01-19 12:12:39 -05:00
Be quiet (will override -l)
2016-10-18 12:40:47 -04:00
.TP
2017-01-19 12:12:39 -05:00
\fB \- c\fR , \fB \- \- config\fR =\fI FILE\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
2016-06-23 04:08:14 -04:00
.TP
2016-10-18 12:40:47 -04:00
\fB \- r\fR , \fB \- \- reload\fR
2017-01-19 12:12:39 -05:00
Reload the application when the config file has been modified
2016-06-23 04:08:14 -04:00
.TP
\fB \- d\fR , \fB \- \- dump\fR =\fI PARAM\fR
2017-01-19 12:12:39 -05:00
Print the value of the specified parameter \fI PARAM\fR in bar section and exit
2017-01-12 21:52:56 -05:00
.TP
\fB \- m\fR , \fB \- \- list\- monitors\fR
2017-01-19 12:12:39 -05:00
Print list of available monitors and exit
2016-06-23 04:08:14 -04:00
.TP
\fB \- w\fR , \fB \- \- print\- wmname\fR
2017-01-19 12:12:39 -05:00
Print the generated \fI WM_NAME\fR and exit
2016-06-29 22:56:58 -04:00
.TP
2016-10-18 12:40:47 -04:00
\fB \- s\fR , \fB \- \- stdout\fR
2017-01-19 12:12:39 -05:00
Output the data to stdout instead of drawing it to the X window
.TP
\fB \- p\fR , \fB \- \- png\fR =\fI FILE\fR
Save png snapshot to \fI FILE\fR after running for 3 seconds
2016-06-29 22:56:58 -04:00
.sp
2017-01-19 12:12:39 -05:00
.SH AUTHOR
Michael Carlberg <c@rlberg.se>
.br
Contributors can be listed on GitHub.
.SH REPORTING BUGS
Report issues on GitHub <https://github.com/jaagr/polybar>
.SH SEE ALSO
Full documentation at: <https://github.com/jaagr/polybar>
.br
Project wiki: <https://github.com/jaagr/polybar/wiki>