1POLYBAR-MSG(1)                Polybar User Manual               POLYBAR-MSG(1)
2
3
4

NAME

6       polybar-msg - Send IPC messages to polybar
7

SYNOPSIS

9       polybar-msg [OPTIONS] action action-string
10       polybar-msg [OPTIONS] action module action [data]
11       polybar-msg [OPTIONS] cmd command
12
13

DESCRIPTION

15       Polybar  allows external control through actions and commands.  Actions
16       control individual modules and commands control the bar itself.
17
18       The full IPC documentation is linked at the end of this document.
19
20       The available actions depend on the target module.   For  actions,  the
21       payload is either a single action string or the module name, the action
22       name, and the optional data string specified separately.
23
24       In order for polybar-msg being able to send  a  message  to  a  running
25       polybar process, the bar must have IPC enabled and both polybar-msg and
26       polybar must run under the same user.
27

OPTIONS

29       -h, --help
30              Display help text and exit
31
32       -p PID Send message only to polybar process  running  under  the  given
33              process  ID.   If not specified, the message is sent to all run‐
34              ning polybar processes.
35

EXAMPLES

37       polybar-msg cmd quit
38              Terminate all running polybar instances.
39
40       polybar-msg action mymodule module_hide
41
42       polybar-msg action "#mymodule.module_hide"
43              Hide the module named mymodule.  The first variant specifies the
44              module  and  action  names separately, the second uses an action
45              string.
46

AUTHORS

48       Polybar was created by Michael Carlberg and is currently maintained by Patrick Ziegler.
49       Contributors can be listed on GitHub.
50
51

REPORTING BUGS

53       Report issues on GitHub <https://github.com/polybar/polybar>
54

SEE ALSO

56       polybar(1), polybar(5)
57       IPC documentation: <https://polybar.rtfd.org/en/stable/user/ipc.html>
58
59

61       2016-2023, Michael Carlberg & contributors
62
63
64
65
663.7.1                            Nov 30, 2023                   POLYBAR-MSG(1)
Impressum