Re: [PATCH v3 03/13] ldconfig.8: ffix

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Branden,

On 1/5/23 23:52, G. Branden Robinson wrote:
* Set page topic in lowercase.
* Rewrite synopses to use groff man(7) `SY`/`YS` extension macros.
* Rewrite synopses to use man(7) font macros instead of *roff font
   selection escape sequences.
* In synopses, set ellipses as separate "operands" to better suggest
   argument separation by white space.

Please keep the ellipses as a separate one.  I want to discuss it separately.

Cheers,

Alex

* In synopses, prevent breaks within option brackets.
* Typeset ellipses more attractively on troff devices.
* Rewrite option list to use man(7) font macros instead of *roff font
   selection escape sequences.
* Use groff man(7) `TQ` extension macro to include multiple tags for
   options with long synonyms instead of comma notation.
* Set literals used as arguments to `-c` option in bold, not italics.

Signed-off-by: G. Branden Robinson <g.branden.robinson@xxxxxxxxx>
---
  man8/ldconfig.8 | 68 ++++++++++++++++++++++++++++++++-----------------
  1 file changed, 44 insertions(+), 24 deletions(-)

diff --git a/man8/ldconfig.8 b/man8/ldconfig.8
index cee0c7583..3460275ad 100644
--- a/man8/ldconfig.8
+++ b/man8/ldconfig.8
@@ -5,22 +5,30 @@
  .\"
  .\" Modified, 6 May 2002, Michael Kerrisk, <mtk.manpages@xxxxxxxxx>
  .\"   Change listed order of /usr/lib and /lib
-.TH LDCONFIG 8 (date) "Linux man-pages (unreleased)"
+.TH ldconfig 8 (date) "Linux man-pages (unreleased)"
  .SH NAME
  ldconfig \- configure dynamic linker run-time bindings
  .SH SYNOPSIS
-.PD 0
-.BR /sbin/ldconfig " [" \-nNvVX "] [" \-C " \fIcache\fP] [" \-f " \fIconf\fP] [" \-r " \fIroot\fP]"
-.IR directory ...
-.PP
-.B /sbin/ldconfig
+.SY /sbin/ldconfig
+.\" TODO?: -c, --format, -i, --ignore-aux-cache, --print-cache,
+.\" --verbose, -V, --version, -?, --help, --usage
+.RB [ \-nNvVX ]
+.RB [ \-C\~\c
+.IR cache ]
+.RB [ \-f\~\c
+.IR conf ]
+.RB [ \-r\~\c
+.IR root ]
+.IR directory \~.\|.\|.
+.YS
+.SY /sbin/ldconfig
  .B \-l
  .RB [ \-v ]
-.IR library ...
-.PP
-.B /sbin/ldconfig
+.IR library \~.\|.\|.
+.YS
+.SY /sbin/ldconfig
  .B \-p
-.PD
+.YS
  .SH DESCRIPTION
  .B \%ldconfig
  creates the necessary links and cache to the most recent shared
@@ -113,35 +121,41 @@ Failure to follow this pattern may result in compatibility issues
  after an upgrade.
  .SH OPTIONS
  .TP
-.BR \-c " \fIfmt\fP, " \-\-format=\fIfmt\fP
+.BI \-c\~ fmt
+.TQ
+.BI \-\-format= fmt
  (Since glibc 2.2)
  .\" commit 45eca4d141c047950db48c69c8941163d0a61fcd
-Cache format to use:
-.IR old ,
-.IR new ,
+Use cache format
+.IR fmt ,
+which is one of
+.BR old ,
+.BR new ,
  or
-.IR \%compat .
+.BR \%compat .
  Since glibc 2.32,
  the default is
-.IR new .
+.BR new .
  .\" commit cad64f778aced84efdaa04ae64f8737b86f063ab
  Before that,
  it was
-.IR \%compat .
+.BR \%compat .
  .TP
-.BI "\-C " cache
+.BI \-C\~ cache
  Use
  .I cache
  instead of
  .IR /etc/ld.so.cache .
  .TP
-.BI "\-f " conf
+.BI \-f\~ conf
  Use
  .I conf
  instead of
  .IR /etc/ld.so.conf .
  .TP
-.BR \-i ", " \-\-ignore\-aux\-cache
+.B \-i
+.TQ
+.B \-\-ignore\-aux\-cache
  (Since glibc 2.7)
  .\" commit 27d9ffda17df4d2388687afd12897774fde39bcc
  Ignore auxiliary cache file.
@@ -167,23 +181,29 @@ Unless
  is also specified,
  links are still updated.
  .TP
-.BR \-p ", " \-\-print\-cache
+.B \-p
+.TQ
+.B \-\-print\-cache
  Print the lists of directories and candidate libraries stored in
  the current cache.
  .TP
-.BI "\-r " root
+.BI \-r\~ root
  Change to and use
  .I root
  as the root directory.
  .TP
-.BR \-v ", " \-\-verbose
+.B \-v
+.TQ
+.B \-\-verbose
  Verbose mode.
  Print current version number,
  the name of each directory as it is scanned,
  and any links that are created.
  Overrides quiet mode.
  .TP
-.BR \-V ", " \-\-version
+.B \-V
+.TQ
+.B \-\-version
  Print program version.
  .TP
  .B \-X

--
<http://www.alejandro-colomar.es/>

Attachment: OpenPGP_signature
Description: OpenPGP digital signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux