mirror of
https://github.com/polybar/polybar.git
synced 2024-11-11 13:50:56 -05:00
1e361fa9ca
This allows us to also have the manual as part of the generated html documentation. The syntax is also easier to use. Right now the man page installed on the system is not replaced with the rst file, this will come in a later step
69 lines
1.6 KiB
ReStructuredText
69 lines
1.6 KiB
ReStructuredText
polybar(1)
|
|
==========
|
|
|
|
SYNOPSIS
|
|
--------
|
|
**polybar** [*OPTIONS*]... *BAR*
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
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.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
.. program:: polybar
|
|
|
|
.. option:: -h, --help
|
|
|
|
Display help text and exit
|
|
|
|
.. option:: -v, --version
|
|
|
|
Display build details and exit
|
|
.. option:: -l, --log=LEVEL
|
|
|
|
| Set the logging verbosity (default: **WARNING**)
|
|
| *LEVEL* is one of: error, warning, info, trace
|
|
.. option:: -q, --quiet
|
|
|
|
Be quiet (will override -l)
|
|
.. option:: -c, --config=FILE
|
|
|
|
Specify the path to the configuration file. By default, the configuration file is loaded from:
|
|
|
|
|
|
|
| **$XDG_CONFIG_HOME/polybar/config**
|
|
| **$HOME/.config/polybar/config**
|
|
.. option:: -r, --reload
|
|
|
|
Reload the application when the config file has been modified
|
|
.. option:: -d, --dump=PARAM
|
|
|
|
Print the value of the specified parameter *PARAM* in bar section and exit
|
|
.. option:: -m, --list-monitors
|
|
|
|
Print list of available monitors and exit
|
|
.. option:: -w, --print-wmname
|
|
|
|
Print the generated *WM_NAME* and exit
|
|
.. option:: -s, --stdout
|
|
|
|
Output the data to stdout instead of drawing it to the X window
|
|
.. option:: -p, --png=FILE
|
|
|
|
Save png snapshot to *FILE* after running for 3 seconds
|
|
|
|
AUTHOR
|
|
------
|
|
| Michael Carlberg <c@rlberg.se>
|
|
| Contributors can be listed on GitHub.
|
|
|
|
REPORTING BUGS
|
|
--------------
|
|
Report issues on GitHub <https://github.com/jaagr/polybar>
|
|
|
|
SEE ALSO
|
|
--------
|
|
| Full documentation at: <https://github.com/jaagr/polybar>
|
|
| Project wiki: <https://github.com/jaagr/polybar/wiki>
|