From f1f0de1c49ab9a5de16c08292b1c2e277cb45a8a Mon Sep 17 00:00:00 2001 From: Quentin Glidic Date: Mon, 20 Aug 2012 20:43:06 +0200 Subject: [PATCH] docs/i3bar-protocol: Document stop/cont_signal --- docs/i3bar-protocol | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/i3bar-protocol b/docs/i3bar-protocol index 21ba9aa0..29ce5713 100644 --- a/docs/i3bar-protocol +++ b/docs/i3bar-protocol @@ -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::