xlsfonts.xml revision 94a251fd 
1<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 'http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd'>
2
3<!-- Process this file with DocBook tools to generate the output format
4(such as manual pages or HTML documents).
5
6Note that strings like __appmansuffix__, __filemansuffix__, __libmansuffix__,
7__miscmansuffix__ etc. have to be replaced first (in theory that's the
8job of ENTITIES but some XML tools are highly allergic to such stuff... ;-().
9A quick way to do that is to filter this document via
10/usr/bin/sed "s/__appmansuffix__/${MANSUFFIX}/g;s/__filemansuffix__/${FILEMANSUFFIX}/g;s/__libmansuffix__/${LIBMANSUFFIX}/g;s/__miscmansuffix__/${MISCMANSUFFIX}/g"
11assuming that env vars like MANSUFFIX etc. have been set to the matching
12manual volume numbers.
13  -->
14
15<refentry>
16  <refmeta>
17    <refentrytitle>xlsfonts</refentrytitle>
18    <manvolnum>__appmansuffix__</manvolnum>
19  </refmeta>
20
21  <refnamediv>
22    <refname>xlsfonts</refname>
23    <refpurpose>server font list displayer for X</refpurpose>
24  </refnamediv>
25
26  <refsynopsisdiv>
27    <cmdsynopsis>
28      <command>xlsfonts</command>
29
30      <arg><option>-display <replaceable>host:dpy</replaceable></option></arg>
31
32      <arg><option>-l</option></arg>
33
34      <arg><option>-ll</option></arg>
35
36      <arg><option>-lll</option></arg>
37
38      <arg><option>-m</option></arg>
39
40      <arg><option>-C</option></arg>
41
42      <arg><option>-1</option></arg>
43
44      <arg><option>-w <replaceable>width</replaceable></option></arg>
45
46      <arg><option>-n <replaceable>columns</replaceable></option></arg>
47
48      <arg><option>-u</option></arg>
49
50      <arg><option>-o</option></arg>
51
52      <arg><option>-fn <replaceable>pattern</replaceable></option></arg>     
53    </cmdsynopsis>
54  </refsynopsisdiv>
55
56  <refsect1>
57    <title>DESCRIPTION</title>
58
59    <para>
60      <command>xlsfonts</command> lists the fonts that match the given pattern.
61      The wildcard character "*" may be used to match any sequence of characters
62      (including none), and "?" to match any single character.
63      If no pattern is given, "*" is assumed.
64    </para>
65    <para>
66      The "*" and "?" characters must be quoted to prevent them from being expanded by the shell.
67    </para>
68  </refsect1>
69
70  <refsect1>
71    <title>OPTIONS</title>
72
73    <variablelist>
74      <varlistentry>
75        <term><option>-display <replaceable>host:dpy</replaceable></option>
76        </term>
77        <listitem>
78          <para>
79            This option specifies the X server to contact.
80          </para>
81        </listitem>
82      </varlistentry>
83
84      <varlistentry>
85        <term><option>-d <replaceable>host:dpy</replaceable></option>
86        </term>
87        <listitem>
88          <para>
89            Same as <option>-display <replaceable>host:dpy</replaceable></option>.
90          </para>
91        </listitem>
92      </varlistentry>
93
94      <varlistentry>
95        <term><option>-l</option>
96        </term>
97        <listitem>
98          <para>
99            Lists some attributes of the font on one line in addition
100            to its name.
101          </para>
102        </listitem>
103      </varlistentry>
104
105      <varlistentry>
106        <term><option>-ll</option>
107        </term>
108        <listitem>
109          <para>
110            Lists font properties in addition to <option>-l</option> output.
111          </para>
112        </listitem>
113      </varlistentry>
114      
115      <varlistentry>
116        <term><option>-lll</option>
117        </term>
118        <listitem>
119          <para>
120            Lists character metrics in addition to <option>-ll</option> output.
121          </para>
122        </listitem>
123      </varlistentry>
124
125      <varlistentry>
126        <term><option>-m</option>
127        </term>
128        <listitem>
129          <para>
130            This option indicates that long listings should also print
131            the minimum and maximum bounds of each font.
132          </para>
133        </listitem>
134      </varlistentry>
135
136      <varlistentry>
137        <term><option>-C</option>
138        </term>
139        <listitem>
140          <para>
141            This option indicates that listings should use multiple columns.
142            This is the same as <option>-n 0</option>.
143          </para>
144        </listitem>
145      </varlistentry>
146
147      <varlistentry>
148        <term><option>-1</option>
149        </term>
150        <listitem>
151          <para>
152            This option indicates that listings should use a single column.
153            This is the same as <option>-n 1</option>.
154          </para>
155        </listitem>
156      </varlistentry>
157
158      <varlistentry>
159        <term><option>-w <replaceable>width</replaceable></option>
160        </term>
161        <listitem>
162          <para>
163            This option specifies the width in characters that should be
164            used in figuring out how many columns to print.
165            The default is 79.
166          </para>
167        </listitem>
168      </varlistentry>
169
170      <varlistentry>
171        <term><option>-n <replaceable>columns</replaceable></option>
172        </term>
173        <listitem>
174          <para>
175            This option specifies the number of columns to use in
176            displaying the output. By default, it will attempt to
177            fit as many columns of font names into the number of
178            character specified by <option>-w</option> width.
179          </para>
180        </listitem>
181      </varlistentry>
182
183      <varlistentry>
184        <term><option>-u</option>
185        </term>
186        <listitem>
187          <para>
188            This option indicates that the output should be left unsorted.
189          </para>
190        </listitem>
191      </varlistentry>
192
193      <varlistentry>
194        <term><option>-o</option>
195        </term>
196        <listitem>
197          <para>
198            This option indicates that xlsfonts should do an OpenFont
199            (and QueryFont, if appropriate) rather than a ListFonts.
200            This is useful if ListFonts or ListFontsWithInfo fail to
201            list a known font (as is the case with some scaled font
202            systems).
203          </para>
204        </listitem>
205      </varlistentry>
206
207      <varlistentry>
208        <term><option>-fn <replaceable>pattern</replaceable></option>
209        </term>
210        <listitem>
211          <para>
212            This option specifies the font name pattern to match.
213          </para>
214        </listitem>
215      </varlistentry>
216    </variablelist>
217  </refsect1>
218
219  <refsect1>
220    <title>SEE ALSO</title>
221    <para>
222      <simplelist type="inline">
223        <member><citerefentry><refentrytitle>X</refentrytitle><manvolnum>__miscmansuffix__</manvolnum></citerefentry></member>
224        <member><citerefentry><refentrytitle>Xserver</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
225        <member><citerefentry><refentrytitle>xset</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
226        <member><citerefentry><refentrytitle>xfd</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
227        <member>X Logical Font Description Conventions</member>
228      </simplelist>
229    </para>
230  </refsect1>
231
232  <refsect1>
233    <title>ENVIRONMENT</title>
234
235    <variablelist>
236      <varlistentry>
237        <term><envar>DISPLAY</envar>
238        </term>
239        <listitem>
240	    <para><envar>DISPLAY</envar> must be set to get the default host and display to use.
241	  </para>
242	</listitem>
243      </varlistentry>
244      
245    </variablelist>
246  </refsect1>
247
248  <refsect1>
249    <title>BUGS</title>
250
251    <para>
252      Doing ``xlsfonts -l'' can tie up your server for a very long time. 
253      This is really a bug  with  single-threaded
254      non-preemptable servers, not with this program.
255    </para>
256  </refsect1>
257
258  <refsect1>
259    <title>AUTHOR</title>
260
261    <para>
262      <simplelist>
263        <member><othercredit><firstname>Mark</firstname> <surname>Lillibridge</surname> <affiliation><orgname>MIT Project Athena</orgname></affiliation></othercredit></member>
264        <member><othercredit><firstname>Jim</firstname> <surname>Fulton</surname> <affiliation><orgname>MIT X Consortium</orgname></affiliation></othercredit></member>
265        <member><othercredit><firstname>Phil</firstname> <surname>Karlton</surname> <affiliation><orgname>SGI</orgname></affiliation></othercredit></member>
266        <member><othercredit><firstname>Roland</firstname> <surname>Mainz</surname> <affiliation><orgname>University Giessen</orgname></affiliation></othercredit></member>
267      </simplelist>
268    </para>
269  </refsect1>
270
271</refentry>
272
273
274