aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-05-16 21:14:34 +0200
committerMattias Andrée <maandree@operamail.com>2015-05-16 21:14:34 +0200
commit17c09be9112c874c1b72e2f43278769058016cc4 (patch)
tree7d5e5f2351e8b4d7d631fbf83ff596d9a43b2e6b /doc
parentm fix doc (diff)
downloadbus-17c09be9112c874c1b72e2f43278769058016cc4.tar.gz
bus-17c09be9112c874c1b72e2f43278769058016cc4.tar.bz2
bus-17c09be9112c874c1b72e2f43278769058016cc4.tar.xz
add -x option to create command, and -n option to broadcast command
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/bus-broadcast.16
-rw-r--r--doc/bus-chgrp.11
-rw-r--r--doc/bus-chmod.11
-rw-r--r--doc/bus-chown.11
-rw-r--r--doc/bus-create.16
-rw-r--r--doc/bus-listen.13
-rw-r--r--doc/bus-remove.11
-rw-r--r--doc/bus-wait.11
8 files changed, 19 insertions, 1 deletions
diff --git a/doc/bus-broadcast.1 b/doc/bus-broadcast.1
index d80c6d2..5a4a7a3 100644
--- a/doc/bus-broadcast.1
+++ b/doc/bus-broadcast.1
@@ -3,10 +3,16 @@
bus broadcast - Broadcast a message on a bus
.SH SYNOPSIS
.B bus broadcast
+.IR [options]
+[--]
.IR pathname
.IR message
.SH DESCRIPTION
Broadcast \fImessage\fP on the bus associated with \fIpathname\fP.
+.SH OPTIONS
+.TP
+.B \-n
+Fail if another process is attempting to broadcast on the bus.
.SH EXIT STATUS
.TP
0
diff --git a/doc/bus-chgrp.1 b/doc/bus-chgrp.1
index cb59916..49f5642 100644
--- a/doc/bus-chgrp.1
+++ b/doc/bus-chgrp.1
@@ -3,6 +3,7 @@
bus chgrp - Change group ownership of a bus
.SH SYNOPSIS
.B bus chgrp
+[--]
.IR group
.IR pathname
.SH DESCRIPTION
diff --git a/doc/bus-chmod.1 b/doc/bus-chmod.1
index f50688c..24cdac9 100644
--- a/doc/bus-chmod.1
+++ b/doc/bus-chmod.1
@@ -3,6 +3,7 @@
bus chmod - Change permissions on a bus
.SH SYNOPSIS
.B bus chmod
+[--]
.IR permissions
.IR pathname
.SH DESCRIPTION
diff --git a/doc/bus-chown.1 b/doc/bus-chown.1
index 64aa7d2..a9c09ff 100644
--- a/doc/bus-chown.1
+++ b/doc/bus-chown.1
@@ -3,6 +3,7 @@
bus chown - Change ownership of a bus
.SH SYNOPSIS
.B bus chown
+[--]
.IR owner[:group]
.IR pathname
.SH DESCRIPTION
diff --git a/doc/bus-create.1 b/doc/bus-create.1
index 8282413..f50ad97 100644
--- a/doc/bus-create.1
+++ b/doc/bus-create.1
@@ -3,11 +3,17 @@
bus create - Create a bus
.SH SYNOPSIS
.B bus create
+.IR [options]
+[--]
.IR [pathname]
.SH DESCRIPTION
Create a bus with an associated \fIpathname\fP. If \fIpathname\fP, a
random pathname in \fI$XDG_RUNTIME_DIR/bus\fP will be created and
printed to stdout.
+.SH OPTIONS
+.TP
+.B \-x
+Fail if the \fIpathname\fP already exists.
.SH EXIT STATUS
.TP
0
diff --git a/doc/bus-listen.1 b/doc/bus-listen.1
index 0d5b9ba..0f56398 100644
--- a/doc/bus-listen.1
+++ b/doc/bus-listen.1
@@ -2,7 +2,8 @@
.SH NAME
bus listen - Listen for new messages on a bus
.SH SYNOPSIS
-.B bus wait
+.B bus listen
+[--]
.IR pathname
.IR command
.SH DESCRIPTION
diff --git a/doc/bus-remove.1 b/doc/bus-remove.1
index 1979629..1b14d50 100644
--- a/doc/bus-remove.1
+++ b/doc/bus-remove.1
@@ -3,6 +3,7 @@
bus remove - Remove a bus
.SH SYNOPSIS
.B bus remove
+[--]
.IR pathname
.SH DESCRIPTION
Remove the bus associated with \fIpathname\fP.
diff --git a/doc/bus-wait.1 b/doc/bus-wait.1
index 5fec137..c9add51 100644
--- a/doc/bus-wait.1
+++ b/doc/bus-wait.1
@@ -3,6 +3,7 @@
bus wait - Listen for a new message on a bus
.SH SYNOPSIS
.B bus wait
+[--]
.IR pathname
.IR command
.SH DESCRIPTION