XHELP(1X11) COMMAND REFERENCE XHELP(1X11) NAME xhelp - user interface for the online manual pages SYNOPSIS xhelp [ section ] [ -display display ] [ -geometry geometry ] [ -ic ] name This is a supported client. DESCRIPTION This command provides an X Window System-based user interface to the online manual pages. When xhelp is invoked, the main window appears. The panes which make up this window are as follows: +------------------------------------------------+ | title pane (label)| +------------------------------------------------+ | summary pane (text)| +------------------------------------------------+ | command pane (buttons)| +------------------------------------------------+ | section pane (buttons)| +------------------------------------------------+ | | | manual page pane (text)| | | +------------------------------------------------+ These panes are described in the following sections. USES Creating a Window Once xhelp has been invoked there will be about a five second pause then upper left corner cursor will appear on the screen. Position the cursor at the location you want xhelp to appear, then click the left mouse button. There will be a pause of less than 20 seconds, then the xhelp window will appear. Buttons with '...' All buttons which are labeled with a word followed by a " ... " will display a prompt, menu, or list when selected. Buttons with NO '...' All buttons which have a single word as a label will perform their action immediately after the button is selected. Printed 3/22/89 1
XHELP(1X11) COMMAND REFERENCE XHELP(1X11) Pane Size Knobs On the right side of the xhelp panes appear several small square boxes. Each knob allows the border between the sections above and below it to be moved. the name of the man page being viewed appears displays a short description of the information found in the man page contains seven buttons and looks like this: +-----+--------+--------+------+---------+----------+------+ |quit |help... |refer...|new...|search...|apropos...|print | +-----+--------+--------+------+---------+----------+------+ Click the left mouse button to select any of the buttons. quit button - exits xhelp. Note that pressing the quit button will cause all child incarnations of xhelp to also exit. help button - uses the xhelp utility to display this man page. refer button - pops up a list of man pages listed in the SEE ALSO section (see the section titled REFER ). new button - prompts for another manual page section and name (see the section titled NEW ). search button - finds a string in the manual page pane (see the section titled SEARCH ). apropos button - runs apropos(1) and captures the output to use to invoke a new xhelp (see the section titled APROPOS ). print button - sends the currently viewed man page to lpr(1) contains a button for each section in the man page; clicking the left mouse button on any of the section buttons will cause that section to appear at the top of the manual page pane lowest pane; contains the text of the manual page. To scroll the manual page either the scroll bar on the left (see the section titled SCROLL BARS ) or the editing movement commands (see the section titled EDITING) may be used. Printed 3/22/89 2
XHELP(1X11) COMMAND REFERENCE XHELP(1X11) REFER Clicking the left mouse button on the refer button causes the Man Page list to popup. It contains an entry for each manual page referenced in the manual page's SEE ALSO section. Clicking the left mouse button on any of these entries and then on the ok button in the Man Page popup window will cause xhelp to be invoked for that manual page. If the desired man page name is not visible, use the scrollbar (see SCROLL BAR ) or the editing movement commands (see EDITING ). Man pages not listed in the Man Page popup window may be viewed using the new button. NEW When the left mouse button is clicked on the new button a prompt appears. The prompt looks like: +------------------------------------------+ |Enter manpage ([section] title): | | ---------------------------------------- | | | | | | ---------------------------------------- | | | ok | cancel | | +------------------------------------------+ When the prompt appears the user may: o enter a manpage name (and section), then click the ok button o click the cancel button to do nothing The ok button will cause xhelp to be invoked for the new manual page. APROPOS When the left button is clicked on the apropos button a dialog window pops up. The user is prompted for the name of a string to use as input for the apropos(1) command. After entering this string and clicking on ok, a few seconds pause occurs, then another window pops up. Inside this window is the output from apropos(1). Selecting one of these lines and ok will cause xhelp to be invoked with the man page shown on that line as its argument. At any stage, selecting cancel aborts the whole operation. INVOCATION When xhelp is invoked without a name argument the following prompt appears: +------------------------------------------+ |Enter manpage ([section] title): | | ---------------------------------------- | Printed 3/22/89 3
XHELP(1X11) COMMAND REFERENCE XHELP(1X11) | | | | | ---------------------------------------- | | | ok | cancel | | +------------------------------------------+ When the prompt appears the user may: o enter a manpage name (and section), then click the ok button o click the cancel button to do nothing The ok button will cause xhelp to be invoked for the new manual page. SEARCH The following tips should help in using the search button in xhelp: o a regular expression may be used as the string o the search will wrap from the bottom to the top of the manual page. o the prompt remains visible until the cancel button is pressed. This allows the user to step through a series of searches by just pressing the ok button. o the RUB OUT key is used to delete the previous character o if the string appears odd (control characters are present) press <Ctrl> A followed by <Ctrl> K to clear the prompt value. o All editing commands are available when entering the string (see EDITING ). SCROLL BARS Along the left side of the manual page pane is a scroll bar. The scroll bar consists of three parts: slide region - a long narrow rectangle which represents all of the text (not just the page shown in text pane). thumb - a small rectangle inside the slide region. The thumb is controlled by pressing one of the mouse buttons and moving the mouse up and down. The thumb color is the inverse of the slide region's color. If the thumb is not visible all of the text is being displayed in the text pane. Printed 3/22/89 4
XHELP(1X11) COMMAND REFERENCE XHELP(1X11) scroll cursors - there are four cursors which appear in the scroll bar depending on which mouse button is being pressed (see below). While the mouse cursor is in the scroll bar's slide region a double headed arrow cursor is visible. The mouse buttons control the movement of the thumb. The mouse buttons have the following effects: left button - scrolls the text up (the up cursor is displayed) middle button - positions the text (the right cursor is displayed) (ex. By placing the mouse cursor in the middle of the slide region, then clicking the middle mouse button, the text will be positioned so that the middle lines of text will be displayed in the text pane). Holding the middle button down while moving up and down the scrollbar allows the user to scroll up and down through the text. right button - scrolls the text down (the down cursor is displayed) The location of the mouse relative to the top and bottom of the slide region affects the left and right mouse actions. If the cursor is at the top of the slide region the text will scroll one line at a time. If the cursor is at the bottom of the slide region the text will scroll one page at a time. If the cursor is between the top and the bottom the text will scroll two to "page-1" lines depending upon the cursor's position. EDITING The following are the commands available while the user is in a text pane (manual page pane or the new button's prompt pane). -- CURSOR MOVEMENT -- <Ctrl>F forward character <Ctrl>B backward character <Meta>F forward word <Meta>B backward word <Ctrl>A beginning of line <Ctrl>E end of line <Ctrl>N next line <Ctrl>P previous line <Ctrl>V next page <Meta>V previous page <Ctrl>Z scroll one line up <Meta>Z scroll one line down Printed 3/22/89 5
XHELP(1X11) COMMAND REFERENCE XHELP(1X11) -- DELETION AND INSERTION -- <Ctrl>D delete next char <Ctrl>H delete previous char <Meta>D delete next word <Meta>H delete previous word <Meta>Y stuff <Ctrl>J newline and indent <Ctrl>O newline and backup <Ctrl>M newline <Ctrl>W kill selection <Ctrl>K kill to end of line shift<Meta>D kill word <Ctrl>Y unkill shift<Meta>H backward kill word <Meta>K kill to end of paragraph -- OTHER -- <Ctrl>L redraw display <Meta>I insert file -- TEXT SELECTION -- <BtnDown>left select start <PtrMoved>left extend adjust <BtnUp>left extend end <BtnDown>right extend start <PtrMoved>right extend adjust <BtnUp>right extend end OPTIONS section - the manual page's section name - the name of the manual page. May either be the name of a command (cc) or a complete path to an online man page (/usr/man/cat1/cc.1). display - the display on which xhelp will appear. geometry - the size and location of the xhelp window. Default size is 680 x 770. ic - xhelp comes up as an icon. RESOURCES The usual client resource specifications may be used to customize the behavior of xhelp. Here is one user's resource specification for xhelp: xhelp*Background: MediumGoldenrod xhelp*Foreground: Salmon xhelp*Text*font: pellucidatypewriter12 xhelp*iconX: 5 xhelp*iconY: 106 Printed 3/22/89 6
XHELP(1X11) COMMAND REFERENCE XHELP(1X11) xhelp.Wm_option.autoRaise: on xhelp.Wm_option.raiseDelay: 50 FILES /usr/lib/man/sections - known manual page sections /usr/lib/man/directories - manual page search directory information SEE ALSO man(1man). Printed 3/22/89 7
%%index%% na:336,102; sy:438,719; de:1157,2830;4395,4133;8936,3893;13237,3601;17246,3258;20912,798; op:21710,1503;23621,81; fi:23702,655; se:24357,149; %%index%%000000000175