From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
To: Alejandro Colomar <alx.manpages@gmail.com>
Cc: linux-man@vger.kernel.org
Subject: [PATCH 2/9] ldconfig.8: Fix style nits
Date: Wed, 4 Jan 2023 01:38:51 -0600 [thread overview]
Message-ID: <20230104073851.h6kg265ev5v4gmjl@illithid> (raw)
[-- Attachment #1: Type: text/plain, Size: 5133 bytes --]
* Set `TH` page title in lowercase.
* In synopses, set ellipses as separate "operands" to better suggest
argument separation by white space.
* In synopses, prevent breaks within option brackets.
* Typeset ellipses more attractively on troff devices.
* Sort option flags in English lexicographic order.
* De-parenthesize content that seems important.
* Perform a Kemper notectomy. That is, stop saying "note that"
followed by some declarative statement. This trope is all over Unix
documentation and I even see it in ISO standards. The latter doesn't
serve to recommend it; as Dave Kemper has pointed out, everything we
put in technical documentation should be worthy of note unless placed
in a footnote, marked as "unnecessary on a first reading", or similar.
It is the exception, not the rule. If you feel the need to say "note
that", consider what adjacent material you shouldn't be saying at all.
* Say "symbolic link" instead of "symlink".
* When one sentence explains the previous, use a semicolon.
* Set literals used as arguments to `-c` option in bold, not italics.
* Place the modifier "only" more carefully.
* Recast option descriptions to be in the imperative mood.
* Recast file descriptions to use the paragraph tag as the subject of
the first sentence.
Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
---
man8/ldconfig.8 | 54 ++++++++++++++++++++++++-------------------------
1 file changed, 27 insertions(+), 27 deletions(-)
diff --git a/man8/ldconfig.8 b/man8/ldconfig.8
index 0e74c1791..2e54cfad4 100644
--- a/man8/ldconfig.8
+++ b/man8/ldconfig.8
@@ -5,7 +5,7 @@
.\"
.\" Modified, 6 May 2002, Michael Kerrisk, <mtk.manpages@gmail.com>
.\" 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
@@ -14,18 +14,18 @@ ldconfig \- configure dynamic linker run-time bindings
.\" --verbose, -V, --version, -?, --help, --usage
.B /sbin/ldconfig
.RB [ \-nNvXV ]
-.RB [ \-f
-.IR conf ]
-.RB [ \-C
+.RB [ \-C\~\c
.IR cache ]
-.RB [ \-r
+.RB [ \-f\~\c
+.IR conf ]
+.RB [ \-r\~\c
.IR root ]
-.IR directory ...
+.IR directory \~.\|.\|.
.PP
.B /sbin/ldconfig
.B \-l
.RB [ \-v ]
-.IR library ...
+.IR library \~.\|.\|.
.PP
.B /sbin/ldconfig
.B \-p
@@ -39,8 +39,8 @@ in the file
and in the trusted directories,
.I /lib
and
-.I /usr/lib
-(on some 64-bit architectures such as x86-64,
+.IR /usr/lib .
+On some 64-bit architectures such as x86-64,
.I /lib
and
.I /usr/lib
@@ -49,7 +49,7 @@ while
.I /lib64
and
.I /usr/lib64
-are used for 64-bit libraries).
+are used for 64-bit libraries.
.PP
The cache is used by the run-time linker,
.I ld.so
@@ -96,9 +96,8 @@ option.
should normally be run by the superuser as it may require write
permission on some root owned directories and files.
.PP
-Note that
.B \%ldconfig
-will only look at files that are named
+will look only at files that are named
.I lib*.so*
(for regular shared objects) or
.I ld\-*.so*
@@ -106,7 +105,7 @@ will only look at files that are named
Other files will be ignored.
Also,
.B \%ldconfig
-expects a certain pattern to how the symlinks are set up,
+expects a certain pattern to how the symbolic links are set up,
like this example,
where the middle file
.RB ( libfoo.so.1
@@ -127,18 +126,20 @@ after an upgrade.
.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
Use
@@ -161,13 +162,12 @@ Ignore auxiliary cache file.
.TP
.B \-l
(Since glibc 2.2)
-Library mode.
-Manually link individual libraries.
-Intended for use by experts only.
+Interpret each operand as a libary name and configure its links.
+Intended for use only by experts.
.TP
.B \-n
-Process only the directories specified on the command line.
-Don't process the trusted directories,
+Process only the directories specified on the command line;
+don't process the trusted directories,
nor those specified in
.IR /etc/ld.so.conf .
Implies
@@ -218,15 +218,15 @@ the cache is still rebuilt.
.PD 0
.TP
.I /lib/ld.so
-Run-time linker/loader.
+is the run-time linker/loader.
.TP
.I /etc/ld.so.conf
-File containing a list of directories,
+contains a list of directories,
one per line,
in which to search for libraries.
.TP
.I /etc/ld.so.cache
-File containing an ordered list of libraries found in the directories
+contains an ordered list of libraries found in the directories
specified in
.IR /etc/ld.so.conf ,
as well as those found in the trusted directories.
--
2.30.2
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next reply other threads:[~2023-01-04 7:38 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-04 7:38 G. Branden Robinson [this message]
2023-01-04 18:50 ` [PATCH 2/9] ldconfig.8: Fix style nits Alejandro Colomar
2023-01-04 20:04 ` G. Branden Robinson
2023-01-05 12:03 ` Alejandro Colomar
2023-01-05 12:35 ` G. Branden Robinson
2023-01-05 18:09 ` Alejandro Colomar
2023-01-06 0:29 ` Alejandro Colomar
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230104073851.h6kg265ev5v4gmjl@illithid \
--to=g.branden.robinson@gmail.com \
--cc=alx.manpages@gmail.com \
--cc=linux-man@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.