polybar/doc
Vincent Bernat 5f3462240c
feat(ipc): allow receiving arbitrary text on IPC socket (#2463)
This adds the 'send' action to the ipc module that can be used to send arbitrary text to the module:

    polybar-msg action "#ipc.send.%{F#4444ff}hello%{F-}"

* feat(ipc): allow receiving arbitrary text on IPC socket

Instead of just allowing hook numbers to be executed, the user can
send arbitrary text and the IPC module will put it in the bar. The IPC
payload format is extended to accept an arbitrary string if the first
character after the module name is ':'.

    polybar-msg hook test :'%{F#4444ff}hello%{F-}'

Fix #2455

* Use actions for sending data to ipc module

* ipc: Don't use exceptions when no hooks are defined

* Update src/modules/ipc.cpp

Co-authored-by: patrick96 <p.ziegler96@gmail.com>
2021-07-11 20:42:28 +02:00
..
_static doc: Finish legacy action migration table 2020-11-26 20:53:53 +01:00
dev Add items for milestones and readthedocs to release workflow 2021-01-07 20:48:04 +01:00
man Add initial support for an escape character (#2361) 2021-01-26 19:16:29 +01:00
user feat(ipc): allow receiving arbitrary text on IPC socket (#2463) 2021-07-11 20:42:28 +02:00
.gitignore build: Allow doc to build as its own project 2019-05-10 08:14:02 +02:00
CMakeLists.txt Install changelog file as part of the documentation 2021-01-07 20:48:04 +01:00
README.md refactor(cmake): Allow targets to be enabled individually 2020-12-24 02:20:38 +01:00
conf.py fix(build): Disable sphinx manpage section dirs 2021-05-09 21:28:22 +02:00
index.rst Change over all IRC mentions to libera (#2450) 2021-06-16 17:02:58 +02:00

README.md

Polybar Manual

The official polybar documentation lives here.

The html documentation and man pages are built automatically when you build with cmake (cmake creates the custom target doc).

Preview Locally

The documentation uses Sphinx to generate the documentation, so you will need to have that installed.

If you build polybar normally while having Sphinx installed during configuration, the documentation will be enabled and built as well. Building the documentation can be disabled by passing -DBUILD_DOC=OFF to cmake.

Once configured, all of the documentation can be generated with make doc or use make doc_html or make doc_man to only generate the html documentation or the man pages respectively.

The HTML documentation is in doc/html/index.html in your build directory and the man pages are in doc/man.