diff options
author | Anthony J. Bentley <bentley@cvs.openbsd.org> | 2014-11-15 14:41:04 +0000 |
---|---|---|
committer | Anthony J. Bentley <bentley@cvs.openbsd.org> | 2014-11-15 14:41:04 +0000 |
commit | d6a0f0865df6bfd123b8ce711276173f1d8cbaa9 (patch) | |
tree | e12333cdaea900019b1f35b2a5adc13985cd7802 /usr.bin | |
parent | 4a23754df430199a403e1215d9387e5b9e25b36f (diff) |
Reduce instances of `` '' in manuals.
troff displays these as typographic quotes, but nroff implementations
almost always print them literally, which rarely has the intended effect
with modern fonts, even in stock xterm.
These uses of `` '' can be replaced either with more semantic alternatives
or with Dq, which prints typographic quotes in a UTF-8 locale (but will
automatically fall back to `` '' in an ASCII locale).
improvements and ok schwarze@
Diffstat (limited to 'usr.bin')
-rw-r--r-- | usr.bin/chpass/chpass.1 | 8 | ||||
-rw-r--r-- | usr.bin/ftp/ftp.1 | 7 | ||||
-rw-r--r-- | usr.bin/hexdump/hexdump.1 | 8 | ||||
-rw-r--r-- | usr.bin/nl/nl.1 | 7 | ||||
-rw-r--r-- | usr.bin/ssh/sshd.8 | 12 | ||||
-rw-r--r-- | usr.bin/stat/stat.1 | 43 | ||||
-rw-r--r-- | usr.bin/telnet/telnet.1 | 114 | ||||
-rw-r--r-- | usr.bin/tset/tset.1 | 12 | ||||
-rw-r--r-- | usr.bin/w/w.1 | 11 | ||||
-rw-r--r-- | usr.bin/yacc/yyfix.1 | 9 |
10 files changed, 146 insertions, 85 deletions
diff --git a/usr.bin/chpass/chpass.1 b/usr.bin/chpass/chpass.1 index 9d923c5113a..56b204fbf41 100644 --- a/usr.bin/chpass/chpass.1 +++ b/usr.bin/chpass/chpass.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: chpass.1,v 1.39 2014/02/16 19:20:26 schwarze Exp $ +.\" $OpenBSD: chpass.1,v 1.40 2014/11/15 14:41:01 bentley Exp $ .\" $NetBSD: chpass.1,v 1.7 1996/05/15 21:50:40 jtc Exp $ .\" .\" Copyright (c) 1988, 1990, 1993 @@ -30,7 +30,7 @@ .\" .\" @(#)chpass.1 8.2 (Berkeley) 12/30/93 .\" -.Dd $Mdocdate: February 16 2014 $ +.Dd $Mdocdate: November 15 2014 $ .Dt CHPASS 1 .Os .Sh NAME @@ -166,7 +166,9 @@ Both the .Ar change and .Ar expire -fields should be entered in the form ``month day year'' where +fields should be entered in the form +.Ar month day year +where .Ar month is the month name (the first three characters are sufficient), .Ar day diff --git a/usr.bin/ftp/ftp.1 b/usr.bin/ftp/ftp.1 index 34338ef2db9..74a6b809063 100644 --- a/usr.bin/ftp/ftp.1 +++ b/usr.bin/ftp/ftp.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ftp.1,v 1.93 2014/07/11 03:31:52 lteo Exp $ +.\" $OpenBSD: ftp.1,v 1.94 2014/11/15 14:41:02 bentley Exp $ .\" $NetBSD: ftp.1,v 1.22 1997/08/18 10:20:22 lukem Exp $ .\" .\" Copyright (c) 1985, 1989, 1990, 1993 @@ -30,7 +30,7 @@ .\" .\" @(#)ftp.1 8.3 (Berkeley) 10/9/94 .\" -.Dd $Mdocdate: July 11 2014 $ +.Dd $Mdocdate: November 15 2014 $ .Dt FTP 1 .Os .Sh NAME @@ -273,7 +273,8 @@ Enables packet tracing. Set .Ar useragent as the User-Agent for HTTP(S) URL requests. -If not specified, the default User-Agent is ``OpenBSD ftp''. +If not specified, the default User-Agent is +.Dq OpenBSD ftp . .It Fl V Disable verbose mode, overriding the default of enabled when input is from a terminal. diff --git a/usr.bin/hexdump/hexdump.1 b/usr.bin/hexdump/hexdump.1 index 4f47bc55aa3..bffbc389a1b 100644 --- a/usr.bin/hexdump/hexdump.1 +++ b/usr.bin/hexdump/hexdump.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hexdump.1,v 1.24 2011/05/06 18:11:43 otto Exp $ +.\" $OpenBSD: hexdump.1,v 1.25 2014/11/15 14:41:02 bentley Exp $ .\" $NetBSD: hexdump.1,v 1.14 2001/12/07 14:46:24 bjh21 Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -30,7 +30,7 @@ .\" .\" from: @(#)hexdump.1 8.2 (Berkeley) 4/18/94 .\" -.Dd $Mdocdate: May 6 2011 $ +.Dd $Mdocdate: November 15 2014 $ .Dt HEXDUMP 1 .Os .Sh NAME @@ -64,7 +64,9 @@ in octal, per line. .Em Canonical hex+ASCII display . Display the input offset in hexadecimal, followed by sixteen space-separated, two column, hexadecimal bytes, followed by the -same sixteen bytes in %_p format enclosed in ``|'' characters. +same sixteen bytes in %_p format enclosed in +.Sq | +characters. .It Fl c .Em One-byte character display . Display the input offset in hexadecimal, followed by sixteen diff --git a/usr.bin/nl/nl.1 b/usr.bin/nl/nl.1 index bd981cbbe23..9913bf33e61 100644 --- a/usr.bin/nl/nl.1 +++ b/usr.bin/nl/nl.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: nl.1,v 1.7 2014/04/09 14:24:21 jmc Exp $ +.\" $OpenBSD: nl.1,v 1.8 2014/11/15 14:41:02 bentley Exp $ .\" $NetBSD: nl.1,v 1.14 2013/09/09 09:02:25 wiz Exp $ .\" .\" Copyright (c) 1999 The NetBSD Foundation, Inc. @@ -28,7 +28,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: April 9 2014 $ +.Dd $Mdocdate: November 15 2014 $ .Dt NL 1 .Os .Sh NAME @@ -115,7 +115,8 @@ At most two characters may be specified; if only one character is specified, the first character is replaced and the second character remains unchanged. The default .Ar delim -characters are ``\e:''. +characters are +.Sq \e: . .It Fl f Ar type Specify the same as .Fl b Ar type diff --git a/usr.bin/ssh/sshd.8 b/usr.bin/ssh/sshd.8 index be23cfb7f68..d947882e216 100644 --- a/usr.bin/ssh/sshd.8 +++ b/usr.bin/ssh/sshd.8 @@ -33,8 +33,8 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: sshd.8,v 1.277 2014/08/30 15:33:50 sobrado Exp $ -.Dd $Mdocdate: August 30 2014 $ +.\" $OpenBSD: sshd.8,v 1.278 2014/11/15 14:41:03 bentley Exp $ +.Dd $Mdocdate: November 15 2014 $ .Dt SSHD 8 .Os .Sh NAME @@ -577,10 +577,10 @@ Disables execution of Forbids X11 forwarding when this key is used for authentication. Any X11 forward requests by the client will return an error. .It Cm permitopen="host:port" -Limit local -.Li ``ssh -L'' -port forwarding such that it may only connect to the specified host and -port. +Limit local port forwarding with +.Xr ssh 1 +.Fl L +such that it may only connect to the specified host and port. IPv6 addresses can be specified by enclosing the address in square brackets. Multiple .Cm permitopen diff --git a/usr.bin/stat/stat.1 b/usr.bin/stat/stat.1 index 9035b72d0e9..94b9172f39f 100644 --- a/usr.bin/stat/stat.1 +++ b/usr.bin/stat/stat.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: stat.1,v 1.21 2013/07/16 00:07:52 schwarze Exp $ +.\" $OpenBSD: stat.1,v 1.22 2014/11/15 14:41:02 bentley Exp $ .\" $NetBSD: stat.1,v 1.11 2003/05/08 13:07:10 wiz Exp $ .\" .\" Copyright (c) 2002 The NetBSD Foundation, Inc. @@ -28,7 +28,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: July 16 2013 $ +.Dd $Mdocdate: November 15 2014 $ .Dt STAT 1 .Os .Sh NAME @@ -124,7 +124,7 @@ That is, for all the fields in the stat-structure, display the raw, numerical value (for example, times in seconds since the Epoch, etc.). .It Fl s -Display information in ``shell output'', suitable for initializing variables. +Format the output as a line of shell variable assignments. .It Fl t Ar timefmt Display timestamps using the specified format. This format is @@ -158,7 +158,9 @@ Any of the following optional flags: .It Cm # Selects an alternate output form for octal and hexadecimal output. Non-zero octal output will have a leading zero, and non-zero -hexadecimal output will have ``0x'' prepended to it. +hexadecimal output will have +.Sq 0x +prepended to it. .It Cm + Asserts that a sign indicating whether a number is positive or negative should always be printed. @@ -232,7 +234,9 @@ Displays the name of Displays the type of .Ar file . .It Cm Y -Insert a `` -\*(Gt '' into the output. +Insert a +.Dq "\ ->\ " +into the output. Note that the default output format for .Cm Y @@ -252,24 +256,24 @@ output formats. It can be one of the following: .Bl -tag -width Ds .It Cm H -``High'' -- specifies the major number for devices from +High -- specifies the major number for devices from .Cm r or .Cm d , -the ``user'' bits for permissions from the string form of +the user bits for permissions from the string form of .Cm p , -the file ``type'' bits from the numeric forms of +the file type bits from the numeric forms of .Cm p , and the long output form of .Cm T . .It Cm L -``Low'' -- specifies the minor number for devices from +Low -- specifies the minor number for devices from .Cm r or .Cm d , -the ``other'' bits for permissions from the string form of +the other bits for permissions from the string form of .Cm p , -the ``user'', ``group'', and ``other'' bits from the numeric forms of +the user, group, and other bits from the numeric forms of .Cm p , and the .Ic ls -F @@ -279,10 +283,11 @@ style output character for file type when used with .Cm L for this is optional). .It Cm M -``Middle'' -- specifies the ``group'' bits for permissions from the +Middle -- specifies the group bits for permissions from the string output form of .Cm p , -or the ``suid'', ``sgid'', and ``sticky'' bits for the numeric forms of +or the +suid, sgid, and sticky bits for the numeric forms of .Cm p . .El .It Cm datum @@ -354,7 +359,9 @@ is given. .It Cm Y The target of a symbolic link. .It Cm Z -Expands to ``major,minor'' from the rdev field for character or block +Expands to +.Ar major , Ns Ar minor +from the rdev field for character or block special devices and gives size output for all others. .El .El @@ -383,7 +390,13 @@ which default to .Sh EXIT STATUS .Ex -std stat .Sh EXAMPLES -Given a symbolic link ``foo'' that points from /tmp/foo to /, you would use +Given a symbolic link +.Pa foo +that points from +.Pa /tmp/foo +to +.Pa / , +you would use .Nm as follows: .Bd -literal -offset indent diff --git a/usr.bin/telnet/telnet.1 b/usr.bin/telnet/telnet.1 index ae4b830b03b..d0c514f8692 100644 --- a/usr.bin/telnet/telnet.1 +++ b/usr.bin/telnet/telnet.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: telnet.1,v 1.53 2014/08/10 02:41:41 guenther Exp $ +.\" $OpenBSD: telnet.1,v 1.54 2014/11/15 14:41:02 bentley Exp $ .\" $NetBSD: telnet.1,v 1.5 1996/02/28 21:04:12 thorpej Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -30,7 +30,7 @@ .\" .\" from: @(#)telnet.1 8.4 (Berkeley) 2/3/94 .\" -.Dd $Mdocdate: August 10 2014 $ +.Dd $Mdocdate: November 15 2014 $ .Dt TELNET 1 .Os .Sh NAME @@ -105,7 +105,9 @@ Uses .Xr bind 2 on the local socket to bind it to an aliased address (see .Xr ifconfig 8 -and the ``alias'' specifier) or to the address of +and the +.Cm alias +specifier) or to the address of another interface than the one naturally chosen by .Xr connect 2 . This can be useful when connecting to services which use IP addresses @@ -203,8 +205,10 @@ option. If this fails, .Nm will revert to one of two input modes: -either ``character at a time'' -or ``old line by line'' +either +.Dq character at a time +or +.Dq old line by line depending on what the remote system supports. .Pp When @@ -218,12 +222,18 @@ The remote system will also relay changes to any special characters that happen on the remote system, so that they can take effect on the local system. .Pp -In ``character at a time'' mode, most +In +.Dq character at a time +mode, most text typed is immediately sent to the remote host for processing. .Pp -In ``old line by line'' mode, all text is echoed locally, +In +.Dq old line by line +mode, all text is echoed locally, and (normally) only completed lines are sent to the remote host. -The ``local echo character'' (initially ``^E'') may be used +The local echo character +.Pq initially Sq ^E +may be used to turn off and on the local echo (this would mostly be used to enter passwords without the password being echoed). @@ -234,7 +244,9 @@ option is enabled, or if the .Ic localchars toggle is .Dv TRUE -(the default for ``old line by line''; see below), +(the default for +.Dq old line by line ; +see below), the user's .Ic quit , .Ic intr , @@ -273,7 +285,8 @@ While connected to a remote host, .Nm command mode may be entered by typing the .Nm -``escape character'' (initially ``^]''). +escape character +.Pq initially Sq ^] . When in command mode, the normal terminal editing conventions are available. Note that the escape character will return to the command mode of the initial invocation of @@ -397,13 +410,17 @@ Disable the .Dv TELNET LINEMODE option, or, if the remote side does not understand the .Dv LINEMODE -option, then enter ``character at a time'' mode. +option, then enter +.Dq character at a time +mode. .It Ic line Enable the .Dv TELNET LINEMODE option, or, if the remote side does not understand the .Dv LINEMODE -option, then attempt to enter ``old-line-by-line'' mode. +option, then attempt to enter +.Dq old line by line +mode. .It Ic isig Pq Ic \-isig Attempt to enable (disable) the .Dv TRAPSIG @@ -460,7 +477,9 @@ is specified, will attempt to contact a TELNET server at the default port. The host specification may be either a host name (see .Xr hosts 5 ) -or an Internet address specified in the ``dot notation'' (see +or an Internet address specified in the +.Dq dot notation +(see .Xr inet_ntop 3 ) . The .Fl a , @@ -478,8 +497,9 @@ After establishing a connection, the file .Pa \&.telnetrc in the user's home directory is opened. -Lines beginning with a ``#'' are -comment lines. +Lines beginning with a +.Sq # +are comment lines. Blank lines are ignored. Lines that begin without whitespace are the start of a machine entry. @@ -551,7 +571,8 @@ sequence. .It Ic escape Sends the current .Nm -escape character (initially ``^]''). +escape character +.Pq initially Sq ^] . .It Ic ga Sends the .Dv TELNET GA @@ -589,7 +610,9 @@ This sequence is sent as TCP urgent data (and may not work if the remote system is a .Bx 4.2 system -- if -it doesn't work, a lower case ``r'' may be echoed on the terminal). +it doesn't work, a lower case +.Sq r +may be echoed on the terminal). .It Ic do Ar cmd Sends the .Dv TELNET DO @@ -702,8 +725,11 @@ remote host. The initial value for the "Are You There" character is the terminal's status character. .It Ic echo -This is the value (initially ``^E'') which, when in -``line by line'' mode, toggles between doing local echoing +This is the value +.Pq initially Sq ^E +which, when in +.Dq line by line +mode, toggles between doing local echoing of entered characters (for normal processing), and suppressing echoing of entered characters (for entering, say, a password). .It Ic eof @@ -711,7 +737,9 @@ If .Nm is operating in .Dv LINEMODE -or ``old line by line'' mode, entering this character +or +.Dq old line by line +mode, entering this character as the first character on a line will cause this character to be sent to the remote system. The initial value of the @@ -730,8 +758,9 @@ mode (see below), and if .Nm -is operating in ``character at a time'' mode, then when this -character is typed, a +is operating in +.Dq character at a time +mode, then when this character is typed, a .Dv TELNET EC sequence (see .Ic send @@ -747,8 +776,9 @@ character. .It Ic escape This is the .Nm -escape character (initially ``^['') which causes entry -into +escape character +.Pq initially Sq ^[ +which causes entry into .Nm command mode (when connected to a remote system). .It Ic flushoutput @@ -820,8 +850,9 @@ mode (see below), and if .Nm -is operating in ``character at a time'' mode, then when this -character is typed, a +is operating in +.Dq character at a time +mode, then when this character is typed, a .Dv TELNET EL sequence (see .Ic send @@ -839,8 +870,9 @@ If .Nm is operating in .Dv LINEMODE -or ``old line by line'' mode, then this character is taken to -be the terminal's +or +.Dq old line by line +mode, then this character is taken to be the terminal's .Ic lnext character. The initial value for the @@ -878,8 +910,9 @@ If .Nm is operating in .Dv LINEMODE -or ``old line by line'' mode, then this character is taken to -be the terminal's +or +.Dq old line by line +mode, then this character is taken to be the terminal's .Ic reprint character. The initial value for the @@ -968,8 +1001,9 @@ If .Nm is operating in .Dv LINEMODE -or ``old line by line'' mode, then this character is taken to -be the terminal's +or +.Dq old line by line +mode, then this character is taken to be the terminal's .Ic worderase character. The initial value for the @@ -1187,10 +1221,13 @@ see above). The initial value for this toggle is .Dv TRUE -in ``old line by line'' mode, -and +in +.Dq old line by line +mode, and .Dv FALSE -in ``character at a time'' mode. +in +.Dq character at a time +mode. When the .Dv LINEMODE option is enabled, the value of @@ -1303,9 +1340,12 @@ command appeared in .Bx 4.2 . .Sh NOTES On some remote systems, echo has to be turned off manually when in -``old line by line'' mode. +.Dq old line by line +mode. .Pp -In ``old line by line'' mode or +In +.Dq old line by line +mode or .Dv LINEMODE the terminal's .Ic eof diff --git a/usr.bin/tset/tset.1 b/usr.bin/tset/tset.1 index 5cfdf4ed448..130a9344229 100644 --- a/usr.bin/tset/tset.1 +++ b/usr.bin/tset/tset.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tset.1,v 1.19 2013/09/18 16:21:30 millert Exp $ +.\" $OpenBSD: tset.1,v 1.20 2014/11/15 14:41:02 bentley Exp $ .\" .\" Copyright (c) 1985, 1990, 1993 .\" The Regents of the University of California. All rights reserved. @@ -29,7 +29,7 @@ .\" .\" @(#)tset.1 8.1 (Berkeley) 6/9/93 .\" -.Dd $Mdocdate: September 18 2013 $ +.Dd $Mdocdate: November 15 2014 $ .Dt TSET 1 .Os .Sh NAME @@ -244,9 +244,11 @@ option is to .Dq map from some set of conditions to a terminal type, that is, to tell -.Nm tset -``If I'm on this port at a particular speed, guess that I'm on that -kind of terminal''. +.Nm tset : +.Do +If I'm on this port at a particular speed, guess that I'm on that +kind of terminal +.Dc . .Pp The argument to the .Fl m diff --git a/usr.bin/w/w.1 b/usr.bin/w/w.1 index ac42c3fd192..f8e7b4a4cf2 100644 --- a/usr.bin/w/w.1 +++ b/usr.bin/w/w.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: w.1,v 1.20 2013/08/14 06:32:30 jmc Exp $ +.\" $OpenBSD: w.1,v 1.21 2014/11/15 14:41:01 bentley Exp $ .\" .\" Copyright (c) 1980, 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -29,7 +29,7 @@ .\" .\" @(#)w.1 8.1 (Berkeley) 6/6/93 .\" -.Dd $Mdocdate: August 14 2013 $ +.Dd $Mdocdate: November 15 2014 $ .Dt W 1 .Os .Sh NAME @@ -107,10 +107,9 @@ command appeared in The notion of the .Dq current process is muddy. -The current algorithm is -``the highest numbered process on the terminal -that is not ignoring interrupts, or, if there is none, the highest numbered -process on the terminal.'' +Currently, the highest numbered process on the terminal that is not ignoring +interrupts is used, or, if there is none, the highest numbered process on the +terminal. This fails, for example, in critical sections of programs like the shell and editor, or when faulty programs running in the background fork and fail to ignore interrupts. diff --git a/usr.bin/yacc/yyfix.1 b/usr.bin/yacc/yyfix.1 index ce74903e849..eff435ae441 100644 --- a/usr.bin/yacc/yyfix.1 +++ b/usr.bin/yacc/yyfix.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: yyfix.1,v 1.5 2014/01/20 05:07:48 schwarze Exp $ +.\" $OpenBSD: yyfix.1,v 1.6 2014/11/15 14:41:02 bentley Exp $ .\" Copyright (c) 1990, 1991 The Regents of the University of California. .\" All rights reserved. .\" @@ -28,7 +28,7 @@ .\" .\" from: @(#)yyfix.1 5.4 (Berkeley) 3/23/93 .\" -.Dd $Mdocdate: January 20 2014 $ +.Dd $Mdocdate: November 15 2014 $ .Dt YYFIX 1 .Os .Sh NAME @@ -39,8 +39,9 @@ .Ar file .Op Ar tables .Sh DESCRIPTION -Programs have historically used a script (often named ``:yyfix'') to -extract tables from the +Programs have historically used a script (often named +.Pa :yyfix ) +to extract tables from the .Xr yacc 1 generated file .Pa y.tab.c . |