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