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

48 lines
977 B
ReStructuredText
Raw Normal View History

doc: Setup in-repo documentation
2018-12-01 11:12:49 +00:00
Polybar Documentation
=====================
.. note:: This is still very much a work-in-progress. Most information is still
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
to be found on our `GitHub Wiki <https://github.com/polybar/polybar/wiki>`_.
doc: Setup in-repo documentation
2018-12-01 11:12:49 +00:00
We will migrate the wiki content step-by-step.
Welcome to the official polybar documentation.
.. toctree::
doc: Allow using rtd theme locally
2020-06-12 20:38:35 +00:00
:maxdepth: 1
doc: Finish legacy action migration table
2020-10-22 23:19:42 +00:00
:caption: Content:
doc: Setup in-repo documentation
2018-12-01 11:12:49 +00:00
doc: Initial action documentation
2020-06-07 19:52:54 +00:00
user/actions
Use sockets for IPC (#2539) Deprecates not using `polybar-msg` for IPC. Fixes #2532 Closes #2465 Fixes #2504 * Create FIFO specific NamedPipeHandle subclass to PipeHandle * Prototype SocketHandle * Move mainloop up to main.cpp * Pass eventloop to ipc class * Deprecate sending ipc over the named pipe Unfortunately, we can only show the warning in the polybar log and not give the user any feedback because the pipe is one-way * Move eventloop into its own namespace * Prototype ipc socket handling * Remove handles from ipc_client Should be independent from eventloop logic * Remove ipc clients when finished * Add tests for ipc_client decoding * Add callback for complete ipc messages * Remove template param from mixins * Move signal handler to new callback system * Move poll handle to new callback system * Move FSEventHandle to new callback system * Move TimerHandle and AsyncHandle to new callback system * Move PipeHandle to new callback system * Implement socket functionality in new callback system * Correctly reset ipc named pipe handle * Let client close handles in error callback * Wrap client pipe and ipc::client in connection class * Better decoder log messages * Socket path logic * Fix CI warnings * Remove UVHandleGeneric * Fix error when socket folder already exists * Proof of concept message writeback * Restructure ipc files * polybar-msg: Use sockets * polybar-msg: Better syntax for actions * Fix memory leak with fifo After EOF, the pipe wasn't closed and EOF was called all the time, each time allocating a new pipe. * Make polybar-msg compile on its own * Rudimentary writeback for polybar-msg * Fix payload reference going out of scope. * Add IPC documentation * Cleanup polybar-msg code * Specify the v0 ipc message format * Close ipc connection after message * Fix ipc tests * Properly close ipc connections * Fix polybar-msg not working with action string * Write polybar-msg manpage * polybar-msg: Stop using exit() * ipc: Print log message with PID * Add tests for ipc util * polybar-msg: Print PID with success message * ipc: Propagate message errors * Rename ipc::client to ipc::decoder * Rename ipc.cpp to polybar-msg.cpp * ipc: Write encoder function and fix decoder bugs * ipc: Use message format for responses * ipc: Handle wrong message types * ipc: Write back error message if ipc message cannot be processed This only happens for commands and empty actions. Non-empty actions are not immediately executed, but deferred until the next loop iteration. * Remove TODO about deleting runtime directory The socket file is not deleted after socket.close() is called, only after libuv executes the close callback. So we can't just call rmdir because it will probably always fail. * CLeanup WriteRequest * Update manpage authors * Cleanup
2022-01-22 19:35:37 +00:00
user/ipc
doc: Initial action documentation
2020-06-07 19:52:54 +00:00
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
.. toctree::
:maxdepth: 1
:caption: Manual Pages:
man/polybar.1
Use sockets for IPC (#2539) Deprecates not using `polybar-msg` for IPC. Fixes #2532 Closes #2465 Fixes #2504 * Create FIFO specific NamedPipeHandle subclass to PipeHandle * Prototype SocketHandle * Move mainloop up to main.cpp * Pass eventloop to ipc class * Deprecate sending ipc over the named pipe Unfortunately, we can only show the warning in the polybar log and not give the user any feedback because the pipe is one-way * Move eventloop into its own namespace * Prototype ipc socket handling * Remove handles from ipc_client Should be independent from eventloop logic * Remove ipc clients when finished * Add tests for ipc_client decoding * Add callback for complete ipc messages * Remove template param from mixins * Move signal handler to new callback system * Move poll handle to new callback system * Move FSEventHandle to new callback system * Move TimerHandle and AsyncHandle to new callback system * Move PipeHandle to new callback system * Implement socket functionality in new callback system * Correctly reset ipc named pipe handle * Let client close handles in error callback * Wrap client pipe and ipc::client in connection class * Better decoder log messages * Socket path logic * Fix CI warnings * Remove UVHandleGeneric * Fix error when socket folder already exists * Proof of concept message writeback * Restructure ipc files * polybar-msg: Use sockets * polybar-msg: Better syntax for actions * Fix memory leak with fifo After EOF, the pipe wasn't closed and EOF was called all the time, each time allocating a new pipe. * Make polybar-msg compile on its own * Rudimentary writeback for polybar-msg * Fix payload reference going out of scope. * Add IPC documentation * Cleanup polybar-msg code * Specify the v0 ipc message format * Close ipc connection after message * Fix ipc tests * Properly close ipc connections * Fix polybar-msg not working with action string * Write polybar-msg manpage * polybar-msg: Stop using exit() * ipc: Print log message with PID * Add tests for ipc util * polybar-msg: Print PID with success message * ipc: Propagate message errors * Rename ipc::client to ipc::decoder * Rename ipc.cpp to polybar-msg.cpp * ipc: Write encoder function and fix decoder bugs * ipc: Use message format for responses * ipc: Handle wrong message types * ipc: Write back error message if ipc message cannot be processed This only happens for commands and empty actions. Non-empty actions are not immediately executed, but deferred until the next loop iteration. * Remove TODO about deleting runtime directory The socket file is not deleted after socket.close() is called, only after libuv executes the close callback. So we can't just call rmdir because it will probably always fail. * CLeanup WriteRequest * Update manpage authors * Cleanup
2022-01-22 19:35:37 +00:00
man/polybar-msg.1
doc: Write syntax definition in polybar.5
2019-10-03 20:42:47 +00:00
man/polybar.5
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
doc: Write page for package maintainers.
2019-12-27 16:19:19 +00:00
.. toctree::
:maxdepth: 1
:caption: For Contributors:
dev/packaging
doc: Write new release workflow We now use OneFlow [1] for releases 3.5.0 and onwards. Closes #1780 [1]: https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
2020-09-22 20:33:12 +00:00
.. toctree::
:maxdepth: 1
:caption: Developer Documentation:
Move style guide to repo
2022-04-03 11:49:06 +00:00
dev/style-guide
Move testing page to repo
2022-04-03 11:58:52 +00:00
dev/testing
doc: Write new release workflow We now use OneFlow [1] for releases 3.5.0 and onwards. Closes #1780 [1]: https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
2020-09-22 20:33:12 +00:00
dev/release-workflow
doc: Setup in-repo documentation
2018-12-01 11:12:49 +00:00
Getting Help
============
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
* `Polybar Wiki <https://github.com/polybar/polybar/wiki>`_
doc: Add Gitter room The Gitter room https://gitter.im/polybar/polybar should serve a similar purpose as the IRC room with the benefit that messages persist and can be received when offline. From now on gitter should be the place where the polybar community lives. Reddit is great for asking longer questions in the style of a forum but not so great for quick back and forth conversations. IRC is better in that aspect but has the serious downside that you have to stay connected to get an answer and messages are not logged (only by your client). Both reddit and IRC are here to stay and I will still check them regularly, but we should encourage people to join gitter.
2019-11-25 17:39:36 +00:00
* `Gitter <https://gitter.im/polybar/polybar>`_
doc: Setup in-repo documentation
2018-12-01 11:12:49 +00:00
* `/r/polybar <https://reddit.com/r/polybar>`_ on reddit
Change over all IRC mentions to libera (#2450)
2021-06-16 15:02:58 +00:00
* ``#polybar`` on `irc.libera.chat:6697 <https://libera.chat/>`_
doc: Setup in-repo documentation
2018-12-01 11:12:49 +00:00
Reference in New Issue Copy Permalink