From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: mtk.manpages@gmail.com, Andrew Morgan <morgan@kernel.org>
Cc: linux-security-module@vger.kernel.org
Subject: [PATCH 01/15] Manual pages: various pages: Use "\-" for real minus signs
Date: Mon, 20 Jul 2020 11:13:14 +0200 [thread overview]
Message-ID: <20200720091328.290336-2-mtk.manpages@gmail.com> (raw)
In-Reply-To: <20200720091328.290336-1-mtk.manpages@gmail.com>
Signed-off-by: Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>
---
doc/cap_get_proc.3 | 8 ++++----
doc/capsh.1 | 14 +++++++-------
doc/getpcaps.8 | 6 +++---
doc/libpsx.3 | 6 +++---
4 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/doc/cap_get_proc.3 b/doc/cap_get_proc.3
index fda00e0..fce8f59 100644
--- a/doc/cap_get_proc.3
+++ b/doc/cap_get_proc.3
@@ -242,11 +242,11 @@ is packaged with a separate POSIX semantics system call library:
If your program uses POSIX threads, to achieve meaningful POSIX
semantics capability manipulation, you should link your program with:
.sp
-.B ld ... -lcap -lpsx -lpthread --wrap=pthread_create
+.B ld ... \-lcap \-lpsx \-lpthread \-\-wrap=pthread_create
.sp
or,
.sp
-.B gcc ... -lcap -lpsx -lpthread -Wl,-wrap,pthread_create
+.B gcc ... \-lcap \-lpsx \-lpthread \-Wl,\-wrap,pthread_create
.sp
When linked this way, due to linker magic, libcap uses
.BR psx_syscall "(3) and " psx_syscall6 (3)
@@ -362,10 +362,10 @@ Note, the above sequence can be performed by the
.B capsh
tool as follows:
.sp
-.B sudo /sbin/capsh --user=nobody --mode=NOPRIV --print
+.B sudo /sbin/capsh \-\-user=nobody \-\-mode=NOPRIV \-\-print
.sp
where
-.B --print
+.B \-\-print
displays the resulting privilege state.
.SH "SEE ALSO"
.BR libcap (3),
diff --git a/doc/capsh.1 b/doc/capsh.1
index 0b987f0..242727c 100644
--- a/doc/capsh.1
+++ b/doc/capsh.1
@@ -107,7 +107,7 @@ preparations for setting the uid without dropping capabilities in the
process. Following this command the prevailing effective capabilities
will be lowered.
.TP
-.BI \-\-is-uid= <id>
+.BI \-\-is\-uid= <id>
Exit with status 1 unless the current
.IR uid " equals " <id> .
.TP
@@ -120,7 +120,7 @@ using the
.BR setgid (2)
system call.
.TP
-.BI \-\-is-gid= <id>
+.BI \-\-is\-gid= <id>
Exit with status 1 unless the current
.IR gid " equals " <id> .
.TP
@@ -129,7 +129,7 @@ Set the supplementary groups to the numerical list provided. The
groups are set with the
.BR setgroups (2)
system call. See
-.B --user
+.B \-\-user
for a more convenient way of doing this.
.TP
.BI \-\-keep= <0|1>
@@ -152,7 +152,7 @@ the current process. In all cases,
is deactivated when an
.BR exec ()
is performed. See
-.B --secbits
+.B \-\-secbits
for ways to disable this feature.
.TP
.BI \-\-secbits= N
@@ -225,18 +225,18 @@ will cause capsh to promptly exit with a status of 1 when run on
kernel 2.6.27. However, when run on kernel 2.6.38 it will silently
succeed.
.TP
-.BI \-\-has-p= xxx
+.BI \-\-has\-p= xxx
Exit with status 1 unless the
.I permitted
vector has capability
.B xxx
raised.
.TP
-.B \-\-has-ambient
+.B \-\-has\-ambient
Performs a check to see if the running kernel supports ambient
capabilities. If not, the capsh command exits with status 1.
.TP
-.BI \-\-has-a= xxx
+.BI \-\-has\-a= xxx
Exit with status 1 unless the
.I ambient
vector has capability
diff --git a/doc/getpcaps.8 b/doc/getpcaps.8
index 53d342e..7b73e86 100644
--- a/doc/getpcaps.8
+++ b/doc/getpcaps.8
@@ -24,13 +24,13 @@ format.
.PP
Optional arguments:
.PP
-.BR --help " or " --usage
+.BR \-\-help " or " \-\-usage
Displays usage information and exits.
.PP
-.BR --ugly " or " --legacy
+.BR \-\-ugly " or " \-\-legacy
Displays output in a somewhat ugly legacy format.
.PP
-.B --verbose
+.B \-\-verbose
Displays usage in a legacy-like format but not quite so ugly in modern
default terminal fonts.
.SH SEE ALSO
diff --git a/doc/libpsx.3 b/doc/libpsx.3
index 615fceb..a907d8b 100644
--- a/doc/libpsx.3
+++ b/doc/libpsx.3
@@ -11,9 +11,9 @@ psx_syscall3, psx_syscall6 \- POSIX semantics for system calls
.sp
Link with one of these:
.sp
-.I ld ... -lpsx -lpthread --wrap=pthread_create
+.I ld ... \-lpsx \-lpthread \-\-wrap=pthread_create
.sp
-.I gcc ... -lpsx -lpthread -Wl,-wrap,pthread_create
+.I gcc ... \-lpsx \-lpthread \-Wl,\-wrap,pthread_create
.SH DESCRIPTION
The
.B libpsx
@@ -58,7 +58,7 @@ and
functions.
.SH RETURN VALUE
The return value for system call functions is generally the value
-returned by the kernel, or -1 in the case of an error. In such cases
+returned by the kernel, or \-1 in the case of an error. In such cases
.BR errno (3)
is set to the detailed error value. The
.BR psx_syscall3 " and " psx_syscall6
--
2.26.2
next prev parent reply other threads:[~2020-07-20 9:13 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-20 9:13 [PATCH 00/15] [libcap] Manual pages: various fixes Michael Kerrisk (man-pages)
2020-07-20 9:13 ` Michael Kerrisk (man-pages) [this message]
2020-07-20 9:13 ` [PATCH 02/15] Manual pages: cap_init.3: Formatting fix Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 03/15] Manual pages: capsh.1: Various minor wording and formatting fixes Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 04/15] Manual pages: cap_copy_ext.3: Typo fix Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 05/15] Manual pages; cap_get_file.3: Fix some clumsily worded text Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 06/15] Manual pages: getcap.8: Add missing word Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 07/15] Manual pages: getcap.8: Fix a clumsily worded sentence Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 08/15] Manual pages: getpcaps.8: Format options as a hanging list Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 09/15] Manual pages: getpcaps.8: Remove a stray .br macro Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 10/15] Manual pages: getpcaps.8: SEE ALSO: fix section number for capsh Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 11/15] Manual pages: setcap.8: Typo fix Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 12/15] Manual pages: cap_get_file.3: NOTES: note the effect of the Ambient set Michael Kerrisk (man-pages)
2020-07-20 15:36 ` Andrew G. Morgan
2020-07-20 20:21 ` Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 13/15] Manual pages: cap_get_proc.3: Update description of capsetp() Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 14/15] Manual pages: cap_get_proc.3, capsh.1: Use "UID" and "GID" consistently Michael Kerrisk (man-pages)
2020-07-20 9:13 ` [PATCH 15/15] Manual pages: capsh.1: Change .TP indent to the default Michael Kerrisk (man-pages)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200720091328.290336-2-mtk.manpages@gmail.com \
--to=mtk.manpages@gmail.com \
--cc=linux-security-module@vger.kernel.org \
--cc=morgan@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).