mirror of https://github.com/polybar/polybar.git
46 lines
1.8 KiB
Groff
46 lines
1.8 KiB
Groff
.TH polybar 1 2016-12-23 "polybar 2.4.2-1-g70bb6f6" "User Manual"
|
|
.SH NAME
|
|
\fBpolybar\fR \- 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\f-s\fR|\fB\-w\fR]
|
|
.P
|
|
polybar [\fB\-h\fR | \fB\-\-help\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.
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
Show help and program options.
|
|
.TP
|
|
\fB\-v\fR, \fB\-\-version\fR
|
|
Print version information.
|
|
.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`.
|
|
.TP
|
|
\fB\-q\fR, \fB\-\-quiet\fR
|
|
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.
|
|
.TP
|
|
\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).
|
|
.TP
|
|
\fB\-d\fR, \fB\-\-dump\fR=\fIPARAM\fR
|
|
Show the value of the specified parameter \fIPARAM\fR in the section [bar/\fIBAR-NAME\fR] inside the configuration file.
|
|
.TP
|
|
\fB\-w\fR, \fB\-\-print\-wmname\fR
|
|
Print the generated \fIWM_NAME\fR.
|
|
.TP
|
|
\fB\-s\fR, \fB\-\-stdout\fR
|
|
Dump content to stdout instead of rendering an X window.
|
|
.RE
|
|
.SH HOMEPAGE
|
|
.sp
|
|
https://github.com/jaagr/polybar
|