diff options
Diffstat (limited to 'xman.man')
| -rw-r--r-- | xman.man | 129 |
1 files changed, 44 insertions, 85 deletions
@@ -1,6 +1,6 @@ .\" $XConsortium: xman.man,v 1.23 94/04/17 20:44:02 matt Exp $ .\" -.\" $XFree86: xc/programs/xman/xman.man,v 1.5 2004/03/12 02:17:55 dickey Exp $ +.\" $XFree86: xc/programs/xman/xman.man,v 1.3 2001/01/27 18:21:18 dawes Exp $ .\" .TH XMAN 1 __xorgversion__ .SH NAME @@ -59,9 +59,9 @@ setenv MANPATH /mit/kit/man:/usr/man .PP By default, .I xman -will search each of the following directories (in each of the directories +will search each of the following directories (in each of the directories specified in the users MANPATH) for manual pages. If manual pages exist -in that directory then they are added to list of manual pages for +in that directory then they are added to list of manual pages for the corresponding menu item. A menu item is only displayed for those sections that actually contain manual pages. @@ -75,14 +75,14 @@ man2 (2) System Calls man3 (3) Subroutines man4 (4) Devices man5 (5) File Formats -man6 (6) Games +man6 (6) Games man7 (7) Miscellaneous man8 (8) Sys. Administration manl (l) Local mann (n) New mano (o) Old -.fi +.fi For instance, a user has three directories in her manual path and each contain a directory called \fIman3\fP. All these manual pages will appear alphabetically sorted when the user selects the menu item called @@ -90,31 +90,31 @@ alphabetically sorted when the user selects the menu item called any of the directories in her MANPATH, or there are no manual pages in any of the directories called \fImano\fP then no menu item will be displayed for the section called \fI(o) Old\fP. -.SH "BSD AND LINUX SYSTEMS" +.SH "BSD AND LINUX SYSTEMS" .PP -In some BSD and Linux systems, \fIXman\fP will search for a file named +In newer BSD and Linux systems, \fIXman\fP will search for a file named \fI/etc/man.conf\fP which will contain the list of directories containing manual pages. See \fIman.conf\fP(5) for a complete description of the file format. -.SH "THE MANDESC FILE" +.SH "THE MANDESC FILE" .PP -By using the \fImandesc\fP file a user or system manager is able to +By using the \fImandesc\fP file a user or system manager is able to more closely control which manual pages will appear in each of the sections -represented by menu items in the \fISections\fP menu. This +represented by menu items in the \fISections\fP menu. This functionality is only available on a section by section basis, and individual manual pages may not be handled in this manner. -(Although generous use of +(Although generous use of symbolic links \(em see \fIln\fP(1) \(em will allow almost any configuration you can imagine.) .PP The format of the mandesc file is a character followed by a label. The character determines which of the sections will be added under this label. -For instance suppose that you would like to create an extra menu item that +For instance suppose that you would like to create an extra menu item that contains all programmer subroutines. This label should contain all manual pages in both sections two and three. The \fImandesc\fP file would look like this: -.nf - +.nf + 2Programmer Subroutines 3Programmer Subroutines @@ -156,7 +156,7 @@ o(o) Old .fi Xman will read any section that is of the from \fIman<character>\fP, where <character> is an upper or lower case letter (they are treated distinctly) or -a numeral (0-9). Be warned, however, that man(1) and catman(8) will +a numeral (0-9). Be warned, however, that man(1) and catman(8) will not search directories that are non-standard. .SH WIDGETS In order to specify resources, it is useful to know the hierarchy of @@ -189,10 +189,10 @@ Xman xman \fI(This widget is never used)\fP MenuButton sections Label manualBrowser Viewport directory - List directory - List directory + List directory + List directory . - . (one for each section, + . (one for each section, . created on the fly) . ScrollByLine manualPage @@ -245,104 +245,64 @@ Xman xman \fI(This widget is never used)\fP SmeBSB quit .fi -.\" **************************************************************** .SH "APPLICATION RESOURCES" \fIxman\fP has the following application-specific resources which allow customizations unique to \fIxman\fP. .PP .TP 18 -\fBbothShown\fP (Class \fBBoolean\fP) -Either `true' or `false,' specifies whether or not you want both the -directory and the manual page shown at start up. +\fBmanualFontNormal\fP (Class \fBFont\fP) +The font to use for normal text in the manual pages. .TP 18 -\fBclearSearchString\fP (Class \fBClearSearchString\fP) -Clear the value shown in the search widget, -rather than inheriting a value from other resource settings. -The default is ``true''. +\fBmanualFontBold\fP (Class \fBFont\fP) +The font to use for bold text in the manual pages. +.TP 18 +\fBmanualFontItalic\fP (Class \fBFont\fP) +The font to use for italic text in the manual pages. .TP 18 \fBdirectoryFontNormal\fP (Class \fBFont\fP) The font to use for the directory text. .TP 18 +\fBbothShown\fP (Class \fBBoolean\fP) +Either `true' or `false,' specifies whether or not you want both the +directory and the manual page shown at start up. +.TP 18 \fBdirectoryHeight\fP (Class \fBDirectoryHeight\fP) The height in pixels of the directory, when the directory and the manual page are shown simultaneously. .TP 18 -\fBformatCommand\fP (Class \fBString\fP) -The formatting command to use to generate man pages (e.g., "|nroff -man"). +\fBtopCursor\fP (Class \fBCursor\fP) +The cursor to use in the top box. .TP 18 \fBhelpCursor\fP (Class \fBCursor\fP) The cursor to use in the help window. .TP 18 -\fBhelpFile\fP (Class \fBFile\fP) -Use this rather than the system default help file. -.TP 18 \fBmanpageCursor\fP (Class \fBCursor\fP) The cursor to use in the manual page window. .TP 18 -\fBpointerColor\fP (Class \fBForeground\fP) -This is the foreground color of all the cursors (pointers) specified above. -The name was chosen to be compatible with xterm. -.TP 18 -\fBpointerColorBackground\fP (Class \fBBackground\fP) -This is the foreground color of all the cursors (pointers) specified above. -The name was chosen to be compatible with xterm. -.TP 18 \fBsearchEntryCursor\fP (Class \fBCursor\fP) The cursor to use in the search entry text widget. .TP 18 +\fBpointerColor\fP (Class \fBForeground\fP) +This is the color of all the cursors (pointers) specified above. The +name was chosen to be compatible with xterm. +.TP 18 +\fBhelpFile\fP (Class \fBFile\fP) +Use this rather than the system default helpfile. +.TP 18 \fBtopBox\fP (Class \fBBoolean\fP) Either `true' or `false,' determines whether the top box (containing the help, quit and manual page buttons) or a manual page is put on the screen at start-up. The default is true. .TP 18 -\fBtopCursor\fP (Class \fBCursor\fP) -The cursor to use in the top box. -.\" **************************************************************** -.PP -These resources apply to the \fBViewport\fP widget: -.TP 18 \fBverticalList\fP (Class \fBBoolean\fP) -Either `true' or `false,' determines whether the directory listing is +Either `true' or `false,' determines whether the directory listing is vertically or horizontally organized. The default is horizontal (false). -You can alter this at runtime by typing control-d while within the -directory listing. -.\" **************************************************************** -.PP -These resources apply to the \fBScrollByLine\fP widget: -.TP 18 -\fBhalfLines\fP (Class \fBBoolean\fP) -If true, assume that the manpage formatter may rely on half-line spacing. -In that case, some pages are not the same number of lines. -The default is ``false''. -.TP 18 -\fBindent\fP (Class \fBBoolean\fP) -Specify the size of the left margin, -i.e., the distance by which the text is shifted right when -displaying a manual page. -The default is 15. -.TP 18 -\fBmanualFontBold\fP (Class \fBFont\fP) -The font to use for bold text in the manual pages. -.TP 18 -\fBmanualFontItalic\fP (Class \fBFont\fP) -The font to use for italic text in the manual pages. -.TP 18 -\fBmanualFontNormal\fP (Class \fBFont\fP) -The font to use for normal text in the manual pages. -.TP 18 -\fBmanualFontSymbol\fP (Class \fBFont\fP) -The font to use for symbols in the manual pages, e.g., bullets. -.TP 18 -\fBuseRight\fP (Class \fBBoolean\fP) -Allows the scrollbar to be placed on the right. -The default is ``false''. -.\" **************************************************************** .SH "GLOBAL ACTIONS" \fIXman\fP defines all user interaction through global actions. This allows the user to modify the translation table of any widget, and bind any event to the new user action. The list of actions supported by \fIxman\fP are: .TP 1.5i -.B GotoPage(\fIpage\fB) +.B GotoPage(\fIpage\fB) When used in a manual page display window this will allow the user to move between a directory and manual page display. The \fIpage\fP argument can be either \fBDirectory\fP or \fBManualPage\fP. @@ -360,7 +320,7 @@ will open a new manual page to display the results of the search, otherwise xman will attempt to display the results in the parent of the search popup. .TP 1.5i .B PopupHelp() -This action may be used anywhere, and will pop up the help widget. +This action may be used anywhere, and will popup the help widget. .TP 1.5i .B PopupSearch() This action may be used anywhere except in a help window. It will cause @@ -378,7 +338,7 @@ associated with it. .TP 1.5i .B SaveFormattedPage(\fIaction\fP) This action can only be used in the \fBlikeToSave\fP popup widget, and -tells xman whether to \fBSave\fP or \fBCancel\fP a save of the +tells xman whether to \fBSave\fP or \fBCancel\fP a save of the manual page that has just been formatted. .TP 1.5i .B ShowVersion() @@ -403,7 +363,7 @@ searches. .I "Athena Widget Set" .SH ENVIRONMENT .TP 1.5i -.B DISPLAY +.B DISPLAY the default host and display to use. .TP 1.5i .B MANPATH @@ -424,5 +384,4 @@ See \fIX(__miscmansuffix__)\fP for a full statement of rights and permissions. .SH AUTHORS Chris Peterson, MIT X Consortium from the V10 version written by Barry Shein formerly of Boston University. -Bug fixes and Linux support by Carlos A M dos Santos, The XFree86 Project. -Other improvements by Thomas Dickey, The XFree86 Project. +Bug fixes and Linux support by Carlos A M dos Santos, for The XFree86 Project. |