Debian Codegraph @

upstream/debian-trixie/man7/groff_rfc1345.7

raw
1 .TH groff_rfc1345 7 "3 June 2025" "groff 1.23.0"
2 .SH Name
3 groff_rfc1345 \- special character names from RFC 1345 and Vim digraphs
4 .
5 .
6 .\" ====================================================================
7 .\" Legal Terms
8 .\" ====================================================================
9 .\"
10 .\" Copyright (c) 2021 Dorai Sitaram
11 .\"
12 .\" Permission is hereby granted, free of charge, to any person
13 .\" obtaining a copy of this software and associated documentation files
14 .\" (the "Software"), to deal in the Software without restriction,
15 .\" including without limitation the rights to use, copy, modify, merge,
16 .\" publish, distribute, sublicense, and/or sell copies of the Software,
17 .\" and to permit persons to whom the Software is furnished to do so,
18 .\" subject to the following conditions:
19 .\"
20 .\" The above copyright notice and this permission notice (including the
21 .\" next paragraph) shall be included in all copies or substantial
22 .\" portions of the Software.
23 .\"
24 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 .\" NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 .\" BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 .\" ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 .\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 .\" SOFTWARE.
32 .
33 .
34 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
35 .do nr *groff_groff_rfc1345_7_man_C \n[.cp]
36 .cp 0
37 .
38 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
39 .nr do-fallback 0
40 .if !\n(.f .nr do-fallback 1 \" mandoc
41 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
42 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
43 .if \n[do-fallback] \{\
44 . de MR
45 . ie \\n(.$=1 \
46 . I \%\\$1
47 . el \
48 . IR \%\\$1 (\\$2)\\$3
49 . .
50 .\}
51 .rr do-fallback
52 .
53 .
54 .\" ====================================================================
55 .SH Description
56 .\" ====================================================================
57 .
58 The file
59 .I rfc1345.tmac
60 defines special character escape sequences for
61 .MR groff 7
62 based on the glyph mnemonics specified in RFC 1345 and the digraph table
63 of the text editor Vim.
64 .
65 Each escape sequence translates to a Unicode code point,
66 and will render correctly if the underlying font is a Unicode font that
67 covers the code point.
68 .
69 .
70 .PP
71 For example,
72 .RB \[lq] \[rs][Rx] \[rq]
73 is the \[lq]recipe\[rq] or \[lq]prescription take\[rq] symbol,
74 and maps to the code point U+211E.
75 .
76 .I groff
77 lets you write it as
78 .RB \[lq] \[rs][u211E] \[rq],
79 but
80 .RB \[lq] \[rs][Rx] \[rq]
81 is more mnemonic.
82 .
83 .
84 .PP
85 For a list of the glyph names provided,
86 please see the file
87 .IR rfc1345.tmac ,
88 which contains definitions of the form
89 .
90 .RS
91 .EX
92 \&.char \[rs][Rx] \[rs][u211E] \[rs]" PRESCRIPTION TAKE
93 .EE
94 .RE
95 .
96 where
97 .BR .char 's
98 first argument defines a
99 .I groff
100 special character escape sequence with a mnemonic glyph name,
101 its second argument is a special character escape sequence based on the
102 code point,
103 and the comment describes the glyph defined.
104 .
105 .
106 .PP
107 The RFC 1345 glyph names cover a wide range of Unicode code points,
108 including
109 supplemental Latin,
110 Greek,
111 Cyrillic,
112 Hebrew,
113 Arabic,
114 Hiragana,
115 Katakana,
116 and Bopomofo letters,
117 punctuation,
118 math notation,
119 currency
120 symbols,
121 industrial and entertainment icons,
122 and box-drawing symbols.
123 .
124 .
125 .PP
126 The Vim digraph table is practically a subset of RFC 1345
127 (being limited to two-character mnemonics),
128 but,
129 as a newer implementation,
130 adds four mnemonics not specified in the RFC
131 (the horizontal ellipsis,
132 the Euro sign,
133 and two mappings for the rouble sign).
134 .
135 These have also been added to
136 .IR rfc1345.tmac .
137 .
138 .
139 .PP
140 .I rfc1345.tmac
141 contains a total of 1,696 glyph names.
142 .
143 It is not an
144 error to load
145 .I rfc1345.tmac
146 if your font does not have all the glyphs,
147 as long as it contains the glyphs that you actually use in your
148 document.
149 .
150 .
151 .PP
152 The RFC 1345 mnemonics are not identical in every case to the mappings
153 for special character glyph names that are built in to
154 .IR groff ;
155 for example,
156 .RB \[lq] \[rs][<<] \[rq]
157 means the \[lq]much less than\[rq] sign (U+226A) when
158 .I rfc1345.tmac
159 is not loaded and this special character is not otherwise defined by a
160 document or macro package.
161 .
162 .I rfc1345.tmac
163 redefines
164 .RB \[lq] \[rs][<<] \[rq]
165 to the \[lq]left-pointing double angle quotation mark\[rq] (U+00AB).
166 .
167 See
168 .MR groff_char 7
169 for the full list of predefined special character escape sequences.
170 .
171 .
172 .\" ====================================================================
173 .SS Usage
174 .\" ====================================================================
175 .
176 Load the
177 .I rfc1345.tmac
178 file.
179 .
180 This can be done by either adding
181 .RB \[lq] ".mso rfc1345.tmac" \[rq]
182 to your document before the first use of any of the glyph names the
183 macro file defines,
184 or by using the
185 .MR \%troff 1
186 option
187 .RB \[lq] "\-m rfc1345" \[rq]
188 from the shell.
189 .
190 .
191 .\" ====================================================================
192 .SS Bugs
193 .\" ====================================================================
194 .
195 As the
196 .I groff
197 Texinfo manual notes,
198 \[lq][o]nly the current font is checked for ligatures and kerns;
199 neither special fonts nor entities defined with the
200 .B char
201 request
202 (and its siblings)
203 are taken into account.\[rq]
204 .
205 Many of the characters defined in
206 .I rfc1345.tmac
207 are accented Latin letters,
208 and will be affected by this deficiency,
209 .UR https://\:savannah\:.gnu\:.org/\:bugs/\:?59932
210 producing subpar typography
211 .UE .
212 .
213 .
214 .\" ====================================================================
215 .SH Files
216 .\" ====================================================================
217 .
218 .TP
219 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:rfc1345\:.tmac
220 implements the character mappings.
221 .
222 .
223 .\" ====================================================================
224 .SH Authors
225 .\" ====================================================================
226 .
227 .I rfc1345\:.tmac
228 was contributed by
229 .MT ds26gte@\:yahoo\:.com
230 Dorai Sitaram
231 .ME .
232 .
233 .
234 .\" ====================================================================
235 .SH "See also"
236 .\" ====================================================================
237 .
238 .UR https://\:tools\:.ietf\:.org/\:html/\:rfc1345
239 RFC 1345
240 .UE ,
241 by Keld Simonsen,
242 June 1992.
243 .
244 .
245 .PP
246 The Vim digraph table can be listed using the
247 .MR vim 1
248 command
249 .RB \[lq] ":help \%digraph\-table" \[rq].
250 .
251 .
252 .PP
253 .MR groff_char 7
254 .
255 .
256 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
257 .cp \n[*groff_groff_rfc1345_7_man_C]
258 .do rr *groff_groff_rfc1345_7_man_C
259 .
260 .
261 .\" Local Variables:
262 .\" fill-column: 72
263 .\" mode: nroff
264 .\" End:
265 .\" vim: set filetype=groff textwidth=72: