From eeea7a3f472dc11188c687e53ed0c3e8a33e64a3 Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Mon, 25 Nov 2024 14:16:02 +0100 Subject: [PATCH] man1/: SYNOPSIS: ffix Use SY/YS, and other formatting improvements. Signed-off-by: Alejandro Colomar --- man/man1/getent.1 | 8 +++++--- man/man1/iconv.1 | 9 +++++---- man/man1/ldd.1 | 7 ++++--- man/man1/locale.1 | 21 +++++++++++++++------ man/man1/localedef.1 | 2 +- man/man1/mansect.1 | 5 +++-- man/man1/memusage.1 | 8 +++++--- man/man1/memusagestat.1 | 8 +++++--- man/man1/mtrace.1 | 8 +++++--- man/man1/pdfman.1 | 3 ++- man/man1/pldd.1 | 10 ++++++---- man/man1/sprof.1 | 9 +++++---- man/man1/time.1 | 7 +++++-- 13 files changed, 66 insertions(+), 39 deletions(-) diff --git a/man/man1/getent.1 b/man/man1/getent.1 index 8efbbe51a4..f927be2b2f 100644 --- a/man/man1/getent.1 +++ b/man/man1/getent.1 @@ -7,9 +7,11 @@ .SH NAME getent \- get entries from Name Service Switch libraries .SH SYNOPSIS -.nf -.B getent [\fIoption\fP]... \fIdatabase\fP \fIkey\fP... -.fi +.SY getent +.RI [ option \~.\|.\|.\&] +.I database +.IR key \~.\|.\|. +.YS .SH DESCRIPTION The .B getent diff --git a/man/man1/iconv.1 b/man/man1/iconv.1 index eaa18c0f9e..b4a73d43ce 100644 --- a/man/man1/iconv.1 +++ b/man/man1/iconv.1 @@ -6,11 +6,12 @@ .SH NAME iconv \- convert text from one character encoding to another .SH SYNOPSIS -.B iconv +.SY iconv .RI [ options ] -.RI "[\-f " from-encoding "]" -.RI "[\-t " to-encoding "]" -.RI [ inputfile ]... +.RI [\f[B]\-f\f[]\~ from-encoding ] +.RI [\f[B]\-t\f[]\~ to-encoding ] +.RI [ inputfile \~.\|.\|.] +.YS .SH DESCRIPTION The .B iconv diff --git a/man/man1/ldd.1 b/man/man1/ldd.1 index 57e9b40ebe..3867358d28 100644 --- a/man/man1/ldd.1 +++ b/man/man1/ldd.1 @@ -12,9 +12,10 @@ .SH NAME ldd \- print shared object dependencies .SH SYNOPSIS -.nf -.BR ldd " [\fIoption\fP]... \fIfile\fP..." -.fi +.SY ldd +.RI [ option \~.\|.\|.\&] +.IR file \~.\|.\|. +.YS .SH DESCRIPTION .B ldd prints the shared objects (shared libraries) required by each program or diff --git a/man/man1/locale.1 b/man/man1/locale.1 index 5d6ab2b409..e32f940eeb 100644 --- a/man/man1/locale.1 +++ b/man/man1/locale.1 @@ -6,12 +6,21 @@ .SH NAME locale \- get locale-specific information .SH SYNOPSIS -.nf -.BR locale " [\fIoption\fP]" -.BR locale " [\fIoption\fP] " \-a -.BR locale " [\fIoption\fP] " \-m -.BR locale " [\fIoption\fP] \fIname\fP..." -.fi +.SY locale +.RI [ option ] +.YS +.SY locale +.RI [ option ] +.B \-a +.YS +.SY locale +.RI [ option ] +.B \-m +.YS +.SY locale +.RI [ option ] +.IR name \~.\|.\|. +.YS .SH DESCRIPTION The .B locale diff --git a/man/man1/localedef.1 b/man/man1/localedef.1 index 6a78770892..b4a87bfbac 100644 --- a/man/man1/localedef.1 +++ b/man/man1/localedef.1 @@ -28,7 +28,7 @@ localedef \- compile locale definition files .SY localedef .B \-\-delete\-from\-archive .RI [ options ] -.IR localename " ..." +.IR localename \~.\|.\|. .YS .SY localedef .B \-\-list\-archive diff --git a/man/man1/mansect.1 b/man/man1/mansect.1 index 4db22b06a8..1f1a989f68 100644 --- a/man/man1/mansect.1 +++ b/man/man1/mansect.1 @@ -8,9 +8,10 @@ mansect \- print the source code of sections of manual pages .SH SYNOPSIS -.B mansect +.SY mansect .I section -.RI [ file\~ .\|.\|.] +.RI [ file \~.\|.\|.] +.YS .SH DESCRIPTION The .B mansect diff --git a/man/man1/memusage.1 b/man/man1/memusage.1 index 304478da4e..e7570434a8 100644 --- a/man/man1/memusage.1 +++ b/man/man1/memusage.1 @@ -6,9 +6,11 @@ .SH NAME memusage \- profile memory usage of a program .SH SYNOPSIS -.nf -.BR memusage " [\fIoption\fR]... \fIprogram\fR [\fIprogramoption\fR]..." -.fi +.SY memusage +.RI [ option \~.\|.\|.\&] +.I program +.RI [ programoption \~.\|.\|.] +.YS .SH DESCRIPTION .B memusage is a diff --git a/man/man1/memusagestat.1 b/man/man1/memusagestat.1 index 4825ca67fd..c81afc6289 100644 --- a/man/man1/memusagestat.1 +++ b/man/man1/memusagestat.1 @@ -5,9 +5,11 @@ .SH NAME memusagestat \- generate graphic from memory profiling data .SH SYNOPSIS -.nf -.BR memusagestat " [\fIoption\fR]... \fIdatafile\fR [\fIoutfile\fR]" -.fi +.SY memusagestat +.RI [ option \~.\|.\|.\&] +.I datafile +.RI [ outfile ] +.YS .SH DESCRIPTION .B memusagestat creates a PNG file containing a graphical representation of the diff --git a/man/man1/mtrace.1 b/man/man1/mtrace.1 index 7b802837ae..ae74a516d0 100644 --- a/man/man1/mtrace.1 +++ b/man/man1/mtrace.1 @@ -5,9 +5,11 @@ .SH NAME mtrace \- interpret the malloc trace log .SH SYNOPSIS -.nf -.BR mtrace " [\fIoption\fR]... [\fIbinary\fR] \fImtracedata\fR" -.fi +.SY mtrace +.RI [ option \~.\|.\|.\&] +.RI [ binary ] +.I mtracedata +.YS .SH DESCRIPTION .B mtrace is a Perl script used to interpret and provide human readable output diff --git a/man/man1/pdfman.1 b/man/man1/pdfman.1 index f2203778c5..29537207aa 100644 --- a/man/man1/pdfman.1 +++ b/man/man1/pdfman.1 @@ -8,9 +8,10 @@ pdfman \- render a manual page in PDF .SH SYNOPSIS -.B pdfman +.SY pdfman .RI [ man-options ] .RI [ section ]\~ page +.YS .SH DESCRIPTION The .B pdfman diff --git a/man/man1/pldd.1 b/man/man1/pldd.1 index 3b374736a0..4722bdfea8 100644 --- a/man/man1/pldd.1 +++ b/man/man1/pldd.1 @@ -6,10 +6,12 @@ .SH NAME pldd \- display dynamic shared objects linked into a process .SH SYNOPSIS -.nf -.BI "pldd " "pid" -.BI pldd " option" -.fi +.SY pldd +.I pid +.YS +.SY pldd +.I option +.YS .SH DESCRIPTION The .B pldd diff --git a/man/man1/sprof.1 b/man/man1/sprof.1 index 2e4c98d56f..ab62187330 100644 --- a/man/man1/sprof.1 +++ b/man/man1/sprof.1 @@ -6,10 +6,11 @@ .SH NAME sprof \- read and display shared object profiling data .SH SYNOPSIS -.nf -.BR sprof " [\fIoption\fP]... \fIshared-object-path\fP \ -[\fIprofile-data-path\fP]" -.fi +.SY sprof +.RI [ option \~.\|.\|.\&] +.I shared-object-path +.RI [ profile-data-path ] +.YS .SH DESCRIPTION The .B sprof diff --git a/man/man1/time.1 b/man/man1/time.1 index 0e70fcc5ad..8ac463a3c7 100644 --- a/man/man1/time.1 +++ b/man/man1/time.1 @@ -8,8 +8,11 @@ .SH NAME time \- time a simple command or give resource usage .SH SYNOPSIS -.B time -.RI [ option \~.\|.\|.\&] " command " [ argument \~.\|.\|.] +.SY time +.RI [ option \~.\|.\|.\&] +.I command +.RI [ argument \~.\|.\|.] +.YS .SH DESCRIPTION The .B time -- 2.47.2