polybar/man/polybar.1

61 lines
1.7 KiB
Groff
Raw Normal View History

2017-01-26 20:56:29 +00:00
.TH polybar 1 2017-01-26 "polybar 3.0.2" "User Manual"
2016-06-23 08:08:14 +00:00
.SH NAME
2017-01-19 17:12:39 +00:00
polybar \- A fast and easy-to-use tool status bar
2016-06-23 08:08:14 +00:00
.SH SYNOPSIS
2017-01-19 17:12:39 +00:00
\fBpolybar\fR [\fIOPTION\fR]... \fIBAR\fR
2016-06-23 08:08:14 +00:00
.SH DESCRIPTION
2017-01-19 17:12:39 +00: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 08:08:14 +00:00
.TP
\fB\-h\fR, \fB\-\-help\fR
2017-01-19 17:12:39 +00:00
Display help text and exit
2016-06-23 08:08:14 +00:00
.TP
2016-10-18 16:40:47 +00:00
\fB\-v\fR, \fB\-\-version\fR
2017-01-19 17:12:39 +00:00
Display build details and exit
2016-10-18 16:40:47 +00:00
.TP
\fB\-l\fR, \fB\-\-log\fR=\fILEVEL\fR
2017-01-19 17:12:39 +00:00
Set the logging verbosity (default: \fBWARNING\fR)
.br
\fILEVEL\fR is one of: error, warning, info, trace
2016-10-18 16:40:47 +00:00
.TP
\fB\-q\fR, \fB\-\-quiet\fR
2017-01-19 17:12:39 +00:00
Be quiet (will override -l)
2016-10-18 16:40:47 +00:00
.TP
2017-01-19 17:12:39 +00:00
\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
2016-06-23 08:08:14 +00:00
.TP
2016-10-18 16:40:47 +00:00
\fB\-r\fR, \fB\-\-reload\fR
2017-01-19 17:12:39 +00:00
Reload the application when the config file has been modified
2016-06-23 08:08:14 +00:00
.TP
\fB\-d\fR, \fB\-\-dump\fR=\fIPARAM\fR
2017-01-19 17:12:39 +00:00
Print the value of the specified parameter \fIPARAM\fR in bar section and exit
.TP
\fB\-m\fR, \fB\-\-list\-monitors\fR
2017-01-19 17:12:39 +00:00
Print list of available monitors and exit
2016-06-23 08:08:14 +00:00
.TP
\fB\-w\fR, \fB\-\-print\-wmname\fR
2017-01-19 17:12:39 +00:00
Print the generated \fIWM_NAME\fR and exit
2016-06-30 02:56:58 +00:00
.TP
2016-10-18 16:40:47 +00:00
\fB\-s\fR, \fB\-\-stdout\fR
2017-01-19 17:12:39 +00:00
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
2016-06-30 02:56:58 +00:00
.sp
2017-01-19 17:12:39 +00: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>