428
+ − 1 @comment node-name, next, previous, up
+ − 2 @node Help, Modes, Customization Basics, Top
+ − 3 @chapter Help
+ − 4 @cindex help
+ − 5
+ − 6
+ − 7 XEmacs provides a comprehensive Help facility. On the extreme right of
+ − 8 the menu-bar there is a @b{Help} menu. There are several help commands
+ − 9 provided by this menu. You can also use @kbd{C-h} for invoking the Help
+ − 10 facility. Type "?" for a list of keys you can type after typing
+ − 11 @kbd{C-h}. If you want more information on what your options are and
+ − 12 what kind of help you can get type "?" again. You will get a listing of
+ − 13 all the keys you can type and what they will do. Initially if you want
+ − 14 help, type @kbd{C-h} three times.
+ − 15
+ − 16 @comment node-name, next, previous, up
+ − 17 @menu
+ − 18 * The Help Menu:: Items on the Help menu
+ − 19 @end menu
+ − 20
+ − 21 @node The Help Menu, , Help, Help
+ − 22 @section Help menu
+ − 23 @cindex help
+ − 24
+ − 25 When you click on the Help menu with any of the mouse buttons you will
+ − 26 get the following menu items:
+ − 27
+ − 28 @table @b
+ − 29 @item Info
+ − 30 Selecting this item will take you to the Info page which is the online
+ − 31 documentation browsing system. You can simply click on the highlighted
+ − 32 items and "Info" will take you to the document providing information
+ − 33 about that topic.
+ − 34
+ − 35 @item Describe Mode
+ − 36 After you select this item, you will get a documentation on the major
+ − 37 and minor modes which are enabled in the buffer you are working
+ − 38 with. @xref{Modes}, for information on Modes.
+ − 39
+ − 40 @item Hyper Apropos...
+ − 41 After you select this item, you will see the following message in the
+ − 42 echo area:
+ − 43
+ − 44 @example
+ − 45 List symbols matching regexp:
+ − 46 @end example
+ − 47
+ − 48 @noindent
+ − 49 If you type "mode" and hit @key{RET}, you will get a list of all the
+ − 50 symbols (like functions and commands). You can now get documentation on
+ − 51 any of the given symbols by "clicking" on any of the symbols (i.e. drag
+ − 52 your mouse on the appropriate symbol and release the button). For
+ − 53 example, if you "click" on the 'auto-fill-mode' you will get the
+ − 54 following message in the window at the bottom:
+ − 55
+ − 56 @example
+ − 57 auto-fill-mode
+ − 58
+ − 59 Function, Command:
+ − 60
+ − 61 Toggle auto-fill mode.
+ − 62 With arg, turn auto-fill mode on if and only if arg is positive.
+ − 63 In auto-fill mode, inserting a space at a column beyond `fill-column'
+ − 64 automatically breaks the line at a previous space.
+ − 65
+ − 66 Variable:
+ − 67
+ − 68 value = nil
+ − 69
+ − 70 variable not documented
+ − 71 @end example
+ − 72
+ − 73 @item Command Apropos...
+ − 74 Selecting this item will prompt you for a string just like when you
+ − 75 select @b{Hyper Apropos...}. After you give a string name, you will get
+ − 76 a listing of all the functions and commands containing that string name
+ − 77 with a very short description about what that command does.
+ − 78
+ − 79 @item Full Apropos...
+ − 80 After you select this item, you will be prompted for a string name in
+ − 81 the echo area:
+ − 82
+ − 83 @example
+ − 84 Apropos (regexp):
+ − 85 @end example
+ − 86
+ − 87 @noindent
+ − 88 Now you can give any string name, for example "mode" and hit
+ − 89 @key{RET}. You will get a listing of all the variables and commands
+ − 90 containing that string i.e "mode" with a short description of its
+ − 91 function.
+ − 92
+ − 93 @item List Keybindings
+ − 94 Select this item and you will get a listing of all the keys and the
+ − 95 commands that they execute. Depending on which Major mode your buffer is
+ − 96 in, you will get a listing of the special keybindings for that
+ − 97 particular buffer also. For example, if you are in "Texinfo" mode, part
+ − 98 of your list will contain:
+ − 99
+ − 100 @example
440
+ − 101 C-c C-c n texinfo-insert-@@node
+ − 102 C-c C-c o texinfo-insert-@@noindent
+ − 103 C-c C-c s texinfo-insert-@@samp
+ − 104 C-c C-c t texinfo-insert-@@table
+ − 105 C-c C-c v texinfo-insert-@@var
+ − 106 C-c C-c x texinfo-insert-@@example
+ − 107 C-c C-c @{ texinfo-insert-braces
428
+ − 108 @end example
+ − 109 @noindent
+ − 110 These keybindings apply only to "Texinfo" mode. @xref{Modes}, for more
+ − 111 information on various modes.
+ − 112
+ − 113 @item Describe Key...
+ − 114 After you select this item, you will be see the following message in the
+ − 115 echo area:
+ − 116
+ − 117 @example
+ − 118 Describe Key:
+ − 119 @end example
+ − 120 After you type a command key sequence, full documentation of that
+ − 121 command will be displayed. For example if you type @kbd{C-g}, you will
+ − 122 see the following documentation for @kbd{C-g}:
+ − 123
+ − 124 @kindex C-g
+ − 125 @example
+ − 126 keyboard-quit:
+ − 127 Signal a `quit' condition.
+ − 128 @end example
+ − 129 This means that @kbd{C-g} will quit whatever command you gave earlier.
+ − 130
+ − 131 @kindex C-h d
+ − 132 @item Describe Function...
+ − 133 This menu item provides documentation for a function. After you select
+ − 134 this item, it will prompt you for a function name in the echo area:
+ − 135
+ − 136 @example
+ − 137 Describe function (default <some function name>):
+ − 138 @end example
+ − 139 @noindent
+ − 140 If you hit @key{RET} without giving a function name, you will get
+ − 141 documentation for that default function name, otherwise if you type a
+ − 142 function name and hit @key{RET}, you will get documentation for the
+ − 143 given function.
+ − 144
+ − 145 @kindex C-h k
+ − 146 @item Describe Variable...
+ − 147 You can get documentation on any variable by selecting this menu
+ − 148 item. It is similar to @b{Describe Function} and will prompt you for a
+ − 149 variable name.
+ − 150
+ − 151 @item Unix Manual...
+ − 152 After you select this item you will be prompted for a Unix command for
+ − 153 which you wish to see the man page. You will see the following message
+ − 154 in the echo area:
+ − 155
+ − 156 @example
+ − 157 Manual entry: (default <some name>)
+ − 158 @end example
+ − 159 @noindent
+ − 160 Now you can type any command, for example type @samp{who} and press
+ − 161 @key{RET}. You will get the man page for the Unix command @samp{who} which
+ − 162 lists who is on the system.
+ − 163
+ − 164 @item Emacs Tutorial
+ − 165 Select this item and you will get a tutorial on Emacs. It is good for new
+ − 166 users.
+ − 167
+ − 168 @item Emacs News
+ − 169 Select this item and you will get a lot of historical and current news
+ − 170 on Emacs !
+ − 171
+ − 172 @end table
+ − 173
+ − 174 For more information on the Help facility, @xref{Help,,,xemacs,XEmacs
+ − 175 User's Manual}.
+ − 176
+ − 177
+ − 178
+ − 179
+ − 180
+ − 181
+ − 182
+ − 183
+ − 184
+ − 185
+ − 186
+ − 187
