1 2 3XMAN is an X Window System manual browsing tool. 4 5 6 7GETTING STARTED 8 9By default, xman starts by creating a small window that contains three 10"buttons" (places on which to click a pointer button). Two of these 11buttons, Help and Quit, are self-explanatory. The third, Manual Page, 12creates a new manual page browser window; you may use this button to 13open a new manual page any time xman is running. 14 15A new manual page starts up displaying this help information. The 16manual page contains three sections. In the upper left corner are two 17menu buttons. When the mouse is clicked on either of these buttons a 18menu is popped up. The contents of these menus is described below. 19Directly to the right of the menu buttons is an informational display. 20This display usually contains the name of the directory or manual page 21being displayed. It is also used to display warning messages and the 22current version of xman. The last and largest section is the 23information display. This section of the application contains either a 24list of manual pages to choose from or the text of a manual page. 25 26To use xman pull down the Sections menu to select a manual section. 27When the section is displayed, click the left pointer button on the name 28of the manual page that you would like to see. Xman will replace the 29directory listing with the manual page you selected. 30 31That should be enough to get you started. Once you understand the 32basics of how to use xman, take a look at the rest of this file to see 33the advanced features that are available to make using xman fast and 34efficient. 35 36 37SCROLLING TEXT 38 39The scroll bars are similar to xterm and xmh scroll bars; clicking the 40left or right pointer button with the pointer at the bottom of the 41scroll bar will scroll the text down or up one page, respectively. 42Clicking with the pointer farther up the scroll bar scrolls 43proportionally less than one page. Clicking the middle button a portion 44of the way down the scroll bar will move the text window that portion of 45the way down the text. Holding the middle button and moving the pointer 46up and down allows the text to be scrolled dynamically. 47 48You may also type 'f' or <space bar> to scroll down one page, and 'b' to 49scroll up one page. 50 51 52RESIZING WINDOWS 53 54You can resize any of the windows in xman with your window manager, and 55xman will do the best it can to resize everything internally into a 56useful configuration. The only control over the internal arrangement 57that you have is moving the border between the manual page and directory 58when both are displayed. This is done by clicking and holding the any 59pointer button when the cursor is over the small square (grip) on the 60right side of the screen. The grip is located on the horizontal line 61which separates the panes. The grip may be moved up and down to resize 62the panes of the screen, and when the pointer button is released xman 63will move the pane boundary to the newly specified location. 64 65 66MENU COMMANDS 67 68There are two ways to activate the menus. The first is to click any 69pointer button in the menu button corresponding to the menu you want to 70activate. The second method is to hold down the "Control" key and click 71the left pointer button for the Options menu or the middle pointer 72button for the Sections menu. Regardless of how the menu was 73activated, selecting items is the same. 74 75Once a menu is activated, continue to hold down the pointer button and 76drag the pointer cursor over the item that you would like to activate. 77Once the item that you want to select is highlighted, select it by 78releasing the pointer button. To avoid making a menu selection, move 79the pointer cursor outside the menu and release the button. 80 81Selecting one of the items in the Sections menu will display the named 82directory. 83 84The following commands are available through the Options menu: 85 86Display Directory Show the current section directory. 87 88Display Manual Page Show the current manual page. 89 90Help Create a help window with this text displayed. 91 92Search Pop up a dialogue box that allows the entire 93 tree of manual pages to be searched for a 94 specific name. A keyword (apropos) search is 95 also available through this dialogue box. 96 97Show Both Screens Split the manual page display window to display 98 both the current manual page and the directory. 99Show One Screen Return to a single screen display of either a 100 manual page or directory listing. 101 102Remove This Man Page Remove this manual page, do not quit. 103 104Open New Man Page Pop up a new manual page browser window. 105 106Show Version Print the current version of xman to the 107 information display window. Please include the 108 version number when reporting bugs. 109 110Quit Close all xman windows and quit xman. 111 112 113SUMMARY OF BASIC ACTIONS 114 115In a menu button: 116 117 CLICK: Pop up a menu 118 119In a directory, manual page, or scroll bar: 120 121 <CONTROL> CLICK LEFT: Pop up the Options menu. 122 <CONTROL> CLICK MIDDLE: Pop up the Sections menu. 123 124In a directory: 125 126 CLICK LEFT: Bring up named manual page 127 <SHIFT> CLICK MIDDLE: Go to manual page previously chosen. 128 129In a manual page or apropos listing: 130 131 <SHIFT> CLICK MIDDLE: Go to directory of manual pages. 132 133In scroll bars: 134 135 CLICK LEFT: Move down - more if pointer is near bottom 136 of window, less if at top. 137 CLICK MIDDLE: Move top of page to current pointer position. 138 CLICK RIGHT: Move up - more if pointer is near bottom 139 of window, less if at top. 140 141SEARCHING 142 143Xman has a built-in searching utility that allows the user to search the 144entire manual page tree for a specific topic (manual page search) or a 145keyword (apropos search). The search dialogue box can be activated from 146the Options menu, or by the key Control-s. If the search is started 147from the small initial topbox xman will open a new manual page if the 148search was successful, and fail silently if the search was unsuccessful. 149 150Manual page searches are performed starting in the currently displayed 151section. If no match is found then the remaining sections are searched 152in the order that the sections appear in the Sections menu, starting at 153the top. The current version of xman immediately displays the first 154manual page that it finds. If the manual page cannot be found that fact 155is noted in the informational display. 156 157An apropos search will search a list of short descriptions for all 158manual pages on the system and return a list of all descriptions which 159contain the keyword specified. 160 161 162KEYBOARD ACCELERATORS 163 164Xman contains a set of preinstalled keyboard accelerators. These are a 165set of key bindings that perform many of the same operations as the menu 166items. Since it is not necessary to pull down the menu, these actions 167can be performed more quickly, hence the name accelerators. 168 169The default key bindings for xman are: 170 171Anywhere: 172 173 Control - c Exit xman 174 Control - h Create the help window 175 Control - n Create a new man page 176 Control - q Exit xman 177 Control - s Create a search popup 178 179In a manual page, directory, or help window: 180 181 Control - r Remove this manual page or help display 182 Control - v Show the current version of xman 183 184In a manual page or directory: 185 186 Control - d Display Directory 187 Control - m Display Man Page 188 189In a manual page only: 190 191 b Page Back 192 f Page forward 193 <Space> Page forward 194 1 One line forward 195 2 Two lines forward 196 3 Three lines forward 197 4 Four lines forward 198 199Note: Control-s does not have any effect in the help window. 200 201 202FURTHER INFORMATION 203 204Xman is highly customizable. Through the X resource database a user can 205customize the look and feel of this application so that it meets a 206preferred style of interaction. Almost any configuration that is 207available dynamically can be specified through resources. This includes 208changing the size, color, and fonts, starting with no topbox, showing 209both screens, and rebinding the keyboard accelerators. 210 211The information on customizing xman is contained in the xman manual 212page, I will leave it to you to figure out how to find and display that 213information :-) 214 215 216 Chris D. Peterson MIT X 217 Consortium 218 219CREDITS 220 221Version: Use 'Show Version' menu item. 222Written By: Chris D. Peterson - formerly MIT X Consortium 223Based Upon: Xman for X10 by Barry Shein - Boston University 224 225Copyright 1988, 1989 X Consortium 226Edited by Donna Converse and Dave Sternlicht 227 228 229