diff options
author | Gaetan Nadon <memsize@videotron.ca> | 2011-01-19 10:06:56 -0500 |
---|---|---|
committer | Gaetan Nadon <memsize@videotron.ca> | 2011-01-19 10:06:56 -0500 |
commit | 19bcefb4c89e02833cb7fcffeb7fd3f7224db1c4 (patch) | |
tree | 51733945fc6d9304717246ffdd470c161c9a6779 /man | |
parent | f68420e9698d9a3b3e18cbefb96a3ccf9d555c65 (diff) |
config: move man pages into their own directory
Use services provided by XORG_MANPAGE_SECTIONS.
Use standard Makefile for man pages.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Diffstat (limited to 'man')
-rw-r--r-- | man/Makefile.am | 12 | ||||
-rw-r--r-- | man/xfontsel.man | 227 |
2 files changed, 239 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..168dbe0 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,12 @@ + +appmandir = $(APP_MAN_DIR) +appman_PRE = xfontsel.man +appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX)) + +EXTRA_DIST = $(appman_PRE) +CLEANFILES = $(appman_DATA) +SUFFIXES = .$(APP_MAN_SUFFIX) .man + +# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure +.man.$(APP_MAN_SUFFIX): + $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@ diff --git a/man/xfontsel.man b/man/xfontsel.man new file mode 100644 index 0000000..00c108d --- /dev/null +++ b/man/xfontsel.man @@ -0,0 +1,227 @@ +.\" Copyright (c) 1994 X Consortium +.\" +.\" Permission is hereby granted, free of charge, to any person obtaining +.\" a copy of this software and associated documentation files (the +.\" "Software"), to deal in the Software without restriction, including +.\" without limitation the rights to use, copy, modify, merge, publish, +.\" distribute, sublicense, and/or sell copies of the Software, and to +.\" permit persons to whom the Software is furnished to do so, subject to +.\" the following conditions: +.\" +.\" 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 X CONSORTIUM 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 X Consortium 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 X Consortium. +.\" +.de EX \"Begin example +.ne 5 +.if n .sp 1 +.if t .sp .5 +.nf +.in +.5i +.. +.de EE +.fi +.in -.5i +.if n .sp 1 +.if t .sp .5 +.. +.TH XFONTSEL 1 __xorgversion__ +.SH NAME +xfontsel \- point and click selection of X11 font names +.SH SYNTAX +.PP +\fBxfontsel\fP [-\fItoolkitoption\fP ...] +[\fB-pattern \fIfontname\fP] +[\fB-print\fP] +[\fB-sample \fItext\fP] +[\fB-sample16 \fItext16\fP] +[\fB-sampleUCS \fItextUCS\fP] +[\fB-scaled\fP] +.PP +.SH DESCRIPTION +.PP +The \fIxfontsel\fP application provides a simple way to display +the fonts known to your X server, examine samples of each, and +retrieve the X Logical Font Description ("XLFD") full name for a font. +.PP +If \fB-pattern\fP is not specified, all fonts with XLFD 14-part +names will be selectable. To work with only a subset of the +fonts, specify \fB-pattern\fP followed by a partially or fully +qualified font name; e.g., ``-pattern *medium*'' will +select that subset of fonts which contain the string ``medium'' +somewhere in their font name. Be careful about escaping +wildcard characters in your shell. +.PP +If \fB-print\fP is specified on the command line the selected +font specifier will be written to standard output when the \fIquit\fP +button is activated. Regardless of whether or not \fB-print\fP was +specified, the font specifier may be made the PRIMARY (text) +selection by activating the \fIselect\fP button. +.PP +The \fB-sample\fP option specifies the sample text to be used to +display the selected font if the font is linearly indexed, +overriding the default. +.PP +The \fB-sample16\fP option specifies the sample text to be used to +display the selected font if the font is matrix encoded, +overriding the default. +.PP +The \fB-sampleUCS\fP option specifies the sample text encoded in the UTF-8 +form to be used to display the selected font if the font has a +CHARSET_REGISTRY of ISO10646, overriding the default. +.PP +The \fB-scaled\fP option enables the ability to select scaled fonts +at arbitrary pixel or point sizes. +.PP +.SH INTERACTIONS +.PP +Clicking any pointer button in one of the XLFD field names will pop up +a menu of the currently-known possibilities for that field. If +previous choices of other fields were made, only values +for fonts which matched the previously selected fields will be +selectable; to make other values selectable, you must deselect +some other field(s) by choosing the ``*'' entry in that field. +Unselectable values may be omitted from the menu entirely as +a configuration option; see the \fBShowUnselectable\fP resource, below. +Whenever any change is made to a field value, \fIxfontsel\fP will +assert ownership of the PRIMARY_FONT selection. Other applications +(see, e.g., \fIxterm\fP) may then retrieve the selected font specification. +.PP +Scalable fonts come back from the server with zero for the pixel size, +point size, and average width fields. Selecting a font name with a +zero in these positions results in an implementation-dependent size. +Any pixel or point size can be selected to scale the font to a particular +size. Any average width can be selected to anamorphically scale the font +(although you may find this challenging given the size of the average +width menu). +.PP +Clicking the left pointer button in the \fIselect\fP widget will +cause the currently selected font name to become the PRIMARY text +selection as well as the PRIMARY_FONT selection. +This then allows you to paste the string into other +applications. The \fBselect\fP button remains +highlighted to remind you of this fact, and de-highlights when +some other application takes the PRIMARY selection away. The +\fIselect\fP widget is a toggle; pressing it when it is highlighted +will cause \fIxfontsel\fP to release the selection ownership and +de-highlight the widget. Activating the \fIselect\fP widget twice +is the only way to cause \fIxfontsel\fP to release the +PRIMARY_FONT selection. +.PP +.SH RESOURCES +.PP +The application class is \fBXFontSel\fP. Most of the user-interface +is configured in the app-defaults file; if this file is missing +a warning message will be printed to standard output and the +resulting window will be nearly incomprehensible. +.PP +Most of the significant parts of the widget hierarchy are documented +in +.IR __apploaddir__/XFontSel , +.PP +Application specific resources: +.PP +.TP 8 +.B "cursor (\fPclass\fB Cursor)" +Specifies the cursor for the application window. +.TP 8 +.B "pattern (\fPclass\fB Pattern)" +Specifies the font name pattern for selecting a subset of +available fonts. Equivalent to the \fB-pattern\fP option. +Most useful patterns will contain at least one field +delimiter; e.g. ``*-m-*'' for monospaced fonts. +.TP 8 +.B "pixelSizeList (\fPclass\fB PixelSizeList)" +Specifies a list of pixel sizes to add to the pixel size menu, +so that scalable fonts can be selected at those pixel sizes. +The default pixelSizeList contains 7, 30, 40, 50, and 60. +.TP 8 +.B "pointSizeList (\fPclass\fB PointSizeList)" +Specifies a list of point sizes (in units of tenths of points) to add to +the point size menu, so that scalable fonts can be selected at those +point sizes. The default pointSizeList contains 250, 300, 350, and 400. +.TP 8 +.B "printOnQuit (\fPclass\fB PrintOnQuit)" +If \fITrue\fP the currently selected font name is printed +to standard output when the quit button is activated. +Equivalent to the \fB-print\fP option. +.TP 8 +.B "sampleText (\fPclass\fB Text)" +The sample 1-byte text to use for linearly indexed fonts. +Each glyph index is a single byte, with newline separating lines. +.TP 8 +.B "sampleText16 (\fPclass\fB Text16)" +The sample 2-byte text to use for matrix-encoded fonts. +Each glyph index is two bytes, with a 1-byte newline separating lines. +.TP 8 +.B "scaledFonts (\fPclass\fB ScaledFonts)" +If \fITrue\fP then selection of arbitrary pixel and point sizes for +scalable fonts is enabled. +.PP +Widget specific resources: +.PP +.TP 8 +.B "showUnselectable (\fPclass\fB ShowUnselectable)" +Specifies, for each field menu, whether or not to show values that +are not currently selectable, based upon previous field selections. +If shown, the unselectable values are clearly identified as such +and do not highlight when the pointer is moved down the menu. +The full name of this resource is \fBfieldN.menu.options.showUnselectable\fP, +class \fBMenuButton.SimpleMenu.Options.ShowUnselectable\fP; +where N is replaced with the field +number (starting with the left-most field numbered 0). +The default is True for all but field 11 (average width of characters +in font) and False for field 11. If you never want to see +unselectable entries, '*menu.options.showUnselectable:False' is +a reasonable thing to specify in a resource file. +.PP +.SH FILES +.PP + $XFILESEARCHPATH/XFontSel +.PP +.SH SEE ALSO +xrdb(__appmansuffix__), xfd(__appmansuffix__) +.PP +.SH BUGS +.PP +Sufficiently ambiguous patterns can be misinterpreted and lead to an +initial selection string which may not correspond to what the user intended +and which may cause the initial sample text output to fail to match +the proffered string. Selecting any new field value will correct the +sample output, though possibly resulting in no matching font. +.PP +Should be able to return a FONT for the PRIMARY selection, not +just a STRING. +.PP +Any change in a field value will cause \fIxfontsel\fP to assert +ownership of the PRIMARY_FONT selection. Perhaps this should +be parameterized. +.PP +When running on a slow machine, it is possible for the user to +request a field menu before the font names have been completely +parsed. An error message indicating a missing menu is printed +to stderr but otherwise nothing bad (or good) happens. +.PP +The average-width menu is too large to be useful. +.SH COPYRIGHT +Copyright 1989, 1991, X Consortium +.PP +See \fIX(__miscmansuffix__)\fP for a full statement of rights and permissions. +.SH AUTHOR +.PP +Ralph R. Swick, Digital Equipment Corporation/MIT Project Athena +.PP +Mark Leisher <mleisher@crl.nmsu.edu> added the support for the UTF-8 sample +text. |