translation approved by the author instead of in the original English.
\1f
-File: xemacs.info, Node: Completion, Next: Repetition, Prev: Minibuffer Edit, Up: Minibuffer
+File: xemacs.info, Node: Completion, Next: Minibuffer History, Prev: Minibuffer Edit, Up: Minibuffer
Completion
==========
- When appropriate, the minibuffer provides a "completion" facility.
-You type the beginning of an argument and one of the completion keys,
-and Emacs visibly fills in the rest, depending on what you have already
-typed.
+ For certain kinds of arguments, you can use "completion" to enter
+the argument value. Completion means that you type part of the
+argument, then XEmacs visibly fills in the rest, or as much as can be
+determined from the part you have typed.
When completion is available, certain keys--<TAB>, <RET>, and
-<SPC>--are redefined to complete an abbreviation present in the
-minibuffer into a longer string that it stands for, by matching it
-against a set of "completion alternatives" provided by the command
-reading the argument. `?' is defined to display a list of possible
-completions of what you have inserted.
-
- For example, when the minibuffer is being used by `Meta-x' to read
-the name of a command, it is given a list of all available Emacs command
-names to complete against. The completion keys match the text in the
-minibuffer against all the command names, find any additional
-characters of the name that are implied by the ones already present in
-the minibuffer, and add those characters to the ones you have given.
+<SPC>--are rebound to complete the text present in the minibuffer into
+a longer string that it stands for, by matching it against a set of
+"completion alternatives" provided by the command reading the argument.
+`?' is defined to display a list of possible completions of what you
+have inserted.
+
+ For example, when `M-x' uses the minibuffer to read the name of a
+command, it provides a list of all available XEmacs command names to
+complete against. The completion keys match the text in the minibuffer
+against all the command names, find any additional name characters
+implied by the ones already present in the minibuffer, and add those
+characters to the ones you have given. This is what makes it possible
+to type `M-x inse <SPC> b <RET>' instead of `M-x insert-buffer <RET>'
+(for example).
Case is normally significant in completion because it is significant
-in most of the names that you can complete (buffer names, file names,
-and command names). Thus, `fo' will not complete to `Foo'. When you
-are completing a name in which case does not matter, case may be ignored
+in most of the names that you can complete (buffer names, file names and
+command names). Thus, `fo' does not complete to `Foo'. When you are
+completing a name in which case does not matter, case may be ignored
for completion's sake if specified by program.
When a completion list is displayed, the completions will highlight
any highlighted completion will "select" it just as if you had typed it
in and hit <RET>.
-A Completion Example
---------------------
+* Menu:
+
+* Example: Completion Example.
+* Commands: Completion Commands.
+* Strict Completion::
+* Options: Completion Options.
+
+\1f
+File: xemacs.info, Node: Completion Example, Next: Completion Commands, Prev: Completion, Up: Completion
+
+Completion Example
+------------------
- Consider the following example. If you type `Meta-x au <TAB>',
+ A concrete example may help here. If you type `M-x au <TAB>', the
<TAB> looks for alternatives (in this case, command names) that start
-with `au'. There are only two commands: `auto-fill-mode' and
-`auto-save-mode'. They are the same as far as `auto-', so the `au' in
-the minibuffer changes to `auto-'.
+with `au'. There are several, including `auto-fill-mode' and
+`auto-save-mode'--but they are all the same as far as `auto', so the
+`au' in the minibuffer changes to `auto'.
- If you type <TAB> again immediately, there are multiple possibilities
-for the very next character--it could be `s' or `f'--so no more
-characters are added; but a list of all possible completions is
-displayed in another window.
+ If you type <TAB> again immediately, there are multiple
+possibilities for the very next character--it could be any of `c-'--so
+no more characters are added; instead, <TAB> displays a list of all
+possible completions in another window.
If you go on to type `f <TAB>', this <TAB> sees `auto-f'. The only
-command name starting this way is `auto-fill-mode', so completion
-inserts the rest of that command. You now have `auto-fill-mode' in the
-minibuffer after typing just `au <TAB> f <TAB>'. Note that <TAB> has
-this effect because in the minibuffer it is bound to the function
-`minibuffer-complete' when completion is supposed to be done.
+command name starting this way is `auto-fill-mode', so completion fills
+in the rest of that. You now have `auto-fill-mode' in the minibuffer
+after typing just `au <TAB> f <TAB>'. Note that <TAB> has this effect
+because in the minibuffer it is bound to the command
+`minibuffer-complete' when completion is available.
+
+\1f
+File: xemacs.info, Node: Completion Commands, Next: Strict Completion, Prev: Completion Example, Up: Completion
Completion Commands
-------------------
- Here is a list of all the completion commands defined in the
-minibuffer when completion is available.
+ Here is a list of the completion commands defined in the minibuffer
+when completion is available.
`<TAB>'
Complete the text in the minibuffer as much as possible
(`minibuffer-complete').
`<SPC>'
- Complete the text in the minibuffer but don't add or fill out more
- than one word (`minibuffer-complete-word').
+ Complete the minibuffer text, but don't go beyond one word
+ (`minibuffer-complete-word').
`<RET>'
Submit the text in the minibuffer as the argument, possibly
Clicking <button2> will select the highlighted completion and exit
the minibuffer. (`minibuf-select-highlighted-completion').
- <SPC> completes in a way that is similar to <TAB>, but it never goes
-beyond the next hyphen or space. If you have `auto-f' in the
-minibuffer and type <SPC>, it finds that the completion is
-`auto-fill-mode', but it stops completing after `fill-'. The result is
-`auto-fill-'. Another <SPC> at this point completes all the way to
-`auto-fill-mode'. <SPC> in the minibuffer runs the function
-`minibuffer-complete-word' when completion is available.
+ <SPC> completes much like <TAB>, but never goes beyond the next
+hyphen or space. If you have `auto-f' in the minibuffer and type
+<SPC>, it finds that the completion is `auto-fill-mode', but it stops
+completing after `fill-'. This gives `auto-fill-'. Another <SPC> at
+this point completes all the way to `auto-fill-mode'. <SPC> in the
+minibuffer when completion is available runs the command
+`minibuffer-complete-word'.
+
+ Here are some commands you can use to choose a completion from a
+window that displays a list of completions:
+
+`button2up'
+ Clicking mouse button 2 on a completion in the list of possible
+ completions chooses that completion (`mouse-choose-completion').
+ You normally use this command while point is in the minibuffer;
+ but you must click in the list of completions, not in the
+ minibuffer itself.
+
+`<RET>'
+ Typing <RET> _in the completion list buffer_ chooses the
+ completion that point is in or next to (`choose-completion'). To
+ use this command, you must first switch windows to the window that
+ shows the list of completions.
+
+`<RIGHT>'
+`<TAB>'
+`C-f'
+ Typing the right-arrow key <RIGHT>, <TAB> or `C-f' _in the
+ completion list buffer_ moves point to the following completion
+ (`next-list-mode-item').
+
+`<LEFT>'
+`C-b'
+ Typing the left-arrow key <LEFT> or `C-b' _in the completion list
+ buffer_ moves point toward the beginning of the buffer, to the
+ previous completion (`previous-list-mode-item').
+
+\1f
+File: xemacs.info, Node: Strict Completion, Next: Completion Options, Prev: Completion Commands, Up: Completion
+
+Strict Completion
+-----------------
There are three different ways that <RET> can work in completing
minibuffers, depending on how the argument will be used.
Cautious completion is used for reading file names for files that
must already exist.
- * "Permissive" completion is used when any string is meaningful, and
- the list of completion alternatives is just a guide. For example,
- when `C-x C-f' reads the name of a file to visit, any file name is
- allowed, in case you want to create a file. In permissive
- completion, <RET> takes the text in the minibuffer exactly as
- given, without completing it.
+ * "Permissive" completion is used when any string whatever is
+ meaningful, and the list of completion alternatives is just a
+ guide. For example, when `C-x C-f' reads the name of a file to
+ visit, any file name is allowed, in case you want to create a
+ file. In permissive completion, <RET> takes the text in the
+ minibuffer exactly as given, without completing it.
- The completion commands display a list of all possible completions
-in a window whenever there is more than one possibility for the very
-next character. Typing `?' explicitly requests such a list. The list
-of completions counts as help text, so `C-M-v' typed in the minibuffer
-scrolls the list.
+ The completion commands display a list of all possible completions in
+a window whenever there is more than one possibility for the very next
+character. Also, typing `?' explicitly requests such a list. If the
+list of completions is long, you can scroll it with `C-M-v' (*note
+Other Window::).
+
+\1f
+File: xemacs.info, Node: Completion Options, Prev: Strict Completion, Up: Completion
+
+Completion Options
+------------------
When completion is done on file names, certain file names are usually
ignored. The variable `completion-ignored-extensions' contains a list
of strings; a file whose name ends in any of those strings is ignored
as a possible completion. The standard value of this variable has
several elements including `".o"', `".elc"', `".dvi"' and `"~"'. The
-effect is that, for example, `foo' completes to `foo.c' even though
-`foo.o' exists as well. If the only possible completions are files
-that end in "ignored" strings, they are not ignored.
+effect is that, for example, `foo' can complete to `foo.c' even though
+`foo.o' exists as well. However, if _all_ the possible completions end
+in "ignored" strings, then they are not ignored. Ignored extensions do
+not apply to lists of completions--those always mention all possible
+completions.
If a completion command finds the next character is undetermined, it
automatically displays a list of all possible completions. If the
This is helpful for catching typos.
\1f
-File: xemacs.info, Node: Repetition, Prev: Completion, Up: Minibuffer
+File: xemacs.info, Node: Minibuffer History, Next: Repetition, Prev: Completion, Up: Minibuffer
+
+Minibuffer History
+==================
+
+ Every argument that you enter with the minibuffer is saved on a
+"minibuffer history list" so that you can use it again later in another
+argument. Special commands load the text of an earlier argument in the
+minibuffer. They discard the old minibuffer contents, so you can think
+of them as moving through the history of previous arguments.
+
+`<UP>'
+`M-p'
+ Move to the next earlier argument string saved in the minibuffer
+ history (`previous-history-element').
+
+`<DOWN>'
+`M-n'
+ Move to the next later argument string saved in the minibuffer
+ history (`next-history-element').
+
+`M-r REGEXP <RET>'
+ Move to an earlier saved argument in the minibuffer history that
+ has a match for REGEXP (`previous-matching-history-element').
+
+`M-s REGEXP <RET>'
+ Move to a later saved argument in the minibuffer history that has a
+ match for REGEXP (`next-matching-history-element').
+
+ The simplest way to reuse the saved arguments in the history list is
+to move through the history list one element at a time. While in the
+minibuffer, use `M-p' or up-arrow (`previous-history-element') to "move
+to" the next earlier minibuffer input, and use `M-n' or down-arrow
+(`next-history-element') to "move to" the next later input.
+
+ The previous input that you fetch from the history entirely replaces
+the contents of the minibuffer. To use it as the argument, exit the
+minibuffer as usual with <RET>. You can also edit the text before you
+reuse it; this does not change the history element that you "moved" to,
+but your new argument does go at the end of the history list in its own
+right.
+
+ For many minibuffer arguments there is a "default" value. In some
+cases, the minibuffer history commands know the default value. Then you
+can insert the default value into the minibuffer as text by using `M-n'
+to move "into the future" in the history.
+
+ There are also commands to search forward or backward through the
+history; they search for history elements that match a regular
+expression that you specify with the minibuffer. `M-r'
+(`previous-matching-history-element') searches older elements in the
+history, while `M-s' (`next-matching-history-element') searches newer
+elements. By special dispensation, these commands can use the
+minibuffer to read their arguments even though you are already in the
+minibuffer when you issue them. As with incremental searching, an
+uppercase letter in the regular expression makes the search
+case-sensitive (*note Search Case::).
+
+ All uses of the minibuffer record your input on a history list, but
+there are separate history lists for different kinds of arguments. For
+example, there is a list for file names, used by all the commands that
+read file names.
+
+ There are several other very specific history lists, including one
+for command names read by `M-x', one for buffer names, one for arguments
+of commands like `query-replace', and one for compilation commands read
+by `compile'. Finally, there is one "miscellaneous" history list that
+most minibuffer arguments use.
+
+\1f
+File: xemacs.info, Node: Repetition, Prev: Minibuffer History, Up: Minibuffer
Repeating Minibuffer Commands
=============================
Every command that uses the minibuffer at least once is recorded on a
-special history list, together with the values of the minibuffer
-arguments, so that you can repeat the command easily. In particular,
-every use of `Meta-x' is recorded, since `M-x' uses the minibuffer to
-read the command name.
+special history list, together with the values of its arguments, so that
+you can repeat the entire command. In particular, every use of `M-x'
+is recorded there, since `M-x' uses the minibuffer to read the command
+name.
-`C-x <ESC>'
- Re-execute a recent minibuffer command
- (`repeat-complex-command').
+`C-x <ESC> <ESC>'
+ Re-execute a recent minibuffer command (`repeat-complex-command').
`M-p'
Within `C-x <ESC>', move to previous recorded command
`M-x list-command-history'
Display the entire command history, showing all the commands `C-x
- <ESC>' can repeat, most recent first.
+ <ESC> <ESC>' can repeat, most recent first.
- `C-x <ESC>' is used to re-execute a recent command that used the
-minibuffer. With no argument, it repeats the last command. A numeric
-argument specifies which command to repeat; 1 means the last one, and
-larger numbers specify earlier commands.
+ `C-x <ESC> <ESC>' is used to re-execute a recent minibuffer-using
+command. With no argument, it repeats the last such command. A
+numeric argument specifies which command to repeat; one means the last
+one, and larger numbers specify earlier ones.
- `C-x <ESC>' works by turning the previous command into a Lisp
+ `C-x <ESC> <ESC>' works by turning the previous command into a Lisp
expression and then entering a minibuffer initialized with the text for
that expression. If you type just <RET>, the command is repeated as
-before. You can also change the command by editing the Lisp expression.
-The expression you finally submit will be executed. The repeated
-command is added to the front of the command history unless it is
-identical to the most recently executed command already there.
+before. You can also change the command by editing the Lisp
+expression. Whatever expression you finally submit is what will be
+executed. The repeated command is added to the front of the command
+history unless it is identical to the most recently executed command
+already there.
Even if you don't understand Lisp syntax, it will probably be obvious
which command is displayed for repetition. If you do not change the
text, you can be sure the command will repeat exactly as before.
- If you are in the minibuffer for `C-x <ESC>' and the command shown
-to you is not the one you want to repeat, you can move around the list
-of previous commands using `M-n' and `M-p'. `M-p' replaces the
+ If you are in the minibuffer for `C-x <ESC> <ESC>' and the command
+shown to you is not the one you want to repeat, you can move around the
+list of previous commands using `M-n' and `M-p'. `M-p' replaces the
contents of the minibuffer with the next earlier recorded command, and
`M-n' replaces it with the next later command. After finding the
desired previous command, you can edit its expression and then resubmit
it by typing <RET>. Any editing you have done on the command to be
repeated is lost if you use `M-n' or `M-p'.
- `M-n' and `M-p' are specially defined within `C-x <ESC>' to run the
-commands `previous-history-element' and `next-history-element'.
+ `M-n' and `M-p' are specially defined within `C-x <ESC> <ESC>' to
+run the commands `previous-history-element' and `next-history-element'.
The list of previous commands using the minibuffer is stored as a
Lisp list in the variable `command-history'. Each element of the list
Help
****
- Emacs provides extensive help features which revolve around a single
+ XEmacs provides extensive help features accessible through a single
character, `C-h'. `C-h' is a prefix key that is used only for
-documentation-printing commands. The characters you can type after
-`C-h' are called "help options". One help option is `C-h'; you use it
-to ask for help about using `C-h'.
+documentation-printing commands. The characters that you can type after
+`C-h' are called "help options". One help option is `C-h'; that is how
+you ask for help about using `C-h'. To cancel, type `C-g'. The
+function key <F1> is equivalent to `C-h'.
- `C-h C-h' prints a list of the possible help options, and then asks
-you to type the desired option. It prompts with the string:
+ `C-h C-h' (`help-for-help') displays a list of the possible help
+options, and then asks you to type the desired option. It prompts with
+the string:
- A, B, C, F, I, K, L, M, N, S, T, V, W, C-c, C-d, C-n, C-w or C-h for more help:
+ A B C F I K L M N P S T V W C-c C-d C-f C-i C-k C-n C-w; ? for more help:
You should type one of those characters.
Typing a third `C-h' displays a description of what the options mean;
Emacs still waits for you to type an option. To cancel, type `C-g'.
+ Most help buffers use a special major mode, Help mode, which lets you
+scroll conveniently with <SPC> and <DEL> or <BS>.
+
+* Menu:
+
+* Help Summary:: Brief list of all Help commands.
+* Key Help:: Asking what a key does in XEmacs.
+* Name Help:: Asking about a command, variable or function name.
+* Apropos:: Asking what pertains to a given topic.
+* Library Keywords:: Finding Lisp libraries by keywords (topics).
+* Help Mode:: Special features of Help mode and Help buffers.
+* Misc Help:: Other help commands.
+
+\1f
+File: xemacs.info, Node: Help Summary, Next: Key Help, Prev: Help, Up: Help
+
+Help Summary
+============
+
Here is a summary of the defined help commands.
-`C-h a STRING <RET>'
- Display a list of commands whose names contain STRING (`command-
- apropos').
+`C-h a REGEXP <RET>'
+ Display a list of functions and variables whose names match REGEXP
+ (`heper-apropos').
+
+`C-h A REGEXP'
+ Show all commands whose names contain matches for REGEXP
+ (`command-apropos').
`C-h b'
- Display a table of all key bindings currently in effect, with
- local bindings of the current major mode first, followed by all
- global bindings (`describe-bindings').
+ Display a table of all key bindings currently in effect, with local
+ bindings of the current major mode first, followed by all global
+ bindings (`describe-bindings').
`C-h c KEY'
- Print the name of the command that KEY runs (`describe-key-
- briefly'). `c' is for `character'. For more extensive
- information on KEY, use `C-h k'.
+ Print the name of the command that KEY runs
+ (`describe-key-briefly'). Here `c' stands for `character'. For
+ more extensive information on KEY, use `C-h k'.
+`C-h d FUNCTION <RET>'
`C-h f FUNCTION <RET>'
Display documentation on the Lisp function named FUNCTION
- (`describe-function'). Note that commands are Lisp functions, so
- a command name may be used.
+ (`describe-function'). Since commands are Lisp functions, a
+ command name may be used.
`C-h i'
Run Info, the program for browsing documentation files (`info').
- The complete Emacs manual is available online in Info.
+ The complete XEmacs manual is available online in Info.
`C-h k KEY'
- Display name and documentation of the command KEY runs
+ Display the name and documentation of the command that KEY runs
(`describe-key').
`C-h l'
Display documentation of the current major mode (`describe-mode').
`C-h n'
- Display documentation of Emacs changes, most recent first
+`C-h C-n'
+ Display documentation of XEmacs changes, most recent first
(`view-emacs-news').
`C-h p'
+ Find packages by topic keyword (`finder-by-keyword').
+
+`C-h C-p'
Display a table of all mouse bindings currently in effect now, with
local bindings of the current major mode first, followed by all
global bindings (`describe-pointer').
`C-h s'
Display current contents of the syntax table, plus an explanation
- of what they mean (`describe-syntax').
+ of what they mean (`describe-syntax'). *Note Syntax::.
`C-h t'
- Display the Emacs tutorial (`help-with-tutorial').
+ Enter the XEmacs interactive tutorial (`help-with-tutorial').
`C-h v VAR <RET>'
- Display the documentation of the Lisp variable VAR (`describe-
- variable').
+ Display the documentation of the Lisp variable VAR
+ (`describe-variable').
`C-h w COMMAND <RET>'
Print which keys run the command named COMMAND (`where-is').
-`M-x apropos REGEXP'
- Show all symbols whose names contain matches for REGEXP.
+`C-h B <RET>'
+ Display info on how to deal with Beta versions of XEmacs
+ (`describe-beta').
+
+`C-h C GROUP <RET>'
+ Select customization buffer for GROUP (`customize').
+
+`C-h F <RET>'
+ View the local copy of the XEmacs FAQ (`xemacs-local-faq').
+
+`C-h C-i FILE <RET>'
+ Read Info file FILE with Info browser (`Info-query').
+
+`C-h C-c COMMAND <RET>'
+ Look up an Emacs command COMMAND in the Emacs manual in the Info
+ system (`Info-goto-emacs-command-node').
+
+`C-h C-f FUNCTION <RET>'
+ Look up an Emacs Lisp function FUNCTION in the Elisp manual in the
+ Info system (`Info-elisp-ref').
+
+\1f
+File: xemacs.info, Node: Key Help, Next: Name Help, Prev: Help Summary, Up: Help
Documentation for a Key
=======================
The most basic `C-h' options are `C-h c' (`describe-key-briefly')
-and `C-h k'
-(`describe-key'). `C-h c KEY' prints the name of the command that KEY
-is bound to in the echo area. For example, `C-h c C-f' prints
-`forward-char'. Since command names are chosen to describe what the
-command does, using this option is a good way to get a somewhat cryptic
-description of what KEY does.
+and `C-h k' (`describe-key'). `C-h c KEY' prints in the echo area the
+name of the command that KEY is bound to. For example, `C-h c C-f'
+prints `forward-char'. Since command names are chosen to describe what
+the commands do, this is a good way to get a very brief description of
+what KEY does.
`C-h k KEY' is similar to `C-h c' but gives more information. It
displays the documentation string of the function KEY is bound to as
interactively, KEY may also be a menu selection. This information does
not usually fit into the echo area, so a window is used for the display.
+ `C-h c' and `C-h k' work for any sort of key sequences, including
+function keys and mouse events.
+
+\1f
+File: xemacs.info, Node: Name Help, Next: Apropos, Prev: Key Help, Up: Help
+
Help by Command or Variable Name
================================
variable `describe-function-show-arglist' is `t', `describe-function'
shows its arglist if the FUNCTION is not an autoload function.
- `C-h f' is also useful for Lisp functions you are planning to use in
-a Lisp program. For example, if you have just written the code
-`(make-vector len)' and want to make sure you are using `make-vector'
-properly, type `C-h f make-vector <RET>'. Because `C-h f' allows all
-function names, not just command names, you may find that some of your
-favorite abbreviations that work in `M-x' don't work in `C-h f'. An
-abbreviation may be unique among command names, yet fail to be unique
-when other function names are allowed.
-
- If you type <RET>, leaving the minibuffer empty, `C-h f' by default
-describes the function called by the innermost Lisp expression in the
-buffer around point, provided that that is a valid, defined Lisp
-function name. For example, if point is located following the text
-`(make-vector (car x)', the innermost list containing point is the one
-starting with `(make-vector', so the default is to describe the
-function `make-vector'.
+ `C-h f' is also useful for Lisp functions that you are planning to
+use in a Lisp program. For example, if you have just written the
+expression `(make-vector len)' and want to make sure you are using
+`make-vector' properly, type `C-h f make-vector <RET>'. Because `C-h
+f' allows all function names, not just command names, you may find that
+some of your favorite abbreviations that work in `M-x' don't work in
+`C-h f'. An abbreviation may be unique among command names, yet fail
+to be unique when other function names are allowed.
+
+ The function name for `C-h f' to describe has a default which is
+used if you type <RET> leaving the minibuffer empty. The default is
+the function called by the innermost Lisp expression in the buffer
+around point, _provided_ that is a valid, defined Lisp function name.
+For example, if point is located following the text `(make-vector (car
+x)', the innermost list containing point is the one that starts with
+`(make-vector', so the default is to describe the function
+`make-vector'.
`C-h f' is often useful just to verify that you have the right
-spelling for the function name. If `C-h f' mentions a default in the
-prompt, you have typed the name of a defined Lisp function. If that is
-what you wanted to know, just type `C-g' to cancel the `C-h f' command
-and continue editing.
+spelling for the function name. If `C-h f' mentions a name from the
+buffer as the default, that name must be defined as a Lisp function. If
+that is all you want to know, just type `C-g' to cancel the `C-h f'
+command, then go on editing.
- `C-h w COMMAND <RET>' (`where-s') tells you what keys are bound to
+ `C-h w COMMAND <RET>' (`where-is') tells you what keys are bound to
COMMAND. It prints a list of the keys in the echo area. Alternatively,
it informs you that a command is not bound to any keys, which implies
that you must use `M-x' to call the command.
around or before point, if that is the name of a known Lisp variable.
*Note Variables::.
+\1f
+File: xemacs.info, Node: Apropos, Next: Library Keywords, Prev: Name Help, Up: Help
+
Apropos
=======
-`C-h a'
+`C-h A'
Show only symbols that are names of commands (`command-apropos').
`M-x apropos REGEXP'
Show all symbols whose names comtain matches for REGEXP.
- It is possible to ask a question like, "What are the commands for
-working with files?" To do this, type `C-h a file <RET>', which
-displays a list of all command names that contain `file', such as
-`copy-file', `find-file', and so on. With each command name a brief
-description of its use and information on the keys you can use to
-invoke it is displayed. For example, you would be informed that you
-can invoke `find-file' by typing `C-x C-f'. The `a' in `C-h a' stands
-for `Apropos'; `C-h a' runs the Lisp function `command-apropos'.
-
- Because `C-h a' looks only for functions whose names contain the
+ A more sophisticated sort of question to ask is, "What are the
+commands for working with files?" To ask this question, type `C-h a
+file <RET>', which displays a list of all command names that contain
+`file', including `copy-file', `find-file', and so on. With each
+command name appears a brief description of how to use the command, and
+what keys you can currently invoke it with. For example, it would say
+that you can invoke `find-file' by typing `C-x C-f'. The `A' in `C-h
+A' stands for `Apropos'; `C-h A' runs the command `command-apropos'.
+This command normally checks only commands (interactive functions); if
+you specify a prefix argument, it checks noninteractive functions as
+well.
+
+ Because `C-h A' looks only for functions whose names contain the
string you specify, you must use ingenuity in choosing the string. If
you are looking for commands for killing backwards and `C-h a
-kill-backwards <RET>' doesn't reveal any commands, don't give up. Try
-just `kill', or just `backwards', or just `back'. Be persistent.
-Pretend you are playing Adventure. Also note that you can use a
-regular expression as the argument (*note Regexps::).
+kill-backwards <RET>' doesn't reveal any, don't give up. Try just
+`kill', or just `backwards', or just `back'. Be persistent. Pretend
+you are playing Adventure. Also note that you can use a regular
+expression as the argument, for more flexibility (*note Regexps::).
Here is a set of arguments to give to `C-h a' that covers many
-classes of Emacs commands, since there are strong conventions for naming
-standard Emacs commands. By giving you a feeling for the naming
-conventions, this set of arguments can also help you develop a
-technique for picking `apropos' strings.
+classes of XEmacs commands, since there are strong conventions for
+naming the standard XEmacs commands. By giving you a feel for the
+naming conventions, this set should also serve to aid you in developing
+a technique for picking `apropos' strings.
char, line, word, sentence, paragraph, region, page, sexp, list,
- defun, buffer, frame, window, file, dir, register, mode,
- beginning, end, forward, backward, next, previous, up, down,
- search, goto, kill, delete, mark, insert, yank, fill, indent, case,
- change, set, what, list, find, view, describe.
+ defun, rect, buffer, frame, window, face, file, dir, register,
+ mode, beginning, end, forward, backward, next, previous, up, down,
+ search, goto, kill, delete, mark, insert, yank, fill, indent,
+ case, change, set, what, list, find, view, describe, default.
To list all Lisp symbols that contain a match for a regexp, not just
the ones that are defined as commands, use the command `M-x apropos'
-instead of `C-h a'.
+instead of `C-h A'. This command does not check key bindings by
+default; specify a numeric argument if you want it to check them.
+
+ The `apropos-documentation' command is like `apropos' except that it
+searches documentation strings for matches for the specified regular
+expression.
+
+ The `apropos-value' command is like `apropos' except that it
+searches symbols' values for matches for the specified regular
+expression. This command does not check function definitions or
+property lists by default; specify a numeric argument if you want it to
+check them.
+
+ If the variable `apropos-do-all' is non-`nil', the commands above
+all behave as if they had been given a prefix argument.
+
+ If you want more information about a function definition, variable or
+symbol property listed in the Apropos buffer, you can click on it with
+`Mouse-2' or move there and type <RET>.
+
+\1f
+File: xemacs.info, Node: Library Keywords, Next: Help Mode, Prev: Apropos, Up: Help
+
+Keyword Search for Lisp Libraries
+=================================
+
+ The `C-h p' command lets you search the standard Emacs Lisp
+libraries by topic keywords. Here is a partial list of keywords you can
+use:
+
+ abbrev abbreviation handling, typing shortcuts, macros
+ bib code related to the `bib' bibliography processor
+ c C, C++, and Objective-C language support
+ calendar calendar and time management support
+ comm communications, networking, remote access to files
+ data support for editing files of data
+ docs support for Emacs documentation
+ dumped files preloaded into Emacs
+ emulations emulations of other editors
+ extensions Emacs Lisp language extensions
+ faces support for multiple fonts
+ frames support for Emacs frames and window systems
+ games games, jokes and amusements
+ hardware support for interfacing with exotic hardware
+ help support for on-line help systems
+ hypermedia support for links between text or other media types
+ i18n internationalization and alternate character-set support
+ internal code for Emacs internals, build process, defaults
+ languages specialized modes for editing programming languages
+ lisp Lisp support, including Emacs Lisp
+ local code local to your site
+ maint maintenance aids for the Emacs development group
+ mail modes for electronic-mail handling
+ matching various sorts of searching and matching
+ mouse mouse support
+ mule multi-language extensions
+ news support for netnews reading and posting
+ oop support for object-oriented programming
+ outlines support for hierarchical outlining
+ processes process, subshell, compilation, and job control support
+ terminals support for terminal types
+ tex code related to the TeX formatter
+ tools programming tools
+ unix front-ends/assistants for, or emulators of, UNIX features
+ vms support code for vms
+ wp word processing
+
+\1f
+File: xemacs.info, Node: Help Mode, Next: Misc Help, Prev: Library Keywords, Up: Help
+
+Help Mode Commands
+==================
+
+ Help buffers provide the commands of View mode (*note Misc File
+Ops::), plus a few special commands of their own.
+
+`<SPC>'
+ Scroll forward.
+
+`<DEL>'
+`<BS>'
+ Scroll backward.
+
+ When a command name (*note Running Commands by Name: M-x.) or
+variable name (*note Variables::) appears in the documentation, it
+normally appears inside paired single-quotes.
+
+\1f
+File: xemacs.info, Node: Misc Help, Prev: Help Mode, Up: Help
Other Help Commands
===================
`C-h i' (`info') runs the Info program, which is used for browsing
-through structured documentation files. The entire Emacs manual is
+through structured documentation files. The entire XEmacs manual is
available within Info. Eventually all the documentation of the GNU
system will be available. Type `h' after entering Info to run a
tutorial on using Info.
+ If you specify a numeric argument, `C-h i' prompts for the name of a
+documentation file. This way, you can browse a file which doesn't have
+an entry in the top-level Info menu. It is also handy when you need to
+get to the documentation quickly, and you know the exact name of the
+file.
+
+ There are two special help commands for accessing XEmacs
+documentation through Info. `C-h C-f FUNCTION <RET>' enters Info and
+goes straight to the documentation of the XEmacs function FUNCTION.
+`C-h C-k KEY' enters Info and goes straight to the documentation of the
+key KEY. These two keys run the commands `Info-elisp-ref' and
+`Info-goto-emacs-key-command-node'.
+
If something surprising happens, and you are not sure what commands
you typed, use `C-h l' (`view-lossage'). `C-h l' prints the last 100
-command characters you typed. If you see commands you don't know, use
-`C-h c' to find out what they do.
+command characters you typed in. If you see commands that you don't
+know, you can use `C-h c' to find out what they do.
- Emacs has several major modes. Each mode redefines a few keys and
+ XEmacs has several major modes. Each mode redefines a few keys and
makes a few other changes in how editing works. `C-h m'
(`describe-mode') prints documentation on the current major mode, which
normally describes all the commands that are changed in this mode.
`C-h b' (`describe-bindings') and `C-h s' (`describe-syntax')
-present information about the current Emacs mode that is not covered by
-`C-h m'. `C-h b' displays a list of all key bindings currently in
-effect, with the local bindings of the current major mode first,
+present information about the current XEmacs mode that is not covered
+by `C-h m'. `C-h b' displays a list of all the key bindings currently
+in effect, with the local bindings of the current major mode first,
followed by the global bindings (*note Key Bindings::). `C-h s'
displays the contents of the syntax table with explanations of each
character's syntax (*note Syntax::).
+ You can get a similar list for a particular prefix key by typing
+`C-h' after the prefix key. (There are a few prefix keys for which
+this does not work--those that provide their own bindings for `C-h'.
+One of these is <ESC>, because `<ESC> C-h' is actually `C-M-h', which
+marks a defun.)
+
The other `C-h' options display various files of useful information.
-`C-h C-w' (`describe-no-warranty') displays details on the complete
-absence of warranty for XEmacs. `C-h n' (`view-emacs-news') displays
-the file `emacs/etc/NEWS', which contains documentation on Emacs
-changes arranged chronologically. `C-h t' (`help-with-tutorial')
-displays the learn-by-doing Emacs tutorial. `C-h C-c'
-(`describe-copying') displays the file `emacs/etc/COPYING', which tells
-you the conditions you must obey in distributing copies of Emacs. `C-h
-C-d' (`describe-distribution') displays another file named
-`emacs/etc/DISTRIB', which tells you how you can order a copy of the
-latest version of Emacs.
+`C-h C-w' (`describe-no-warranty') displays the full details on the
+complete absence of warranty for XEmacs. `C-h n' (`view-emacs-news')
+displays the file `xemacs/etc/NEWS', which contains documentation on
+XEmacs changes arranged chronologically. `C-h F' (`xemacs-local-faq')
+displays local version of the XEmacs
+frequentliy-answered-questions-list. `C-h t' (`help-with-tutorial')
+displays the learn-by-doing XEmacs tutorial. `C-h C-c'
+(`describe-copying') displays the file `xemacs/etc/COPYING', which
+tells you the conditions you must obey in distributing copies of
+XEmacs. `C-h C-d' (`describe-distribution') displays another file named
+`xemacs/etc/DISTRIB', which tells you how you can order a copy of the
+latest version of XEmacs.
\1f
File: xemacs.info, Node: Mark, Next: Mouse Selection, Prev: Help, Up: Top
Edit pull-down menu on it. Since it is also the Emacs region, you can
use Emacs region commands on it.
-\1f
-File: xemacs.info, Node: Additional Mouse Operations, Next: Killing, Prev: Mouse Selection, Up: Top
-
-Additional Mouse Operations
-===========================
-
- XEmacs also provides the following mouse functions. Most of these
-are not bound to mouse gestures by default, but they are provided for
-your customization pleasure. For example, if you wanted `shift-left'
-(that is, holding down the <Shift> key and clicking the left mouse
-button) to delete the character at which you are pointing, then you
-could do this:
-
- (global-set-key '(shift button1) 'mouse-del-char)
-
-`mouse-del-char'
- Delete the character pointed to by the mouse.
-
-`mouse-delete-window'
- Delete the Emacs window that the mouse is on.
-
-`mouse-keep-one-window'
- Select the Emacs window that the mouse is on, then delete all other
- windows on this frame.
-
-`mouse-kill-line'
- Kill the line pointed to by the mouse.
-
-`mouse-line-length'
- Print the length of the line indicated by the pointer.
-
-`mouse-scroll'
- Scroll point to the mouse position.
-
-`mouse-select'
- Select the Emacs window the mouse is on.
-
-`mouse-select-and-split'
- Select the Emacs window mouse is on, then split it vertically in
- half.
-
-`mouse-set-mark'
- Select the Emacs window the mouse is on and set the mark at the
- mouse position. Display the cursor at that position for a second.
-
-`mouse-set-point'
- Select the Emacs window that the mouse is on and move point to the
- mouse position.
-
-`mouse-track'
- Make a selection with the mouse. This is the default binding of
- the left mouse button (<button1>).
-
-`mouse-track-adjust'
- Extend the existing selection. This is the default binding of
- <Shift-button1>.
-
-`mouse-track-and-copy-to-cutbuffer'
- Make a selection like `mouse-track', but also copy it to the cut
- buffer.
-
-`mouse-track-delete-and-insert'
- Make a selection with the mouse and insert it at point. This is
- the default binding of <control-shift-button1>.
-
-`mouse-track-insert'
- Make a selection with the mouse and insert it at point. This is
- the default binding of <control-button1>.
-
-`mouse-window-to-region'
- Narrow a window to the region between the cursor and the mouse
- pointer.
-
- The `M-x mouse-track' command should be bound to a mouse button. If
-you click-and-drag, the selection is set to the region between the
-point of the initial click and the point at which you release the
-button. These positions do not need to be ordered.
-
- If you click-and-release without moving the mouse, the point is
-moved, and the selection is disowned (there will be no selection
-owner.) The mark will be set to the previous position of point.
-
- If you double-click, the selection will extend by symbols instead of
-by characters. If you triple-click, the selection will extend by lines.
-
- If you drag the mouse off the top or bottom of the window, you can
-select pieces of text that are larger than the visible part of the
-buffer; the buffer will scroll as necessary.
-
- The selected text becomes the current X selection, and is also
-copied to the top of the kill ring. Point will be left at the position
-at which you released the button and the mark will be left at the
-initial click position. Bind a mouse click to
-`mouse-track-and-copy-to-cutbuffer' to copy selections to the cut
-buffer. (See also the `mouse-track-adjust' command, on
-`Shift-button1'.)
-
- The `M-x mouse-track-adjust' command should be bound to a mouse
-button. The selection will be enlarged or shrunk so that the point of
-the mouse click is one of its endpoints. This is only meaningful after
-the `mouse-track' command (<button1>) has been executed.
-
- The `M-x mouse-track-delete-and-insert' command is exactly the same
-as the `mouse-track' command on <button1>, except that point is not
-moved; the selected text is immediately inserted after being selected;
-and the text of the selection is deleted.
-
- The `M-x mouse-track-insert' command is exactly the same as the
-`mouse-track' command on <button1>, except that point is not moved; the
-selected text is immediately inserted after being selected; and the
-selection is immediately disowned afterwards.
-
-\1f
-File: xemacs.info, Node: Killing, Next: Yanking, Prev: Additional Mouse Operations, Up: Top
-
-Deletion and Killing
-====================
-
- Most commands that erase text from the buffer save it. You can get
-the text back if you change your mind, or you can move or copy it to
-other parts of the buffer. Commands which erase text and save it in the
-kill ring are known as "kill" commands. Some other commands erase text
-but do not save it; they are known as "delete" commands. (This
-distinction is made only for erasing text in the buffer.)
-
- The commands' names and individual descriptions use the words `kill'
-and `delete' to indicate what they do. If you perform a kill or delete
-command by mistake, use the `C-x u' (`undo') command to undo it (*note
-Undo::). The delete commands include `C-d' (`delete-char') and <DEL>
-(`delete-backward-char'), which delete only one character at a time,
-and those commands that delete only spaces or newlines. Commands that
-can destroy significant amounts of nontrivial data usually kill.
-
-Deletion
---------
-
-`C-d'
- Delete next character (`delete-char').
-
-`<DEL>'
- Delete previous character (`delete-backward-char').
-
-`M-\'
- Delete spaces and tabs around point (`delete-horizontal-space').
-
-`M-<SPC>'
- Delete spaces and tabs around point, leaving one space
- (`just-one-space').
-
-`C-x C-o'
- Delete blank lines around the current line (`delete-blank-lines').
-
-`M-^'
- Join two lines by deleting the intervening newline, and any
- indentation following it (`delete-indentation').
-
- The most basic delete commands are `C-d' (`delete-char') and <DEL>
-(`delete-backward-char'). `C-d' deletes the character after point, the
-one the cursor is "on top of". Point doesn't move. <DEL> deletes the
-character before the cursor, and moves point back. You can delete
-newlines like any other characters in the buffer; deleting a newline
-joins two lines. Actually, `C-d' and <DEL> aren't always delete
-commands; if you give them an argument, they kill instead, since they
-can erase more than one character this way.
-
- The other delete commands delete only formatting characters: spaces,
-tabs and newlines. `M-\' (`delete-horizontal-space') deletes all
-spaces and tab characters before and after point. `M-<SPC>'
-(`just-one-space') does the same but leaves a single space after point,
-regardless of the number of spaces that existed previously (even zero).
-
- `C-x C-o' (`delete-blank-lines') deletes all blank lines after the
-current line. If the current line is blank, it deletes all blank lines
-preceding the current line as well as leaving one blank line, the
-current line. `M-^' (`delete-indentation') joins the current line and
-the previous line, or, if given an argument, joins the current line and
-the next line by deleting a newline and all surrounding spaces, possibly
-leaving a single space. *Note M-^: Indentation.
-
-Killing by Lines
-----------------
-
-`C-k'
- Kill rest of line or one or more lines (`kill-line').
-
- The simplest kill command is `C-k'. If given at the beginning of a
-line, it kills all the text on the line, leaving the line blank. If
-given on a blank line, the blank line disappears. As a consequence, a
-line disappears completely if you go to the front of a non-blank line
-and type `C-k' twice.
-
- More generally, `C-k' kills from point up to the end of the line,
-unless it is at the end of a line. In that case, it kills the newline
-following the line, thus merging the next line into the current one.
-Emacs ignores invisible spaces and tabs at the end of the line when
-deciding which case applies: if point appears to be at the end of the
-line, you can be sure the newline will be killed.
-
- If you give `C-k' a positive argument, it kills that many lines and
-the newlines that follow them (however, text on the current line before
-point is not killed). With a negative argument, `C-k' kills back to a
-number of line beginnings. An argument of -2 means kill back to the
-second line beginning. If point is at the beginning of a line, that
-line beginning doesn't count, so `C-u - 2 C-k' with point at the front
-of a line kills the two previous lines.
-
- `C-k' with an argument of zero kills all the text before point on the
-current line.
-
-Other Kill Commands
--------------------
-
-`C-w'
- Kill region (from point to the mark) (`kill-region'). *Note
- Words::.
-
-`M-d'
- Kill word (`kill-word').
-
-`M-<DEL>'
- Kill word backwards (`backward-kill-word').
-
-`C-x <DEL>'
- Kill back to beginning of sentence (`backward-kill-sentence').
- *Note Sentences::.
-
-`M-k'
- Kill to end of sentence (`kill-sentence').
-
-`C-M-k'
- Kill sexp (`kill-sexp'). *Note Lists::.
-
-`M-z CHAR'
- Kill up to next occurrence of CHAR (`zap-to-char').
-
- `C-w' (`kill-region') is a very general kill command; it kills
-everything between point and the mark. You can use this command to kill
-any contiguous sequence of characters by first setting the mark at one
-end of a sequence of characters, then going to the other end and typing
-`C-w'.
-
- A convenient way of killing is combined with searching: `M-z'
-(`zap-to-char') reads a character and kills from point up to (but not
-including) the next occurrence of that character in the buffer. If
-there is no next occurrence, killing goes to the end of the buffer. A
-numeric argument acts as a repeat count. A negative argument means to
-search backward and kill text before point.
-
- Other syntactic units can be killed: words, with `M-<DEL>' and `M-d'
-(*note Words::); sexps, with `C-M-k' (*note Lists::); and sentences,
-with `C-x <DEL>' and `M-k' (*note Sentences::).
-
-\1f
-File: xemacs.info, Node: Yanking, Next: Using X Selections, Prev: Killing, Up: Top
-
-Yanking
-=======
-
- "Yanking" means getting back text which was killed. Some systems
-call this "pasting". The usual way to move or copy text is to kill it
-and then yank it one or more times.
-
-`C-y'
- Yank last killed text (`yank').
-
-`M-y'
- Replace re-inserted killed text with the previously killed text
- (`yank-pop').
-
-`M-w'
- Save region as last killed text without actually killing it
- (`copy-region-as-kill').
-
-`C-M-w'
- Append next kill to last batch of killed text (`append-next-kill').
-
-* Menu:
-
-* Kill Ring:: Where killed text is stored. Basic yanking.
-* Appending Kills:: Several kills in a row all yank together.
-* Earlier Kills:: Yanking something killed some time ago.
-
-\1f
-File: xemacs.info, Node: Kill Ring, Next: Appending Kills, Prev: Yanking, Up: Yanking
-
-The Kill Ring
--------------
-
- All killed text is recorded in the "kill ring", a list of blocks of
-text that have been killed. There is only one kill ring, used in all
-buffers, so you can kill text in one buffer and yank it in another
-buffer. This is the usual way to move text from one file to another.
-(*Note Accumulating Text::, for some other ways.)
-
- If you have two separate Emacs processes, you cannot use the kill
-ring to move text. If you are using XEmacs under X, however, you can
-use the X selection mechanism to move text from one to another.
-
- If you are using XEmacs under X and have one Emacs process with
-multiple frames, they do share the same kill ring. You can kill or
-copy text in one Emacs frame, then yank it in the other frame belonging
-to the same process.
-
- The command `C-y' (`yank') reinserts the text of the most recent
-kill. It leaves the cursor at the end of the text and sets the mark at
-the beginning of the text. *Note Mark::.
-
- `C-u C-y' yanks the text, leaves the cursor in front of the text,
-and sets the mark after it, if the argument is with just a `C-u'. Any
-other argument, including `C-u' and digits, has different results,
-described below, under "Yanking Earlier Kills".
-
- To copy a block of text, you can also use `M-w'
-(`copy-region-as-kill'), which copies the region into the kill ring
-without removing it from the buffer. `M-w' is similar to `C-w' followed
-by `C-y' but does not mark the buffer as "modified" and does not
-actually cut anything.
-
projects / chise / xemacs-chise.git.1 / blobdiff