From e4e68f1123bbcaaf87a5bf5bdf25af9a8c8eda70 Mon Sep 17 00:00:00 2001 From: "Steinar H. Gunderson" Date: Tue, 24 Oct 2023 00:46:44 +0200 Subject: [PATCH] Fix all relevant instances of wrong hyphens in man pages. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Cf. https://lwn.net/Articles/947941/, not escaping - will change e.g. “plocate-build” to “plocate(Unicode dash)build”, which breaks cut-and-paste. We had this right most places, but not all. --- plocate-build.8 | 8 ++++---- plocate.1 | 16 ++++++++-------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/plocate-build.8 b/plocate-build.8 index 58bf473..00e3899 100644 --- a/plocate-build.8 +++ b/plocate-build.8 @@ -1,6 +1,6 @@ -.TH plocate-build 8 "Oct 2020" plocate-build +.TH plocate\-build 8 "Oct 2020" plocate\-build .SH NAME -plocate-build \- generate index for plocate +plocate\-build \- generate index for plocate .SH SYNOPSIS .B plocate-build @@ -9,7 +9,7 @@ plocate-build \- generate index for plocate .I "PLOCATE_DB" .SH DESCRIPTION -.B plocate-build +.B plocate\-build creates an index from .BR plocate (1) from an index earlier generated by @@ -70,4 +70,4 @@ Steinar H. Gunderson .SH SEE ALSO \fBplocate\fP(1), \fB/etc/cron.daily/plocate\fR (which is called -\fBupdate-plocate.sh\fR in the source distribution) +\fBupdate\-plocate.sh\fR in the source distribution) diff --git a/plocate.1 b/plocate.1 index 03ba56e..b70b148 100644 --- a/plocate.1 +++ b/plocate.1 @@ -14,7 +14,7 @@ of the patterns if multiple are given). It does this by means of an index made by .BR updatedb (8) or (less commonly) converted from another index by -.BR plocate-build (8). +.BR plocate\-build (8). plocate is largely argument-compatible with .BR mlocate (1), @@ -39,10 +39,10 @@ By default, patterns are taken to be substrings to search for. If at least one non-escaped globbing metacharacter (*, ? or []) is given, that pattern is instead taken to be a glob pattern (which means it needs to start and end in * for a substring match). If -.B --regexp +.B \-\-regexp is given, patterns are instead taken to be (non-anchored) POSIX basic regular expressions, and if -.B --regex +.B \-\-regex is given, patterns are taken to be POSIX extended regular expressions. All of this matches .BR mlocate (1) @@ -60,9 +60,9 @@ testing visibility as the calling user. .SH EXIT STATUS .B plocate exits with 0 to indicate that a match was found or that -.B --help +.B \-\-help or -.B --version +.B \-\-version were passed. Otherwise, .B plocate exits with status code 1, indicating that an error occurred or that no matches were found. @@ -127,7 +127,7 @@ Print entry names without quoting. Normally, .B plocate will escape special characters in filenames, so that they are safe for consumption by typical shells (similar to the GNU coreutils -.I shell-escape-always +.I shell\-escape\-always quoting style), unless printing to a pipe, but this options will turn off such quoting. @@ -156,7 +156,7 @@ regular expressions. .TP \fB\-w\fR, \fB\-\-wholename\fR Match against the entire path name. This is the default, -so unless \fB-b\fR is given first (see above), it will not do +so unless \fB\-b\fR is given first (see above), it will not do anything. This option thus exists only as compatibility with .BR mlocate (1). @@ -181,6 +181,6 @@ as for \fB\-\-database\fR. Steinar H. Gunderson .SH SEE ALSO -\fBplocate-build\fP(8), +\fBplocate\-build\fP(8), \fBmlocate\fP(1), \fBupdatedb\fP(8) -- 2.39.2