Skip to contentSkip to conversation

Use proper grave accent character

PATCH In review sebastien peterson boudreau 3 participants 8 messages Apr 18 – Jun 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Use proper grave accent character

---
 src/dash.1 | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
src/dash.1 +3 -3
index dbc34c9..f651a03 100644
@@ -293,12 +293,12 @@ Enclosing characters within double quotes preserves the literal
 meaning of all characters except dollarsign
 .Pq $ ,
 backquote
-.Pq ` ,
+.Pq \(ga ,
 and backslash
 .Pq \e .
 The backslash inside double quotes is historically weird, and serves to
 quote only the following characters:
-.Dl $  `  \*q  \e  \*[Lt]newline\*[Gt] .
+.Dl $  \(ga  \*q  \e  \*[Lt]newline\*[Gt] .
 Otherwise it remains literal.
 .Ss Reserved Words
 Reserved words are words that have special meaning to the
@@ -983,7 +983,7 @@ or
 version
 .Pc :
 .Pp
-.Dl `command`
+.Dl \(gacommand\(ga
 .Pp
 The shell expands the command substitution by executing command in a
 subshell environment and replacing the command substitution with the
Signature · 1 line
2.53.0
#1 lore raw
Quoted 9 lines · sebastien peterson boudreau

---
src/dash.1 | 6 +++---

1 file changed, 3 insertions(+), 3 deletions(-)
src/dash.1 +0 -0
index dbc34c9..f651a03 100644
@@ -293,12 +293,12 @@ Enclosing characters within double quotes preserves the literal
Quoted 5 lines

meaning of all characters except dollarsign
.Pq $ ,
backquote
-.Pq ` ,
+.Pq \(ga ,

Sorry could you please explain why this makes any difference because they look identical to my untrained eye.

This explanation should also go into the patch description.

Thanks,

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
#2 lore raw
Quoted 2 lines

Sorry could you please explain why this makes any difference because they look identical to my untrained eye.

No worries! In the troff(7)* language, the character ` becomes a left quotation on typesetters supporting it, and ' becomes a right quotation.

IOW, if your terminal supports unicode (along with a few other variables),

command

in the input code can end up being displayed as

‘command‘

which is not the input the shell expects!
The way to typeset the character is with either the \ escape sequence or the \(ga character -- both should be portable across different *roff's according to groff_char(7), so I opted for the latter.

Hope this clarifies :)
---
* manual page might be groff(7) on your system.

Signature · 1 line
S.
#3 lore raw
Quoted 10 lines · Sebastien Peterson-Boudreau
Quoted 2 lines

Sorry could you please explain why this makes any difference because they look identical to my untrained eye.

No worries! In the troff(7)* language, the character ` becomes a left quotation on typesetters supporting it, and ' becomes a right quotation.

IOW, if your terminal supports unicode (along with a few other variables),

command

Quoted 8 lines

in the input code can end up being displayed as

‘command‘

which is not the input the shell expects!
The way to typeset the character is with either the \ escape sequence or the \(ga character -- both should be portable across different *roff's according to groff_char(7), so I opted for the latter.

Thanks for the explanation. Please repost the patch with this explanation included in the description.

Cheers,

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
#4 lore raw

PATCH 1/1 Use literal > and < characters

\*[...] is groff(1) specific syntax, whereas \*(XX is the standard troff(1) syntax. Furthermore, groff_mdoc(1) lists the literal characters >' and <' as preferred over the Gt and Lt strings, which are only defined for compatibility with legacy documents. NetBSD also uses the literal characters for their sh(1) manual page (changed in commit 30b9dfc8813e15031a13fc2fc85094b81c71e2b7).
---

Quoted 2 lines

Everything looks good except that your emails has no Subject and so it's been discarded by patchwork:

Oops! Seems like I handled my gpg key fine, but goobered mail client config. Crossing my fingers this time...

 src/dash.1 | 58 +++++++++++++++++++++++++++---------------------------
 1 file changed, 29 insertions(+), 29 deletions(-)
src/dash.1 +29 -29
index dbc34c9..8e1306f 100644
@@ -197,7 +197,7 @@ operand and the positional parameters ($1, $2, etc.)
 set from the remaining argument operands.
 .It Fl C Em noclobber
 Don't overwrite existing files with
-.Dq \*[Gt] .
+.Dq > .
 .It Fl e Em errexit
 If not interactive, exit immediately if any untested command fails.
 The exit status of a command is considered to be
@@ -268,9 +268,9 @@ operators (their meaning is discussed later).
 Following is a list of operators:
 .Bl -ohang -offset indent
 .It "Control operators:"
-.Dl &  &&  \&(  \&)  \&;  ;; | || \*[Lt]newline\*[Gt]
+.Dl &  &&  \&(  \&)  \&;  ;; | || <newline>
 .It "Redirection operators:"
-.Dl \*[Lt]  \*[Gt]  \*[Gt]|  \*[Lt]\*[Lt]  \*[Gt]\*[Gt]  \*[Lt]&  \*[Gt]&  \*[Lt]\*[Lt]-  \*[Lt]\*[Gt]
+.Dl <  >  >|  <<  >>  <&  >&  <<-  <>
 .El
 .Ss Quoting
 Quoting is used to remove the special meaning of certain characters or
@@ -298,7 +298,7 @@ and backslash
 .Pq \e .
 The backslash inside double quotes is historically weird, and serves to
 quote only the following characters:
-.Dl $  `  \*q  \e  \*[Lt]newline\*[Gt] .
+.Dl $  `  \*q  \e  <newline> .
 Otherwise it remains literal.
 .Ss Reserved Words
 Reserved words are words that have special meaning to the
@@ -391,25 +391,25 @@ is an optional number between 0 and 9, as in
 .Sq Bq 3 ) ,
 that refers to a file descriptor.
 .Bl -tag -width aaabsfiles -offset indent
-.It [n] Ns \*[Gt] file
+.It [n] Ns > file
 Redirect standard output (or n) to file.
-.It [n] Ns \*[Gt]| file
+.It [n] Ns >| file
 Same, but override the
 .Fl C
 option.
-.It [n] Ns \*[Gt]\*[Gt] file
+.It [n] Ns >> file
 Append standard output (or n) to file.
-.It [n] Ns \*[Lt] file
+.It [n] Ns < file
 Redirect standard input (or n) from file.
-.It [n1] Ns \*[Lt]& Ns n2
+.It [n1] Ns <& Ns n2
 Copy file descriptor n2 as stdin (or fd n1).
-.It [n] Ns \*[Lt]&-
+.It [n] Ns <&-
 Close standard input (or n).
-.It [n1] Ns \*[Gt]& Ns n2
+.It [n1] Ns >& Ns n2
 Copy file descriptor n2 as stdout (or fd n1).
-.It [n] Ns \*[Gt]&-
+.It [n] Ns >&-
 Close standard output (or n).
-.It [n] Ns \*[Lt]\*[Gt] file
+.It [n] Ns <> file
 Open file for reading and writing on standard input (or n).
 .El
 .Pp
@@ -417,7 +417,7 @@ The following redirection is often called a
 .Dq here-document .
 .Bl -item -offset indent
 .It
-.Li [n]\*[Lt]\*[Lt] delimiter
+.Li [n]<< delimiter
 .Dl here-doc-text ...
 .Li delimiter
 .El
@@ -431,9 +431,9 @@ subjected to parameter expansion, command substitution, and arithmetic
 expansion (as described in the section on
 .Dq Expansions ) .
 If the operator is
-.Dq \*[Lt]\*[Lt]-
+.Dq <<-
 instead of
-.Dq \*[Lt]\*[Lt] ,
+.Dq << ,
 then leading tabs in the here-doc-text are stripped.
 .Ss Search and Execution
 There are three types of commands: shell functions, builtin commands, and
@@ -567,7 +567,7 @@ Because pipeline assignment of standard input or standard output or both
 takes place before redirection, it can be modified by redirection.
 For example:
 .Pp
-.Dl $ command1 2\*[Gt]&1 | command2
+.Dl $ command1 2>&1 | command2
 .Pp
 sends both the standard output and standard error of command1
 to the standard input of command2.
@@ -698,7 +698,7 @@ Grouping commands together this way allows you to redirect
 their output as though they were one program:
 .\".Pp
 .Bd -literal -offset indent
-{ printf \*q hello \*q ; printf \*q world\\n" ; } \*[Gt] greeting
+{ printf \*q hello \*q ; printf \*q world\\n" ; } > greeting
 .Ed
 .Pp
 Note that
@@ -764,7 +764,7 @@ numeric.
 A parameter can also be denoted by a number or a special
 character as explained below.
 .Ss Positional Parameters
-A positional parameter is a parameter denoted by a number (n \*[Gt] 0).
+A positional parameter is a parameter denoted by a number (n > 0).
 The shell sets these initially to the values of its command line arguments
 that follow the name of the shell script.
 The
@@ -1627,19 +1627,19 @@ Character escape sequences are in backslash notation as defined in
 The characters and their meanings are as follows:
 .Bl -tag -width Ds -offset indent
 .It Cm \ea
-Write a \*[Lt]bell\*[Gt] character.
+Write a <bell> character.
 .It Cm \eb
-Write a \*[Lt]backspace\*[Gt] character.
+Write a <backspace> character.
 .It Cm \ef
-Write a \*[Lt]form-feed\*[Gt] character.
+Write a <form-feed> character.
 .It Cm \en
-Write a \*[Lt]new-line\*[Gt] character.
+Write a <new-line> character.
 .It Cm \er
-Write a \*[Lt]carriage return\*[Gt] character.
+Write a <carriage return> character.
 .It Cm \et
-Write a \*[Lt]tab\*[Gt] character.
+Write a <tab> character.
 .It Cm \ev
-Write a \*[Lt]vertical tab\*[Gt] character.
+Write a <vertical tab> character.
 .It Cm \e\e
 Write a backslash character.
 .It Cm \e Ns Ar num
@@ -2062,13 +2062,13 @@ True if the strings
 and
 .Ar \&s\&2
 are not identical.
-.It Ar \&s\&1 Cm \&\*[Lt] Ar \&s\&2
+.It Ar \&s\&1 Cm \&< Ar \&s\&2
 True if string
 .Ar \&s\&1
 comes before
 .Ar \&s\&2
 based on the ASCII value of their characters.
-.It Ar \&s\&1 Cm \&\*[Gt] Ar \&s\&2
+.It Ar \&s\&1 Cm \&> Ar \&s\&2
 True if string
 .Ar \&s\&1
 comes after
@@ -2380,7 +2380,7 @@ unless you are the superuser, in which case it defaults to
 .Dq #\  .
 .It Ev PS2
 The secondary prompt string, which defaults to
-.Dq \*[Gt]\  .
+.Dq >\  .
 .It Ev PS4
 Output before each line when execution trace (set -x) is enabled,
 defaults to
Signature · 1 line
2.54.0
#5 lore raw

Re: [PATCH] Use literal > and < characters

Email seems okay this time, but looks like it double sent... Sigh. Sorry about that!

Signature · 1 line
S.
#6 lore raw

PATCH 1/1 Use proper grave accent character

In reply to Herbert Xu

In the troff(7) (may be groff(7) on your system) input language, the ascii grave accent (backtick) character is interpreted as a left typographers quotation on output devices that support it. Likewise, a ' is interpreted as a right quotation.

IOW, if your terminal supports unicode (along with some other variables..),

command

in dash.1 can end up being displayed as

‘command‘

which is not the input the shell expects, and so a user following examples in the manual will be very confused.

The way to typeset the grave accent character as it most likely appears on your keyboard, the character the shell expects for command expansion, you must use the troff character \(ga

---
 src/dash.1 | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
src/dash.1 +3 -3
index dbc34c9..f651a03 100644
@@ -293,12 +293,12 @@ Enclosing characters within double quotes preserves the literal
 meaning of all characters except dollarsign
 .Pq $ ,
 backquote
-.Pq ` ,
+.Pq \(ga ,
 and backslash
 .Pq \e .
 The backslash inside double quotes is historically weird, and serves to
 quote only the following characters:
-.Dl $  `  \*q  \e  \*[Lt]newline\*[Gt] .
+.Dl $  \(ga  \*q  \e  \*[Lt]newline\*[Gt] .
 Otherwise it remains literal.
 .Ss Reserved Words
 Reserved words are words that have special meaning to the
@@ -983,7 +983,7 @@ or
 version
 .Pc :
 .Pp
-.Dl `command`
+.Dl \(gacommand\(ga
 .Pp
 The shell expands the command substitution by executing command in a
 subshell environment and replacing the command substitution with the
Signature · 1 line
2.54.0
#7 lore raw
Quoted 17 lines · Sébastien Peterson-Boudreau

In the troff(7) (may be groff(7) on your system) input language, the ascii grave accent (backtick) character is interpreted as a left typographers quotation on output devices that support it. Likewise, a ' is interpreted as a right quotation.

IOW, if your terminal supports unicode (along with some other variables..),

command

in dash.1 can end up being displayed as

‘command‘

which is not the input the shell expects, and so a user following examples in the manual will be very confused.

Quoted 6 lines

The way to typeset the grave accent character as it most likely appears on your keyboard, the character the shell expects for command expansion, you must use the troff character \(ga
---
src/dash.1 | 6 +++---

1 file changed, 3 insertions(+), 3 deletions(-)

Patch applied. Thanks.

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt