aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/bus-broadcast.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/bus-broadcast.1')
-rw-r--r--doc/man/bus-broadcast.134
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/man/bus-broadcast.1 b/doc/man/bus-broadcast.1
new file mode 100644
index 0000000..e6094be
--- /dev/null
+++ b/doc/man/bus-broadcast.1
@@ -0,0 +1,34 @@
+.TH BUS-BROADCAST 1 BUS-%VERSION%
+.SH NAME
+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
+The command was successful.
+.TP
+1
+The command failed.
+.TP
+2
+The command is not recognised.
+.SH SEE ALSO
+.BR bus (5)
+.SH AUTHORS
+See the LICENSE file for the authors.
+.SH LICENSE
+See the LICENSE file for the terms of redistribution.
+.SH BUGS
+Please report bugs to https://github.com/maandree/bus/issues or to
+maandree@member.fsf.org