[v1,07/10] man: Add SYNOPSYS section

Commit Message

Alejandro Colomar June 19, 2024, 11:25 p.m. UTC

This is a simpler and more standard way of documenting the header that
provides these functions.

Signed-off-by: Alejandro Colomar <[e-mail]>
---
 man/keyctl.3   | 12 +++++-------
 man/keyutils.7 | 12 +++++-------
 2 files changed, 10 insertions(+), 14 deletions(-)

Patch

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 <keyutils.h>
+.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 <keyutils.h>
-.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 <keyutils.h>
+.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 <keyutils.h>
-.RE
-.P
 Three system calls are provided:
 .TP
 .BR add_key (2)