polybar-msg1
Send ipc messages to polybar
Usage
polybar-msg [OPTIONS]
action
action-string
polybar-msg [OPTIONS]
action
module
action
[data]
polybar-msg [OPTIONS]
cmd
command
Overview
Polybar allows external control through actions and commands. Actions control individual modules and commands control the bar itself.
The full IPC documentation is linked at the end of this document.
The available actions depend on the target module. For actions, the payload is either a single action string or the module name, the action name, and the optional data string specified separately.
In order for polybar-msg being able to send a message to a running polybar process, the bar must have IPC enabled and both polybar-msg and polybar must run under the same user.
Options
-
-h, --help -
Display help text and exit
-
-p PID -
Send message only to
polybarprocess running under the given process ID. If not specified, the message is sent to all runningpolybarprocesses.
Examples
polybar-msgcmdquit-
Terminate all running
polybarinstances.
polybar-msg action mymodule module_hide
polybar-msgaction"#mymodule.module_hide"-
Hide the module named mymodule. The first variant specifies the module and action names separately, the second uses an action string.
Releases
3 releases since Debian 12 (Bookworm); the text changed 2 times.