From a1e98fa858537daa467340c7b9fa023544eb8f4d Mon Sep 17 00:00:00 2001 From: Roland Mainz Date: Mon, 13 Dec 2004 05:26:50 +0000 Subject: xc/programs/xlsfonts/Imakefile xc/programs/xlsfonts/xlsfonts.c xc/programs/xlsfonts/xlsfonts.man xc/programs/xlsfonts/xlsfonts.sgml xc/programs/xplsprinters/xplsprinters.html xc/programs/xplsprinters/xplsprinters.man //freedesktop.org/bugzilla/show_bug.cgi?id=1551) attachment #1025 (https://bugs.freedesktop.org/attachment.cgi?id=1025): Convert "xlsfonts" manual page to DocBook format (and document the new functionality introduced with bug #1518). --- xlsfonts.c | 4 +- xlsfonts.man | 255 ++++++++++++++++++++++++++++++++++++---------------------- xlsfonts.sgml | 2 +- 3 files changed, 163 insertions(+), 98 deletions(-) diff --git a/xlsfonts.c b/xlsfonts.c index f3e469c..9718c93 100644 --- a/xlsfonts.c +++ b/xlsfonts.c @@ -93,9 +93,9 @@ void usage(void) fprintf (stderr, " -1 force single column\n"); fprintf (stderr, " -u keep output unsorted\n"); #ifdef BUILD_PRINTSUPPORT - fprintf (stderr, " -b list printer builtin fonts (default)\n"); + fprintf (stderr, " -b list printer builtin fonts\n"); fprintf (stderr, " -B do not list printer builtin fonts\n"); - fprintf (stderr, " -g list glyph fonts (default)\n"); + fprintf (stderr, " -g list glyph fonts\n"); fprintf (stderr, " -G do not list glyph fonts\n"); fprintf (stderr, " -x mode enable listfont mode\n"); fprintf (stderr, " -X mode disable listfont mode\n"); diff --git a/xlsfonts.man b/xlsfonts.man index c9f4a8f..bf5a35f 100644 --- a/xlsfonts.man +++ b/xlsfonts.man @@ -1,105 +1,170 @@ -.\" $Xorg: xlsfonts.man,v 1.4 2001/02/09 02:05:55 xorgcvs Exp $ -.\" Copyright 1988, 1998 The Open Group -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and its -.\" documentation for any purpose is hereby granted without fee, provided that -.\" the above copyright notice appear in all copies and that both that -.\" copyright notice and this permission notice appear in supporting -.\" documentation. -.\" -.\" The above copyright notice and this permission notice shall be included -.\" in all copies or substantial portions of the Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR -.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -.\" OTHER DEALINGS IN THE SOFTWARE. -.\" -.\" Except as contained in this notice, the name of The Open Group shall -.\" not be used in advertising or otherwise to promote the sale, use or -.\" other dealings in this Software without prior written authorization -.\" from The Open Group. -.\" -.\" $XFree86: xc/programs/xlsfonts/xlsfonts.man,v 1.7 2001/01/27 18:21:18 dawes Exp $ -.\" -.TH XLSFONTS 1 __xorgversion__ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng . +.TH "XLSFONTS" "__appmansuffix__" "07 October 2004" "" "" .SH NAME xlsfonts \- server font list displayer for X .SH SYNOPSIS -.B xlsfonts -[\-options ...] [\-fn pattern] -.SH DESCRIPTION -.I Xlsfonts -lists the fonts that match the given \fIpattern\fP. -The wildcard character "*" may be used to match any sequence of -characters (including none), and "?" to match any single character. + +\fBxlsfonts\fR [ \fB-display \fIhost:dpy\fB\fR] [ \fB-l\fR] [ \fB-ll\fR] [ \fB-lll\fR] [ \fB-m\fR] [ \fB-C\fR] [ \fB-1\fR] [ \fB-w \fIwidth\fB\fR] [ \fB-n \fIcolumns\fB\fR] [ \fB-u\fR] [ \fB-o\fR] [ \fB-fn \fIpattern\fB\fR] + + +\fBxlsfonts\fR \fB-printer \fIprintername\fB\fR [ \fB-l\fR] [ \fB-ll\fR] [ \fB-lll\fR] [ \fB-m\fR] [ \fB-C\fR] [ \fB-1\fR] [ \fB-w \fIwidth\fB\fR] [ \fB-n \fIcolumns\fB\fR] [ \fB-u\fR] [ \fB-o\fR] [ \fB-b\fR] [ \fB-B\fR] [ \fB-g\fR] [ \fB-G\fR] [ \fB-x \fImode\fB\fR] [ \fB-X \fImode\fB\fR] [ \fB-fn \fIpattern\fB\fR] + +.SH "DESCRIPTION" +.PP +\fBxlsfonts\fR lists the fonts that match the given pattern. +The wildcard character "*" may be used to match any sequence of characters +(including none), and "?" to match any single character. If no pattern is given, "*" is assumed. .PP -The "*" and "?" characters must be quoted to prevent them from -being expanded by the shell. +The "*" and "?" characters must be quoted to prevent them from being expanded by the shell. .SH "OPTIONS" -.PP -.TP 8 -.B \-display \fIhost\fP:\fIdpy\fP +.TP +\fB-display \fIhost:dpy\fB \fR This option specifies the X server to contact. -.PP -.TP 8 -.B \-l -Lists some attributes of the font on one line in addition to its name. -.TP 8 -.B \-ll -Lists font properties in addition to \fB\-l\fP output. -.TP 8 -.B \-lll -Lists character metrics in addition to \fB\-ll\fP output. -.TP 8 -.B \-m -This option indicates that long listings should also print the minimum and -maximum bounds of each font. -.TP 8 -.B \-C -This option indicates that listings should use multiple columns. This is the -same as \fB\-n 0\fP. -.TP 8 -.B \-1 -This option indicates that listings should use a single column. This is the -same as \fB\-n 1\fP. -.TP 8 -.B \-w \fIwidth\fP -This option specifies the width in characters that should be used in -figuring out how many columns to print. The default is 79. -.TP 8 -.B \-n \fIcolumns\fP -This option specifies the number of columns to use in displaying the output. -By default, it will attempt to fit as many columns of font names into the -number of character specified by \fB\-w \fIwidth\fR. -.TP 8 -.B \-u +.TP +\fB-printer \fIprintername\fB \fR +This option specifies the Xprint printer to contact. +.TP +\fB-d \fIhost:dpy\fB \fR +Same as \fB-display \fIhost:dpy\fB\fR. +.TP +\fB-p \fIprintername\fB \fR +Same as \fB-printer \fIprintername\fB\fR. +.TP +\fB-l \fR +Lists some attributes of the font on one line in addition +to its name. +.TP +\fB-ll \fR +Lists font properties in addition to \fB-l\fR output. +.TP +\fB-lll \fR +Lists character metrics in addition to \fB-ll\fR output. +.TP +\fB-m \fR +This option indicates that long listings should also print +the minimum and maximum bounds of each font. +.TP +\fB-C \fR +This option indicates that listings should use multiple columns. +This is the same as \fB-n 0\fR. +.TP +\fB-1 \fR +This option indicates that listings should use a single column. +This is the same as \fB-n 1\fR. +.TP +\fB-w \fIwidth\fB \fR +This option specifies the width in characters that should be +used in figuring out how many columns to print. +The default is 79. +.TP +\fB-n \fIcolumns\fB \fR +This option specifies the number of columns to use in +displaying the output. By default, it will attempt to +fit as many columns of font names into the number of +character specified by \fB-w\fR width. +.TP +\fB-u \fR This option indicates that the output should be left unsorted. -.TP 8 -.B \-o -This option indicates that \fIxlsfonts\fP should do an \fBOpenFont\fP (and -\fBQueryFont\fP, if appropriate) rather than a \fBListFonts\fP. This is -useful if \fBListFonts\fP or \fBListFontsWithInfo\fP fail to list a known -font (as is the case with some scaled font systems). -.TP 8 -.B \-fn \fIpattern\fP +.TP +\fB-o \fR +This option indicates that xlsfonts should do an OpenFont +(and QueryFont, if appropriate) rather than a ListFonts. +This is useful if ListFonts or ListFontsWithInfo fail to +list a known font (as is the case with some scaled font +systems). +.TP +\fB-b \fR +List printer builtin fonts. +This is the same as \fB-x xp-list-internal-printer-fonts\fR. + +(printer mode only) +.TP +\fB-B \fR +Do not list printer builtin fonts. +This is the same as \fB-X xp-list-internal-printer-fonts\fR. + +(printer mode only) +.TP +\fB-g \fR +List glyph fonts. +This is the same as \fB-x xp-list-glyph-fonts\fR. + +(printer mode only) +.TP +\fB-G \fR +Do not list glyph fonts. +This is the same as \fB-X xp-list-glyph-fonts\fR. + +(printer mode only) +.TP +\fB-x \fImode\fB \fR +Enable listfont mode \fImode\fR. + +Supported modes are: +.RS +.TP +\fBxp-listinternal-printer-fonts\fR +If xp-listinternal-printer-fonts was set +(via option \fB-b\fR or +\fB-x xp-listinternal-printer-fonts\fR \fBxlsfonts\fR +will include all of the fonts defined as internal printer fonts. +.TP +\fBxp-list-glyph-fonts\fR +If xp-list-glyph-fonts was set (via option \fB-g\fR or +\fB-x xp-list-glyph-fonts\fR) \fBxlsfonts\fR will +include all of the fonts available to the server which have +glyphs associated with them. +.RE + +The default value is implicitly determined by the ddx driver to be the +all of the listfonts modes specified in the xp-listfonts-modes-supported +printer attribute. + +The value of xp-listfonts-modes-supported and +xp-listfonts-modes (the defaults) can be looked-up via +\fBxplsprinters\fR(__appmansuffix__). + +(printer mode only) +.TP +\fB-X \fImode\fB \fR +Disable listfont mode \fImode\fR. +See option \fB-x\fR for a list of valid +\fImode\fR values. + +(printer mode only) +.TP +\fB-fn \fIpattern\fB \fR This option specifies the font name pattern to match. -.PP .SH "SEE ALSO" -X(__miscmansuffix__), Xserver(1), xset(1), xfd(1), -.I "X Logical Font Description Conventions" -.SH ENVIRONMENT -.TP 8 -.B DISPLAY -to get the default host and display to use. -.SH BUGS -Doing ``xlsfonts -l'' can tie up your server for a very long time. -This is really a bug with single-threaded non-preemptable servers, not with -this program. -.SH AUTHOR -Mark Lillibridge, MIT Project Athena; Jim Fulton, MIT X Consortium; -Phil Karlton, SGI +.PP +\fBX\fR(__miscmansuffix__), \fBXprint\fR(__miscmansuffix__), \fBXserver\fR(__appmansuffix__), \fBxset\fR(__appmansuffix__), \fBxfd\fR(__appmansuffix__), \fBxplsprinters\fR(__appmansuffix__), X Logical Font Description Conventions +.SH "ENVIRONMENT" +.TP +\fBDISPLAY \fR +\fBDISPLAY\fR must be set to get the default host and display to use. +.TP +\fBXPSERVERLIST \fR +\fBXPSERVERLIST\fR must be set for the \fB-printer\fR option +identifying the available Xprint servers. +See \fBXprint\fR(__miscmansuffix__) +for more details. +.SH "BUGS" +.PP +Doing ``xlsfonts -l'' can tie up your server for a very long time. +This is really a bug with single-threaded +non-preemptable servers, not with this program. +.SH "AUTHOR" +.PP + +MarkLillibridgeMIT Project Athena + +JimFultonMIT X Consortium + +PhilKarltonSGI + +RolandMainzUniversity Giessen diff --git a/xlsfonts.sgml b/xlsfonts.sgml index fa46518..34b4dba 100644 --- a/xlsfonts.sgml +++ b/xlsfonts.sgml @@ -1,4 +1,4 @@ - +