bug-bash
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 13/18] doc/bash.1: bracket displayed examples with EX/EE


From: G. Branden Robinson
Subject: [PATCH 13/18] doc/bash.1: bracket displayed examples with EX/EE
Date: Wed, 31 Jan 2024 02:42:59 -0600

This will set them in Courier with modern formatters* when they render
to a typesetting device or to HTML, and does no damage on ancient ones.

Diff of rendering (groff, Heirloom Doctools, mandoc):

-            MAILPATH='/var/mail/bfox?"You have mail":~/shell-mail?"$_ has
-            mail!"'
+            MAILPATH='/var/mail/bfox?"You have mail":~/shell-mail?"$_ has 
mail!"'

DWB adds vertical space, indents, and doesn't render the ~ characters.
A fix for the last comes later in this patch series.
---
 doc/bash.1 | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/doc/bash.1 b/doc/bash.1
index 81c3153e..3854d561 100644
--- a/doc/bash.1
+++ b/doc/bash.1
@@ -2572,7 +2572,9 @@ .SS Shell Variables
 Example:
 .RS
 .PP
+.EX
 \fBMAILPATH\fP=\(aq/var/mail/bfox?\(dqYou have 
mail\(dq:\(ti/shell\-mail?\(dq$_ has mail!\(dq\(aq
+.EE
 .PP
 .B Bash
 can be configured to supply
@@ -6035,11 +6037,13 @@ .SS "Readline Key Bindings"
 are not recognized.
 .PP
 .RS
+.EX
+.nf
 \(dq\eC\-u\(dq: universal\-argument
-.br
 \(dq\eC\-x\eC\-r\(dq: re\-read\-init\-file
-.br
 \(dq\ee[11\(ti\(dq: \(dqFunction Key 1\(dq
+.fi
+.EE
 .RE
 .PP
 In this example,
@@ -6585,12 +6589,14 @@ .SS "Readline Conditional Constructs"
 key sequence that quotes the current or previous word in \fBbash\fP:
 .PP
 .RS
+.EX
 .nf
 \fB$if\fP Bash
 # Quote the current or previous word
 \(dq\eC\-xq\(dq: \(dq\eeb\e\(dq\eef\e\(dq\(dq
 \fB$endif\fP
 .fi
+.EE
 .RE
 .IP \fIvariable\fP
 The \fIvariable\fP construct provides simple equality tests for readline
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]