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)