add manpages for the bus command

Signed-off-by: Mattias Andrée <maandree@operamail.com>

6 files changed, 189 insertions, 0 deletions

diff --git a/doc/bus-broadcast.1 b/doc/bus-broadcast.1
new file mode 100644
index 0000000..291f5c1
--- /dev/null
+++ b/doc/bus-broadcast.1
@@ -0,0 +1,27 @@
+.TH BUS-BROADCAST 1 BUS-%VERSION%
+.SH NAME
+bus broadcast - Broadcast a message on a bus
+.SH SYNOPSIS
+.B bus broadcast
+.IR message
+.SH DESCRIPTION
+Broadcast \fImessage\fP on the bus associated with \fIpathname\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
+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 them.
+
diff --git a/doc/bus-create.1 b/doc/bus-create.1
new file mode 100644
index 0000000..0e445ba
--- /dev/null
+++ b/doc/bus-create.1
@@ -0,0 +1,30 @@
+.TH BUS-CREATE 1 BUS-%VERSION%
+.SH NAME
+bus create - Create a bus
+.SH SYNOPSIS
+.B bus create
+.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 EXIT STATUS
+.TP
+0
+The command was successful.
+.TP
+1
+The command failed.
+.TP
+2
+The command is not recognised.
+.SH SEE ALSO
+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 them.
+
diff --git a/doc/bus-listen.1 b/doc/bus-listen.1
new file mode 100644
index 0000000..89ae7d9
--- /dev/null
+++ b/doc/bus-listen.1
@@ -0,0 +1,32 @@
+.TH BUS-LISTEN 1 BUS-%VERSION%
+.SH NAME
+bus listen - Listen for new messages on a bus
+.SH SYNOPSIS
+.B bus wait
+.IR pathname
+.IR command
+.SH DESCRIPTION
+Listen for new messages on the bus associated
+with \fIpathname\fP. Once a message is received
+\fIcommand\fP will be spawned with the \fI$arg\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
+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 them.
+
diff --git a/doc/bus-remove.1 b/doc/bus-remove.1
new file mode 100644
index 0000000..8e6c807
--- /dev/null
+++ b/doc/bus-remove.1
@@ -0,0 +1,25 @@
+.TH BUS-REMOVE 1 BUS-%VERSION%
+.SH NAME
+bus remove - Remove a bus
+.SH SYNOPSIS
+.B bus remove
+.IR pathname
+.SH DESCRIPTION
+Remove the bus associated with \fIpathname\fP.
+.SH EXIT STATUS
+.TP
+0
+The command was successful.
+.TP
+1
+The command failed.
+.TP
+2
+The command is not recognised.
+.SH AUTHORS
+See the LICENSE file for the authors.
+.SH LICENSE
+See the LICENSE file for the terms of redistribution.
+.SH BUGS
+Please report them.
+
diff --git a/doc/bus-wait.1 b/doc/bus-wait.1
new file mode 100644
index 0000000..42d176e
--- /dev/null
+++ b/doc/bus-wait.1
@@ -0,0 +1,33 @@
+.TH BUS-WAIT 1 BUS-%VERSION%
+.SH NAME
+bus wait - Listen for one new message only on a bus
+.SH SYNOPSIS
+.B bus wait
+.IR pathname
+.IR command
+.SH DESCRIPTION
+Listen for one new message on the bus associated
+with \fIpathname\fP, and stop listening once a
+message has been received. Once a message is
+received \fIcommand\fP will be spawned with
+\fI$arg\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
+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 them.
+
diff --git a/doc/bus.1 b/doc/bus.1
new file mode 100644
index 0000000..c2383fb
--- /dev/null
+++ b/doc/bus.1
@@ -0,0 +1,42 @@
+.TH BUS 1 BUS-%VERSION%
+.SH NAME
+bus - A simple daemonless system for broadcasting messages locally
+.SH SYNOPSIS
+.B bus
+.IR command
+.IR argument...
+.SH COMMANDS
+.TP
+.B create
+Create a bus.
+.TP
+.B remove
+Remove a bus.
+.TP
+.B listen
+Listen for new message on a bus.
+.TP
+.B wait
+Listen for one new message only on a bus.
+.TP
+.B broadcast
+Broadcast a message on a 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
+bus(5), libbus(7)
+.SH AUTHORS
+See the LICENSE file for the authors.
+.SH LICENSE
+See the LICENSE file for the terms of redistribution.
+.SH BUGS
+Please report them.
+