]> git.sur5r.net Git - i3/i3/commitdiff
docs/i3bar-protocol: Document stop/cont_signal
authorQuentin Glidic <sardemff7+git@sardemff7.net>
Mon, 20 Aug 2012 18:43:06 +0000 (20:43 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Sat, 22 Sep 2012 13:13:21 +0000 (15:13 +0200)
docs/i3bar-protocol

index 21ba9aa0f8e350252e1fdbc8f7a8f76b9d125056..29ce571346985f499b1215bace0ea01f979547d2 100644 (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::