aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Howells <dhowells@redhat.com>2016-12-16 15:50:48 +0000
committerDavid Howells <dhowells@redhat.com>2016-12-16 15:50:48 +0000
commit87ba4d8c641279cdcef1bd924168427de7cb34b0 (patch)
treefc41bf5888db1784ba139d114fb18863f823364c
parent03f6bd27361eba3f0134cc1f2d26d6f4271179ef (diff)
parent0349e51076e01f625739f80eba07b9e1ec96730b (diff)
downloadkeyutils-master.tar.gz
Merge branch 'man_formatting_fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/mtk/keyutils.gitHEADmaster
Signed-off-by: David Howells <dhowells@redhat.com>
-rw-r--r--man/find_key_by_type_and_name.35
-rw-r--r--man/key.dns_resolver.82
-rw-r--r--man/keyctl.119
-rw-r--r--man/keyctl.32
-rw-r--r--man/keyctl_chown.36
-rw-r--r--man/keyctl_clear.36
-rw-r--r--man/keyctl_describe.310
-rw-r--r--man/keyctl_get_keyring_ID.36
-rw-r--r--man/keyctl_get_persistent.38
-rw-r--r--man/keyctl_get_security.310
-rw-r--r--man/keyctl_instantiate.328
-rw-r--r--man/keyctl_invalidate.36
-rw-r--r--man/keyctl_join_session_keyring.36
-rw-r--r--man/keyctl_link.37
-rw-r--r--man/keyctl_read.36
-rw-r--r--man/keyctl_revoke.36
-rw-r--r--man/keyctl_search.36
-rw-r--r--man/keyctl_session_to_parent.36
-rw-r--r--man/keyctl_set_reqkey_keyring.310
-rw-r--r--man/keyctl_set_timeout.36
-rw-r--r--man/keyctl_setperm.36
-rw-r--r--man/keyctl_update.36
-rw-r--r--man/keyutils.712
-rw-r--r--man/recursive_key_scan.314
-rw-r--r--man/request-key.82
25 files changed, 124 insertions, 77 deletions
diff --git a/man/find_key_by_type_and_name.3 b/man/find_key_by_type_and_name.3
index 2d0f13d..ad8ae54 100644
--- a/man/find_key_by_type_and_name.3
+++ b/man/find_key_by_type_and_name.3
@@ -10,7 +10,7 @@
.TH FIND_KEY_BY_TYPE_AND_NAME 3 "10 Sep 2013" Linux "Linux Key Utility Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-find_key_by_type_and_name \- Find a key by type and name
+find_key_by_type_and_name \- find a key by type and name
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -26,7 +26,8 @@ searches for a key with the given
and exact
.IR description ,
firstly in the thread, process and session keyrings to which a process is
-subscribed and secondly in /proc/keys.
+subscribed and secondly in
+.IR /proc/keys .
.P
If a key is found, and
.I destringid
diff --git a/man/key.dns_resolver.8 b/man/key.dns_resolver.8
index 0529294..c737768 100644
--- a/man/key.dns_resolver.8
+++ b/man/key.dns_resolver.8
@@ -9,7 +9,7 @@
.\"
.TH KEY.DNS_RESOLVER 8 "04 Mar 2011" Linux "Linux Key Management Utilities"
.SH NAME
-key.dns_resolver - Upcall for request-key to handle dns_resolver keys
+key.dns_resolver \- upcall for request\-key to handle dns_resolver keys
.SH SYNOPSIS
\fB/sbin/key.dns_resolver \fR<key>
.br
diff --git a/man/keyctl.1 b/man/keyctl.1
index e7ce451..cd8abf7 100644
--- a/man/keyctl.1
+++ b/man/keyctl.1
@@ -9,7 +9,7 @@
.\"
.TH KEYCTL 1 "20 Feb 2014" Linux "Linux Key Management Utilities"
.SH NAME
-keyctl - Key management facility control
+keyctl - key management facility control
.SH SYNOPSIS
\fBkeyctl\fR \-\-version
.br
@@ -139,18 +139,21 @@ 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
.P
A named keyring. This will be searched for in the process's keyrings and in
-/proc/keys.
+.IR /proc/keys .
.P
(*) Key by name: \fB%<type>:<name>\fR
.P
A named key of the given type. This will be searched for in the process's
-keyrings and in /proc/keys.
+keyrings and in
+.IR /proc/keys .
.SH COMMAND SYNTAX
Any non-ambiguous shortening of a command name may be used in lieu of the full
command name. This facility should not be used in scripting as new commands may
@@ -217,7 +220,9 @@ is given, the key will be added to that keyring also.
.P
If there is no key, the first command will simply return the error ENOKEY and
fail. The second and third commands will create a partial key with the type and
-description, and call out to \fB/sbin/request-key\fR with that key and the
+description, and call out to
+.IR /sbin/request-key
+with that key and the
extra information supplied. This will then attempt to instantiate the key in
some manner, such that a valid key is obtained.
.P
@@ -590,7 +595,9 @@ keyring;4043;4043;3f1f0000;fish
\fBkeyctl reject\fR <key> <timeout> <error> <keyring>
.P
These commands are used to attach data to a partially set up key (as created by
-the kernel and passed to /sbin/request-key). "instantiate" marks a key as
+the kernel and passed to
+.IR /sbin/request-key ).
+"instantiate" marks a key as
being valid and attaches the data as the payload. "negate" and "reject" mark a
key as invalid and sets a timeout on it so that it'll go away after a while.
This prevents a lot of quickly sequential requests from slowing the system down
diff --git a/man/keyctl.3 b/man/keyctl.3
index af2663b..d9a2f85 100644
--- a/man/keyctl.3
+++ b/man/keyctl.3
@@ -10,7 +10,7 @@
.TH KEYCTL 3 "21 Feb 2014" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_*() \- Key management function wrappers
+keyctl_*() \- key management function wrappers
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH DESCRIPTION
The
diff --git a/man/keyctl_chown.3 b/man/keyctl_chown.3
index 0836e25..1db72ef 100644
--- a/man/keyctl_chown.3
+++ b/man/keyctl_chown.3
@@ -10,7 +10,7 @@
.TH KEYCTL_CHOWN 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_chown \- Change the ownership of a key
+keyctl_chown \- change the ownership of a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -46,7 +46,9 @@ returns
.B 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_clear.3 b/man/keyctl_clear.3
index 2b6bfa1..da10fe8 100644
--- a/man/keyctl_clear.3
+++ b/man/keyctl_clear.3
@@ -10,7 +10,7 @@
.TH KEYCTL_CLEAR 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_clear \- Clear a keyring
+keyctl_clear \- clear a keyring
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -34,7 +34,9 @@ returns
.BR 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_describe.3 b/man/keyctl_describe.3
index 5e4881e..3db2c20 100644
--- a/man/keyctl_describe.3
+++ b/man/keyctl_describe.3
@@ -10,7 +10,7 @@
.TH KEYCTL_DESCRIBE 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_describe \- Describe a key
+keyctl_describe \- describe a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -65,13 +65,17 @@ returns the amount of data placed into the buffer. If the buffer was too
small, then the size of buffer required will be returned, but no data will be
transferred. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.P
On success
.BR keyctl_describe_alloc ()
returns the amount of data in the buffer, less the NUL terminator. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_get_keyring_ID.3 b/man/keyctl_get_keyring_ID.3
index bc8dd56..44b07af 100644
--- a/man/keyctl_get_keyring_ID.3
+++ b/man/keyctl_get_keyring_ID.3
@@ -10,7 +10,7 @@
.TH KEYCTL_GET_KEYRING_ID 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_get_keyring_ID \- Get the ID of a special keyring
+keyctl_get_keyring_ID \- get the ID of a special keyring
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -61,7 +61,9 @@ On success
.BR keyctl_get_keyring_ID ()
returns the serial number of the key it found. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_get_persistent.3 b/man/keyctl_get_persistent.3
index 35c7b06..72088f8 100644
--- a/man/keyctl_get_persistent.3
+++ b/man/keyctl_get_persistent.3
@@ -10,7 +10,7 @@
.TH KEYCTL_GET_PERSISTENT 3 "20 Feb 2014" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_get_persistent \- Get the persistent keyring for a user
+keyctl_get_persistent \- get the persistent keyring for a user
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -43,7 +43,7 @@ then the calling process's real user ID will be used. If
is not
.B -1
then error
-.I EPERM
+.B EPERM
will be given if the user ID requested does not match either the caller's real
or effective user IDs or if the calling process does not have
.B SetUid
@@ -57,7 +57,9 @@ On success
.BR keyctl_get_persistent ()
returns the serial number of the persistent keyring. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_get_security.3 b/man/keyctl_get_security.3
index f99aa61..28b1675 100644
--- a/man/keyctl_get_security.3
+++ b/man/keyctl_get_security.3
@@ -10,7 +10,7 @@
.TH KEYCTL_GET_SECURITY 3 "26 Feb 2010" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_get_security \- Retrieve a key's security context
+keyctl_get_security \- retrieve a key's security context
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -55,13 +55,17 @@ returns the amount of data placed into the buffer. If the buffer was too
small, then the size of buffer required will be returned, but no data will be
transferred. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.P
On success
.BR keyctl_get_security_alloc ()
returns the amount of data in the buffer, less the NUL terminator. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_instantiate.3 b/man/keyctl_instantiate.3
index 8fe9b64..da72054 100644
--- a/man/keyctl_instantiate.3
+++ b/man/keyctl_instantiate.3
@@ -10,15 +10,7 @@
.TH KEYCTL_INSTANTIATE 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_assume_authority \- Assume the authority to instantiate a key
-.br
-keyctl_instantiate \- Instantiate a key from flat data
-.br
-keyctl_instantiate_iov \- Instantiate a key from segmented data
-.br
-keyctl_reject \- Negatively instantiate a key specifying search error
-.br
-keyctl_negate \- Negatively instantiate a key
+keyctl_assume_authority, keyctl_instantiate, keyctl_instantiate_iov, keyctl_reject, keyctl_negate \- key instantiation functions
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -49,7 +41,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:
@@ -104,13 +98,17 @@ specifies the lifetime of the key in seconds.
.I error
specifies the error to be returned when a search hits the key (this is
typically
-.IR EKEYREJECTED ", " EKEYREVOKED " or " EKEYEXPIRED ")."
-Note that keyctl_reject() falls back to keyctl_negate() if the kernel does not
+.BR EKEYREJECTED ", " EKEYREVOKED " or " EKEYEXPIRED ")."
+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
@@ -140,7 +138,9 @@ returns
.BR 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_invalidate.3 b/man/keyctl_invalidate.3
index 9545abe..82ee1df 100644
--- a/man/keyctl_invalidate.3
+++ b/man/keyctl_invalidate.3
@@ -10,7 +10,7 @@
.TH KEYCTL_INVALIDATE 3 "29 Aug 2013" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_invalidate \- Invalidate a key
+keyctl_invalidate \- invalidate a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -37,7 +37,9 @@ returns
.BR 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_join_session_keyring.3 b/man/keyctl_join_session_keyring.3
index d7ec4b4..5d7db93 100644
--- a/man/keyctl_join_session_keyring.3
+++ b/man/keyctl_join_session_keyring.3
@@ -10,7 +10,7 @@
.TH KEYCTL_JOIN_SESSION_KEYRING 3 "20 Feb 2014" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_join_session_keyring \- Join a different session keyring
+keyctl_join_session_keyring \- join a different session keyring
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -45,7 +45,9 @@ On success
.BR keyctl_join_session_keyring ()
returns the serial number of the key it found or created. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_link.3 b/man/keyctl_link.3
index 6dbbc04..2f51670 100644
--- a/man/keyctl_link.3
+++ b/man/keyctl_link.3
@@ -10,8 +10,7 @@
.TH KEYCTL_LINK 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_link \- Link a key to a keyring
-keyctl_unlink \- Unlink a key from a keyring
+keyctl_link, keyctl_unlink \- link/unlink a key to/from a keyring
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -54,7 +53,9 @@ return
.BR 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_read.3 b/man/keyctl_read.3
index 4411818..23d623b 100644
--- a/man/keyctl_read.3
+++ b/man/keyctl_read.3
@@ -10,7 +10,7 @@
.TH KEYCTL_READ 3 "21 Feb 2014" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_read \- Read a key
+keyctl_read \- read a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -69,7 +69,9 @@ On success
.BR keyctl_read_alloc ()
returns the amount of data in the buffer.
.P
-On error, both functions set errno to an appropriate code and return the value
+On error, both functions set
+.I errno
+to an appropriate code and return the value
.BR -1 .
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
diff --git a/man/keyctl_revoke.3 b/man/keyctl_revoke.3
index 3220e10..dd0e152 100644
--- a/man/keyctl_revoke.3
+++ b/man/keyctl_revoke.3
@@ -10,7 +10,7 @@
.TH KEYCTL_REVOKE 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_revoke \- Revoke a key
+keyctl_revoke \- revoke a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -37,7 +37,9 @@ returns
.BR 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_search.3 b/man/keyctl_search.3
index cc57f66..7fb068b 100644
--- a/man/keyctl_search.3
+++ b/man/keyctl_search.3
@@ -10,7 +10,7 @@
.TH KEYCTL_SEARCH 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_search \- Search a keyring for a key
+keyctl_search \- search a keyring for a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -82,7 +82,9 @@ On success
.BR keyctl_search ()
returns the serial number of the key it found. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_session_to_parent.3 b/man/keyctl_session_to_parent.3
index 84657e6..343feb9 100644
--- a/man/keyctl_session_to_parent.3
+++ b/man/keyctl_session_to_parent.3
@@ -10,7 +10,7 @@
.TH KEYCTL_SESSION_TO_PARENT 3 "20 Feb 2014" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_session_to_parent \- Set the parent process's session keyring
+keyctl_session_to_parent \- set the parent process's session keyring
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -39,7 +39,9 @@ On success
.BR keyctl_session_to_parent ()
returns 0. On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_set_reqkey_keyring.3 b/man/keyctl_set_reqkey_keyring.3
index b4a8013..ed8e9e0 100644
--- a/man/keyctl_set_reqkey_keyring.3
+++ b/man/keyctl_set_reqkey_keyring.3
@@ -10,7 +10,7 @@
.TH KEYCTL_SET_REQKEY_KEYRING 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_set_reqkey_keyring \- Set the implicit destination keyring
+keyctl_set_reqkey_keyring \- set the implicit destination keyring
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -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
@@ -68,7 +70,9 @@ returns
.BR 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_set_timeout.3 b/man/keyctl_set_timeout.3
index 523ed90..e434ff5 100644
--- a/man/keyctl_set_timeout.3
+++ b/man/keyctl_set_timeout.3
@@ -10,7 +10,7 @@
.TH KEYCTL_SET_TIMEOUT 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_set_timeout \- Set the expiration timer on a key
+keyctl_set_timeout \- set the expiration timer on a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -42,7 +42,9 @@ returns
.B 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_setperm.3 b/man/keyctl_setperm.3
index e51047a..6a1bfbd 100644
--- a/man/keyctl_setperm.3
+++ b/man/keyctl_setperm.3
@@ -10,7 +10,7 @@
.TH KEYCTL_SETPERM 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_setperm \- Change the permissions mask on a key
+keyctl_setperm \- change the permissions mask on a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -91,7 +91,9 @@ returns
.B 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyctl_update.3 b/man/keyctl_update.3
index c971d94..9823dd8 100644
--- a/man/keyctl_update.3
+++ b/man/keyctl_update.3
@@ -10,7 +10,7 @@
.TH KEYCTL_UPDATE 3 "4 May 2006" Linux "Linux Key Management Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyctl_update \- Update a key
+keyctl_update \- update a key
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -44,7 +44,9 @@ returns
.BR 0 .
On error, the value
.B -1
-will be returned and errno will have been set to an appropriate error.
+will be returned and
+.I errno
+will have been set to an appropriate error.
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH ERRORS
.TP
diff --git a/man/keyutils.7 b/man/keyutils.7
index 5257a6c..ab245ce 100644
--- a/man/keyutils.7
+++ b/man/keyutils.7
@@ -10,7 +10,7 @@
.TH KEYRINGS 7 "21 Feb 2014" Linux "Kernel key management"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-keyutils \- In-kernel key management utilities
+keyutils \- in-kernel key management utilities
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH DESCRIPTION
The
@@ -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.
@@ -80,9 +80,9 @@ The upcalling mechanism is usually routed via the:
program. What this does with any particular key is configurable in:
.P
.RS
-.B /etc/request-key.conf
+.I /etc/request-key.conf
.br
-.B /etc/request-key.d/
+.I /etc/request-key.d/
.RE
.P
See the
diff --git a/man/recursive_key_scan.3 b/man/recursive_key_scan.3
index 4ec6399..689ff7a 100644
--- a/man/recursive_key_scan.3
+++ b/man/recursive_key_scan.3
@@ -10,9 +10,7 @@
.TH RECURSIVE_KEY_SCAN 3 "10 Mar 2011" Linux "Linux Key Utility Calls"
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH NAME
-recursive_key_scan \- Apply a function to all keys in a keyring tree
-.br
-recursive_session_key_scan \- Apply a function to all keys in the session keyring tree
+recursive_key_scan, recursive_session_key_scan \- apply a function to all keys in a keyring tree
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.SH SYNOPSIS
.nf
@@ -45,7 +43,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,10 +60,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 errno will retain the error from
-.IR keyctl_describe_alloc ().
+retrieved and
+.I errno
+will retain the error from
+.BR keyctl_describe_alloc ().
.TP
.B data
The data passed to the scanner function.
diff --git a/man/request-key.8 b/man/request-key.8
index 5867978..45cdeb1 100644
--- a/man/request-key.8
+++ b/man/request-key.8
@@ -9,7 +9,7 @@
.\"
.TH REQUEST-KEY 8 "15 Nov 2011" Linux "Linux Key Management Utilities"
.SH NAME
-request-key - Handle key instantiation callback requests from the kernel
+request\-key \- handle key instantiation callback requests from the kernel
.SH SYNOPSIS
\fB/sbin/request-key \fR<op> <key> <uid> <gid> <threadring> <processring>
<sessionring> [<info>]