polybar/man/polybar.1

46 lines
1.8 KiB
Groff
Raw Normal View History

2016-12-23 17:10:19 +00:00
.TH polybar 1 2016-12-23 "polybar 2.4.2-1-g70bb6f6" "User Manual"
2016-06-23 08:08:14 +00:00
.SH NAME
2016-11-19 05:22:44 +00:00
\fBpolybar\fR \- A fast and easy-to-use tool status bar.
2016-06-23 08:08:14 +00:00
.SH SYNOPSIS
.P
2016-11-19 05:22:44 +00:00
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]
2016-06-23 08:08:14 +00:00
.P
2016-11-19 05:22:44 +00:00
polybar [\fB\-h\fR | \fB\-\-help\fR]
2016-06-23 08:08:14 +00:00
.SH DESCRIPTION
2016-12-23 17:10:19 +00:00
\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.
2016-06-23 08:08:14 +00:00
.P
2016-12-23 17:10:19 +00:00
Please report issues by creating a ticket on GitHub (\fIhttps://github.com/jaagr/polybar\fR).
2016-06-23 08:08:14 +00: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 16:40:47 +00:00
\fB\-v\fR, \fB\-\-version\fR
Print version information.
.TP
\fB\-l\fR, \fB\-\-log\fR=\fILEVEL\fR
2016-12-23 17:10:19 +00:00
Set how verbose \fBpolybar\fR's logging is. \fILEVEL\fR must be one of: `error`, `warning` or `info`.
2016-10-18 16:40:47 +00:00
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Be quiet (will override -l).
.TP
2016-06-30 02:56:58 +00:00
\fB\-c\fR, \fB\-\-config\fR=\fICONFIG\fR
2016-11-19 05:22:44 +00: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 08:08:14 +00:00
.TP
2016-10-18 16:40:47 +00: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 08:08:14 +00:00
.TP
\fB\-d\fR, \fB\-\-dump\fR=\fIPARAM\fR
2016-06-30 02:56:58 +00:00
Show the value of the specified parameter \fIPARAM\fR in the section [bar/\fIBAR-NAME\fR] inside the configuration file.
2016-06-23 08:08:14 +00:00
.TP
\fB\-w\fR, \fB\-\-print\-wmname\fR
Print the generated \fIWM_NAME\fR.
2016-06-30 02:56:58 +00:00
.TP
2016-10-18 16:40:47 +00:00
\fB\-s\fR, \fB\-\-stdout\fR
Dump content to stdout instead of rendering an X window.
2016-06-30 02:56:58 +00:00
.RE
.SH HOMEPAGE
.sp
2016-11-19 05:22:44 +00:00
https://github.com/jaagr/polybar