Debian Codegraph @

upstream/debian-unstable/man7/groff_rfc1345.7

raw
1 .TH groff_rfc1345 7 "2026-04-22" "groff 1.24.1"
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 2021-2024 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 largely a subset of RFC 1345
127 (being limited to two-character mnemonics),
128 but,
129 as a newer implementation,
130 adds several mnemonics not specified in the RFC
131 .\" W` w` Y` y` oo ,. 4' .= =e Eu =R =P
132 (Latin capital and small letters W and Y with grave accent,
133 bullet,
134 horizontal ellipsis,
135 quadruple prime,
136 \[lq]approaches the limit\[rq],
137 and two mappings each for the Euro and rouble signs).
138 .
139 These have also been added to
140 .IR rfc1345.tmac .
141 .
142 .
143 .PP
144 .I rfc1345.tmac
145 contains about 1,700 glyph names.
146 .
147 It is not an
148 error to load
149 .I rfc1345.tmac
150 if your font does not have all the glyphs,
151 as long as it contains the glyphs that you actually use in your
152 document.
153 .
154 .
155 .PP
156 The RFC 1345 mnemonics are not identical in every case to the mappings
157 for special character glyph names that are built in to
158 .IR groff ;
159 for example,
160 .RB \[lq] \[rs][<<] \[rq]
161 means the \[lq]much less than\[rq] sign (U+226A) when
162 .I rfc1345.tmac
163 is not loaded and this special character is not otherwise defined by a
164 document or macro package.
165 .
166 .I rfc1345.tmac
167 redefines
168 .RB \[lq] \[rs][<<] \[rq]
169 to the \[lq]left-pointing double angle quotation mark\[rq] (U+00AB).
170 .
171 See
172 .MR groff_char 7
173 for the full list of predefined special character escape sequences.
174 .
175 .
176 .\" ====================================================================
177 .SS Usage
178 .\" ====================================================================
179 .
180 Load the
181 .I rfc1345.tmac
182 file.
183 .
184 This can be done by either adding
185 .RB \[lq] ".mso rfc1345.tmac" \[rq]
186 to your document before the first use of any of the glyph names the
187 macro file defines,
188 or by using the
189 .MR \%troff 1
190 option
191 .RB \[lq] "\-m rfc1345" \[rq]
192 from the shell.
193 .
194 .
195 .\" ====================================================================
196 .SH Bugs
197 .\" ====================================================================
198 .
199 As the
200 .I groff
201 Texinfo manual notes,
202 \[lq][o]nly the current font is checked for ligatures and kerns;
203 neither special fonts nor entities defined with the
204 .B char
205 request
206 (and its siblings)
207 are taken into account.\[rq]
208 .
209 Many of the characters defined in
210 .I rfc1345.tmac
211 are accented Latin letters,
212 and will be affected by this deficiency,
213 .UR https://\:savannah\:.gnu\:.org/\:bugs/\:?59932
214 producing subpar typography
215 .UE .
216 .
217 .
218 .\" ====================================================================
219 .SH Files
220 .\" ====================================================================
221 .
222 .TP
223 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:rfc1345\:.tmac
224 implements the character mappings.
225 .
226 .
227 .\" ====================================================================
228 .SH Authors
229 .\" ====================================================================
230 .
231 .I rfc1345\:.tmac
232 was contributed by
233 .MT ds26gte@\:yahoo\:.com
234 Dorai Sitaram
235 .ME .
236 .
237 .
238 .\" ====================================================================
239 .SH "See also"
240 .\" ====================================================================
241 .
242 .UR https://\:tools\:.ietf\:.org/\:html/\:rfc1345
243 RFC 1345
244 .UE ,
245 by Keld Simonsen,
246 June 1992.
247 .
248 .
249 .PP
250 The Vim digraph table can be listed using the
251 .MR vim 1
252 command
253 .RB \[lq] ":help \%digraph\-table" \[rq].
254 .
255 .
256 .PP
257 .MR groff_char 7
258 .
259 .
260 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
261 .cp \n[*groff_groff_rfc1345_7_man_C]
262 .do rr *groff_groff_rfc1345_7_man_C
263 .
264 .
265 .\" Local Variables:
266 .\" fill-column: 72
267 .\" mode: nroff
268 .\" End:
269 .\" vim: set filetype=groff textwidth=72: