diff options
author | Andrew G. Morgan <morgan@kernel.org> | 2021-03-06 18:19:04 -0800 |
---|---|---|
committer | Andrew G. Morgan <morgan@kernel.org> | 2021-03-06 18:19:04 -0800 |
commit | b3c2cd00f3fe9353bf5300e046714cfd34b1626d (patch) | |
tree | 441ebb5b1c49b4b4e776c21bfb010aec059489f7 | |
parent | 2c1b9e59c9ec39cd247df1af9384cedcde43da5e (diff) | |
download | libcap2-b3c2cd00f3fe9353bf5300e046714cfd34b1626d.tar.gz |
Make documentation more consistently formatted
This is easier to edit and also seems to work with pandoc.
Signed-off-by: Andrew G. Morgan <morgan@kernel.org>
-rw-r--r-- | doc/cap_clear.3 | 27 | ||||
-rw-r--r-- | doc/cap_copy_ext.3 | 16 | ||||
-rw-r--r-- | doc/cap_from_text.3 | 3 | ||||
-rw-r--r-- | doc/cap_get_file.3 | 25 | ||||
-rw-r--r-- | doc/cap_get_proc.3 | 67 | ||||
-rw-r--r-- | doc/cap_init.3 | 16 | ||||
-rw-r--r-- | doc/libcap.3 | 80 | ||||
-rw-r--r-- | doc/libpsx.3 | 12 |
8 files changed, 105 insertions, 141 deletions
diff --git a/doc/cap_clear.3 b/doc/cap_clear.3 index 73aac61..954b32e 100644 --- a/doc/cap_clear.3 +++ b/doc/cap_clear.3 @@ -1,25 +1,20 @@ -.TH CAP_CLEAR 3 "2008-05-11" "" "Linux Programmer's Manual" +.TH CAP_CLEAR 3 "2021-03-06" "" "Linux Programmer's Manual" .SH NAME cap_clear, cap_clear_flag, cap_get_flag, cap_set_flag, cap_compare \- capability data object manipulation .SH SYNOPSIS .nf -.B #include <sys/capability.h> -.sp -.BI "int cap_clear(cap_t " cap_p ); -.sp -.BI "int cap_clear_flag(cap_t " cap_p ", cap_flag_t " flag ");" -.sp -.BI "int cap_get_flag(cap_t " cap_p ", cap_value_t " cap , -.BI " cap_flag_t " flag ", cap_flag_value_t *" value_p ");" -.sp -.BI "int cap_set_flag(cap_t " cap_p ", cap_flag_t " flag ", int " ncap , -.BI " const cap_value_t *" caps \ -", cap_flag_value_t " value ");" -.sp -.BI "int cap_compare(cap_t " cap_a ", cap_t " cap_b ");" +#include <sys/capability.h> + +int cap_clear(cap_t cap_p); +int cap_clear_flag(cap_t cap_p, cap_flag_t flag); +int cap_get_flag(cap_t cap_p, cap_value_t cap, + cap_flag_t flag, cap_flag_value_t *value_p); +int cap_set_flag(cap_t cap_p, cap_flag_t flag, int ncap, + const cap_value_t *caps, cap_flag_value_t value); +int cap_compare(cap_t cap_a, cap_t cap_b); +.fi .sp Link with \fI\-lcap\fP. -.fi .SH DESCRIPTION These functions work on a capability state held in working storage. A diff --git a/doc/cap_copy_ext.3 b/doc/cap_copy_ext.3 index acbb487..0965ad1 100644 --- a/doc/cap_copy_ext.3 +++ b/doc/cap_copy_ext.3 @@ -1,15 +1,15 @@ -.TH CAP_COPY_EXT 3 "2008-05-11" "" "Linux Programmer's Manual" +.TH CAP_COPY_EXT 3 "2021-03-06" "" "Linux Programmer's Manual" .SH NAME cap_copy_ext, cap_size, cap_copy_int \- capability state external representation translation .SH SYNOPSIS -.B #include <sys/capability.h> -.sp -.BI "ssize_t cap_size(cap_t " cap_p ); -.sp -.BI "ssize_t cap_copy_ext(void *" ext_p ", cap_t " cap_p ", ssize_t " size ); -.sp -.BI "cap_t cap_copy_int(const void *" ext_p ); +.nf +#include <sys/capability.h> + +ssize_t cap_size(cap_t cap_p); +ssize_t cap_copy_ext(void *ext_p, cap_t cap_p, ssize_t size); +cap_t cap_copy_int(const void * ext_p); +.fi .sp Link with \fI\-lcap\fP. .SH DESCRIPTION diff --git a/doc/cap_from_text.3 b/doc/cap_from_text.3 index 59724c7..9370e26 100644 --- a/doc/cap_from_text.3 +++ b/doc/cap_from_text.3 @@ -1,7 +1,7 @@ .\" .\" written by Andrew Main <zefram@dcs.warwick.ac.uk> .\" -.TH CAP_FROM_TEXT 3 "2008-05-10" "" "Linux Programmer's Manual" +.TH CAP_FROM_TEXT 3 "2021-03-06" "" "Linux Programmer's Manual" .SH NAME cap_from_text, cap_to_text, cap_to_name, cap_from_name \- capability state textual representation translation @@ -14,6 +14,7 @@ char *cap_to_text(cap_t caps, ssize_t * length_p); int cap_from_name(const char* name , cap_value_t* cap_p); char *cap_to_name(cap_value_t cap); .fi +.sp Link with \fI\-lcap\fP. .SH DESCRIPTION These functions translate a capability state between diff --git a/doc/cap_get_file.3 b/doc/cap_get_file.3 index 3f73734..4c812fe 100644 --- a/doc/cap_get_file.3 +++ b/doc/cap_get_file.3 @@ -1,24 +1,21 @@ .\" .\" written by Andrew Main <zefram@dcs.warwick.ac.uk> .\" -.TH CAP_GET_FILE 3 "2008-05-11" "" "Linux Programmer's Manual" +.TH CAP_GET_FILE 3 "2021-03-06" "" "Linux Programmer's Manual" .SH NAME cap_get_file, cap_set_file, cap_get_fd, cap_set_fd \- capability manipulation on files .SH SYNOPSIS -.B #include <sys/capability.h> -.sp -.BI "cap_t cap_get_file(const char *" path_p ); -.sp -.BI "int cap_set_file(const char *" path_p ", cap_t " cap_p ); -.sp -.BI "cap_t cap_get_fd(int " fd ); -.sp -.BI "int cap_set_fd(int " fd ", cap_t " caps ); -.sp -.BI "uid_t cap_get_nsowner(cap_t " caps ); -.sp -.BI "int cap_set_nsowner(cap_t " caps ", uid_t " rootuid ); +.nf +#include <sys/capability.h> + +cap_t cap_get_file(const char *path_p); +int cap_set_file(const char *path_p, cap_t cap_p); +cap_t cap_get_fd(int fd); +int cap_set_fd(int fd, cap_t caps); +uid_t cap_get_nsowner(cap_t caps); +int cap_set_nsowner(cap_t caps, uid_t rootuid); +.fi .sp Link with \fI\-lcap\fP. .SH DESCRIPTION diff --git a/doc/cap_get_proc.3 b/doc/cap_get_proc.3 index 74e5e8c..38e18ed 100644 --- a/doc/cap_get_proc.3 +++ b/doc/cap_get_proc.3 @@ -1,4 +1,4 @@ -.TH CAP_GET_PROC 3 "2019-12-21" "" "Linux Programmer's Manual" +.TH CAP_GET_PROC 3 "2021-03-06" "" "Linux Programmer's Manual" .SH NAME cap_get_proc, cap_set_proc, capgetp, cap_get_bound, cap_drop_bound, \ cap_get_ambient, cap_set_ambient, cap_reset_ambient, \ @@ -6,44 +6,33 @@ cap_get_secbits, cap_set_secbits, cap_get_mode, cap_set_mode, \ cap_mode_name, cap_get_pid, cap_setuid, cap_setgroups \ \- capability manipulation on processes .SH SYNOPSIS -.B #include <sys/capability.h> -.sp -.B "cap_t cap_get_proc(void);" -.sp -.BI "int cap_set_proc(cap_t " cap_p ); -.sp -.BI "int cap_get_bound(cap_value_t " cap ); -.sp -.BI "CAP_IS_SUPPORTED(cap_value_t " cap ); -.sp -.BI "int cap_drop_bound(cap_value_t " cap ); -.sp -.BI "int cap_get_ambient(cap_value_t " cap ); -.sp -.BI "int cap_set_ambient(cap_value_t " cap ", cap_flag_value_t " value ); -.sp -.B int cap_reset_ambient(void); -.sp -.BI CAP_AMBIENT_SUPPORTED(); -.sp -.B "unsigned cap_get_secbits(void);" -.sp -.BI "int cap_set_secbits(unsigned " bits ); -.sp -.B "cap_mode_t cap_get_mode(void);" -.sp -.BI "const char *cap_mode_name(cap_mode_t " mode ); -.sp -.BI "int cap_set_mode(cap_mode_t " mode ); -.sp -.B #include <sys/types.h> -.sp -.BI "cap_t cap_get_pid(pid_t " pid ); -.sp -.BI "int cap_setuid(uid_t " uid ); -.sp -.BI "int cap_setgroups(gid_t " gid ", size_t " ngroups ", const gid_t " \ -groups ); +.nf +#include <sys/capability.h> + +cap_t cap_get_proc(void); +int cap_set_proc(cap_t cap_p); + +int cap_get_bound(cap_value_t cap); +CAP_IS_SUPPORTED(cap_value_t cap); + +int cap_drop_bound(cap_value_t cap); +int cap_get_ambient(cap_value_t cap); +int cap_set_ambient(cap_value_t cap, cap_flag_value_t value); +int cap_reset_ambient(void); +CAP_AMBIENT_SUPPORTED(); + +unsigned cap_get_secbits(void); +int cap_set_secbits(unsigned bits); +cap_mode_t cap_get_mode(void); +const char *cap_mode_name(cap_mode_t mode); +int cap_set_mode(cap_mode_t mode); + +#include <sys/types.h> + +cap_t cap_get_pid(pid_t pid); +int cap_setuid(uid_t uid); +int cap_setgroups(gid_t gid, size_t ngroups, const gid_t groups); +.fi .sp Link with \fI\-lcap\fP. .SH DESCRIPTION diff --git a/doc/cap_init.3 b/doc/cap_init.3 index 362db66..125b529 100644 --- a/doc/cap_init.3 +++ b/doc/cap_init.3 @@ -1,17 +1,17 @@ .\" .\" written by Andrew Main <zefram@dcs.warwick.ac.uk> .\" -.TH CAP_INIT 3 "2008-05-11" "" "Linux Programmer's Manual" +.TH CAP_INIT 3 "2021-03-06" "" "Linux Programmer's Manual" .SH NAME cap_init, cap_free, cap_dup \- capability data object storage management .SH SYNOPSIS -.B #include <sys/capability.h> -.sp -.B cap_t cap_init(void); -.sp -.BI "int cap_free(void *" obj_d ); -.sp -.BI "cap_t cap_dup(cap_t " cap_p ); +.nf +#include <sys/capability.h> + +cap_t cap_init(void); +int cap_free(void *obj_d); +cap_t cap_dup(cap_t cap_p); +.fi .sp Link with \fI\-lcap\fP. .SH DESCRIPTION diff --git a/doc/libcap.3 b/doc/libcap.3 index 730e275..e6b7312 100644 --- a/doc/libcap.3 +++ b/doc/libcap.3 @@ -1,4 +1,4 @@ -.TH LIBCAP 3 "2020-01-07" "" "Linux Programmer's Manual" +.TH LIBCAP 3 "2021-03-06" "" "Linux Programmer's Manual" .SH NAME cap_clear, cap_clear_flag, cap_compare, cap_copy_ext, cap_copy_int, \ cap_free, cap_from_name, cap_from_text, cap_get_fd, cap_get_file, \ @@ -7,54 +7,36 @@ cap_set_flag, cap_set_proc, cap_size, cap_to_name, cap_to_text, \ cap_get_pid, cap_dup \- capability data object manipulation .SH SYNOPSIS .nf -.B #include <sys/capability.h> -.sp -.BI "int cap_clear(cap_t " cap_p ); -.sp -.BI "int cap_clear_flag(cap_t " cap_p ", cap_flag_t " flag ");" -.sp -.BI "int cap_compare(cap_t " cap_a ", cap_t " cap_b ");" -.sp -.BI "ssize_t cap_copy_ext(void *" ext_p ", cap_t " cap_p ", ssize_t " size ); -.sp -.BI "cap_t cap_copy_int(const void *" ext_p ); -.sp -.BI "int cap_free(void *" obj_d ); -.sp -.BI "int cap_from_name(const char *" name ", cap_value_t *" cap_p ); -.sp -.BI "cap_t cap_from_text(const char *" buf_p ); -.sp -.BI "cap_t cap_get_fd(int " fd ); -.sp -.BI "cap_t cap_get_file(const char *" path_p ); -.sp -.BI "int cap_get_flag(cap_t " cap_p ", cap_value_t " cap , -.BI " cap_flag_t " flag ", cap_flag_value_t *" value_p ");" -.sp -.B #include <sys/types.h> -.BI "cap_t cap_get_pid(pid_t " pid ); -.sp -.B "cap_t cap_get_proc(void);" -.sp -.BI "int cap_set_fd(int " fd ", cap_t " caps ); -.sp -.BI "int cap_set_file(const char *" path_p ", cap_t " cap_p ); -.sp -.sp -.BI "int cap_set_flag(cap_t " cap_p ", cap_flag_t " flag ", int " ncap , -.BI " const cap_value_t *" caps ", cap_flag_value_t " value ");" -.BI "int cap_set_proc(cap_t " cap_p ); -.sp -.BI "ssize_t cap_size(cap_t " cap_p ); -.sp -.BI "char *cap_to_name(cap_value_t " cap ); -.sp -.BI "char *cap_to_text(cap_t " caps ", ssize_t *" length_p ); -.sp -.BI "cap_t cap_get_pid(pid_t " pid ); -.sp -.BI "cap_t cap_dup(cap_t " cap_p ); +#include <sys/capability.h> + +int cap_clear(cap_t cap_p); +int cap_clear_flag(cap_t cap_p, cap_flag_t flag); +int cap_compare(cap_t cap_a, cap_t cap_b); +ssize_t cap_copy_ext(void *ext_p, cap_t cap_p, ssize_t size); +cap_t cap_copy_int(const void *ext_p); +int cap_free(void *obj_d); +int cap_from_name(const char *name, cap_value_t *cap_p); +cap_t cap_from_text(const char *buf_p); +cap_t cap_get_fd(int fd); +cap_t cap_get_file(const char *path_p); +int cap_get_flag(cap_t cap_p, cap_value_t cap , + cap_flag_t flag, cap_flag_value_t *value_p); + +#include <sys/types.h> + +cap_t cap_get_pid(pid_t pid); +cap_t cap_get_proc(void); +int cap_set_fd(int fd, cap_t caps); +int cap_set_file(const char *path_p, cap_t cap_p); +int cap_set_flag(cap_t cap_p, cap_flag_t flag, int ncap , + const cap_value_t *caps, cap_flag_value_t value); +int cap_set_proc(cap_t cap_p); +ssize_t cap_size(cap_t cap_p); +char *cap_to_name(cap_value_t cap); +char *cap_to_text(cap_t caps, ssize_t *length_p); +cap_t cap_get_pid(pid_t pid); +cap_t cap_dup(cap_t cap_p); +.fi .sp Link with \fI\-lcap\fP. .fi diff --git a/doc/libpsx.3 b/doc/libpsx.3 index 61baa88..43128eb 100644 --- a/doc/libpsx.3 +++ b/doc/libpsx.3 @@ -1,13 +1,13 @@ -.TH LIBPSX 3 "2021-01-31" "" "Linux Programmer's Manual" +.TH LIBPSX 3 "2021-03-06" "" "Linux Programmer's Manual" .SH NAME psx_syscall3, psx_syscall6 \- POSIX semantics for system calls .SH SYNOPSIS .nf -.B #include <sys/psx_syscall.h> -.sp -.BI "long int psx_syscall3(long int" " syscall_nr, " "long int" " arg1, " "long int" " arg2, " "long int" " arg3);" -.sp -.BI "long int psx_syscall6(long int" " syscall_nr, " "long int" " arg1, " "long int" " arg2, " "long int" " arg3, " "long int" " arg4, " "long int" " arg5, " "long int" " arg6);" +#include <sys/psx_syscall.h> + +long int psx_syscall3(long int syscall_nr, long int arg1, long int arg2, long int arg3); +long int psx_syscall6(long int syscall_nr, long int arg1, long int arg2, long int arg3, long int arg4, long int arg5, long int arg6); +.fi .sp Link with one of these: .sp |