diff options
author | Michael Kerrisk <mtk.manpages@gmail.com> | 2016-11-08 15:22:34 +0100 |
---|---|---|
committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2016-12-13 15:33:42 +0100 |
commit | b1cec32fdaa6b3aee789cc9c4bd5f5283937d1d2 (patch) | |
tree | 8eef833dfd240dfdd5cdf73c28ba7be3b1de2f49 /man | |
parent | 7e6ec8977357d47fbc4a58c77c18c8f8cb6833e0 (diff) | |
download | keyutils-b1cec32fdaa6b3aee789cc9c4bd5f5283937d1d2.tar.gz |
man: Format function references consistently
Always format functions as: .BR func ()
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Diffstat (limited to 'man')
-rw-r--r-- | man/keyctl.1 | 4 | ||||
-rw-r--r-- | man/keyctl_instantiate.3 | 12 | ||||
-rw-r--r-- | man/keyctl_set_reqkey_keyring.3 | 4 | ||||
-rw-r--r-- | man/keyutils.7 | 6 | ||||
-rw-r--r-- | man/recursive_key_scan.3 | 6 |
5 files changed, 21 insertions, 11 deletions
diff --git a/man/keyctl.1 b/man/keyctl.1 index 56b29ce..8bacfb2 100644 --- a/man/keyctl.1 +++ b/man/keyctl.1 @@ -137,7 +137,9 @@ implemented yet in the kernel. .P (*) Assumed request_key authorisation key: \fB@a\fR or \fB-7\fR .P -This selects the authorisation key provided to the request_key() helper to +This selects the authorisation key provided to the +.BR request_key () +helper to permit it to access the callers keyrings and instantiate the target key. .P (*) Keyring by name: \fB%:<name>\fR diff --git a/man/keyctl_instantiate.3 b/man/keyctl_instantiate.3 index 7989e22..9041d69 100644 --- a/man/keyctl_instantiate.3 +++ b/man/keyctl_instantiate.3 @@ -49,7 +49,9 @@ The calling thread must have the appopriate authorisation key resident in one of its keyrings for this to succeed, and that authority must not have been revoked. .P -The authorising key is allocated by request_key() when it needs to invoke +The authorising key is allocated by +.BR request_key() +when it needs to invoke userspace to generate a key for the requesting process. This is then attached to one of the keyrings of the userspace process to which the task of instantiating the key is given: @@ -105,12 +107,16 @@ specifies the lifetime of the key in seconds. specifies the error to be returned when a search hits the key (this is typically .BR EKEYREJECTED ", " EKEYREVOKED " or " EKEYEXPIRED ")." -Note that keyctl_reject() falls back to keyctl_negate() if the kernel does not +Note that +.BR keyctl_reject () +falls back to +.BR keyctl_negate () +if the kernel does not support it. .P .BR keyctl_negate () as -.IR keyctl_reject () +.BR keyctl_reject () with an error code of .IB ENOKEY . .P diff --git a/man/keyctl_set_reqkey_keyring.3 b/man/keyctl_set_reqkey_keyring.3 index a83976e..b34cb36 100644 --- a/man/keyctl_set_reqkey_keyring.3 +++ b/man/keyctl_set_reqkey_keyring.3 @@ -24,7 +24,9 @@ sets the default destination for implicit key requests for the current thread and returns the old setting. .P After this operation has been issued, keys acquired by implicit key requests, -such as might be performed by open() on an AFS or NFS filesystem, will be +such as might be performed by +.BR open () +on an AFS or NFS filesystem, will be linked by default to the specified keyring by this function. .P The valid values of diff --git a/man/keyutils.7 b/man/keyutils.7 index b49e21e..39f12a5 100644 --- a/man/keyutils.7 +++ b/man/keyutils.7 @@ -34,11 +34,11 @@ To link with the library, the following: should be specified to the linker. .P Three system calls are provided: -.IP \fBadd_key\fP() +.BR \fBadd_key\fP() Supply a new key to the kernel. -.IP \fBrequest_key\fP() +.BR \fBrequest_key\fP() Find an existing key for use, or, optionally, create one if one does not exist. -.IP \fBkeyctl\fP() +.BR \fBkeyctl\fP() Control a key in various ways. The library provides a variety of wrappers around this system call and those should be used rather than calling it directly. diff --git a/man/recursive_key_scan.3 b/man/recursive_key_scan.3 index ed7f440..5e8a58d 100644 --- a/man/recursive_key_scan.3 +++ b/man/recursive_key_scan.3 @@ -45,7 +45,7 @@ func. .P .BR recursive_session_key_scan () works exactly like -.IR recursive_key_scan () +.BR recursive_key_scan () with the caller's session keyring specified as the starting keyring. .P The callback function is called for each link found in all the keyrings in the @@ -62,12 +62,12 @@ The key to which the link points. .TP .BR desc " and " desc_len A pointer to the raw description and its length as retrieved with -.IR keyctl_describe_alloc (). +.BR keyctl_describe_alloc (). These will be NULL and \-1 respectively if the description couldn't be retrieved and .I errno will retain the error from -.IR keyctl_describe_alloc (). +.BR keyctl_describe_alloc (). .TP .B data The data passed to the scanner function. |