Debian Codegraph @

upstream/debian-unstable/man1/xtotroff.1

raw
1 .TH xtotroff 1 "2026-04-22" "groff 1.24.1"
2 .SH Name
3 xtotroff \- convert X font metrics into
4 .I groff
5 font metrics
6 .
7 .
8 .\" ====================================================================
9 .\" Legal Terms
10 .\" ====================================================================
11 .\"
12 .\" Copyright 2004 Free Software Foundation, Inc.
13 .\" 2021-2024 G. Branden Robinson
14 .\"
15 .\" Permission is granted to make and distribute verbatim copies of this
16 .\" manual provided the copyright notice and this permission notice are
17 .\" preserved on all copies.
18 .\"
19 .\" Permission is granted to copy and distribute modified versions of
20 .\" this manual under the conditions for verbatim copying, provided that
21 .\" the entire resulting derived work is distributed under the terms of
22 .\" a permission notice identical to this one.
23 .\"
24 .\" Permission is granted to copy and distribute translations of this
25 .\" manual into another language, under the above conditions for
26 .\" modified versions, except that this permission notice may be
27 .\" included in translations approved by the Free Software Foundation
28 .\" instead of in the original English.
29 .
30 .
31 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
32 .do nr *groff_xtotroff_1_man_C \n[.cp]
33 .cp 0
34 .
35 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
36 .nr do-fallback 0
37 .if !\n(.f .nr do-fallback 1 \" mandoc
38 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
39 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
40 .if \n[do-fallback] \{\
41 . de MR
42 . ie \\n(.$=1 \
43 . I \%\\$1
44 . el \
45 . IR \%\\$1 (\\$2)\\$3
46 . .
47 .\}
48 .rr do-fallback
49 .
50 .
51 .\" ====================================================================
52 .SH Synopsis
53 .\" ====================================================================
54 .
55 .SY xtotroff
56 .RB [ \-d\~\c
57 .IR destination-directory ]
58 .RB [ \-r\~\c
59 .IR resolution ]
60 .RB [ \-s\~\c
61 .IR type-size ]
62 .I font-map
63 .YS
64 .
65 .
66 .P
67 .SY xtotroff
68 .B \-\-help
69 .YS
70 .
71 .
72 .P
73 .SY xtotroff
74 .B \-v
75 .YS
76 .
77 .SY xtotroff
78 .B \%\-\-version
79 .YS
80 .
81 .
82 .\" ====================================================================
83 .SH Description
84 .\" ====================================================================
85 .
86 .I xtotroff
87 uses
88 .I font-map
89 to create
90 .MR groff 1
91 font description files from X11 fonts.
92 .
93 Each line in
94 .I font-map
95 pairs a
96 .I groff
97 font name with an X font name as an X Logical Font Description (XLFD)
98 pattern.
99 .
100 The pair's members are separated by spaces and/or tabs.
101 .
102 For example,
103 an input
104 .I font-map
105 file consisting of the line
106 .
107 .RS
108 .EX
109 TB \-adobe\-times\-bold\-r\-normal\-\-*\-*\-*\-*\-p\-*\-iso8859\-1
110 .EE
111 .RE
112 .
113 maps the XLFD on the right to the
114 .I groff
115 font name
116 .BR TB ,
117 conventionally \[lq]Times bold\[rq].
118 .
119 .
120 .PP
121 .I xtotroff
122 opens a connection to the running X server to query its font catalog,
123 and aborts if it cannot.
124 .
125 If necessary,
126 the wildcards in the XLFD patterns are populated with the arguments to
127 the
128 .B \-r
129 and
130 .B \-s
131 options.
132 .
133 If a font name is still ambiguous,
134 .I xtotroff
135 aborts.
136 .
137 For each successful mapping,
138 .I xtotroff
139 creates a
140 .I groff
141 font description file in the current working directory
142 (or that specified by the
143 .B \-d
144 option)
145 named for each
146 .I groff
147 font,
148 and reports the mapping to the standard output stream.
149 .
150 .
151 .\" ====================================================================
152 .SH Options
153 .\" ====================================================================
154 .
155 .B \-\-help
156 displays a usage message,
157 while
158 .B \-v
159 and
160 .B \%\-\-version
161 show version information;
162 all exit afterward.
163 .
164 .
165 .TP
166 .BI \-d\~ destination-directory
167 Write font descriptions to
168 .I destination-directory
169 rather than the current working directory.
170 .
171 .
172 .TP
173 .BI \-r\~ resolution
174 Set the resolution for all font patterns in
175 .IR font-map .
176 .
177 The value is used for both the horizontal and vertical motion quanta.
178 .
179 If not specified,
180 a resolution of 75dpi is assumed.
181 .
182 .
183 .TP
184 .BI \-s\~ type-size
185 Set the type size in points for all font patterns in
186 .IR font-map .
187 .
188 If not specified,
189 a size of 10 points is assumed.
190 .
191 .
192 .\" ====================================================================
193 .SH "Exit status"
194 .\" ====================================================================
195 .
196 .I \%xtotroff
197 exits with
198 .RB status\~ 0
199 on successful operation,
200 .RB status\~ 2
201 if the program cannot interpret its command-line arguments,
202 and
203 .RB status\~ 1
204 if it encounters an error during operation.
205 .
206 .
207 .\" ====================================================================
208 .SH Files
209 .\" ====================================================================
210 .
211 .TP
212 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%FontMap\-X11
213 is the font mapping file used to produce the pre-generated font
214 description files,
215 supplied with
216 .IR groff ,
217 of X11 core fonts corresponding to the 13 base Type\~1 fonts for
218 PostScript level 1.
219 .
220 .
221 .\" ====================================================================
222 .SH Bugs
223 .\" ====================================================================
224 .
225 The only supported font encodings are \[lq]iso8859\-1\[rq] and
226 \%\[lq]adobe\-\:fontspecific\[rq].
227 .
228 .
229 .\" ====================================================================
230 .SH "See also"
231 .\" ====================================================================
232 .
233 .UR https://\:www\:.x\:.org/\:releases/\:X11R7.6/\:doc/\:xorg\-docs/\
234 \:specs/\:XLFD/xlfd\:.html
235 \[lq]X Logical Font Description Conventions\[rq]
236 .UE ,
237 by Jim Flowers and Stephen Gildea.
238 .
239 .
240 .PP
241 .MR X 7 ,
242 .MR groff 1 ,
243 .MR gxditview 1 ,
244 .MR \%troff 1 ,
245 .MR groff_font 5
246 .
247 .
248 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
249 .cp \n[*groff_xtotroff_1_man_C]
250 .do rr *groff_xtotroff_1_man_C
251 .
252 .
253 .\" Local Variables:
254 .\" fill-column: 72
255 .\" mode: nroff
256 .\" End:
257 .\" vim: set filetype=groff textwidth=72: