summaryrefslogtreecommitdiffstats
path: root/sys-utils
diff options
context:
space:
mode:
authorBenno Schulenberg2013-10-14 22:02:00 +0200
committerKarel Zak2013-10-15 10:28:31 +0200
commit87ec43b671d4d67d2f2afa16c5d6c6ab3fe6b768 (patch)
treec84fa3ad585232fc3e1b7765eadcb1ffab042bb0 /sys-utils
parentdocs: standardize the phrases for --help and --version in all man pages (diff)
downloadkernel-qcow2-util-linux-87ec43b671d4d67d2f2afa16c5d6c6ab3fe6b768.tar.gz
kernel-qcow2-util-linux-87ec43b671d4d67d2f2afa16c5d6c6ab3fe6b768.tar.xz
kernel-qcow2-util-linux-87ec43b671d4d67d2f2afa16c5d6c6ab3fe6b768.zip
docs: tweak wording and formatting of unshare and nsenter man pages
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
Diffstat (limited to 'sys-utils')
-rw-r--r--sys-utils/nsenter.110
-rw-r--r--sys-utils/unshare.116
2 files changed, 14 insertions, 12 deletions
diff --git a/sys-utils/nsenter.1 b/sys-utils/nsenter.1
index 60ee6b3da..3964ee5d7 100644
--- a/sys-utils/nsenter.1
+++ b/sys-utils/nsenter.1
@@ -1,9 +1,9 @@
-.TH NSENTER 1 "May 2013" "util-linux" "User Commands"
+.TH NSENTER 1 "June 2013" "util-linux" "User Commands"
.SH NAME
nsenter \- run program with namespaces of other processes
.SH SYNOPSIS
.B nsenter
-.RB [ options ]
+.RI [ options ]
.RI [ program
.RI [ arguments ]]
.SH DESCRIPTION
@@ -123,13 +123,13 @@ file.
\fB\-U\fR, \fB\-\-user\fR[=\fIfile\fR]
Enter the user namespace. If no file is specified, enter the user namespace of
the target process. If file is specified, enter the user namespace specified by
-file. See also \fB\-\-setuid\fR and \fB\-\-setgid\fR options.
+file. See also the \fB\-\-setuid\fR and \fB\-\-setgid\fR options.
.TP
\fB\-G\fR, \fB\-\-setgid\fR \fIgid\fR
-Set group ID which will be used in the entered user namespace.
+Set the group ID which will be used in the entered user namespace.
.TP
\fB\-S\fR, \fB\-\-setuid\fR \fIuid\fR
-Set user ID which will be used in the entered user namespace.
+Set the user ID which will be used in the entered user namespace.
.TP
\fB\-r\fR, \fB\-\-root\fR[=\fIdirectory\fR]
Set the root directory. If no directory is specified, set the root directory to
diff --git a/sys-utils/unshare.1 b/sys-utils/unshare.1
index d88b07344..b78ace833 100644
--- a/sys-utils/unshare.1
+++ b/sys-utils/unshare.1
@@ -1,17 +1,18 @@
.\" Process this file with
.\" groff -man -Tascii lscpu.1
.\"
-.TH UNSHARE 1 "May 2013" "util-linux" "User Commands"
+.TH UNSHARE 1 "July 2013" "util-linux" "User Commands"
.SH NAME
unshare \- run program with some namespaces unshared from parent
.SH SYNOPSIS
.B unshare
-.RB [ options ]
+.RI [ options ]
.I program
.RI [ arguments ]
.SH DESCRIPTION
Unshares the indicated namespaces from the parent process and then executes
-the specified program. Unshareable namespaces are:
+the specified program. The namespaces to be unshared are indicated via
+options. Unshareable namespaces are:
.TP
.BR "mount namespace"
Mounting and unmounting filesystems will not affect the rest of the system
@@ -56,7 +57,8 @@ Unshare the mount namespace.
Unshare the network namespace.
.TP
.BR \-p , " \-\-pid"
-Unshare the pid namespace. See also \fB--fork\fP and \fB--mount-proc\fP options.
+Unshare the pid namespace.
+See also the \fB--fork\fP and \fB--mount-proc\fP options.
.TP
.BR \-u , " \-\-uts"
Unshare the UTS namespace.
@@ -65,10 +67,10 @@ Unshare the UTS namespace.
Unshare the user namespace.
.TP
.BR \-f , " \-\-fork"
-Fork the specified process as a child of unshare rather than running it
-directly. This is useful when creating a new pid namespace.
+Fork the specified \fIprogram\fR as a child process of \fBunshare\fR rather than
+running it directly. This is useful when creating a new pid namespace.
.TP
-.BR "\fB\-\-mount-proc\fR [=\fImountpoint\fP]"
+.BR \-\-mount-proc "[=\fImountpoint\fP]"
Just before running the program, mount the proc filesystem at the \fImountpoint\fP
(default is /proc). This is useful when creating a new pid namespace. It also
implies creating a new mount namespace since the /proc mount would otherwise