From 91e3124a29803dcc4c454d32c10c45689722b103 Mon Sep 17 00:00:00 2001 From: "Andrew G. Morgan" Date: Wed, 19 Mar 2025 20:17:01 -0700 Subject: [PATCH] More useful cross linking for man pages. Signed-off-by: Andrew G. Morgan --- doc/cap_text_formats.7 | 2 +- doc/capsh.1 | 13 ++++++++----- doc/captree.8 | 5 ++++- doc/getpcaps.8 | 18 ++++++++++-------- doc/setcap.8 | 7 ++++--- 5 files changed, 27 insertions(+), 18 deletions(-) diff --git a/doc/cap_text_formats.7 b/doc/cap_text_formats.7 index b25a5fe..e193e61 100644 --- a/doc/cap_text_formats.7 +++ b/doc/cap_text_formats.7 @@ -119,7 +119,7 @@ website. Please report bugs as directed at that site. .PP Related manual pages: .BR libcap (3), -.BR capsh (8), +.BR capsh (1), .BR setcap (8), .BR getcap (8), .BR captree (8), diff --git a/doc/capsh.1 b/doc/capsh.1 index 4f3aaae..dcd3b0a 100644 --- a/doc/capsh.1 +++ b/doc/capsh.1 @@ -1,4 +1,4 @@ -.TH CAPSH 1 "2021-10-22" "libcap" "User Commands" +.TH CAPSH 1 "2025-03-19" "libcap" "User Commands" .SH NAME capsh \- capability shell wrapper .SH SYNOPSIS @@ -62,8 +62,8 @@ Set the prevailing process capabilities to those specified by .IR cap-set . Where .I cap-set -is a text-representation of capability state as per -.BR cap_from_text (3). +is a text-representation of a capability `Set' as per +.BR cap_text_formats (7). .TP .BI \-\-drop= cap-list Remove the listed capabilities from the prevailing bounding set. The @@ -318,7 +318,9 @@ in its (default) non-blocked state. .BI \-\-iab= xxx Attempts to set the IAB tuple of inheritable capability vectors. The text conventions used for \fIxxx\fP are those of -.BR cap_iab_from_text (3). +.BR cap_iab_from_text (3), +and described in +.BR cap_text_formats (7). .TP .BI \-\-addamb= xxx Adds the specified ambient capability to the running process. @@ -356,7 +358,8 @@ https://bugzilla.kernel.org/buglist.cgi?component=libcap&list_id=1090757 .SH "SEE ALSO" .BR libcap (3), .BR cap_from_text (3), -.BR cap_iab (3) +.BR cap_iab (3), +.BR cap_text_formats (7), .BR capabilities (7), .BR captree (8), .BR getcap (8), diff --git a/doc/captree.8 b/doc/captree.8 index dad9e9a..d717a40 100644 --- a/doc/captree.8 +++ b/doc/captree.8 @@ -1,5 +1,5 @@ .\" Hey, EMACS: -*- nroff -*- -.TH CAPTREE 8 "2022-04-11" +.TH CAPTREE 8 "2022-03-19" .\" Please adjust this date whenever revising the manpage. .SH NAME captree \- display tree of process capabilities @@ -23,6 +23,8 @@ The POSIX.1e capabilities are displayed in double quotes in the format. The IAB tuple of capabilities is displayed between square brackets in the text format described in .BR cap_iab (3). +Both of these text formats are described in +.BR cap_text_formats (7). Note, the IAB tuple text is omitted if it contains empty A and B components. This is because the regular POSIX.1e text contains information about the Inheritable flag already. This behavior can be @@ -63,6 +65,7 @@ Please report bugs via: https://bugzilla.kernel.org/buglist.cgi?component=libcap&list_id=1090757 .SH SEE ALSO .BR cap_from_text (3), +.BR cap_text_formats (7), .BR capabilities (7), and .BR cap_iab (3). diff --git a/doc/getpcaps.8 b/doc/getpcaps.8 index 1c59ddc..6032837 100644 --- a/doc/getpcaps.8 +++ b/doc/getpcaps.8 @@ -1,5 +1,5 @@ .\" Hey, EMACS: -*- nroff -*- -.TH GETPCAPS 8 "2020-08-29" +.TH GETPCAPS 8 "2025-03-19" .\" Please adjust this date whenever revising the manpage. .SH NAME getpcaps \- display process capabilities @@ -17,10 +17,9 @@ of 0 displays the capabilities of the process that is running .B getpcaps itself. .PP -The capabilities are displayed in -the -.BR cap_from_text (3) -format. +The capability Set of the process is displayed in +the text represenation described here: +.BR cap_text_formats (7). .PP Optional arguments: .TP @@ -36,9 +35,11 @@ default terminal fonts. .TP .B \-\-iab Displays IAB tuple capabilities from the process. The output format -here is the text format described in \fBcap_iab\fR(3). Double -quotes encase the regular process capabilities and square brackets -encase the IAB tuple. This format is also used by \fBcaptree\fR(8). +here is also described in +.BR cap_text_formats (7). +Double quotes encase the regular process capabilities and square +brackets encase the IAB tuple. This format is also used by +.BR captree (8). .SH "REPORTING BUGS" Please report bugs via: .TP @@ -47,6 +48,7 @@ https://bugzilla.kernel.org/buglist.cgi?component=libcap&list_id=1090757 .BR capsh (1), .BR cap_from_text (3), .BR cap_iab (3), +.BR cap_text_format (7), .BR capabilities (7), .BR captree (8), .BR getcap (8), diff --git a/doc/setcap.8 b/doc/setcap.8 index c6b1d50..66d9435 100644 --- a/doc/setcap.8 +++ b/doc/setcap.8 @@ -1,4 +1,4 @@ -.TH SETCAP 8 "2020-08-29" +.TH SETCAP 8 "2025-03-19" .SH NAME setcap \- set file capabilities .SH SYNOPSIS @@ -24,8 +24,8 @@ argument is also verified. .PP The .I capabilities -are specified in the form described in -.BR cap_from_text (3). +Set are specified in the form described in +.BR cap_text_formats (7). .PP The special capability string, .BR '\-' , @@ -67,6 +67,7 @@ https://bugzilla.kernel.org/buglist.cgi?component=libcap&list_id=1090757 .BR capsh (1), .BR cap_from_text (3), .BR cap_get_file (3), +.BR cap_text_formats (7), .BR capabilities (7), .BR user_namespaces (7), .BR captree (8),