aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/bus-wait.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/bus-wait.1')
-rw-r--r--doc/man/bus-wait.133
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/man/bus-wait.1 b/doc/man/bus-wait.1
new file mode 100644
index 0000000..4231cd0
--- /dev/null
+++ b/doc/man/bus-wait.1
@@ -0,0 +1,33 @@
+.TH BUS-WAIT 1 BUS-%VERSION%
+.SH NAME
+bus wait - Listen for a new message on a bus
+.SH SYNOPSIS
+.B bus wait
+[--]
+.IR pathname
+.IR command
+.SH DESCRIPTION
+Listen for a new message on the bus associated with \fIpathname\fP, stop
+listening once a message has been received. Once a message is received,
+\fIcommand\fP will be spawned with \fI$msg\fP set to the received
+message. POSIX shell syntax applies to \fIcommand\fP.
+.SH EXIT STATUS
+.TP
+0
+The command was successful.
+.TP
+1
+The command failed.
+.TP
+2
+The command is not recognised.
+.SH SEE ALSO
+.BR bus (5)
+.SH AUTHORS
+Principal author, Mattias Andrée. See the LICENSE file for the full
+list of authors.
+.SH LICENSE
+MIT/X Consortium License.
+.SH BUGS
+Please report bugs to https://github.com/maandree/bus/issues or to
+maandree@member.fsf.org