>Number: 6604
>Category: documentation
>Synopsis: footnote marks illegible in csh tutorial
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: bugs
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: unknown
>Arrival-Date: Fri May 13 20:00:01 GMT 2011
>Closed-Date:
>Last-Modified:
>Originator:
>Release:
>Organization:
>Environment:
>Description:
"An Introduction to the C shell" (src/bin/csh/USD.doc/csh.*)
uses dagger and double-dagger glyphs for footnote marks.
"groff -Tascii" doesn't have definitions for these glyphs, so
they simply get left out, making the ASCII version slightly
less readable.
I realize this is not built by default and is mainly of historic
interest, so I don't mind if you decide to reject the patch.
>How-To-Repeat:
$ cd /usr/src/bin/csh/USD.doc
$ make paper.txt
groff -ms -Tascii tabs csh.1 csh.2 csh.3 csh.4 csh.a csh.g > paper.txt
csh.2:296: warning: can't find special character `dg'
csh.2:542: warning: can't find special character `dd'
Search for "clobbering the file is ok" / "The space between" to
verify that footnote marks don't show up in the output.
(There may be minor differences as I'm reporting this from a
Debian system. groff 1.18.1.1, 1.20.1, and 1.21 all print the
same warnings.)
>Fix:
Provide fallback definitions using groff's schar request:
"*" for dagger (dg) and "**" for double-dagger (dd).
--- src/bin/csh/USD.doc/csh.1~
+++ src/bin/csh/USD.doc/csh.1
@@ -34,6 +34,14 @@
.po 5n
.ll 70n
.\}
+.\" If this is groff, i.e. if schar is available...
+.if \n(.g \{
+.\" ... provide fallback definitions for dagger and double-dagger to make
+.\" footnote marks legible in ASCII output. This is a no-op if they are
+.\" supported by the output device (e.g. -Tps, -Tutf8).
+.schar \(dg *
+.schar \(dd **
+.\}
.EH 'USD:4-%''An Introduction to the C shell'
.OH 'An Introduction to the C shell''USD:4-%'
.\".RP
>Release-Note:
>Audit-Trail:
>Unformatted:
