diff options
author | Anthony J. Bentley <bentley@cvs.openbsd.org> | 2019-06-02 06:53:12 +0000 |
---|---|---|
committer | Anthony J. Bentley <bentley@cvs.openbsd.org> | 2019-06-02 06:53:12 +0000 |
commit | 802f885d01f6c3254766c03b08a59cf170ddfe8e (patch) | |
tree | cf77042f31f461357b83ba8362821d23096ee2f1 | |
parent | 998ea190075c8b3b256bd0cbd684948bc4773298 (diff) |
In manpages, don't escape apostrophes as \'; it's rarely what you want.
Most of these are correct just as '. A few benefit from Ql or \(aq.
But if in doubt, just use '.
-rw-r--r-- | bin/csh/csh.1 | 52 | ||||
-rw-r--r-- | sbin/ncheck_ffs/ncheck_ffs.8 | 6 | ||||
-rw-r--r-- | usr.bin/less/lesskey.1 | 6 | ||||
-rw-r--r-- | usr.bin/sort/sort.1 | 14 | ||||
-rw-r--r-- | usr.sbin/amd/amq/amq.8 | 8 |
5 files changed, 48 insertions, 38 deletions
diff --git a/bin/csh/csh.1 b/bin/csh/csh.1 index 79df89a7ba2..e1af22e543c 100644 --- a/bin/csh/csh.1 +++ b/bin/csh/csh.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: csh.1,v 1.80 2018/11/10 19:40:43 daniel Exp $ +.\" $OpenBSD: csh.1,v 1.81 2019/06/02 06:53:11 bentley Exp $ .\" $NetBSD: csh.1,v 1.10 1995/03/21 09:02:35 cgd Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -30,7 +30,7 @@ .\" .\" @(#)csh.1 8.2 (Berkeley) 1/21/94 .\" -.Dd $Mdocdate: November 10 2018 $ +.Dd $Mdocdate: June 2 2019 $ .Dt CSH 1 .Os .Sh NAME @@ -231,15 +231,15 @@ A newline preceded by a is equivalent to a blank. .Pp Strings enclosed in matched pairs of quotations, -.Ql ' , -.Ql ` , +.Ql \(aq , +.Ql \` , or .Ql \&" , form parts of a word; metacharacters in these strings, including blanks and tabs, do not form separate words. These quotations have semantics to be described later. Within pairs of -.Ql ' +.Ql \(aq or .Ql \&" characters, a newline preceded by a @@ -255,8 +255,8 @@ input line. This special meaning is prevented when preceded by .Ql \e and in quotations using -.Ql ` , -.Ql ' , +.Ql \` , +.Ql \(aq , and .Ql \&" . .Ss Commands @@ -807,15 +807,15 @@ while .Ic !la would look for a command starting with .Dq la . -.Ss Quotations with \' and \&" +.Ss Quotations with \(aq and \&" The quotation of strings by -.Ql ' +.Ql \(aq and .Ql \&" can be used to prevent all or some of the remaining substitutions. Strings enclosed in -.Ql ' +.Ql \(aq are prevented from any further interpretation. Strings enclosed in .Ql \&" @@ -827,7 +827,7 @@ only in one special case (see below) does a .Ql \&" quoted string yield parts of more than one word; -.Ql ' +.Ql \(aq quoted strings never do. .Ss Alias substitution The shell maintains a list of aliases that can be established, displayed @@ -920,13 +920,17 @@ This expansion can be prevented by preceding the with a .Ql \e except -within double quotes (`"'), where it +within double quotes +.Pq Ql \&" , +where it .Em always -occurs, and within single quotes (`''), where it +occurs, and within single quotes +.Pq Ql \(aq , +where it .Em never occurs. Strings quoted by backticks -.Pq ` ` +.Pq \` \` are interpreted later (see .Sx Command substitution below), so @@ -1089,11 +1093,13 @@ after input-output redirection is performed, and in a child of the main shell. .Ss Command substitution Command substitution is shown by a command enclosed in -.Ql ` . +.Ql \` . The output from such a command is normally broken into separate words at blanks, tabs, and newlines, with null words being discarded; this text then replaces the original string. -Within double quotes (`"'), only newlines force new words; +Within double quotes +.Pq Ql \&" , +only newlines force new words; blanks and tabs are preserved. .Pp In any case, the single final newline does not force a new word. @@ -1254,9 +1260,9 @@ before any substitutions are done on the input line. Unless a quoting .Ql \e , .Ql \&" , -.Ql ' +.Ql \(aq or -.Ql ` +.Ql \` appears in .Ar word , variable and command substitution is performed on the intervening lines, @@ -1266,7 +1272,7 @@ to quote .Ql $ , .Ql \e and -.Ql ` . +.Ql \` . Commands that are substituted have all blanks, tabs, and newlines preserved, except for the final newline which is dropped. The resultant text is placed in an anonymous temporary file that @@ -1697,7 +1703,7 @@ Execution continues after the specified line. .It Ic hashstat Print a statistics line showing how effective the internal hash table has been at locating commands (and avoiding -.Ic exec Ns \'s ) . +.Ic exec Ns 's ) . An .Ic exec is attempted for each component of the @@ -1953,7 +1959,7 @@ ignored. All processes detached with .Ql & are effectively -.Ic nohup Ns \'ed . +.Ic nohup Ns 'ed . .Pp .It Ic notify .It Ic notify % Ns Ar job ... @@ -1997,7 +2003,7 @@ Pops the directory stack, returning to the new top directory. With an argument .Dq + Ns Ar n discards the -.Ar n Ns \'th +.Ar n Ns 'th entry in the stack. The members of the directory stack are numbered from the top starting at 0. .Pp @@ -2020,7 +2026,7 @@ onto the directory stack. With a numeric argument, .Ic pushd rotates the -.Ar n Ns \'th +.Ar n Ns 'th argument of the directory stack around to be the top element and changes to it. The members diff --git a/sbin/ncheck_ffs/ncheck_ffs.8 b/sbin/ncheck_ffs/ncheck_ffs.8 index 3f165ab67f9..558d19c166b 100644 --- a/sbin/ncheck_ffs/ncheck_ffs.8 +++ b/sbin/ncheck_ffs/ncheck_ffs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ncheck_ffs.8,v 1.24 2015/11/23 16:34:00 jmc Exp $ +.\" $OpenBSD: ncheck_ffs.8,v 1.25 2019/06/02 06:53:11 bentley Exp $ .\" .\" Copyright (c) 1995, 1996 SigmaSoft, Th. Lockert <tholo@sigmasoft.com> .\" All rights reserved. @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: November 23 2015 $ +.Dd $Mdocdate: June 2 2019 $ .Dt NCHECK_FFS 8 .Os .Sh NAME @@ -98,7 +98,7 @@ character. Print a .Aq vertical tab character. -.It Cm \e\' +.It Cm \e\(aq Print a .Aq single quote character. diff --git a/usr.bin/less/lesskey.1 b/usr.bin/less/lesskey.1 index ce1d4e764e2..3fccdcea841 100644 --- a/usr.bin/less/lesskey.1 +++ b/usr.bin/less/lesskey.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lesskey.1,v 1.15 2015/11/23 12:56:13 tb Exp $ +.\" $OpenBSD: lesskey.1,v 1.16 2019/06/02 06:53:11 bentley Exp $ .\" .\" Copyright (C) 2000-2012 Mark Nudelman .\" @@ -22,7 +22,7 @@ .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.Dd $Mdocdate: November 23 2015 $ +.Dd $Mdocdate: June 2 2019 $ .Dt LESSKEY 1 .Os .Sh NAME @@ -277,7 +277,7 @@ N reverse-search \eeN reverse-search-all & filter m set-mark -\' goto-mark +\(aq goto-mark ^X^X goto-mark E examine :e examine diff --git a/usr.bin/sort/sort.1 b/usr.bin/sort/sort.1 index e02dcecc0cf..be8f73c993f 100644 --- a/usr.bin/sort/sort.1 +++ b/usr.bin/sort/sort.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sort.1,v 1.60 2019/05/15 09:07:46 schwarze Exp $ +.\" $OpenBSD: sort.1,v 1.61 2019/06/02 06:53:11 bentley Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -32,7 +32,7 @@ .\" .\" @(#)sort.1 8.1 (Berkeley) 6/6/93 .\" -.Dd $Mdocdate: May 15 2019 $ +.Dd $Mdocdate: June 2 2019 $ .Dt SORT 1 .Os .Sh NAME @@ -52,7 +52,9 @@ The .Nm utility sorts text and binary files by lines. A line is a record separated from the subsequent record by a -newline (default) or NUL \'\\0\' character +newline (default) or NUL +.Ql \e0 +character .Po .Fl z option @@ -278,12 +280,14 @@ delimit an empty field; further, the initial blank space considered part of a field when determining key offsets. To use NUL as field separator, use .Fl t -\'\\0\'. +\(aq\e0\(aq. .It Fl z , Fl Fl zero-terminated Use NUL as the record separator. By default, records in the files are expected to be separated by the newline characters. -With this option, NUL (\'\\0\') is used as the record separator character. +With this option, NUL +.Pq Ql \e0 +is used as the record separator character. .El .Pp Other options: diff --git a/usr.sbin/amd/amq/amq.8 b/usr.sbin/amd/amq/amq.8 index 4156522f185..4705368cc8f 100644 --- a/usr.sbin/amd/amq/amq.8 +++ b/usr.sbin/amd/amq/amq.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: amq.8,v 1.15 2017/08/22 17:08:43 schwarze Exp $ +.\" $OpenBSD: amq.8,v 1.16 2019/06/02 06:53:11 bentley Exp $ .\" .\" Copyright (c) 1990 Jan-Simon Pendry .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine @@ -34,7 +34,7 @@ .\" .\" from: @(#)amq.8 8.3 (Berkeley) 4/18/94 .\" -.Dd $Mdocdate: August 22 2017 $ +.Dd $Mdocdate: June 2 2019 $ .Dt AMQ 8 .Os .Sh NAME @@ -84,12 +84,12 @@ instead of providing information about them. Unmounts are requested, not forced. They merely cause the mounted filesystem to timeout, which will be picked up by -.Xr amd 8 Ns \'s +.Xr amd 8 Ns 's main scheduler thus causing the normal timeout action to be taken. .It Fl v Request the automounter to provide version information. This is a subset of the information provided by -.Xr amd 8 Ns \'s Fl v +.Xr amd 8 Ns 's Fl v option. .\".It Fl M .\"Request automounter to add the given map entry to the root map and then |