pgrondek/polybar-dwm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
282b0f4e73
polybar-dwm/doc/man/polybar.1.rst

89 lines
2.4 KiB
ReStructuredText
Raw Normal View History

doc: Add manpage as rst file 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
2018-12-02 18:05:48 +00:00
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
logger: Add default logging level 'notice' Between info and warning. Should be for things the user should be aware of but not imply anything has to be done about it.
2020-04-21 22:12:08 +00:00
| Set the logging verbosity (default: **notice**)
| *LEVEL* is one of: error, warning, notice, info, trace
doc: Add manpage as rst file 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
2018-12-02 18:05:48 +00:00
.. 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:
Create default config (#2511) * Create default config and install to /etc/polybar Closes #2405 * Search for config in /etc We search in XDG_CONFIG_DIRS, /etc/xdg, and /etc but only for config.ini Closes #2016 * Remove config installation from build.sh * Remove userconfig cmake file * Cleanup * Cleanup default config * Update CHANGELOG.md Co-authored-by: dvermd <315743+dvermd@users.noreply.github.com> * Update src/main.cpp Co-authored-by: dvermd <315743+dvermd@users.noreply.github.com> * Add tests for string functions * Support loading bars from fallbacks in /etc * Combine duplicate string_util::contains test Co-authored-by: dvermd <315743+dvermd@users.noreply.github.com>
2021-10-05 11:07:19 +00:00
* ``$XDG_CONFIG_HOME/polybar/config``
* ``$XDG_CONFIG_HOME/polybar/config.ini``
* ``$HOME/.config/polybar/config``
* ``$HOME/.config/polybar/config.ini``
* ``$XDG_CONFIG_DIRS/polybar/config.ini``
* ``/etc/xdg/polybar/config.ini`` (only if ``XDG_CONFIG_DIRS`` is not set)
* ``/etc/polybar/config.ini``
doc: Add manpage as rst file 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
2018-12-02 18:05:48 +00:00
.. 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
doc: Update description of polybar -m/-M (#2487) It should be clear that `polybar -M` represents all valid monitor names.
2021-09-02 16:18:52 +00:00
| Print list of available monitors and exit.
| If some monitors are cloned, this will exclude all but one of them.
| If polybar was compiled with RandR monitor support, only monitors are listed and not physical outputs.
Add -M CLI argument to display cloned monitors Works the same as -m but doesn't purge cloned monitors
2019-06-24 15:58:40 +00:00
.. option:: -M, --list-all-monitors
doc: Update description of polybar -m/-M (#2487) It should be clear that `polybar -M` represents all valid monitor names.
2021-09-02 16:18:52 +00:00
| Print list of all available monitors and exit.
| This includes cloned monitors as well as both physical outputs and RandR monitors (if supported).
| Only the names listed here can be used as monitor names in polybar.
doc: Add manpage as rst file 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
2018-12-02 18:05:48 +00:00
.. 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
--------------
migration: Update URLs jaagr/polybar -> polybar/polybar Travis changed their url for new projects to travis-ci.com
2019-05-06 11:51:49 +00:00
Report issues on GitHub <https://github.com/polybar/polybar>
doc: Add manpage as rst file 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
2018-12-02 18:05:48 +00:00
SEE ALSO
--------
migration: Update URLs jaagr/polybar -> polybar/polybar Travis changed their url for new projects to travis-ci.com
2019-05-06 11:51:49 +00:00
| Full documentation at: <https://github.com/polybar/polybar>
| Project wiki: <https://github.com/polybar/polybar/wiki>
doc: Write syntax definition in polybar.5
2019-10-03 20:42:47 +00:00
.. only:: man
:manpage:`polybar(5)`
.. only:: not man
:doc:`polybar.5`
Reference in New Issue Copy Permalink