Imported Upstream version 1.22.4
[platform/upstream/groff.git] / src / utils / xtotroff / xtotroff.1.man
1 .TH XTOTROFF @MAN1EXT@ "@MDATE@" "groff @VERSION@"
2 .SH NAME
3 xtotroff \- convert X font metrics into GNU troff font metrics
4 .
5 .
6 .\" ====================================================================
7 .\" Legal Terms
8 .\" ====================================================================
9 .\"
10 .\" Copyright (C) 2004-2018 Free Software Foundation, Inc.
11 .\"
12 .\" Permission is granted to make and distribute verbatim copies of this
13 .\" manual provided the copyright notice and this permission notice are
14 .\" preserved on all copies.
15 .\"
16 .\" Permission is granted to copy and distribute modified versions of
17 .\" this manual under the conditions for verbatim copying, provided that
18 .\" the entire resulting derived work is distributed under the terms of
19 .\" a permission notice identical to this one.
20 .\"
21 .\" Permission is granted to copy and distribute translations of this
22 .\" manual into another language, under the above conditions for
23 .\" modified versions, except that this permission notice may be
24 .\" included in translations approved by the Free Software Foundation
25 .\" instead of in the original English.
26 .
27 .
28 .\" ====================================================================
29 .SH SYNOPSIS
30 .\" ====================================================================
31 .
32 .SY xtotroff
33 .OP \-r resolution
34 .OP \-s point-size
35 .I font-map
36 .YS
37 .
38 .SY xtotroff
39 .B \-\-help
40 .YS
41 .
42 .SY xtotroff
43 .B \-v
44 .SY xtotroff
45 .B \-\-version
46 .YS
47 .
48 .
49 .\" ====================================================================
50 .SH DESCRIPTION
51 .\" ====================================================================
52 .
53 .I xtotroff
54 takes a
55 .IR font-map ,
56 which maps
57 .IR groff (@MAN1EXT@)
58 fonts to X11 fonts,
59 creates GNU
60 .IR troff (@MAN1EXT@)
61 metric files for all fonts listed.
62 .
63 Each line in
64 .I font-map
65 consists of a
66 .I groff
67 font name and an X font name as a X Logical Font Description (XLFD)
68 pattern,
69 separated by whitespace.
70 .
71 Example:
72 .
73 .
74 .PP
75 .RS
76 .EX
77 TB \-adobe\-times\-bold\-r\-normal\-\-*\-*\-*\-*\-p\-*\-iso8859\-1
78 .EE
79 .RE
80 .
81 .
82 .PP
83 The wildcards in the patterns are filled with the arguments to the
84 .B \-r
85 and
86 .B \-s
87 switches.
88 .
89 If a font name is still ambiguous,
90 .I xtotroff
91 aborts.
92 .
93 .
94 .\" ====================================================================
95 .SH OPTIONS
96 .\" ====================================================================
97 .
98 Whitespace is permitted between a command-line option and its argument.
99 .
100 .
101 .TP
102 .B \-\-help
103 Display a usage message and exit.
104 .
105 .
106 .TP
107 .BI \-r resolution
108 Set the resolution for all font patterns in
109 .IR font-map .
110 .
111 The value is used for both the horizontal and vertical resolution.
112 .
113 If not specified, a resolution of 75dpi is assumed.
114 .
115 .
116 .TP
117 .BI \-s point-size
118 Set the point size for all font patterns in
119 .IR font-map .
120 .
121 If not specified, a size of 10pt is assumed.
122 .
123 .
124 .TP
125 .B \-v
126 .TQ
127 .B \-\-version
128 Display version information and exit.
129 .
130 .
131 .\" ====================================================================
132 .SH BUGS
133 .\" ====================================================================
134 The only supported font encodings are \(lqiso8859\-1\(rq and
135 \(lqadobe\-fontspecific\(rq.
136 .
137 .
138 .\" ====================================================================
139 .SH "SEE ALSO"
140 .\" ====================================================================
141 .IR groff (@MAN1EXT@),
142 .IR gxditview (@MAN1EXT@),
143 .IR troff (@MAN1EXT@)
144 .
145 .
146 .\" Local Variables:
147 .\" mode: nroff
148 .\" End:
149 .\" vim: set filetype=groff: