Debian Codegraph @

upstream/debian-trixie/man1/xtotroff.1

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