]> git.lizzy.rs Git - bspwm.git/commitdiff
Improve *subscribe*'s documentation
authorBastien Dejean <nihilhill@gmail.com>
Sun, 23 Jul 2017 08:33:15 +0000 (10:33 +0200)
committerBastien Dejean <nihilhill@gmail.com>
Sun, 23 Jul 2017 08:33:15 +0000 (10:33 +0200)
doc/bspwm.1
doc/bspwm.1.asciidoc

index f3558b00e4745c9fa99809317cdc1766c6dd7112..a06f995095b53241dd529f707b652445e2528910 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: bspwm
 .\"    Author: [see the "Author" section]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 07/22/2017
+.\"      Date: 07/23/2017
 .\"    Manual: Bspwm Manual
-.\"    Source: Bspwm 0.9.3-1-g0ae3c57
+.\"    Source: Bspwm 0.9.3-7-gc968f7a
 .\"  Language: English
 .\"
-.TH "BSPWM" "1" "07/22/2017" "Bspwm 0\&.9\&.3\-1\-g0ae3c57" "Bspwm Manual"
+.TH "BSPWM" "1" "07/23/2017" "Bspwm 0\&.9\&.3\-7\-gc968f7a" "Bspwm Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -973,13 +973,27 @@ Get or set the value of <setting>\&.
 \fBGeneral Syntax\fR
 .RS 4
 .PP
-subscribe [\-c|\-\-count \fICOUNT\fR] (all|report|monitor|desktop|node|\&...)*
+subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)*
 .RS 4
 Continuously print status information\&. See the
 \fBEVENTS\fR
-section for the detailed description of each event\&. If a
-\fICOUNT\fR
-argument is provided, then the subscriber will return after having received
+section for the detailed description of each event\&.
+.RE
+.RE
+.sp
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBOptions\fR
+.RS 4
+.PP
+\fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR
+.RS 4
+Stop the corresponding
+\fBbspc\fR
+process after having received
 \fICOUNT\fR
 events\&.
 .RE
index 336b3ad00ae8178339930306435fd816ae0ea183..9b0b451b29343ab05e8ef37b60e50be36c4a8ac1 100644 (file)
@@ -574,8 +574,14 @@ Subscribe
 
 General Syntax
 ^^^^^^^^^^^^^^
-subscribe [-c|--count 'COUNT'] (all|report|monitor|desktop|node|...)*::
-       Continuously print status information. See the *EVENTS* section for the detailed description of each event. If a 'COUNT' argument is provided, then the subscriber will return after having received 'COUNT' events.
+subscribe ['OPTIONS'] (all|report|monitor|desktop|node|...)*::
+       Continuously print status information. See the *EVENTS* section for the detailed description of each event.
+
+Options
+^^^^^^^
+
+*-c*, *--count* 'COUNT'::
+       Stop the corresponding *bspc* process after having received 'COUNT' events.
 
 Quit
 ~~~~