aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHubert Hirtz <hubert@hirtzfr.eu>2020-08-03 16:08:05 +0200
committerSimon Ser <contact@emersion.fr>2020-08-04 10:39:29 +0200
commitc5c632aaae78b1e6ac8c28341e782541bd138599 (patch)
treec67fddac973b8ed646ced20c98fa62de849ef293
parent8fb9f3b7119e263edd1b7f857341d6ea9f3410e3 (diff)
Document required '\n' in swaybar-protocol
The following statusbar output is not considered by sway to be following the swaybar-protocol: {"version":1}[[{"full_text":"2.89","urgent":false}], However this one is: {"version":1}\n[[{"full_text":"2.89","urgent":false}], Both outputs contain a header with the required values and an unfinished array of objects with the required values, but the first one is showed verbatim.
-rw-r--r--swaybar/swaybar-protocol.7.scd8
1 files changed, 4 insertions, 4 deletions
diff --git a/swaybar/swaybar-protocol.7.scd b/swaybar/swaybar-protocol.7.scd
index 3f6a712c..2ecd2a7e 100644
--- a/swaybar/swaybar-protocol.7.scd
+++ b/swaybar/swaybar-protocol.7.scd
@@ -8,10 +8,10 @@ swaybar-protocol - JSON status line protocol for swaybar
swaybar defines the following JSON protocol to specify what information is
displayed in the status line on the right side of swaybar. The protocol
-comprises a header, that is a JSON object, followed by an infinite JSON
-array that represents the information to display. All communication is done by
-writing the status line to standard output and reading events from standard
-input.
+comprises a header, that is a JSON object, followed by a newline (*0x0A*),
+followed by an infinite JSON array that represents the information to display.
+All communication is done by writing the status line to standard output and
+reading events from standard input.
# HEADER