From patchwork Wed Jun 19 23:24:50 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704716 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D55BC762C1 for ; Wed, 19 Jun 2024 23:24:53 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839493; cv=none; b=GNAF0aSkE+l5hLS9O3vwCpR0P6njrfFUmXWsXZCXhBD5C2oCvhqFR+cdzfwlZzVy2S4rZOO1HxQc7GgGu4uXFRyrUh8iuiiuy8Y3yV2yKhJ04Fzdwmb0/9lbTgZn+rxYvsThdW7ftWTYQ22RiQ9VH7AwKLc07VfBVEmS1iVeBRo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839493; c=relaxed/simple; bh=GIvxGJro2OWFybe+l7M86CcTbxtDK8CcZJZkjh8inpM=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=fs3D34AkilOVXV8/nqSVEXa6N/mxystCmlWIpuYm7RUNQNYQNYCpu5H7nLt+Vsws/TDDfGfE7vGYV/JETZn2/oLnXAi73igkEK2Mm2SvMFnzqrmsMvw4SM7Tefui3Sf2Ea6uisWgFfrBUEqTNtRiYB7Ot9kByd8ZZzJv57k7CW0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=JWcQ6AzO; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="JWcQ6AzO" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 8B50FC2BBFC; Wed, 19 Jun 2024 23:24:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839493; bh=GIvxGJro2OWFybe+l7M86CcTbxtDK8CcZJZkjh8inpM=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=JWcQ6AzO4fmnm/nNCgctWDIyMxo6yBCiUmJnUde+g+02ctUgu+ga0RfRmMvio1WJc +8eIajBaJv9ENJ1Wdjpi5X3oYGhiTSjeCxbBUq1Aoz5MYs4lI0DCF7hF77O4pK/sIh Bub2xp7qQM4GG/gxPSENN0nZAaGtq9tOFtNW0PryhkT4GjkXewDyEy3Zrnhejnk8T5 SB0TpncAF9Ofn+9/I+kMGnCLJN8Ktg1R1lOSSkGdKf5ePojz+HbU290G+LNptZ5e9a VsCxeV0SGEqgUz0rLDJnDaxa3wdUYUPnC7vTkwADVoViD7322OT5NOeNafiWsVU9HS umvPAvcVmzf1g== Date: Thu, 20 Jun 2024 01:24:50 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 01/10] man/asymmetric-key.7: Use HISTORY instead of VERSIONS Message-ID: <20240619232444.36444-2-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> The VERSIONS section is usually used to describe differences in different systems, focusing on portability to other current systems. The HISTORY section is used to describe the history of an API, such as when it appeared, or when it was standardized, focusing on portability to older versions of the same system. Signed-off-by: Alejandro Colomar --- man/asymmetric-key.7 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/asymmetric-key.7 b/man/asymmetric-key.7 index 5fc78cb..82193f6 100644 --- a/man/asymmetric-key.7 +++ b/man/asymmetric-key.7 @@ -211,7 +211,7 @@ .SH BLACKLISTING that blacklisting is not retroactive, so an asymmetric key that is already on the system cannot be blacklisted by adding a matching blacklist entry later. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH VERSIONS +.SH HISTORY The .B asymmetric key type first appeared in v3.7 of the Linux kernel, the From patchwork Wed Jun 19 23:24:54 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704717 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B20FC15B143 for ; Wed, 19 Jun 2024 23:24:57 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839497; cv=none; b=tKUCpMUHNZMvZsQw9L8m0GkaBgqOyOwFOnK1Y/s2oIhdesE35D3H/OtQB3i9x4nB56FKcSp1YikAMzTNuKDmDD5DPMNDlOaCkwDO1/H8dRPVTJ+QAcJW4dAIpCY3vOCK+YpEcPV1DNI3YDjWcGDkns7qRJBw6VWxAz0U6wTBK2o= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839497; c=relaxed/simple; bh=kOG0Ie2qMny2QMB9JQRB9RUOmlULolpomAbrP1D5Kgs=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=a7znj916LD+dNs9Wl6l+vhloVZz9AZJ59TGbbE34vP416Gz6dWCWTQcdIYpXZj5x+b2rq74j92A50L6DN5T53tLvdlwcdsrfnptzl4B/J/Hs2gmHQPaCzaO6wofI4swSzooAMcLXEPpZuaNa46TGCuPVLGVC7MRsAb/qUJSUmvY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=U3dhYdEl; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="U3dhYdEl" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 46A23C2BBFC; Wed, 19 Jun 2024 23:24:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839497; bh=kOG0Ie2qMny2QMB9JQRB9RUOmlULolpomAbrP1D5Kgs=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=U3dhYdEl1NC/J2ZKSJUq5SmV471kHxSqcVau3XaW8yso4oqbkE4YPKgRs6yoHOxLu +fFAuvCSLbrHSmEIOKwJl7DhiSV9AkjQZ5terNPUL2DlLf+ScWLWxy77kuhGEhjYQ9 7L3z1CkObIkDXgiBfEfuismmWucx38vyJOYLYjHyyKH2ATqnI7leS6y/Mrpax1l6+H nKR767TjOPhhHQncHNAnld0O5u55CtEe1JJTwWhiUPOJJQb63GQbSbYXYbm2BVBB3u 3H8CWCHkNTNKyppTIY2C5h/46ZFTV8aF3iu29VH/mqSmtKjANQTkUm/HeA4CdGzueF YArsnwTuMi10g== Date: Thu, 20 Jun 2024 01:24:54 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 02/10] man: Use the LIBRARY section Message-ID: <20240619232444.36444-3-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> This is the de-facto standard way of documenting the library that provides a function, and the linker option to link to it. This LIBRARY section is used (at least) by FreeBSD and the Linux man-pages project. Signed-off-by: Alejandro Colomar --- man/find_key_by_type_and_name.3 | 9 ++++----- man/keyctl.3 | 11 ++++------- man/keyctl_capabilities.3 | 11 ++++------- man/keyctl_chown.3 | 11 ++++------- man/keyctl_clear.3 | 11 ++++------- man/keyctl_describe.3 | 11 ++++------- man/keyctl_dh_compute.3 | 11 ++++------- man/keyctl_get_keyring_ID.3 | 11 ++++------- man/keyctl_get_persistent.3 | 11 ++++------- man/keyctl_get_security.3 | 11 ++++------- man/keyctl_instantiate.3 | 11 ++++------- man/keyctl_invalidate.3 | 11 ++++------- man/keyctl_join_session_keyring.3 | 11 ++++------- man/keyctl_link.3 | 11 ++++------- man/keyctl_move.3 | 11 ++++------- man/keyctl_pkey_encrypt.3 | 11 ++++------- man/keyctl_pkey_query.3 | 11 ++++------- man/keyctl_pkey_sign.3 | 11 ++++------- man/keyctl_read.3 | 11 ++++------- man/keyctl_restrict_keyring.3 | 11 ++++------- man/keyctl_revoke.3 | 11 ++++------- man/keyctl_search.3 | 13 ++++--------- man/keyctl_session_to_parent.3 | 11 ++++------- man/keyctl_set_reqkey_keyring.3 | 11 ++++------- man/keyctl_set_timeout.3 | 11 ++++------- man/keyctl_setperm.3 | 11 ++++------- man/keyctl_update.3 | 11 ++++------- man/keyctl_watch_key.3 | 11 ++++------- man/keyutils.7 | 12 ++++-------- man/recursive_key_scan.3 | 9 ++++----- 30 files changed, 120 insertions(+), 209 deletions(-) diff --git a/man/find_key_by_type_and_name.3 b/man/find_key_by_type_and_name.3 index 2fbd21e..c961ece 100644 --- a/man/find_key_by_type_and_name.3 +++ b/man/find_key_by_type_and_name.3 @@ -12,6 +12,10 @@ .SH NAME find_key_by_type_and_name \- find a key by type and name .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -52,11 +56,6 @@ .SH ERRORS .B writable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl.3 b/man/keyctl.3 index fda0363..708fcbe 100644 --- a/man/keyctl.3 +++ b/man/keyctl.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_*() \- key management function wrappers .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH DESCRIPTION The .BR keyctl () @@ -24,13 +28,6 @@ .SH DESCRIPTION .nf .B #include .RE -.P -and then telling the linker it should link in the library: -.sp -.RS -.nf -.B \-lkeyutils -.RE .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH KEYCTL FUNCTIONS .BR keyctl_assume_authority (3) diff --git a/man/keyctl_capabilities.3 b/man/keyctl_capabilities.3 index f816df6..86ec352 100644 --- a/man/keyctl_capabilities.3 +++ b/man/keyctl_capabilities.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_capabilities \- Query subsystem capabilities .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -104,13 +108,6 @@ .SH ERRORS .B EFAULT The buffer cannot be written to. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_chown.3 b/man/keyctl_chown.3 index f85840a..2006af4 100644 --- a/man/keyctl_chown.3 +++ b/man/keyctl_chown.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_chown \- change the ownership of a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -69,13 +73,6 @@ .SH ERRORS .B setattr permission to the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_clear.3 b/man/keyctl_clear.3 index 8da699e..34e7262 100644 --- a/man/keyctl_clear.3 +++ b/man/keyctl_clear.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_clear \- clear a keyring .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -54,13 +58,6 @@ .SH ERRORS .B writable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_describe.3 b/man/keyctl_describe.3 index b4f100e..97d454b 100644 --- a/man/keyctl_describe.3 +++ b/man/keyctl_describe.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_describe \- describe a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -93,13 +97,6 @@ .SH ERRORS .B viewable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_dh_compute.3 b/man/keyctl_dh_compute.3 index 5b79378..befb83d 100644 --- a/man/keyctl_dh_compute.3 +++ b/man/keyctl_dh_compute.3 @@ -14,6 +14,10 @@ .SH NAME .br keyctl_dh_compute_kdf \- Derive key from a Diffie-Hellman shared secret .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -151,13 +155,6 @@ .SH ERRORS .I buflen is too big. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .BR keyctl (1), .br diff --git a/man/keyctl_get_keyring_ID.3 b/man/keyctl_get_keyring_ID.3 index 6525292..4c2ca5c 100644 --- a/man/keyctl_get_keyring_ID.3 +++ b/man/keyctl_get_keyring_ID.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_get_keyring_ID \- get the ID of a special keyring .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -77,13 +81,6 @@ .SH ERRORS The key quota for this user would be exceeded by creating this key or linking it to the keyring. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_get_persistent.3 b/man/keyctl_get_persistent.3 index 8d79957..d878cbb 100644 --- a/man/keyctl_get_persistent.3 +++ b/man/keyctl_get_persistent.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_get_persistent \- get the persistent keyring for a user .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -93,13 +97,6 @@ .SH ERRORS .B write permission to the calling process. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l diff --git a/man/keyctl_get_security.3 b/man/keyctl_get_security.3 index a2c5b41..7113e2f 100644 --- a/man/keyctl_get_security.3 +++ b/man/keyctl_get_security.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_get_security \- retrieve a key's security context .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -83,13 +87,6 @@ .SH ERRORS .B viewable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_instantiate.3 b/man/keyctl_instantiate.3 index d436bf2..0d3b459 100644 --- a/man/keyctl_instantiate.3 +++ b/man/keyctl_instantiate.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_assume_authority, keyctl_instantiate, keyctl_instantiate_iov, keyctl_reject, keyctl_negate \- key instantiation functions .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -171,13 +175,6 @@ .SH ERRORS .B writable by the requester. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_invalidate.3 b/man/keyctl_invalidate.3 index 120da45..928319f 100644 --- a/man/keyctl_invalidate.3 +++ b/man/keyctl_invalidate.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_invalidate \- invalidate a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -57,13 +61,6 @@ .SH ERRORS .B searchable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_join_session_keyring.3 b/man/keyctl_join_session_keyring.3 index 4e27717..b8ed639 100644 --- a/man/keyctl_join_session_keyring.3 +++ b/man/keyctl_join_session_keyring.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_join_session_keyring \- join a different session keyring .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -63,13 +67,6 @@ .SH ERRORS .B searchable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_link.3 b/man/keyctl_link.3 index 2cbc104..9046121 100644 --- a/man/keyctl_link.3 +++ b/man/keyctl_link.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_link, keyctl_unlink \- link/unlink a key to/from a keyring .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -88,13 +92,6 @@ .SH ERRORS .B linkable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_move.3 b/man/keyctl_move.3 index 6f144df..a8f0c7f 100644 --- a/man/keyctl_move.3 +++ b/man/keyctl_move.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_move \- Move a key between keyrings .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -89,13 +93,6 @@ .SH ERRORS .B EDQUOT Expanding to_keyring would exceed the keyring owner's quota. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_pkey_encrypt.3 b/man/keyctl_pkey_encrypt.3 index 5a5b71b..b199a05 100644 --- a/man/keyctl_pkey_encrypt.3 +++ b/man/keyctl_pkey_encrypt.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_pkey_encrypt, keyctl_pkey_decrypt \- Encrypt and decrypt data .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -93,13 +97,6 @@ .SH ERRORS .B EFAULT Bad address. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_pkey_query.3 b/man/keyctl_pkey_query.3 index e70665f..e7613c8 100644 --- a/man/keyctl_pkey_query.3 +++ b/man/keyctl_pkey_query.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_pkey_query \- Query public key parameters .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -116,13 +120,6 @@ .SH ERRORS .B EFAULT Bad address. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_pkey_sign.3 b/man/keyctl_pkey_sign.3 index 4fb6a14..2f0b106 100644 --- a/man/keyctl_pkey_sign.3 +++ b/man/keyctl_pkey_sign.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_pkey_sign, keyctl_pkey_verify \- Generate and verify signatures .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -114,13 +118,6 @@ .SH ERRORS .B EFAULT Bad address. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_read.3 b/man/keyctl_read.3 index 97b0e24..6728b5b 100644 --- a/man/keyctl_read.3 +++ b/man/keyctl_read.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_read \- read a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -92,13 +96,6 @@ .SH ERRORS .B EOPNOTSUPP The key type does not support reading of the payload data. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_restrict_keyring.3 b/man/keyctl_restrict_keyring.3 index 468d5b4..9e4d023 100644 --- a/man/keyctl_restrict_keyring.3 +++ b/man/keyctl_restrict_keyring.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_restrict_keyring \- restrict keys that may be linked to a keyring .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -66,13 +70,6 @@ .SH ERRORS .B ENOENT The key type exists but does not support restrictions. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_revoke.3 b/man/keyctl_revoke.3 index 622f1ac..a973d39 100644 --- a/man/keyctl_revoke.3 +++ b/man/keyctl_revoke.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_revoke \- revoke a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -54,13 +58,6 @@ .SH ERRORS .B writable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_search.3 b/man/keyctl_search.3 index f3e7bc5..f7db46d 100644 --- a/man/keyctl_search.3 +++ b/man/keyctl_search.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_search \- search a keyring for a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -117,15 +121,6 @@ .SH ERRORS .B link permission to the caller. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -Although this is a Linux system call, it is not present in -.I libc -but can be found rather in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_session_to_parent.3 b/man/keyctl_session_to_parent.3 index 829b3be..b05c030 100644 --- a/man/keyctl_session_to_parent.3 +++ b/man/keyctl_session_to_parent.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_session_to_parent \- set the parent process's session keyring .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -56,13 +60,6 @@ .SH ERRORS .B linkable by the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_set_reqkey_keyring.3 b/man/keyctl_set_reqkey_keyring.3 index 6e6725e..e8d6afa 100644 --- a/man/keyctl_set_reqkey_keyring.3 +++ b/man/keyctl_set_reqkey_keyring.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_set_reqkey_keyring \- set the implicit destination keyring .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -81,13 +85,6 @@ .SH ERRORS .I reqkey_defl is invalid. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_set_timeout.3 b/man/keyctl_set_timeout.3 index 24c7049..ec8b364 100644 --- a/man/keyctl_set_timeout.3 +++ b/man/keyctl_set_timeout.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_set_timeout \- set the expiration timer on a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -62,13 +66,6 @@ .SH ERRORS .B setattr permission to the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_setperm.3 b/man/keyctl_setperm.3 index d5d9015..8607680 100644 --- a/man/keyctl_setperm.3 +++ b/man/keyctl_setperm.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_setperm \- change the permissions mask on a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -111,13 +115,6 @@ .SH ERRORS .B setattr permission to the calling process. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_update.3 b/man/keyctl_update.3 index 2d44740..cdf0a8e 100644 --- a/man/keyctl_update.3 +++ b/man/keyctl_update.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_update \- update a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -77,13 +81,6 @@ .SH ERRORS .B EOPNOTSUPP The key type does not support the update operation on its keys. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyctl_watch_key.3 b/man/keyctl_watch_key.3 index 044b7a3..0cfba6f 100644 --- a/man/keyctl_watch_key.3 +++ b/man/keyctl_watch_key.3 @@ -12,6 +12,10 @@ .SH NAME keyctl_watch_key \- Watch for changes to a key .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -187,13 +191,6 @@ .SH ERRORS .B EBADSLT The specified key doesn't have a watch on it (removal only). .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -This is a library function that can be found in -.IR libkeyutils . -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh diff --git a/man/keyutils.7 b/man/keyutils.7 index e17253b..3ab193c 100644 --- a/man/keyutils.7 +++ b/man/keyutils.7 @@ -12,6 +12,10 @@ .SH NAME keyutils \- in-kernel key management utilities .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH DESCRIPTION The .B keyutils @@ -25,14 +29,6 @@ .SH DESCRIPTION .B #include .RE .P -To link with the library, the following: -.P -.RS -.B \-lkeyutils -.RE -.P -should be specified to the linker. -.P Three system calls are provided: .TP .BR add_key (2) diff --git a/man/recursive_key_scan.3 b/man/recursive_key_scan.3 index 8658002..4e38d4a 100644 --- a/man/recursive_key_scan.3 +++ b/man/recursive_key_scan.3 @@ -12,6 +12,10 @@ .SH NAME recursive_key_scan, recursive_session_key_scan \- apply a function to all keys in a keyring tree .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIBRARY +Key management utilities library +.RI ( libkeyutils ,\~ \-lkeyutils ) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SYNOPSIS .nf .B #include @@ -77,11 +81,6 @@ .SH RETURN VALUE .SH ERRORS Ignored. .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -.SH LINKING -When linking, -.B \-lkeyutils -should be specified to the linker. -.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH SEE ALSO .ad l .nh From patchwork Wed Jun 19 23:24:58 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704718 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 567D415B145 for ; Wed, 19 Jun 2024 23:25:01 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839501; cv=none; b=MN32ZBLTab3RQMEcco8Kpgo2aUv122DuFiIrj8XFskYccP7q7Us/xdv8KjA33dTrM2MItRS6dDWMxo+SRWGEqK7xmSt+UOycq9cT25n7BFfN30sPWvNYKNCklOsOgM/FS9ngMTZ+vFjN5WY7+NCuVzGmuVJhnSPdVCJT00SWn34= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839501; c=relaxed/simple; bh=nbXQDsFi5e40L98y2QzXaWpV4nOAiyayF2HAmQa0zRQ=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=taiEimaQyMLv7AU7PrYGRqWaoBK4SdG5Setrlh3AnM9OoxhXDTju8NaSLNuF7ps/uHMs8gRCDo1+ZeR8d2vW1SlvAu+bT7v0FL0TPb+PL+ZcYKAiQqwjWUnGWJJL0ZVJwMIl6ocdZsZCr1E5b4HC+RhAFQyY7gDgYhNRoBAKOjY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=BIHadh1D; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="BIHadh1D" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 1B90FC2BBFC; Wed, 19 Jun 2024 23:24:59 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839500; bh=nbXQDsFi5e40L98y2QzXaWpV4nOAiyayF2HAmQa0zRQ=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=BIHadh1DvC4Q3cXuQ5L1U1BQtcJKqpgCdkA5iAFrMmQn8NXZTywwHHvZ3UfAbTsJd L5jDd7uzDb6tACdnJczw0uzzdKVaXrACxc/RGAfZVp1iQqKbrOF7bZzVmOaPEqcOeH yU76mJEASsxQr0Fzj5TQWGyTHRNx8z0H0KmdWgEgpg0SuZdc9VAb8qLY2b/K4mllPp gU0BNnLkNBtGo6RgMgb5iAADoVX3jAeHLKdFnWlcZPqixHkfcWinXR3YW2M792bLA/ mHfdBlgbwn+n6Db7WsotlcqKQGy1bx2pJdk2Kx4sxwf90O07FkRnoMOiWURsnD2h0d TMQSQOjhyvZ6w== Date: Thu, 20 Jun 2024 01:24:58 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 03/10] man: Fix TH arguments 4 and 5 Message-ID: <20240619232444.36444-4-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> mandoc_man(7) says: TH Set the name of the manual page for use in the page header and footer with the following syntax: .TH name section date [source [volume]] [...]. The recommended date format is YYYY‐MM‐DD as specified in the ISO‐8601 standard; if the argument does not conform, it is printed verbatim. If the date is empty or not specified, the current date is used. The optional source string specifies the organisation providing the utility. When unspecified, mandoc(1) uses its -Ios argument. The volume string replaces the default volume title of the section. groff_man_style(7) says: .TH identifier section [footer‐middle [footer‐inside [header‐middle]]] [...] By convention, footer‐middle is the date of the most recent modification to the man page source document, and footer‐ inside is the name and version or release of the project providing it. The 5th argument is usually to be omitted, and it will default to the description of the chapter of the manual, that is, for man3 it will be "Library Functions Manual". The 4th argument should be the name of the project providing the manual page, possibly including the version of it. For example, in the Linux man-pages project, we use the following in the git repository: .TH keyctl 2 (date) "Linux man-pages (unreleased)" and the following on a release: .TH keyctl 2 2024-06-15 "Linux man-pages 6.9.1" Here, I'd use keyutils, or possibly keyutils-X.Y. For now, I've made it just contain the project name. Signed-off-by: Alejandro Colomar --- man/asymmetric-key.7 | 2 +- man/find_key_by_type_and_name.3 | 2 +- man/key.dns_resolver.8 | 2 +- man/key.dns_resolver.conf.5 | 2 +- man/keyctl.1 | 2 +- man/keyctl.3 | 2 +- man/keyctl_capabilities.3 | 2 +- man/keyctl_chown.3 | 2 +- man/keyctl_clear.3 | 2 +- man/keyctl_describe.3 | 2 +- man/keyctl_dh_compute.3 | 2 +- man/keyctl_get_keyring_ID.3 | 2 +- man/keyctl_get_persistent.3 | 2 +- man/keyctl_get_security.3 | 2 +- man/keyctl_instantiate.3 | 2 +- man/keyctl_invalidate.3 | 2 +- man/keyctl_join_session_keyring.3 | 2 +- man/keyctl_link.3 | 2 +- man/keyctl_move.3 | 2 +- man/keyctl_pkey_encrypt.3 | 2 +- man/keyctl_pkey_query.3 | 2 +- man/keyctl_pkey_sign.3 | 2 +- man/keyctl_read.3 | 2 +- man/keyctl_restrict_keyring.3 | 2 +- man/keyctl_revoke.3 | 2 +- man/keyctl_search.3 | 2 +- man/keyctl_session_to_parent.3 | 2 +- man/keyctl_set_reqkey_keyring.3 | 2 +- man/keyctl_set_timeout.3 | 2 +- man/keyctl_setperm.3 | 2 +- man/keyctl_update.3 | 2 +- man/keyctl_watch_key.3 | 2 +- man/keyutils.7 | 2 +- man/recursive_key_scan.3 | 2 +- man/request-key.8 | 2 +- man/request-key.conf.5 | 2 +- 36 files changed, 36 insertions(+), 36 deletions(-) diff --git a/man/asymmetric-key.7 b/man/asymmetric-key.7 index 82193f6..273f930 100644 --- a/man/asymmetric-key.7 +++ b/man/asymmetric-key.7 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH ASYMMETRIC-KEY 7 "8 Nov 2018" Linux "Asymmetric Kernel Key Type" +.TH ASYMMETRIC-KEY 7 "8 Nov 2018" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME asymmetric \- Kernel key type for holding asymmetric keys diff --git a/man/find_key_by_type_and_name.3 b/man/find_key_by_type_and_name.3 index c961ece..2a338e8 100644 --- a/man/find_key_by_type_and_name.3 +++ b/man/find_key_by_type_and_name.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH FIND_KEY_BY_TYPE_AND_NAME 3 "10 Sep 2013" Linux "Linux Key Utility Calls" +.TH FIND_KEY_BY_TYPE_AND_NAME 3 "10 Sep 2013" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME find_key_by_type_and_name \- find a key by type and name diff --git a/man/key.dns_resolver.8 b/man/key.dns_resolver.8 index 0b17edd..c67df97 100644 --- a/man/key.dns_resolver.8 +++ b/man/key.dns_resolver.8 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEY.DNS_RESOLVER 8 "18 May 2020" Linux "Linux Key Management Utilities" +.TH KEY.DNS_RESOLVER 8 "18 May 2020" keyutils .SH NAME key.dns_resolver \- upcall for request\-key to handle dns_resolver keys .SH SYNOPSIS diff --git a/man/key.dns_resolver.conf.5 b/man/key.dns_resolver.conf.5 index c944ad5..c395b8e 100644 --- a/man/key.dns_resolver.conf.5 +++ b/man/key.dns_resolver.conf.5 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEY.DNS_RESOLVER.CONF 5 "18 May 2020" Linux "Linux Key Management Utilities" +.TH KEY.DNS_RESOLVER.CONF 5 "18 May 2020" keyutils .SH NAME key.dns_resolver.conf \- Kernel DNS resolver config .SH DESCRIPTION diff --git a/man/keyctl.1 b/man/keyctl.1 index c1d067f..7aa0cb7 100644 --- a/man/keyctl.1 +++ b/man/keyctl.1 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL 1 "20 Feb 2014" Linux "Linux Key Management Utilities" +.TH KEYCTL 1 "20 Feb 2014" keyutils .SH NAME keyctl \- key management facility control .SH SYNOPSIS diff --git a/man/keyctl.3 b/man/keyctl.3 index 708fcbe..0d04ea6 100644 --- a/man/keyctl.3 +++ b/man/keyctl.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL 3 "21 Feb 2014" Linux "Linux Key Management Calls" +.TH KEYCTL 3 "21 Feb 2014" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_*() \- key management function wrappers diff --git a/man/keyctl_capabilities.3 b/man/keyctl_capabilities.3 index 86ec352..c687faa 100644 --- a/man/keyctl_capabilities.3 +++ b/man/keyctl_capabilities.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CAPABILITIES 3 "30 May 2019" Linux "Linux Key Management Calls" +.TH KEYCTL_CAPABILITIES 3 "30 May 2019" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_capabilities \- Query subsystem capabilities diff --git a/man/keyctl_chown.3 b/man/keyctl_chown.3 index 2006af4..1c8fa9a 100644 --- a/man/keyctl_chown.3 +++ b/man/keyctl_chown.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CHOWN 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_CHOWN 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_chown \- change the ownership of a key diff --git a/man/keyctl_clear.3 b/man/keyctl_clear.3 index 34e7262..010b175 100644 --- a/man/keyctl_clear.3 +++ b/man/keyctl_clear.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CLEAR 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_CLEAR 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_clear \- clear a keyring diff --git a/man/keyctl_describe.3 b/man/keyctl_describe.3 index 97d454b..198f1b7 100644 --- a/man/keyctl_describe.3 +++ b/man/keyctl_describe.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_DESCRIBE 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_DESCRIBE 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_describe \- describe a key diff --git a/man/keyctl_dh_compute.3 b/man/keyctl_dh_compute.3 index befb83d..8a2d29f 100644 --- a/man/keyctl_dh_compute.3 +++ b/man/keyctl_dh_compute.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_DH_COMPUTE 3 "07 Apr 2016" Linux "Linux Key Management Calls" +.TH KEYCTL_DH_COMPUTE 3 "07 Apr 2016" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_dh_compute \- Compute a Diffie-Hellman shared secret or public key diff --git a/man/keyctl_get_keyring_ID.3 b/man/keyctl_get_keyring_ID.3 index 4c2ca5c..a754aa1 100644 --- a/man/keyctl_get_keyring_ID.3 +++ b/man/keyctl_get_keyring_ID.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GET_KEYRING_ID 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_GET_KEYRING_ID 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_get_keyring_ID \- get the ID of a special keyring diff --git a/man/keyctl_get_persistent.3 b/man/keyctl_get_persistent.3 index d878cbb..71d8626 100644 --- a/man/keyctl_get_persistent.3 +++ b/man/keyctl_get_persistent.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GET_PERSISTENT 3 "20 Feb 2014" Linux "Linux Key Management Calls" +.TH KEYCTL_GET_PERSISTENT 3 "20 Feb 2014" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_get_persistent \- get the persistent keyring for a user diff --git a/man/keyctl_get_security.3 b/man/keyctl_get_security.3 index 7113e2f..b9b05c2 100644 --- a/man/keyctl_get_security.3 +++ b/man/keyctl_get_security.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GET_SECURITY 3 "26 Feb 2010" Linux "Linux Key Management Calls" +.TH KEYCTL_GET_SECURITY 3 "26 Feb 2010" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_get_security \- retrieve a key's security context diff --git a/man/keyctl_instantiate.3 b/man/keyctl_instantiate.3 index 0d3b459..ff1dea5 100644 --- a/man/keyctl_instantiate.3 +++ b/man/keyctl_instantiate.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_INSTANTIATE 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_INSTANTIATE 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_assume_authority, keyctl_instantiate, keyctl_instantiate_iov, keyctl_reject, keyctl_negate \- key instantiation functions diff --git a/man/keyctl_invalidate.3 b/man/keyctl_invalidate.3 index 928319f..e54f505 100644 --- a/man/keyctl_invalidate.3 +++ b/man/keyctl_invalidate.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_INVALIDATE 3 "29 Aug 2013" Linux "Linux Key Management Calls" +.TH KEYCTL_INVALIDATE 3 "29 Aug 2013" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_invalidate \- invalidate a key diff --git a/man/keyctl_join_session_keyring.3 b/man/keyctl_join_session_keyring.3 index b8ed639..65233f8 100644 --- a/man/keyctl_join_session_keyring.3 +++ b/man/keyctl_join_session_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_JOIN_SESSION_KEYRING 3 "20 Feb 2014" Linux "Linux Key Management Calls" +.TH KEYCTL_JOIN_SESSION_KEYRING 3 "20 Feb 2014" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_join_session_keyring \- join a different session keyring diff --git a/man/keyctl_link.3 b/man/keyctl_link.3 index 9046121..7b607bf 100644 --- a/man/keyctl_link.3 +++ b/man/keyctl_link.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_LINK 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_LINK 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_link, keyctl_unlink \- link/unlink a key to/from a keyring diff --git a/man/keyctl_move.3 b/man/keyctl_move.3 index a8f0c7f..894e76d 100644 --- a/man/keyctl_move.3 +++ b/man/keyctl_move.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_MOVE 3 "29 May 2019" Linux "Linux Key Management Calls" +.TH KEYCTL_MOVE 3 "29 May 2019" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_move \- Move a key between keyrings diff --git a/man/keyctl_pkey_encrypt.3 b/man/keyctl_pkey_encrypt.3 index b199a05..f3c5478 100644 --- a/man/keyctl_pkey_encrypt.3 +++ b/man/keyctl_pkey_encrypt.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_ENCRYPT 3 "8 Nov 2018" Linux "Linux Public-Key Encryption" +.TH KEYCTL_PKEY_ENCRYPT 3 "8 Nov 2018" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_encrypt, keyctl_pkey_decrypt \- Encrypt and decrypt data diff --git a/man/keyctl_pkey_query.3 b/man/keyctl_pkey_query.3 index e7613c8..837b9db 100644 --- a/man/keyctl_pkey_query.3 +++ b/man/keyctl_pkey_query.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_QUERY 3 "8 Nov 2018" Linux "Linux Key Management Calls" +.TH KEYCTL_PKEY_QUERY 3 "8 Nov 2018" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_query \- Query public key parameters diff --git a/man/keyctl_pkey_sign.3 b/man/keyctl_pkey_sign.3 index 2f0b106..5997046 100644 --- a/man/keyctl_pkey_sign.3 +++ b/man/keyctl_pkey_sign.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_SIGN 3 "8 Nov 2018" Linux "Linux Public-Key Signatures" +.TH KEYCTL_PKEY_SIGN 3 "8 Nov 2018" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_sign, keyctl_pkey_verify \- Generate and verify signatures diff --git a/man/keyctl_read.3 b/man/keyctl_read.3 index 6728b5b..8b767a3 100644 --- a/man/keyctl_read.3 +++ b/man/keyctl_read.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_READ 3 "21 Feb 2014" Linux "Linux Key Management Calls" +.TH KEYCTL_READ 3 "21 Feb 2014" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_read \- read a key diff --git a/man/keyctl_restrict_keyring.3 b/man/keyctl_restrict_keyring.3 index 9e4d023..1f3d1eb 100644 --- a/man/keyctl_restrict_keyring.3 +++ b/man/keyctl_restrict_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_RESTRICT_KEYRING 3 "28 Feb 2017" Linux "Linux Key Management Calls" +.TH KEYCTL_RESTRICT_KEYRING 3 "28 Feb 2017" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_restrict_keyring \- restrict keys that may be linked to a keyring diff --git a/man/keyctl_revoke.3 b/man/keyctl_revoke.3 index a973d39..a00b1f8 100644 --- a/man/keyctl_revoke.3 +++ b/man/keyctl_revoke.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_REVOKE 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_REVOKE 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_revoke \- revoke a key diff --git a/man/keyctl_search.3 b/man/keyctl_search.3 index f7db46d..c779fb0 100644 --- a/man/keyctl_search.3 +++ b/man/keyctl_search.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SEARCH 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_SEARCH 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_search \- search a keyring for a key diff --git a/man/keyctl_session_to_parent.3 b/man/keyctl_session_to_parent.3 index b05c030..e208459 100644 --- a/man/keyctl_session_to_parent.3 +++ b/man/keyctl_session_to_parent.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SESSION_TO_PARENT 3 "20 Feb 2014" Linux "Linux Key Management Calls" +.TH KEYCTL_SESSION_TO_PARENT 3 "20 Feb 2014" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_session_to_parent \- set the parent process's session keyring diff --git a/man/keyctl_set_reqkey_keyring.3 b/man/keyctl_set_reqkey_keyring.3 index e8d6afa..e742f13 100644 --- a/man/keyctl_set_reqkey_keyring.3 +++ b/man/keyctl_set_reqkey_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SET_REQKEY_KEYRING 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_SET_REQKEY_KEYRING 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_set_reqkey_keyring \- set the implicit destination keyring diff --git a/man/keyctl_set_timeout.3 b/man/keyctl_set_timeout.3 index ec8b364..b5d055b 100644 --- a/man/keyctl_set_timeout.3 +++ b/man/keyctl_set_timeout.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SET_TIMEOUT 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_SET_TIMEOUT 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_set_timeout \- set the expiration timer on a key diff --git a/man/keyctl_setperm.3 b/man/keyctl_setperm.3 index 8607680..f246946 100644 --- a/man/keyctl_setperm.3 +++ b/man/keyctl_setperm.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SETPERM 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_SETPERM 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_setperm \- change the permissions mask on a key diff --git a/man/keyctl_update.3 b/man/keyctl_update.3 index cdf0a8e..4cff75c 100644 --- a/man/keyctl_update.3 +++ b/man/keyctl_update.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_UPDATE 3 "4 May 2006" Linux "Linux Key Management Calls" +.TH KEYCTL_UPDATE 3 "4 May 2006" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_update \- update a key diff --git a/man/keyctl_watch_key.3 b/man/keyctl_watch_key.3 index 0cfba6f..b8ed158 100644 --- a/man/keyctl_watch_key.3 +++ b/man/keyctl_watch_key.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GRANT_PERMISSION 3 "28 Aug 2019" Linux "Linux Key Management Calls" +.TH KEYCTL_GRANT_PERMISSION 3 "28 Aug 2019" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_watch_key \- Watch for changes to a key diff --git a/man/keyutils.7 b/man/keyutils.7 index 3ab193c..f17ee35 100644 --- a/man/keyutils.7 +++ b/man/keyutils.7 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYUTILS 7 "21 Feb 2014" Linux "Kernel key management" +.TH KEYUTILS 7 "21 Feb 2014" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyutils \- in-kernel key management utilities diff --git a/man/recursive_key_scan.3 b/man/recursive_key_scan.3 index 4e38d4a..daf75f1 100644 --- a/man/recursive_key_scan.3 +++ b/man/recursive_key_scan.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH RECURSIVE_KEY_SCAN 3 "10 Mar 2011" Linux "Linux Key Utility Calls" +.TH RECURSIVE_KEY_SCAN 3 "10 Mar 2011" keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME recursive_key_scan, recursive_session_key_scan \- apply a function to all keys in a keyring tree diff --git a/man/request-key.8 b/man/request-key.8 index 50a7506..1db6ebc 100644 --- a/man/request-key.8 +++ b/man/request-key.8 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH REQUEST-KEY 8 "15 Nov 2011" Linux "Linux Key Management Utilities" +.TH REQUEST-KEY 8 "15 Nov 2011" keyutils .SH NAME request\-key \- handle key instantiation callback requests from the kernel .SH SYNOPSIS diff --git a/man/request-key.conf.5 b/man/request-key.conf.5 index 276c771..dde6295 100644 --- a/man/request-key.conf.5 +++ b/man/request-key.conf.5 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH REQUEST-KEY.CONF 5 "15 November 2011" Linux "Linux Key Management Utilities" +.TH REQUEST-KEY.CONF 5 "15 November 2011" keyutils .SH NAME request\-key.conf \- Instantiation handler configuration file .SH DESCRIPTION From patchwork Wed Jun 19 23:25:02 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704719 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A036E762C1 for ; Wed, 19 Jun 2024 23:25:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839504; cv=none; b=KextAjWIuFhfM3GGse2mk/L2T9xwfBymGBInVFIqN0owbGWOqr5vrhPodV1nRRfHp+QggqeqZwtkY9/lbgFnmtyyg3Fbo4SvdtllPDKvI7M5iWK2xrz6pM2nv1FYJ8Ao5S4hXemWkmfRYjebamtZRyw0Ib1Y0ALkXOJG2m6lT24= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839504; c=relaxed/simple; bh=A7/xWVLDOwmmR0U9v5350HQknLdyXmlKywxJ6vjDArw=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=MF9intr+BDi2oKhb4Vn8ATY9rM205sEJniAep6BsRKJrYNInlUgBwSWLImtMdOHbOawoZ6ZS983NR7CKLaE+i9h4arMWqMsMmUTKB2F/SjZ02K+H5JWkmPCLgRE5CAJq5NDzplwCuMYEZZfSLEtan/ow/xJ2QILYFJk/lWtmLjc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=sLdozA+y; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="sLdozA+y" Received: by smtp.kernel.org (Postfix) with ESMTPSA id AE77DC2BBFC; Wed, 19 Jun 2024 23:25:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839504; bh=A7/xWVLDOwmmR0U9v5350HQknLdyXmlKywxJ6vjDArw=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=sLdozA+y5bXNgsevVrZzsSAy3R/Pa32U3CbVvUz3Www4x4f4V80gUG6/6hl2kDH7R wS6zt/o56MrDTVbXaYUYQczx9qRg7ec9q4CBLiZb45LYi3JsoQJxQd7d4R2neYnRnY l2zwarjVKNlhY/6Lxi3Mr3HiowDnYUgwhTmwMGlLZsYUy6XWla4jC0sswz1XKynTcU DLNj65/xqy86WNx/ySISPKlERkYOneZ13mu7OhQQ4uUQ/d2719jZPU7CKhN75Ef/lS MC0pxEqXAhsCI8Aozo+ec3AzHmubLYZMHk3wTOGmnitqLA+St8oW+WhHrx7qfWSHqs +gB//5NL9aCCw== Date: Thu, 20 Jun 2024 01:25:02 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 04/10] man: Update date in TH Message-ID: <20240619232444.36444-5-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> The date in the TH line is meant to be the date of last modification of the page. Also, the recommended date format is YYYY-MM-DD, which conforms to ISO-8601, so switch to it. mandoc_man(7) says: TH Set the name of the manual page for use in the page header and footer with the following syntax: .TH name section date [source [volume]] [...]. The recommended date format is YYYY‐MM‐DD as specified in the ISO‐8601 standard; if the argument does not conform, it is printed verbatim. If the date is empty or not specified, the current date is used. [...] groff_man_style(7) says: .TH identifier section [footer‐middle [footer‐inside [header‐middle]]] [...] By convention, footer‐middle is the date of the most recent modification to the man page source document, [...] [...] In the title heading (.TH), the date of the page’s last revision is more important than packaging information; it should not be omitted. Ideally, a page maintainer will keep both up to date. Signed-off-by: Alejandro Colomar --- man/asymmetric-key.7 | 2 +- man/find_key_by_type_and_name.3 | 2 +- man/key.dns_resolver.8 | 2 +- man/key.dns_resolver.conf.5 | 2 +- man/keyctl.1 | 2 +- man/keyctl.3 | 2 +- man/keyctl_capabilities.3 | 2 +- man/keyctl_chown.3 | 2 +- man/keyctl_clear.3 | 2 +- man/keyctl_describe.3 | 2 +- man/keyctl_dh_compute.3 | 2 +- man/keyctl_get_keyring_ID.3 | 2 +- man/keyctl_get_persistent.3 | 2 +- man/keyctl_get_security.3 | 2 +- man/keyctl_instantiate.3 | 2 +- man/keyctl_invalidate.3 | 2 +- man/keyctl_join_session_keyring.3 | 2 +- man/keyctl_link.3 | 2 +- man/keyctl_move.3 | 2 +- man/keyctl_pkey_encrypt.3 | 2 +- man/keyctl_pkey_query.3 | 2 +- man/keyctl_pkey_sign.3 | 2 +- man/keyctl_read.3 | 2 +- man/keyctl_restrict_keyring.3 | 2 +- man/keyctl_revoke.3 | 2 +- man/keyctl_search.3 | 2 +- man/keyctl_session_to_parent.3 | 2 +- man/keyctl_set_reqkey_keyring.3 | 2 +- man/keyctl_set_timeout.3 | 2 +- man/keyctl_setperm.3 | 2 +- man/keyctl_update.3 | 2 +- man/keyctl_watch_key.3 | 2 +- man/keyutils.7 | 2 +- man/recursive_key_scan.3 | 2 +- man/request-key.8 | 2 +- man/request-key.conf.5 | 2 +- 36 files changed, 36 insertions(+), 36 deletions(-) diff --git a/man/asymmetric-key.7 b/man/asymmetric-key.7 index 273f930..70ed935 100644 --- a/man/asymmetric-key.7 +++ b/man/asymmetric-key.7 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH ASYMMETRIC-KEY 7 "8 Nov 2018" keyutils +.TH ASYMMETRIC-KEY 7 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME asymmetric \- Kernel key type for holding asymmetric keys diff --git a/man/find_key_by_type_and_name.3 b/man/find_key_by_type_and_name.3 index 2a338e8..802b9cd 100644 --- a/man/find_key_by_type_and_name.3 +++ b/man/find_key_by_type_and_name.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH FIND_KEY_BY_TYPE_AND_NAME 3 "10 Sep 2013" keyutils +.TH FIND_KEY_BY_TYPE_AND_NAME 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME find_key_by_type_and_name \- find a key by type and name diff --git a/man/key.dns_resolver.8 b/man/key.dns_resolver.8 index c67df97..383f5af 100644 --- a/man/key.dns_resolver.8 +++ b/man/key.dns_resolver.8 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEY.DNS_RESOLVER 8 "18 May 2020" keyutils +.TH KEY.DNS_RESOLVER 8 2024-06-19 keyutils .SH NAME key.dns_resolver \- upcall for request\-key to handle dns_resolver keys .SH SYNOPSIS diff --git a/man/key.dns_resolver.conf.5 b/man/key.dns_resolver.conf.5 index c395b8e..43668ca 100644 --- a/man/key.dns_resolver.conf.5 +++ b/man/key.dns_resolver.conf.5 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEY.DNS_RESOLVER.CONF 5 "18 May 2020" keyutils +.TH KEY.DNS_RESOLVER.CONF 5 2024-06-19 keyutils .SH NAME key.dns_resolver.conf \- Kernel DNS resolver config .SH DESCRIPTION diff --git a/man/keyctl.1 b/man/keyctl.1 index 7aa0cb7..bb4856e 100644 --- a/man/keyctl.1 +++ b/man/keyctl.1 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL 1 "20 Feb 2014" keyutils +.TH KEYCTL 1 2024-06-19 keyutils .SH NAME keyctl \- key management facility control .SH SYNOPSIS diff --git a/man/keyctl.3 b/man/keyctl.3 index 0d04ea6..ef59397 100644 --- a/man/keyctl.3 +++ b/man/keyctl.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL 3 "21 Feb 2014" keyutils +.TH KEYCTL 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_*() \- key management function wrappers diff --git a/man/keyctl_capabilities.3 b/man/keyctl_capabilities.3 index c687faa..6686143 100644 --- a/man/keyctl_capabilities.3 +++ b/man/keyctl_capabilities.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CAPABILITIES 3 "30 May 2019" keyutils +.TH KEYCTL_CAPABILITIES 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_capabilities \- Query subsystem capabilities diff --git a/man/keyctl_chown.3 b/man/keyctl_chown.3 index 1c8fa9a..09d5129 100644 --- a/man/keyctl_chown.3 +++ b/man/keyctl_chown.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CHOWN 3 "4 May 2006" keyutils +.TH KEYCTL_CHOWN 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_chown \- change the ownership of a key diff --git a/man/keyctl_clear.3 b/man/keyctl_clear.3 index 010b175..e17acac 100644 --- a/man/keyctl_clear.3 +++ b/man/keyctl_clear.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CLEAR 3 "4 May 2006" keyutils +.TH KEYCTL_CLEAR 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_clear \- clear a keyring diff --git a/man/keyctl_describe.3 b/man/keyctl_describe.3 index 198f1b7..17573d0 100644 --- a/man/keyctl_describe.3 +++ b/man/keyctl_describe.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_DESCRIBE 3 "4 May 2006" keyutils +.TH KEYCTL_DESCRIBE 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_describe \- describe a key diff --git a/man/keyctl_dh_compute.3 b/man/keyctl_dh_compute.3 index 8a2d29f..b986131 100644 --- a/man/keyctl_dh_compute.3 +++ b/man/keyctl_dh_compute.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_DH_COMPUTE 3 "07 Apr 2016" keyutils +.TH KEYCTL_DH_COMPUTE 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_dh_compute \- Compute a Diffie-Hellman shared secret or public key diff --git a/man/keyctl_get_keyring_ID.3 b/man/keyctl_get_keyring_ID.3 index a754aa1..39d2115 100644 --- a/man/keyctl_get_keyring_ID.3 +++ b/man/keyctl_get_keyring_ID.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GET_KEYRING_ID 3 "4 May 2006" keyutils +.TH KEYCTL_GET_KEYRING_ID 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_get_keyring_ID \- get the ID of a special keyring diff --git a/man/keyctl_get_persistent.3 b/man/keyctl_get_persistent.3 index 71d8626..4f81ade 100644 --- a/man/keyctl_get_persistent.3 +++ b/man/keyctl_get_persistent.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GET_PERSISTENT 3 "20 Feb 2014" keyutils +.TH KEYCTL_GET_PERSISTENT 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_get_persistent \- get the persistent keyring for a user diff --git a/man/keyctl_get_security.3 b/man/keyctl_get_security.3 index b9b05c2..b0f87ab 100644 --- a/man/keyctl_get_security.3 +++ b/man/keyctl_get_security.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GET_SECURITY 3 "26 Feb 2010" keyutils +.TH KEYCTL_GET_SECURITY 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_get_security \- retrieve a key's security context diff --git a/man/keyctl_instantiate.3 b/man/keyctl_instantiate.3 index ff1dea5..08d0d37 100644 --- a/man/keyctl_instantiate.3 +++ b/man/keyctl_instantiate.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_INSTANTIATE 3 "4 May 2006" keyutils +.TH KEYCTL_INSTANTIATE 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_assume_authority, keyctl_instantiate, keyctl_instantiate_iov, keyctl_reject, keyctl_negate \- key instantiation functions diff --git a/man/keyctl_invalidate.3 b/man/keyctl_invalidate.3 index e54f505..c7edf7b 100644 --- a/man/keyctl_invalidate.3 +++ b/man/keyctl_invalidate.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_INVALIDATE 3 "29 Aug 2013" keyutils +.TH KEYCTL_INVALIDATE 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_invalidate \- invalidate a key diff --git a/man/keyctl_join_session_keyring.3 b/man/keyctl_join_session_keyring.3 index 65233f8..0d5793e 100644 --- a/man/keyctl_join_session_keyring.3 +++ b/man/keyctl_join_session_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_JOIN_SESSION_KEYRING 3 "20 Feb 2014" keyutils +.TH KEYCTL_JOIN_SESSION_KEYRING 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_join_session_keyring \- join a different session keyring diff --git a/man/keyctl_link.3 b/man/keyctl_link.3 index 7b607bf..bf57651 100644 --- a/man/keyctl_link.3 +++ b/man/keyctl_link.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_LINK 3 "4 May 2006" keyutils +.TH KEYCTL_LINK 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_link, keyctl_unlink \- link/unlink a key to/from a keyring diff --git a/man/keyctl_move.3 b/man/keyctl_move.3 index 894e76d..14259d1 100644 --- a/man/keyctl_move.3 +++ b/man/keyctl_move.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_MOVE 3 "29 May 2019" keyutils +.TH KEYCTL_MOVE 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_move \- Move a key between keyrings diff --git a/man/keyctl_pkey_encrypt.3 b/man/keyctl_pkey_encrypt.3 index f3c5478..d81c625 100644 --- a/man/keyctl_pkey_encrypt.3 +++ b/man/keyctl_pkey_encrypt.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_ENCRYPT 3 "8 Nov 2018" keyutils +.TH KEYCTL_PKEY_ENCRYPT 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_encrypt, keyctl_pkey_decrypt \- Encrypt and decrypt data diff --git a/man/keyctl_pkey_query.3 b/man/keyctl_pkey_query.3 index 837b9db..211aca7 100644 --- a/man/keyctl_pkey_query.3 +++ b/man/keyctl_pkey_query.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_QUERY 3 "8 Nov 2018" keyutils +.TH KEYCTL_PKEY_QUERY 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_query \- Query public key parameters diff --git a/man/keyctl_pkey_sign.3 b/man/keyctl_pkey_sign.3 index 5997046..0351cfe 100644 --- a/man/keyctl_pkey_sign.3 +++ b/man/keyctl_pkey_sign.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_SIGN 3 "8 Nov 2018" keyutils +.TH KEYCTL_PKEY_SIGN 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_sign, keyctl_pkey_verify \- Generate and verify signatures diff --git a/man/keyctl_read.3 b/man/keyctl_read.3 index 8b767a3..a672526 100644 --- a/man/keyctl_read.3 +++ b/man/keyctl_read.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_READ 3 "21 Feb 2014" keyutils +.TH KEYCTL_READ 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_read \- read a key diff --git a/man/keyctl_restrict_keyring.3 b/man/keyctl_restrict_keyring.3 index 1f3d1eb..63f9f7e 100644 --- a/man/keyctl_restrict_keyring.3 +++ b/man/keyctl_restrict_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_RESTRICT_KEYRING 3 "28 Feb 2017" keyutils +.TH KEYCTL_RESTRICT_KEYRING 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_restrict_keyring \- restrict keys that may be linked to a keyring diff --git a/man/keyctl_revoke.3 b/man/keyctl_revoke.3 index a00b1f8..22f8b4c 100644 --- a/man/keyctl_revoke.3 +++ b/man/keyctl_revoke.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_REVOKE 3 "4 May 2006" keyutils +.TH KEYCTL_REVOKE 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_revoke \- revoke a key diff --git a/man/keyctl_search.3 b/man/keyctl_search.3 index c779fb0..7b56310 100644 --- a/man/keyctl_search.3 +++ b/man/keyctl_search.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SEARCH 3 "4 May 2006" keyutils +.TH KEYCTL_SEARCH 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_search \- search a keyring for a key diff --git a/man/keyctl_session_to_parent.3 b/man/keyctl_session_to_parent.3 index e208459..56d2c92 100644 --- a/man/keyctl_session_to_parent.3 +++ b/man/keyctl_session_to_parent.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SESSION_TO_PARENT 3 "20 Feb 2014" keyutils +.TH KEYCTL_SESSION_TO_PARENT 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_session_to_parent \- set the parent process's session keyring diff --git a/man/keyctl_set_reqkey_keyring.3 b/man/keyctl_set_reqkey_keyring.3 index e742f13..356a008 100644 --- a/man/keyctl_set_reqkey_keyring.3 +++ b/man/keyctl_set_reqkey_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SET_REQKEY_KEYRING 3 "4 May 2006" keyutils +.TH KEYCTL_SET_REQKEY_KEYRING 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_set_reqkey_keyring \- set the implicit destination keyring diff --git a/man/keyctl_set_timeout.3 b/man/keyctl_set_timeout.3 index b5d055b..36c3274 100644 --- a/man/keyctl_set_timeout.3 +++ b/man/keyctl_set_timeout.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SET_TIMEOUT 3 "4 May 2006" keyutils +.TH KEYCTL_SET_TIMEOUT 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_set_timeout \- set the expiration timer on a key diff --git a/man/keyctl_setperm.3 b/man/keyctl_setperm.3 index f246946..30dff85 100644 --- a/man/keyctl_setperm.3 +++ b/man/keyctl_setperm.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SETPERM 3 "4 May 2006" keyutils +.TH KEYCTL_SETPERM 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_setperm \- change the permissions mask on a key diff --git a/man/keyctl_update.3 b/man/keyctl_update.3 index 4cff75c..d292c4f 100644 --- a/man/keyctl_update.3 +++ b/man/keyctl_update.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_UPDATE 3 "4 May 2006" keyutils +.TH KEYCTL_UPDATE 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_update \- update a key diff --git a/man/keyctl_watch_key.3 b/man/keyctl_watch_key.3 index b8ed158..57534a8 100644 --- a/man/keyctl_watch_key.3 +++ b/man/keyctl_watch_key.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GRANT_PERMISSION 3 "28 Aug 2019" keyutils +.TH KEYCTL_GRANT_PERMISSION 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_watch_key \- Watch for changes to a key diff --git a/man/keyutils.7 b/man/keyutils.7 index f17ee35..08402e0 100644 --- a/man/keyutils.7 +++ b/man/keyutils.7 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYUTILS 7 "21 Feb 2014" keyutils +.TH KEYUTILS 7 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyutils \- in-kernel key management utilities diff --git a/man/recursive_key_scan.3 b/man/recursive_key_scan.3 index daf75f1..fe690f9 100644 --- a/man/recursive_key_scan.3 +++ b/man/recursive_key_scan.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH RECURSIVE_KEY_SCAN 3 "10 Mar 2011" keyutils +.TH RECURSIVE_KEY_SCAN 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME recursive_key_scan, recursive_session_key_scan \- apply a function to all keys in a keyring tree diff --git a/man/request-key.8 b/man/request-key.8 index 1db6ebc..242db77 100644 --- a/man/request-key.8 +++ b/man/request-key.8 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH REQUEST-KEY 8 "15 Nov 2011" keyutils +.TH REQUEST-KEY 8 2024-06-19 keyutils .SH NAME request\-key \- handle key instantiation callback requests from the kernel .SH SYNOPSIS diff --git a/man/request-key.conf.5 b/man/request-key.conf.5 index dde6295..29ba977 100644 --- a/man/request-key.conf.5 +++ b/man/request-key.conf.5 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH REQUEST-KEY.CONF 5 "15 November 2011" keyutils +.TH REQUEST-KEY.CONF 5 2024-06-19 keyutils .SH NAME request\-key.conf \- Instantiation handler configuration file .SH DESCRIPTION From patchwork Wed Jun 19 23:25:05 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704720 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5D19E762C1 for ; Wed, 19 Jun 2024 23:25:08 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839508; cv=none; b=F0eMo39XL/mN8NyWEQfLigkS2gG/REZf3PLlQUnxZUueF4EYaTUB1zL6GLH34MmyWIyOxfQQqyYfpBpFHQYWMqj11urJt/flwmKwE8t5VccWGHx2bFoCK+UwnL6uScu6WTxeLKdAh9fj2MRFFywp/e2cLGyF7rfgAJG3OJq/7lw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839508; c=relaxed/simple; bh=uQpjNvmqr94RYtXfjBFOidvT2SIHvXqv6lAji58npmY=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=m+c798sGd07NJ0vSoFkjdC+hRc3vKYhtNff/8fLDgxBCun55yy7JpbDKsT0cwI/WnyjYY3OP0HXTvRkZGCXcrO4F+nG5dwTjITkJb1PUEzF/d3FBa71/qQmEAj5AOA1c/NEu00aX8+F7LIoPW9Oj1qKo0AHu3YnIuGozvN5Ni4I= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=fRWC8Cya; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="fRWC8Cya" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 631ECC2BBFC; Wed, 19 Jun 2024 23:25:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839508; bh=uQpjNvmqr94RYtXfjBFOidvT2SIHvXqv6lAji58npmY=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=fRWC8CyaiywFeKR2UGa9DXdM5GpC1pNimOmAnEwQCRpRSjJh3dtDtF9Dm+e2H/OnB ojm7s4l2Tyg2lh4gtaaSAOHmQkGLYQPvdU0+MuuVkp0yfYdV8Aql6lCuZ02mxHZ5z8 Yd9usBJfOSLPHP/q58MPa82vOMfhWsBLKZEsDQhdS6VnTB22S/ygHmZIL5gnXLLV1F 2zldoMm+lfg0tfSg05uW0MYVVG3LhujUC6a/T1T5hPukZDfgqJIA+/ruI0MyLRE/aw RXVRZcaEB8nllh/AsfW1kxsvXQJC/KTiNBuQUSvEB9nofNrgGrMtPjNgvFy5watZus juUHgDdFp5TwA== Date: Thu, 20 Jun 2024 01:25:05 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 05/10] man: Use lowercase in TH 1st argument Message-ID: <20240619232444.36444-6-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> The maintainers of groff(1), mandoc(1), man(1), and the Linux man-pages project, and several others have reached a consensus that using upper case in the TH 1st argument is unnecessarily imprecise, and that it would be more appropriate to use the same case that the name of the thing to be documented: so for NULL, it would be upper case, but for printf, it would be lower case. The use of upper case seems to have been inertia from a time when there was no bold face, so authors of the manual chose use upper case for emphasis. These days we can do better. Link: Signed-off-by: Alejandro Colomar --- man/asymmetric-key.7 | 2 +- man/find_key_by_type_and_name.3 | 2 +- man/key.dns_resolver.8 | 2 +- man/key.dns_resolver.conf.5 | 2 +- man/keyctl.1 | 2 +- man/keyctl.3 | 2 +- man/keyctl_capabilities.3 | 2 +- man/keyctl_chown.3 | 2 +- man/keyctl_clear.3 | 2 +- man/keyctl_describe.3 | 2 +- man/keyctl_dh_compute.3 | 2 +- man/keyctl_get_keyring_ID.3 | 2 +- man/keyctl_get_security.3 | 2 +- man/keyctl_instantiate.3 | 2 +- man/keyctl_invalidate.3 | 2 +- man/keyctl_join_session_keyring.3 | 2 +- man/keyctl_link.3 | 2 +- man/keyctl_move.3 | 2 +- man/keyctl_pkey_encrypt.3 | 2 +- man/keyctl_pkey_query.3 | 2 +- man/keyctl_pkey_sign.3 | 2 +- man/keyctl_read.3 | 2 +- man/keyctl_restrict_keyring.3 | 2 +- man/keyctl_revoke.3 | 2 +- man/keyctl_search.3 | 2 +- man/keyctl_session_to_parent.3 | 2 +- man/keyctl_set_reqkey_keyring.3 | 2 +- man/keyctl_set_timeout.3 | 2 +- man/keyctl_setperm.3 | 2 +- man/keyctl_update.3 | 2 +- man/keyctl_watch_key.3 | 2 +- man/keyutils.7 | 2 +- man/recursive_key_scan.3 | 2 +- man/request-key.8 | 2 +- man/request-key.conf.5 | 2 +- 35 files changed, 35 insertions(+), 35 deletions(-) diff --git a/man/asymmetric-key.7 b/man/asymmetric-key.7 index 70ed935..bd338b4 100644 --- a/man/asymmetric-key.7 +++ b/man/asymmetric-key.7 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH ASYMMETRIC-KEY 7 2024-06-19 keyutils +.TH asymmetric-key 7 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME asymmetric \- Kernel key type for holding asymmetric keys diff --git a/man/find_key_by_type_and_name.3 b/man/find_key_by_type_and_name.3 index 802b9cd..c2e8130 100644 --- a/man/find_key_by_type_and_name.3 +++ b/man/find_key_by_type_and_name.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH FIND_KEY_BY_TYPE_AND_NAME 3 2024-06-19 keyutils +.TH find_key_by_type_and_name 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME find_key_by_type_and_name \- find a key by type and name diff --git a/man/key.dns_resolver.8 b/man/key.dns_resolver.8 index 383f5af..aef61db 100644 --- a/man/key.dns_resolver.8 +++ b/man/key.dns_resolver.8 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEY.DNS_RESOLVER 8 2024-06-19 keyutils +.TH key.dns_resolver 8 2024-06-19 keyutils .SH NAME key.dns_resolver \- upcall for request\-key to handle dns_resolver keys .SH SYNOPSIS diff --git a/man/key.dns_resolver.conf.5 b/man/key.dns_resolver.conf.5 index 43668ca..052a7ff 100644 --- a/man/key.dns_resolver.conf.5 +++ b/man/key.dns_resolver.conf.5 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEY.DNS_RESOLVER.CONF 5 2024-06-19 keyutils +.TH key.dns_resolver.conf 5 2024-06-19 keyutils .SH NAME key.dns_resolver.conf \- Kernel DNS resolver config .SH DESCRIPTION diff --git a/man/keyctl.1 b/man/keyctl.1 index bb4856e..59eabf7 100644 --- a/man/keyctl.1 +++ b/man/keyctl.1 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL 1 2024-06-19 keyutils +.TH keyctl 1 2024-06-19 keyutils .SH NAME keyctl \- key management facility control .SH SYNOPSIS diff --git a/man/keyctl.3 b/man/keyctl.3 index ef59397..f583640 100644 --- a/man/keyctl.3 +++ b/man/keyctl.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL 3 2024-06-19 keyutils +.TH keyctl 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_*() \- key management function wrappers diff --git a/man/keyctl_capabilities.3 b/man/keyctl_capabilities.3 index 6686143..c56b6b2 100644 --- a/man/keyctl_capabilities.3 +++ b/man/keyctl_capabilities.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CAPABILITIES 3 2024-06-19 keyutils +.TH keyctl_capabilities 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_capabilities \- Query subsystem capabilities diff --git a/man/keyctl_chown.3 b/man/keyctl_chown.3 index 09d5129..71b9332 100644 --- a/man/keyctl_chown.3 +++ b/man/keyctl_chown.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CHOWN 3 2024-06-19 keyutils +.TH keyctl_chown 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_chown \- change the ownership of a key diff --git a/man/keyctl_clear.3 b/man/keyctl_clear.3 index e17acac..c25cae3 100644 --- a/man/keyctl_clear.3 +++ b/man/keyctl_clear.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_CLEAR 3 2024-06-19 keyutils +.TH keyctl_clear 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_clear \- clear a keyring diff --git a/man/keyctl_describe.3 b/man/keyctl_describe.3 index 17573d0..409ec0a 100644 --- a/man/keyctl_describe.3 +++ b/man/keyctl_describe.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_DESCRIBE 3 2024-06-19 keyutils +.TH keyctl_describe 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_describe \- describe a key diff --git a/man/keyctl_dh_compute.3 b/man/keyctl_dh_compute.3 index b986131..0f2326d 100644 --- a/man/keyctl_dh_compute.3 +++ b/man/keyctl_dh_compute.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_DH_COMPUTE 3 2024-06-19 keyutils +.TH keyctl_dh_compute 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_dh_compute \- Compute a Diffie-Hellman shared secret or public key diff --git a/man/keyctl_get_keyring_ID.3 b/man/keyctl_get_keyring_ID.3 index 39d2115..0e7f82d 100644 --- a/man/keyctl_get_keyring_ID.3 +++ b/man/keyctl_get_keyring_ID.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GET_KEYRING_ID 3 2024-06-19 keyutils +.TH keyctl_get_keyring_ID 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_get_keyring_ID \- get the ID of a special keyring diff --git a/man/keyctl_get_security.3 b/man/keyctl_get_security.3 index b0f87ab..f8d918b 100644 --- a/man/keyctl_get_security.3 +++ b/man/keyctl_get_security.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GET_SECURITY 3 2024-06-19 keyutils +.TH keyctl_get_security 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_get_security \- retrieve a key's security context diff --git a/man/keyctl_instantiate.3 b/man/keyctl_instantiate.3 index 08d0d37..c45a7cb 100644 --- a/man/keyctl_instantiate.3 +++ b/man/keyctl_instantiate.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_INSTANTIATE 3 2024-06-19 keyutils +.TH keyctl_instantiate 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_assume_authority, keyctl_instantiate, keyctl_instantiate_iov, keyctl_reject, keyctl_negate \- key instantiation functions diff --git a/man/keyctl_invalidate.3 b/man/keyctl_invalidate.3 index c7edf7b..e29e0b4 100644 --- a/man/keyctl_invalidate.3 +++ b/man/keyctl_invalidate.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_INVALIDATE 3 2024-06-19 keyutils +.TH keyctl_invalidate 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_invalidate \- invalidate a key diff --git a/man/keyctl_join_session_keyring.3 b/man/keyctl_join_session_keyring.3 index 0d5793e..b9d5f1b 100644 --- a/man/keyctl_join_session_keyring.3 +++ b/man/keyctl_join_session_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_JOIN_SESSION_KEYRING 3 2024-06-19 keyutils +.TH keyctl_join_session_keyring 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_join_session_keyring \- join a different session keyring diff --git a/man/keyctl_link.3 b/man/keyctl_link.3 index bf57651..b24a03b 100644 --- a/man/keyctl_link.3 +++ b/man/keyctl_link.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_LINK 3 2024-06-19 keyutils +.TH keyctl_link 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_link, keyctl_unlink \- link/unlink a key to/from a keyring diff --git a/man/keyctl_move.3 b/man/keyctl_move.3 index 14259d1..ec6834d 100644 --- a/man/keyctl_move.3 +++ b/man/keyctl_move.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_MOVE 3 2024-06-19 keyutils +.TH keyctl_move 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_move \- Move a key between keyrings diff --git a/man/keyctl_pkey_encrypt.3 b/man/keyctl_pkey_encrypt.3 index d81c625..b3a4445 100644 --- a/man/keyctl_pkey_encrypt.3 +++ b/man/keyctl_pkey_encrypt.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_ENCRYPT 3 2024-06-19 keyutils +.TH keyctl_pkey_encrypt 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_encrypt, keyctl_pkey_decrypt \- Encrypt and decrypt data diff --git a/man/keyctl_pkey_query.3 b/man/keyctl_pkey_query.3 index 211aca7..ee194c7 100644 --- a/man/keyctl_pkey_query.3 +++ b/man/keyctl_pkey_query.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_QUERY 3 2024-06-19 keyutils +.TH keyctl_pkey_query 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_query \- Query public key parameters diff --git a/man/keyctl_pkey_sign.3 b/man/keyctl_pkey_sign.3 index 0351cfe..445114c 100644 --- a/man/keyctl_pkey_sign.3 +++ b/man/keyctl_pkey_sign.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYCTL_PKEY_SIGN 3 2024-06-19 keyutils +.TH keyctl_pkey_sign 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_pkey_sign, keyctl_pkey_verify \- Generate and verify signatures diff --git a/man/keyctl_read.3 b/man/keyctl_read.3 index a672526..cd0c117 100644 --- a/man/keyctl_read.3 +++ b/man/keyctl_read.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_READ 3 2024-06-19 keyutils +.TH keyctl_read 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_read \- read a key diff --git a/man/keyctl_restrict_keyring.3 b/man/keyctl_restrict_keyring.3 index 63f9f7e..b94c4c4 100644 --- a/man/keyctl_restrict_keyring.3 +++ b/man/keyctl_restrict_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_RESTRICT_KEYRING 3 2024-06-19 keyutils +.TH keyctl_restrict_keyring 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_restrict_keyring \- restrict keys that may be linked to a keyring diff --git a/man/keyctl_revoke.3 b/man/keyctl_revoke.3 index 22f8b4c..e07e708 100644 --- a/man/keyctl_revoke.3 +++ b/man/keyctl_revoke.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_REVOKE 3 2024-06-19 keyutils +.TH keyctl_revoke 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_revoke \- revoke a key diff --git a/man/keyctl_search.3 b/man/keyctl_search.3 index 7b56310..149bb3b 100644 --- a/man/keyctl_search.3 +++ b/man/keyctl_search.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SEARCH 3 2024-06-19 keyutils +.TH keyctl_search 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_search \- search a keyring for a key diff --git a/man/keyctl_session_to_parent.3 b/man/keyctl_session_to_parent.3 index 56d2c92..aedb6a3 100644 --- a/man/keyctl_session_to_parent.3 +++ b/man/keyctl_session_to_parent.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SESSION_TO_PARENT 3 2024-06-19 keyutils +.TH keyctl_session_to_parent 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_session_to_parent \- set the parent process's session keyring diff --git a/man/keyctl_set_reqkey_keyring.3 b/man/keyctl_set_reqkey_keyring.3 index 356a008..2f7d1f7 100644 --- a/man/keyctl_set_reqkey_keyring.3 +++ b/man/keyctl_set_reqkey_keyring.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SET_REQKEY_KEYRING 3 2024-06-19 keyutils +.TH keyctl_set_reqkey_keyring 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_set_reqkey_keyring \- set the implicit destination keyring diff --git a/man/keyctl_set_timeout.3 b/man/keyctl_set_timeout.3 index 36c3274..f29feb4 100644 --- a/man/keyctl_set_timeout.3 +++ b/man/keyctl_set_timeout.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SET_TIMEOUT 3 2024-06-19 keyutils +.TH keyctl_set_timeout 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_set_timeout \- set the expiration timer on a key diff --git a/man/keyctl_setperm.3 b/man/keyctl_setperm.3 index 30dff85..628d34c 100644 --- a/man/keyctl_setperm.3 +++ b/man/keyctl_setperm.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_SETPERM 3 2024-06-19 keyutils +.TH keyctl_setperm 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_setperm \- change the permissions mask on a key diff --git a/man/keyctl_update.3 b/man/keyctl_update.3 index d292c4f..11a65db 100644 --- a/man/keyctl_update.3 +++ b/man/keyctl_update.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_UPDATE 3 2024-06-19 keyutils +.TH keyctl_update 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_update \- update a key diff --git a/man/keyctl_watch_key.3 b/man/keyctl_watch_key.3 index 57534a8..f0087da 100644 --- a/man/keyctl_watch_key.3 +++ b/man/keyctl_watch_key.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH KEYCTL_GRANT_PERMISSION 3 2024-06-19 keyutils +.TH keyctl_grant_permission 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyctl_watch_key \- Watch for changes to a key diff --git a/man/keyutils.7 b/man/keyutils.7 index 08402e0..5bb1742 100644 --- a/man/keyutils.7 +++ b/man/keyutils.7 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH KEYUTILS 7 2024-06-19 keyutils +.TH keyutils 7 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME keyutils \- in-kernel key management utilities diff --git a/man/recursive_key_scan.3 b/man/recursive_key_scan.3 index fe690f9..aa78a25 100644 --- a/man/recursive_key_scan.3 +++ b/man/recursive_key_scan.3 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the Licence, or (at your option) any later version. .\" -.TH RECURSIVE_KEY_SCAN 3 2024-06-19 keyutils +.TH recursive_key_scan 3 2024-06-19 keyutils .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH NAME recursive_key_scan, recursive_session_key_scan \- apply a function to all keys in a keyring tree diff --git a/man/request-key.8 b/man/request-key.8 index 242db77..1ce1761 100644 --- a/man/request-key.8 +++ b/man/request-key.8 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH REQUEST-KEY 8 2024-06-19 keyutils +.TH request-key 8 2024-06-19 keyutils .SH NAME request\-key \- handle key instantiation callback requests from the kernel .SH SYNOPSIS diff --git a/man/request-key.conf.5 b/man/request-key.conf.5 index 29ba977..fbee4df 100644 --- a/man/request-key.conf.5 +++ b/man/request-key.conf.5 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH REQUEST-KEY.CONF 5 2024-06-19 keyutils +.TH request-key.conf 5 2024-06-19 keyutils .SH NAME request\-key.conf \- Instantiation handler configuration file .SH DESCRIPTION From patchwork Wed Jun 19 23:25:09 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704721 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 03EDD762C1 for ; Wed, 19 Jun 2024 23:25:11 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839512; cv=none; b=FTkUHsB/nGAvCUzHedtDAXIFUwOWg8qMKhFVywlrjv4Ktjv7P9D+D0iIFDM+5QvXiNMZDq64UG93uI5wA1eFcBQMxSVIJl8zEFK5zo2wy5P6ww3BSXPgVBS9y3VqQPg5EQ6xXqrrsf2MpJiVcK86kMUGjYkufCx190Jt2n1TJbI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839512; c=relaxed/simple; bh=PrIbiM9cXPYfxcm5HJh2GxzF8CVL+ITwgnxG3U/BCx0=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=l0MznzNURbOnrn2wQseDIX7Jzjzr/YJP10DMY0f31zeXpj4m3BbGPuK/Zw7QSOaWfZPO8Q+RhHl6EFWeEUpXVh98QEjefWwrhPQalnf9eqJ/bk6claPQdWN66dRjyxF1IajG+OIcfECsqDpz6hln5ArTBDCTPTpmEfaaJhIDmxM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=Oqwic8Br; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="Oqwic8Br" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 150DBC2BBFC; Wed, 19 Jun 2024 23:25:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839511; bh=PrIbiM9cXPYfxcm5HJh2GxzF8CVL+ITwgnxG3U/BCx0=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=Oqwic8BrHTC9GsXwUzSasjzyZ6Rjpjc7xQWcTkKfcKsEXGKvcTyrim44YjY4b3lSm Vx4dlYoklNVzXwpQvGIBcwv9cOmk6JHiiAzR81qoH2Ao2yYYboyUPhCAP6fMh1qhch Y0XbfUmj4cy248FtCyDQoqsJ+WM1DN1pCmy+71SD/DlS4EEIALds52x3UysKCw7mxW yuK63sNiBnWdl15X9Ii2dq1fR3A21GGMk+GGgLX7GFwzR0qAKpJn31FNqF4JwL92Cz BQYKMWc6tTdYxnJLJ7Fg4joXHt5FaBE/dgb8hCiDHe2PUQqrD1SXC2zfhyQMfVIvxA BHun3XFPbD7Ww== Date: Thu, 20 Jun 2024 01:25:09 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 06/10] man: Escape dashes in TH Message-ID: <20240619232444.36444-7-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> When they document an identifier that uses a dash. Signed-off-by: Alejandro Colomar --- man/request-key.8 | 2 +- man/request-key.conf.5 | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/man/request-key.8 b/man/request-key.8 index 1ce1761..d49ca78 100644 --- a/man/request-key.8 +++ b/man/request-key.8 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH request-key 8 2024-06-19 keyutils +.TH request\-key 8 2024-06-19 keyutils .SH NAME request\-key \- handle key instantiation callback requests from the kernel .SH SYNOPSIS diff --git a/man/request-key.conf.5 b/man/request-key.conf.5 index fbee4df..c2e77d4 100644 --- a/man/request-key.conf.5 +++ b/man/request-key.conf.5 @@ -7,7 +7,7 @@ .\" as published by the Free Software Foundation; either version .\" 2 of the License, or (at your option) any later version. .\" -.TH request-key.conf 5 2024-06-19 keyutils +.TH request\-key.conf 5 2024-06-19 keyutils .SH NAME request\-key.conf \- Instantiation handler configuration file .SH DESCRIPTION From patchwork Wed Jun 19 23:25:13 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704722 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B86B2762C1 for ; Wed, 19 Jun 2024 23:25:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839515; cv=none; b=CLrVrbqd6IPU/ji+usnalpZTmJyLVTm1ZuvipiRs9xX52ws/iBzpXtFIP84xgwdrrOKphxNS8ZjAknqck6nvphMEQs+EWl1LtRm4Rs3ZlqUmzrHb0bSjSrzxCXPQaw5mSkX6/JXs0d4LjNeH4I5IJzDRd3XAb++IbYjDSflE4oM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839515; c=relaxed/simple; bh=OTyEfod0n6GaPTMy+FfJyNifU9qCfuguwDaKVtyJYVw=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=TCOgPEyf7eR0KKQXaUlaLhHqYGHQQM7TAGj6Ucv4QJqK9PUl19M+lKgc7iZh5NCzxp1oekthAde+rb0mWG08mikT/NZwGAtAuoHqqQEQMaNDeJ4PRDy3pUHAMuyw1iXLs9f67JjmivEA/eBp4DX04DAaTPYtmSd3fadgmq/hCfI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=DKZ3RQ3A; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="DKZ3RQ3A" Received: by smtp.kernel.org (Postfix) with ESMTPSA id B6CBEC2BBFC; Wed, 19 Jun 2024 23:25:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839515; bh=OTyEfod0n6GaPTMy+FfJyNifU9qCfuguwDaKVtyJYVw=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=DKZ3RQ3AUZmacEHwEapRILi1aLntQ6BX1YW26Z/qeqsLWFrFIicDAFqkPfTXWUYol SeKtw0tAb8YiBy7T8TYa+y2rbvTJofMojeFkF0yR6R0RaA2NX2mrnS8fzG4eF+JKAV zThVSA81bsH8KIv9X1MmJ4sjsXY9Zai1Zksck7zKjjJN/hUVpiQ4lb8M83MqsogQX1 QHdyRjtfYuvOqVytmnvNPHu2mgGjM/wA1aELOpdMrxqvjsxqTA99QB2TJIlB1BcVKO nK6pv/Hd828q16UZbkLM7+0Qw7HxEAjgsMYGO4kaATd+9tZLRmgonROP2t7u6dQdJb DXp2R2czHwp/Q== Date: Thu, 20 Jun 2024 01:25:13 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 07/10] man: Add SYNOPSYS section Message-ID: <20240619232444.36444-8-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> This is a simpler and more standard way of documenting the header that provides these functions. Signed-off-by: Alejandro Colomar --- man/keyctl.3 | 12 +++++------- man/keyutils.7 | 12 +++++------- 2 files changed, 10 insertions(+), 14 deletions(-) diff --git a/man/keyctl.3 b/man/keyctl.3 index f583640..352b0c4 100644 --- a/man/keyctl.3 +++ b/man/keyctl.3 @@ -16,18 +16,16 @@ .SH LIBRARY Key management utilities library .RI ( libkeyutils ,\~ \-lkeyutils ) .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH SYNOPSIS +.nf +.B #include +.fi +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH DESCRIPTION The .BR keyctl () system call is a multiplexor for a number of key management functions. These should be called via the wrappers in the libkeyutils library. -.P -The functions can be compiled in by including the \fBkeyutils\fR header file: -.sp -.RS -.nf -.B #include -.RE .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH KEYCTL FUNCTIONS .BR keyctl_assume_authority (3) diff --git a/man/keyutils.7 b/man/keyutils.7 index 5bb1742..33811e7 100644 --- a/man/keyutils.7 +++ b/man/keyutils.7 @@ -16,19 +16,17 @@ .SH LIBRARY Key management utilities library .RI ( libkeyutils ,\~ \-lkeyutils ) .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH SYNOPSIS +.nf +.B #include +.fi +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .SH DESCRIPTION The .B keyutils package is a library and a set of utilities for accessing the kernel \fBkeyrings\fP facility. .P -A header file is supplied to provide the definitions and declarations required -to access the library: -.P -.RS -.B #include -.RE -.P Three system calls are provided: .TP .BR add_key (2) From patchwork Wed Jun 19 23:25:16 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704723 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id AE264762C1 for ; Wed, 19 Jun 2024 23:25:19 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839519; cv=none; b=XJGmivZQnaIxX7KjJYR5nWFaUf1FJKb82NN1zJo3+4F2rcHXoIl+9PvdA2FzkoZpczGYrfxQSZvnbvJE/ffnyslQABZJRLw5T1AE5glxZlg44CF1EVEOw7OHpzJZ5pIVo60NjCwSkonF5tW4t98Ul7ir5N91LWayCwFBbW+wm20= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839519; c=relaxed/simple; bh=ClFxDF/rVkPAXxxcP6pKi94V6NXq87GnrM7oCvFaxEQ=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=ZQo5xZ48v3IajP2+gLgoVWonRKBgTYvQGUlrh7TTu1YHSBY+Mtizh4jhuGDI1EXpTBVGikDeHKT5/krs7KI2NC6A4AcAu58ECSTjhml9RZYlRjwAAMW0bdxpIgtRWm6fKMQPA69mAwyXoOmfePQX6PiWnZeGqs4FTP6OYCt16pI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=o4tjnLpV; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="o4tjnLpV" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 7831EC2BBFC; Wed, 19 Jun 2024 23:25:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839519; bh=ClFxDF/rVkPAXxxcP6pKi94V6NXq87GnrM7oCvFaxEQ=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=o4tjnLpVwlo8IMfjkTn1oMtr5CiLQ396HeesDjYmPcDK0Y6oeX0LULemPXgUgSw0l ULRAOOxfISgGsV7uwcB2+ogU95Y0vwc5jeCY8HDEhFGoADcLsw9f2ieF+iiwYfbxzv /QJjNdiSu/fkN2OI5NWQ4lz3eKAwCllKRHJ7dZ6fFRvjvv7ciQyIeb9FTF6AYnqRRC mkiP3owHyDKrCqfbCmHYNYvopE7pFNXpy5ERJOVstIOsfBszAwRhsAJZJGtB/6MCqy CEv8hL2qRdDYVTvXX4RipTUbSGnkPSYrR0xLSyQ0SQmrUEpprKH5POKL3MGwQcXzsr vWTOsaxcRAkzQ== Date: Thu, 20 Jun 2024 01:25:16 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 08/10] man: Improve formatting of SYNOPSIS of commands Message-ID: <20240619232444.36444-9-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> Signed-off-by: Alejandro Colomar --- man/keyctl.1 | 426 ++++++++++++++++++++++++++++++++++------------ man/request-key.8 | 12 +- 2 files changed, 324 insertions(+), 114 deletions(-) diff --git a/man/keyctl.1 b/man/keyctl.1 index 59eabf7..59172d4 100644 --- a/man/keyctl.1 +++ b/man/keyctl.1 @@ -11,118 +11,320 @@ .SH NAME keyctl \- key management facility control .SH SYNOPSIS -\fBkeyctl\fR \-\-version -.br -\fBkeyctl\fR supports [ | --raw] -.br -\fBkeyctl\fR id [] -.br -\fBkeyctl\fR show [\-x] [] -.br -\fBkeyctl\fR add [\-x] -.br -\fBkeyctl\fR padd [\-x] -.br -\fBkeyctl\fR request [] -.br -\fBkeyctl\fR request2 [] -.br -\fBkeyctl\fR prequest2 [] -.br -\fBkeyctl\fR update [\-x] -.br -\fBkeyctl\fR pupdate [\-x] -.br -\fBkeyctl\fR newring -.br -\fBkeyctl\fR revoke -.br -\fBkeyctl\fR clear -.br -\fBkeyctl\fR link -.br -\fBkeyctl\fR unlink [] -.br -\fBkeyctl\fR move [-f] -.br -\fBkeyctl\fR search [] -.br -\fBkeyctl\fR restrict_keyring [ []] -.br -\fBkeyctl\fR read -.br -\fBkeyctl\fR pipe -.br -\fBkeyctl\fR print -.br -\fBkeyctl\fR list -.br -\fBkeyctl\fR rlist -.br -\fBkeyctl\fR describe -.br -\fBkeyctl\fR rdescribe [sep] -.br -\fBkeyctl\fR chown -.br -\fBkeyctl\fR chgrp -.br -\fBkeyctl\fR setperm -.br -\fBkeyctl\fR new_session [] -.br -\fBkeyctl\fR session -.br -\fBkeyctl\fR session \- [ ...] -.br -\fBkeyctl\fR session [ ...] -.br -\fBkeyctl\fR instantiate [\-x] -.br -\fBkeyctl\fR pinstantiate [\-x] -.br -\fBkeyctl\fR negate -.br -\fBkeyctl\fR reject -.br -\fBkeyctl\fR timeout -.br -\fBkeyctl\fR security -.br -\fBkeyctl\fR reap [\-v] -.br -\fBkeyctl\fR purge -.br -\fBkeyctl\fR purge [\-i] [\-p] -.br -\fBkeyctl\fR purge \-s -.br -\fBkeyctl\fR get_persistent [] -.br -\fBkeyctl\fR dh_compute -.br -\fBkeyctl\fR dh_compute_kdf -.br -\fBkeyctl\fR dh_compute_kdf_oi [\-x] -.br -\fBkeyctl\fR pkey_query [k=v]* -.br -\fBkeyctl\fR pkey_encrypt [k=v]* > -.br -\fBkeyctl\fR pkey_decrypt [k=v]* > -.br -\fBkeyctl\fR pkey_sign [k=v]* > -.br -\fBkeyctl\fR pkey_decrypt [k=v]* -.br -\fBkeyctl\fR watch [\-f] -.br -\fBkeyctl\fR watch_add -.br -\fBkeyctl\fR watch_rm -.br -\fBkeyctl\fR watch_session [\-f ] [-n ] \\ - [ ...] +.SY keyctl +.B \-\-version +.YS +.SY keyctl +.B supports +.RI [ cap \~|\~\fB--raw\fP] +.YS +.SY keyctl +.B id +.RI [ keyring ] +.YS +.SY keyctl +.B show +.RB [ \-x ] +.RI [ keyring ] +.YS +.SY keyctl +.B add +.RB [ \-x ] +.I type +.I desc +.I data +.I keyring +.YS +.SY keyctl +.B padd +.RB [ \-x ] +.I type +.I desc +.I keyring +.YS +.SY keyctl +.B request +.I type +.I desc +.RI [ dest_keyring ] +.YS +.SY keyctl +.B request2 +.I type +.I desc +.I info +.RI [ dest_keyring ] +.YS +.SY keyctl +.B prequest2 +.I type +.I desc +.RI [ dest_keyring ] +.YS +.SY keyctl +.B update +.RB [ \-x ] +.I key +.I data +.YS +.SY keyctl +.B pupdate +.RB [ \-x ] +.I key +.YS +.SY keyctl +.B newring +.I name +.I keyring +.YS +.SY keyctl +.B revoke +.I key +.YS +.SY keyctl +.B clear +.I keyring +.YS +.SY keyctl +.B link +.I key +.I keyring +.YS +.SY keyctl +.B unlink +.I key +.RI [ keyring ] +.YS +.SY keyctl +.B move +.RB [ -f ] +.I key +.I from_keyring +.I to_keyring +.YS +.SY keyctl +.B search +.I keyring +.I type +.I desc +.RI [ dest_keyring ] +.YS +.SY keyctl +.B restrict_keyring +.I keyring +.RI [ type +.RI [ restriction ]] +.YS +.SY keyctl +.B read +.I key +.YS +.SY keyctl +.B pipe +.I key +.YS +.SY keyctl +.B print +.I key +.YS +.SY keyctl +.B list +.I keyring +.YS +.SY keyctl +.B rlist +.I keyring +.YS +.SY keyctl +.B describe +.I keyring +.YS +.SY keyctl +.B rdescribe +.I keyring +.RB [ sep ] +.YS +.SY keyctl +.B chown +.I key +.I uid +.YS +.SY keyctl +.B chgrp +.I key +.I gid +.YS +.SY keyctl +.B setperm +.I key +.I mask +.YS +.SY keyctl +.B new_session +.RI [ name ] +.YS +.SY keyctl +.B session +.YS +.SY keyctl +.B session +.B \- +.RI [ prog +.IR args \~.\|.\|.] +.YS +.SY keyctl +.B session +.I name +.RI [ prog +.RI [ args \~.\|.\|.]] +.YS +.SY keyctl +.B instantiate +.RB [ \-x ] +.I key +.I data +.I keyring +.YS +.SY keyctl +.B pinstantiate +.RB [ \-x ] +.I key +.I keyring +.YS +.SY keyctl +.B negate +.I key +.I timeout +.I keyring +.YS +.SY keyctl +.B reject +.I key +.I timeout +.I error +.I keyring +.YS +.SY keyctl +.B timeout +.I key +.I timeout +.YS +.SY keyctl +.B security +.I key +.YS +.SY keyctl +.B reap +.RB [ \-v ] +.YS +.SY keyctl +.B purge +.I type +.YS +.SY keyctl +.B purge +.RB [ \-i ] +.RB [ \-p ] +.I type +.I desc +.YS +.SY keyctl +.B purge +.B \-s +.I type +.I desc +.YS +.SY keyctl +.B get_persistent +.I keyring +.RI [ uid ] +.YS +.SY keyctl +.B dh_compute +.I private +.I prime +.I base +.YS +.SY keyctl +.B dh_compute_kdf +.I private +.I prime +.I base +.I output_length +.I hash_type +.YS +.SY keyctl +.B dh_compute_kdf_oi +.RB [ \-x ] +.I private +.I prime +.I base +.I output_length +.I hash_type +.YS +.SY keyctl +.B pkey_query +.I key +.I pass +.RI [ k \fB=\fP v \~.\|.\|.] +.YS +.SY keyctl +.B pkey_encrypt +.I key +.I pass +.I datafile +.RI [ k \fB=\fP v \~.\|.\|.\&] +.I encfile +.YS +.SY keyctl +.B pkey_decrypt +.I key +.I pass +.I encfile +.RI [ k \fB=\fP v \~.\|.\|.\&] +.I datafile +.YS +.SY keyctl +.B pkey_sign +.I key +.I pass +.I datafile +.RI [ k \fB=\fP v \~.\|.\|.\&] +.I sigfile +.YS +.SY keyctl +.B pkey_decrypt +.I key +.I pass +.I datafile +.I sigfile +.RI [ k \fB=\fP v \~.\|.\|.] +.YS +.SY keyctl +.B watch +.RB [ \-f \~\fIfilters\fP] +.I key +.YS +.SY keyctl +.B watch_add +.I fd +.I key +.YS +.SY keyctl +.B watch_rm +.I fd +.I key +.YS +.SY keyctl +.B watch_session +.RB [ \-f \~\fIfilters\fP] +.RB [ \-n \~\fIname\fP] +.I notifylog +.I gclog +.I fd +.I prog +.RI [ args \~.\|.\|.] +.YS .SH DESCRIPTION This program is used to control the key management facility in various ways using a variety of subcommands. diff --git a/man/request-key.8 b/man/request-key.8 index d49ca78..08f2ace 100644 --- a/man/request-key.8 +++ b/man/request-key.8 @@ -11,8 +11,16 @@ .SH NAME request\-key \- handle key instantiation callback requests from the kernel .SH SYNOPSIS -\fB/sbin/request\-key \fR - [] +.SY /sbin/request\-key +.I op +.I key +.I uid +.I gid +.I threadring +.I processring +.I sessionring +.RI [ info ] +.YS .SH DESCRIPTION This program is invoked by the kernel when the kernel is asked for a key that it doesn't have immediately available. The kernel creates a partially set up From patchwork Wed Jun 19 23:25:20 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704724 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3645A762C1 for ; Wed, 19 Jun 2024 23:25:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839523; cv=none; b=cWZUVk5fIazieqk4yWYmXE+mPhnMc1RlTtv8LDo7XDs19yIXHmYBNKfTaYuc+AXSgTAFwNTyDsQJa12aYQyvEbNSP8305JVfkHNXCMhH2qPwovdqO2QaFHZ81eoyvUHZRaPcA1w8s4AvWKaiEy94qcG290ffscFsPwn3LVZUT80= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839523; c=relaxed/simple; bh=nVdUWJZqh6agLFHDFBCsvVmmjvGY2icPIJAw3+Fs8dg=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=tFEhW5FcRyEhDKHLuZSFPdtnX/8S4SuYGRZCtEy2fqYzxa/6qV11GR9uurOfoqyPdxs1T0xk5x26VOh0j9gL44kgmmY8g4wYDwNORfSerhcdhBcnNEeHXdDkyhlPixkr578CstweAz7ADv8aefozHEXhLAoLBLQbSyLa0wYBxiY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=Zep8O9iI; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="Zep8O9iI" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 3A4A4C2BBFC; Wed, 19 Jun 2024 23:25:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839523; bh=nVdUWJZqh6agLFHDFBCsvVmmjvGY2icPIJAw3+Fs8dg=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=Zep8O9iIrPCELU6sVpY8F9BUpUHyZupjrXjnuSU0cnbmPvCA6DIPijiCes+ywkGb/ Y9244vkFFxL5rzt5CqVox2vKAX+NZp+FUHJS7Lp5XApRnq0zwl3XS+AoCSe6rR5DSr 2T1sdIwH2keErfBOTK7ZY3OOKRpa/uviAJoKvvMRD39dY/RRI40FWPEZFDU00rAQi5 IgfT9+C6fFYBvB8rx2NKGnaVGOneheEQRe0xDqBSuVZrYSVxxNMpb7N1N7bEYSk+S2 DONMJO30YZF+iZREk3xWDtRe52sBiBGqpeU3K5nkhmdghmPDFwKiLOdKe6t7sxvjV9 8xxrF6M4SnFRg== Date: Thu, 20 Jun 2024 01:25:20 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 09/10] man/keyctl.1: Improve formatting Message-ID: <20240619232444.36444-10-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> Signed-off-by: Alejandro Colomar --- man/keyctl.1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/man/keyctl.1 b/man/keyctl.1 index 59172d4..828223b 100644 --- a/man/keyctl.1 +++ b/man/keyctl.1 @@ -369,11 +369,11 @@ .SH KEY IDENTIFIERS helper to permit it to access the callers keyrings and instantiate the target key. .TP -Keyring by name: \fB%:\fR +Keyring by name: \f[B]%:\f[BI]name\f[R] A named keyring. This will be searched for in the process's keyrings and in .IR /proc/keys . .TP -Key by name: \fB%:\fR +Key by name: \f[B]%\f[BI]type\f[B]:\f[BI]name\f[R] A named key of the given type. This will be searched for in the process's keyrings and in .IR /proc/keys . From patchwork Wed Jun 19 23:25:24 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 13704725 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 24E3A762C1 for ; Wed, 19 Jun 2024 23:25:26 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839527; cv=none; b=pPwTswE8B0nOZOIFl+up2xgRNb+VoR0UMKe+C9Trml1Q/B6WxsA0iyw8EsQiviMSkTN3OfxAYFiMAlI3nDW4w5TIICBNalot7KCXGmKWu+SunO6TwCPhZHfUWpE0ryP5utoUpShppNf6zB+DV+nniAyP5QSkWhyfpacd2gtkM0A= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718839527; c=relaxed/simple; bh=zqmOG5dd4E6vCkadFjsSfUHiFU0o+C5c1x0SLOvpzlM=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=NZnGWzHlQlalZFcphwFm0i/HoWw4tal2kWxy4LcAzSbZ63kb0xrTpfz1H+XiGeHU15VCneTBOu14qUJV3e/u0t2I6smi8OQE+1KIZZp8eDIx1PSmIpC88NMvl1fTJlZ4D49Y+242GsuJ7mR05FNjRh+b2NIfW6aOsccRE+yHQU8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=oER3nZY+; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="oER3nZY+" Received: by smtp.kernel.org (Postfix) with ESMTPSA id E86FDC2BBFC; Wed, 19 Jun 2024 23:25:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1718839526; bh=zqmOG5dd4E6vCkadFjsSfUHiFU0o+C5c1x0SLOvpzlM=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=oER3nZY+otXFUzeq/5WigjYzPgD/1LKIK2j2zevz2bh7igMszO0lX8ZfbjTS9RhTM Z5MXtcshHG7lEJwhxJB7uBMSrdw/HvzDs4m1HMRzYIgNiOVcRIxzvjmgWCwgCAxlAW 0/bu/+Z7GBW1Flfz7RN22Qm2oxAKMyGk++vM7iRlX+Za8AB376yjb6Kj1/OIZLr6FY BAnIrhsbpW96phytGf87zgNBZDmDqptbQJavz/mfH8mr7Juc0fXOKmGAUu00a+WF6W HmrorQuTY9Q04OfP1CMhUoidZqzjoB1WU7RZyUPv0J9Z9JjzZt6uyyA7MXCMxcdOIO z9Sexs+ajHz6g== Date: Thu, 20 Jun 2024 01:25:24 +0200 From: Alejandro Colomar To: keyrings@vger.kernel.org, David Howells Cc: Alejandro Colomar Subject: [PATCH v1 10/10] man: Organize manual pages in subdirectories Message-ID: <20240619232444.36444-11-alx@kernel.org> X-Mailer: git-send-email 2.45.2 References: <20240619232444.36444-1-alx@kernel.org> Precedence: bulk X-Mailing-List: keyrings@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240619232444.36444-1-alx@kernel.org> Signed-off-by: Alejandro Colomar --- Makefile | 10 +++++----- man/{ => man1}/keyctl.1 | 0 man/{ => man3}/find_key_by_type_and_name.3 | 0 man/{ => man3}/keyctl.3 | 0 man/{ => man3}/keyctl_capabilities.3 | 0 man/{ => man3}/keyctl_chown.3 | 0 man/{ => man3}/keyctl_clear.3 | 0 man/{ => man3}/keyctl_describe.3 | 0 man/{ => man3}/keyctl_dh_compute.3 | 0 man/{ => man3}/keyctl_get_keyring_ID.3 | 0 man/{ => man3}/keyctl_get_persistent.3 | 0 man/{ => man3}/keyctl_get_security.3 | 0 man/{ => man3}/keyctl_instantiate.3 | 0 man/{ => man3}/keyctl_invalidate.3 | 0 man/{ => man3}/keyctl_join_session_keyring.3 | 0 man/{ => man3}/keyctl_link.3 | 0 man/{ => man3}/keyctl_move.3 | 0 man/{ => man3}/keyctl_pkey_decrypt.3 | 0 man/{ => man3}/keyctl_pkey_encrypt.3 | 0 man/{ => man3}/keyctl_pkey_query.3 | 0 man/{ => man3}/keyctl_pkey_sign.3 | 0 man/{ => man3}/keyctl_pkey_verify.3 | 0 man/{ => man3}/keyctl_read.3 | 0 man/{ => man3}/keyctl_restrict_keyring.3 | 0 man/{ => man3}/keyctl_revoke.3 | 0 man/{ => man3}/keyctl_search.3 | 0 man/{ => man3}/keyctl_session_to_parent.3 | 0 man/{ => man3}/keyctl_set_reqkey_keyring.3 | 0 man/{ => man3}/keyctl_set_timeout.3 | 0 man/{ => man3}/keyctl_setperm.3 | 0 man/{ => man3}/keyctl_update.3 | 0 man/{ => man3}/keyctl_watch_key.3 | 0 man/{ => man3}/recursive_key_scan.3 | 0 man/{ => man5}/key.dns_resolver.conf.5 | 0 man/{ => man5}/request-key.conf.5 | 0 man/{ => man7}/asymmetric-key.7 | 0 man/{ => man7}/keyutils.7 | 0 man/{ => man8}/key.dns_resolver.8 | 0 man/{ => man8}/request-key.8 | 0 39 files changed, 5 insertions(+), 5 deletions(-) rename man/{ => man1}/keyctl.1 (100%) rename man/{ => man3}/find_key_by_type_and_name.3 (100%) rename man/{ => man3}/keyctl.3 (100%) rename man/{ => man3}/keyctl_capabilities.3 (100%) rename man/{ => man3}/keyctl_chown.3 (100%) rename man/{ => man3}/keyctl_clear.3 (100%) rename man/{ => man3}/keyctl_describe.3 (100%) rename man/{ => man3}/keyctl_dh_compute.3 (100%) rename man/{ => man3}/keyctl_get_keyring_ID.3 (100%) rename man/{ => man3}/keyctl_get_persistent.3 (100%) rename man/{ => man3}/keyctl_get_security.3 (100%) rename man/{ => man3}/keyctl_instantiate.3 (100%) rename man/{ => man3}/keyctl_invalidate.3 (100%) rename man/{ => man3}/keyctl_join_session_keyring.3 (100%) rename man/{ => man3}/keyctl_link.3 (100%) rename man/{ => man3}/keyctl_move.3 (100%) rename man/{ => man3}/keyctl_pkey_decrypt.3 (100%) rename man/{ => man3}/keyctl_pkey_encrypt.3 (100%) rename man/{ => man3}/keyctl_pkey_query.3 (100%) rename man/{ => man3}/keyctl_pkey_sign.3 (100%) rename man/{ => man3}/keyctl_pkey_verify.3 (100%) rename man/{ => man3}/keyctl_read.3 (100%) rename man/{ => man3}/keyctl_restrict_keyring.3 (100%) rename man/{ => man3}/keyctl_revoke.3 (100%) rename man/{ => man3}/keyctl_search.3 (100%) rename man/{ => man3}/keyctl_session_to_parent.3 (100%) rename man/{ => man3}/keyctl_set_reqkey_keyring.3 (100%) rename man/{ => man3}/keyctl_set_timeout.3 (100%) rename man/{ => man3}/keyctl_setperm.3 (100%) rename man/{ => man3}/keyctl_update.3 (100%) rename man/{ => man3}/keyctl_watch_key.3 (100%) rename man/{ => man3}/recursive_key_scan.3 (100%) rename man/{ => man5}/key.dns_resolver.conf.5 (100%) rename man/{ => man5}/request-key.conf.5 (100%) rename man/{ => man7}/asymmetric-key.7 (100%) rename man/{ => man7}/keyutils.7 (100%) rename man/{ => man8}/key.dns_resolver.8 (100%) rename man/{ => man8}/request-key.8 (100%) diff --git a/Makefile b/Makefile index d8d4ee3..d8d058d 100644 --- a/Makefile +++ b/Makefile @@ -221,15 +221,15 @@ endif mkdir -p $(DESTDIR)$(ETCDIR)/request-key.d mkdir -p $(DESTDIR)$(ETCDIR)/keyutils mkdir -p $(DESTDIR)$(MAN1) - $(INSTALL) -m 0644 $(wildcard man/*.1) $(DESTDIR)$(MAN1) + $(INSTALL) -m 0644 $(wildcard man/man1/*.1) $(DESTDIR)$(MAN1) mkdir -p $(DESTDIR)$(MAN3) - $(INSTALL) -m 0644 $(wildcard man/*.3) $(DESTDIR)$(MAN3) + $(INSTALL) -m 0644 $(wildcard man/man3/*.3) $(DESTDIR)$(MAN3) mkdir -p $(DESTDIR)$(MAN5) - $(INSTALL) -m 0644 $(wildcard man/*.5) $(DESTDIR)$(MAN5) + $(INSTALL) -m 0644 $(wildcard man/man5/*.5) $(DESTDIR)$(MAN5) mkdir -p $(DESTDIR)$(MAN7) - $(INSTALL) -m 0644 $(wildcard man/*.7) $(DESTDIR)$(MAN7) + $(INSTALL) -m 0644 $(wildcard man/man7/*.7) $(DESTDIR)$(MAN7) mkdir -p $(DESTDIR)$(MAN8) - $(INSTALL) -m 0644 $(wildcard man/*.8) $(DESTDIR)$(MAN8) + $(INSTALL) -m 0644 $(wildcard man/man8/*.8) $(DESTDIR)$(MAN8) $(LNS) keyctl_describe.3 $(DESTDIR)$(MAN3)/keyctl_describe_alloc.3 $(LNS) keyctl_get_security.3 $(DESTDIR)$(MAN3)/keyctl_get_security_alloc.3 $(LNS) keyctl_instantiate.3 $(DESTDIR)$(MAN3)/keyctl_instantiate_iov.3 diff --git a/man/keyctl.1 b/man/man1/keyctl.1 similarity index 100% rename from man/keyctl.1 rename to man/man1/keyctl.1 diff --git a/man/find_key_by_type_and_name.3 b/man/man3/find_key_by_type_and_name.3 similarity index 100% rename from man/find_key_by_type_and_name.3 rename to man/man3/find_key_by_type_and_name.3 diff --git a/man/keyctl.3 b/man/man3/keyctl.3 similarity index 100% rename from man/keyctl.3 rename to man/man3/keyctl.3 diff --git a/man/keyctl_capabilities.3 b/man/man3/keyctl_capabilities.3 similarity index 100% rename from man/keyctl_capabilities.3 rename to man/man3/keyctl_capabilities.3 diff --git a/man/keyctl_chown.3 b/man/man3/keyctl_chown.3 similarity index 100% rename from man/keyctl_chown.3 rename to man/man3/keyctl_chown.3 diff --git a/man/keyctl_clear.3 b/man/man3/keyctl_clear.3 similarity index 100% rename from man/keyctl_clear.3 rename to man/man3/keyctl_clear.3 diff --git a/man/keyctl_describe.3 b/man/man3/keyctl_describe.3 similarity index 100% rename from man/keyctl_describe.3 rename to man/man3/keyctl_describe.3 diff --git a/man/keyctl_dh_compute.3 b/man/man3/keyctl_dh_compute.3 similarity index 100% rename from man/keyctl_dh_compute.3 rename to man/man3/keyctl_dh_compute.3 diff --git a/man/keyctl_get_keyring_ID.3 b/man/man3/keyctl_get_keyring_ID.3 similarity index 100% rename from man/keyctl_get_keyring_ID.3 rename to man/man3/keyctl_get_keyring_ID.3 diff --git a/man/keyctl_get_persistent.3 b/man/man3/keyctl_get_persistent.3 similarity index 100% rename from man/keyctl_get_persistent.3 rename to man/man3/keyctl_get_persistent.3 diff --git a/man/keyctl_get_security.3 b/man/man3/keyctl_get_security.3 similarity index 100% rename from man/keyctl_get_security.3 rename to man/man3/keyctl_get_security.3 diff --git a/man/keyctl_instantiate.3 b/man/man3/keyctl_instantiate.3 similarity index 100% rename from man/keyctl_instantiate.3 rename to man/man3/keyctl_instantiate.3 diff --git a/man/keyctl_invalidate.3 b/man/man3/keyctl_invalidate.3 similarity index 100% rename from man/keyctl_invalidate.3 rename to man/man3/keyctl_invalidate.3 diff --git a/man/keyctl_join_session_keyring.3 b/man/man3/keyctl_join_session_keyring.3 similarity index 100% rename from man/keyctl_join_session_keyring.3 rename to man/man3/keyctl_join_session_keyring.3 diff --git a/man/keyctl_link.3 b/man/man3/keyctl_link.3 similarity index 100% rename from man/keyctl_link.3 rename to man/man3/keyctl_link.3 diff --git a/man/keyctl_move.3 b/man/man3/keyctl_move.3 similarity index 100% rename from man/keyctl_move.3 rename to man/man3/keyctl_move.3 diff --git a/man/keyctl_pkey_decrypt.3 b/man/man3/keyctl_pkey_decrypt.3 similarity index 100% rename from man/keyctl_pkey_decrypt.3 rename to man/man3/keyctl_pkey_decrypt.3 diff --git a/man/keyctl_pkey_encrypt.3 b/man/man3/keyctl_pkey_encrypt.3 similarity index 100% rename from man/keyctl_pkey_encrypt.3 rename to man/man3/keyctl_pkey_encrypt.3 diff --git a/man/keyctl_pkey_query.3 b/man/man3/keyctl_pkey_query.3 similarity index 100% rename from man/keyctl_pkey_query.3 rename to man/man3/keyctl_pkey_query.3 diff --git a/man/keyctl_pkey_sign.3 b/man/man3/keyctl_pkey_sign.3 similarity index 100% rename from man/keyctl_pkey_sign.3 rename to man/man3/keyctl_pkey_sign.3 diff --git a/man/keyctl_pkey_verify.3 b/man/man3/keyctl_pkey_verify.3 similarity index 100% rename from man/keyctl_pkey_verify.3 rename to man/man3/keyctl_pkey_verify.3 diff --git a/man/keyctl_read.3 b/man/man3/keyctl_read.3 similarity index 100% rename from man/keyctl_read.3 rename to man/man3/keyctl_read.3 diff --git a/man/keyctl_restrict_keyring.3 b/man/man3/keyctl_restrict_keyring.3 similarity index 100% rename from man/keyctl_restrict_keyring.3 rename to man/man3/keyctl_restrict_keyring.3 diff --git a/man/keyctl_revoke.3 b/man/man3/keyctl_revoke.3 similarity index 100% rename from man/keyctl_revoke.3 rename to man/man3/keyctl_revoke.3 diff --git a/man/keyctl_search.3 b/man/man3/keyctl_search.3 similarity index 100% rename from man/keyctl_search.3 rename to man/man3/keyctl_search.3 diff --git a/man/keyctl_session_to_parent.3 b/man/man3/keyctl_session_to_parent.3 similarity index 100% rename from man/keyctl_session_to_parent.3 rename to man/man3/keyctl_session_to_parent.3 diff --git a/man/keyctl_set_reqkey_keyring.3 b/man/man3/keyctl_set_reqkey_keyring.3 similarity index 100% rename from man/keyctl_set_reqkey_keyring.3 rename to man/man3/keyctl_set_reqkey_keyring.3 diff --git a/man/keyctl_set_timeout.3 b/man/man3/keyctl_set_timeout.3 similarity index 100% rename from man/keyctl_set_timeout.3 rename to man/man3/keyctl_set_timeout.3 diff --git a/man/keyctl_setperm.3 b/man/man3/keyctl_setperm.3 similarity index 100% rename from man/keyctl_setperm.3 rename to man/man3/keyctl_setperm.3 diff --git a/man/keyctl_update.3 b/man/man3/keyctl_update.3 similarity index 100% rename from man/keyctl_update.3 rename to man/man3/keyctl_update.3 diff --git a/man/keyctl_watch_key.3 b/man/man3/keyctl_watch_key.3 similarity index 100% rename from man/keyctl_watch_key.3 rename to man/man3/keyctl_watch_key.3 diff --git a/man/recursive_key_scan.3 b/man/man3/recursive_key_scan.3 similarity index 100% rename from man/recursive_key_scan.3 rename to man/man3/recursive_key_scan.3 diff --git a/man/key.dns_resolver.conf.5 b/man/man5/key.dns_resolver.conf.5 similarity index 100% rename from man/key.dns_resolver.conf.5 rename to man/man5/key.dns_resolver.conf.5 diff --git a/man/request-key.conf.5 b/man/man5/request-key.conf.5 similarity index 100% rename from man/request-key.conf.5 rename to man/man5/request-key.conf.5 diff --git a/man/asymmetric-key.7 b/man/man7/asymmetric-key.7 similarity index 100% rename from man/asymmetric-key.7 rename to man/man7/asymmetric-key.7 diff --git a/man/keyutils.7 b/man/man7/keyutils.7 similarity index 100% rename from man/keyutils.7 rename to man/man7/keyutils.7 diff --git a/man/key.dns_resolver.8 b/man/man8/key.dns_resolver.8 similarity index 100% rename from man/key.dns_resolver.8 rename to man/man8/key.dns_resolver.8 diff --git a/man/request-key.8 b/man/man8/request-key.8 similarity index 100% rename from man/request-key.8 rename to man/man8/request-key.8