nixo
/
gri3-wm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs/i3bar-protocol: Document stop/cont_signal

This commit is contained in:
Quentin Glidic 2012-08-20 20:43:06 +02:00 committed by Michael Stapelberg
parent 2e5838fb49
commit f1f0de1c49
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/i3bar-protocol
View File

@ -44,11 +44,16 @@ understand the old protocol version, but in order to use the new one, you need
to provide the correct version. The header block is terminated by a newline and
consists of a single JSON hash:
*Example*:
*Minimal example*:
----------------
{ "version": 1 }
----------------
*All features example*:
----------------
{ "version": 1, "stop_signal": 10, "cont_signal": 12 }
----------------
(Note that before i3 v4.3 the precise format had to be +{"version":1}+,
byte-for-byte.)
@ -93,6 +98,19 @@ You can find an example of a shell script which can be used as your
+status_command+ in the bar configuration at
http://code.stapelberg.de/git/i3/tree/contrib/trivial-bar-script.sh?h=next
=== Header in detail
version::
The version number (as an integer) of the i3bar protocol you will use.
stop_signal::
Specify to i3bar the signal (as an integer) to send to stop your
processing.
The default value (if none is specified) is SIGSTOP.
cont_signal::
Specify to i3bar the signal (as an integer)to send to continue your
processing.
The default value (if none is specified) is SIGCONT.
=== Blocks in detail
full_text::