external/yambar
1
0
Fork 1
mirror of https://codeberg.org/dnkl/yambar.git synced 2025-04-23 04:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: yambar-modules: script: stress the importance of an empty line after a transaction

Browse source 
Closes #34
This commit is contained in:
Daniel Eklöf 2021-02-21 20:27:29 +01:00
parent cc6be3a923
commit 153d7a2ffa
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/yambar-modules.5.scd
View file

@ -738,8 +738,11 @@ terminated. Or, the script can continue executing and update yambar
with new tag sets, either periodically, or when there is new data to with new tag sets, either periodically, or when there is new data to
feed to yambar. feed to yambar.
Tag sets, or _transactions_, are separated by an empty line. Each Tag sets, or _transactions_, are separated by an empty line
_tag_ is a single line on the format: (e.g. *echo ""*). The empty line is required to commit (update) the
tag even for only one transaction.
Each _tag_ is a single line on the format:
``` ```
name|type|value name|type|value
@ -754,14 +757,16 @@ Example:
``` ```
var1|string|hello var1|string|hello
var2|int|13 var2|int|13
<empty>
var1|string|world var1|string|world
var2|int|37 var2|int|37
<empty>
``` ```
The example above consists of two transactions. Each transaction has The example above consists of two transactions. Each transaction has
two tags: one string tag and one integer tag. The second transaction two tags: one string tag and one integer tag. The second transaction
replaces the tags from the first transaction. replaces the tags from the first transaction. Note that **both**
transactions need to be terminated with an empty line.
Supported _types_ are: Supported _types_ are: