aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-05-14 21:54:05 +0200
committerMattias Andrée <maandree@operamail.com>2015-05-14 21:54:05 +0200
commitff7fe9ed7310e9426e5056fca19febbacde55401 (patch)
tree052f6785b271043902c9e3586bdae2f1e2f8abd0 /doc
parentadd chmod, chown and chgrp to the command line tool (diff)
downloadbus-ff7fe9ed7310e9426e5056fca19febbacde55401.tar.gz
bus-ff7fe9ed7310e9426e5056fca19febbacde55401.tar.bz2
bus-ff7fe9ed7310e9426e5056fca19febbacde55401.tar.xz
doc bus-chgrp, bus-chown, and bus-chmod
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--doc/bus-chgrp.131
-rw-r--r--doc/bus-chmod.138
-rw-r--r--doc/bus-chown.134
-rw-r--r--doc/bus.118
4 files changed, 120 insertions, 1 deletions
diff --git a/doc/bus-chgrp.1 b/doc/bus-chgrp.1
new file mode 100644
index 0000000..cb59916
--- /dev/null
+++ b/doc/bus-chgrp.1
@@ -0,0 +1,31 @@
+.TH BUS-CHGRP 1 BUS-%VERSION%
+.SH NAME
+bus chgrp - Change group ownership of a bus
+.SH SYNOPSIS
+.B bus chgrp
+.IR group
+.IR pathname
+.SH DESCRIPTION
+Change the group, that owns a bus with an associated \fIpathname\fP,
+to the specified \fIgroup\fP. The \fIgroup\fP can be specified either
+with a GID or with a group name.
+.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-chown(1), bus-chmod(1)
+.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
diff --git a/doc/bus-chmod.1 b/doc/bus-chmod.1
new file mode 100644
index 0000000..432ac84
--- /dev/null
+++ b/doc/bus-chmod.1
@@ -0,0 +1,38 @@
+.TH BUS-CHMOD 1 BUS-%VERSION%
+.SH NAME
+bus chmod - Change permissions on a bus
+.SH SYNOPSIS
+.B bus chmod
+.IR permissions
+.IR pathname
+.SH DESCRIPTION
+Change whom as access to a bus with an associated \fIpathname\fP.
+In the \fIpermissions\fP, the owner, the group, and others (not
+in group) are represented by the symbols \fBu\fP, \fBg\fP, and
+\fBo\fP, respectively. The \fIpermissions\fP string is imagined
+to have always be prefixed with an \fB=\fP. This symbols means
+that all user classes list after it, and only those classes, as
+permission to use the bus. Similarly the symbols \fB+\fP and
+\fB\-\fP can be used to grant and revoke access, respectively.
+The symbols \fB=\fP, \fB+\fP, and \fB\-\fP can be maked, and are
+interpreted from left to right.
+.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-chown(1), bus-chgrp(1)
+.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
diff --git a/doc/bus-chown.1 b/doc/bus-chown.1
new file mode 100644
index 0000000..64aa7d2
--- /dev/null
+++ b/doc/bus-chown.1
@@ -0,0 +1,34 @@
+.TH BUS-CHOWN 1 BUS-%VERSION%
+.SH NAME
+bus chown - Change ownership of a bus
+.SH SYNOPSIS
+.B bus chown
+.IR owner[:group]
+.IR pathname
+.SH DESCRIPTION
+Change the owner, that owns a bus with an associated \fIpathname\fP,
+to the specified \fIowner\fP. The \fIowner\fP can be specified either
+with a UID or with a user name.
+If a \fIgroup\fP is specified, the bus's owner-group will be set to
+that \fIgroup\fP, otherwise the group will remain unchanged. The
+\fIgroup\fP can be specified either with a GID or with a group name.
+.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-chgrp(1), bus-chmod(1)
+.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
diff --git a/doc/bus.1 b/doc/bus.1
index c7eaad9..b5a0f27 100644
--- a/doc/bus.1
+++ b/doc/bus.1
@@ -31,6 +31,21 @@ for further details.
Broadcast a message on a bus, see
.BR bus-broadcast (1)
for further details.
+.TP
+.B chmod
+Change permissions on a bus, see
+.BR bus-chmod (1)
+for further details.
+.TP
+.B chown
+Change ownership of a bus, see
+.BR bus-chown (1)
+for further details.
+.TP
+.B chgrp
+Change group ownership of a bus, see
+.BR bus-chgrp (1)
+for further details.
.SH EXIT STATUS
.TP
0
@@ -43,7 +58,8 @@ The command failed.
The command is not recognised.
.SH SEE ALSO
bus-create(1), bus-remove(1), bus-listen(1), bus-wait(1),
-bus-broadcast(1), bus(5), libbus(7)
+bus-broadcast(1), bus-chmod(1), bus-chown(1) bus-chgrp(1),
+bus(5), libbus(7)
.SH AUTHORS
Principal author, Mattias Andrée. See the LICENSE file for the full
list of authors.