Mercurial > emacs
changeset 46205:6676ac71682b
Update mouse button info.
Don't give the names of Emacs commands that the characters run.
Clarify what SPC and DEL do.
Clarify the description of the minibuffer.
Wording change for completion.
Explain Mouse-2 better.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 07 Jul 2002 11:31:31 +0000 |
parents | dfc0a989ae61 |
children | 1ad1838fbda4 |
files | man/info.texi |
diffstat | 1 files changed, 96 insertions(+), 89 deletions(-) [+] |
line wrap: on
line diff
--- a/man/info.texi Sun Jul 07 11:22:29 2002 +0000 +++ b/man/info.texi Sun Jul 07 11:31:31 2002 +0000 @@ -6,7 +6,7 @@ @syncodeindex vr cp @syncodeindex ky cp @comment %**end of header -@comment $Id: info.texi,v 1.22 2002/04/24 00:58:45 miles Exp $ +@comment $Id: info.texi,v 1.23 2002/04/26 11:56:35 eliz Exp $ @dircategory Texinfo documentation system @direntry @@ -75,18 +75,18 @@ @node Top @top Info: An Introduction -Info is a program, which you are using now, for reading documentation of -computer programs. The GNU Project distributes most of its on-line -manuals in the Info format, so you need a program called @dfn{Info -reader} to read the manuals. One of such programs you are using now. +The GNU Project distributes most of its on-line manuals in the +@dfn{Info format}, which you read using an @dfn{Info reader}. You are +probably using an Info reader to read this now. @ifinfo -If you are new to Info and want to learn how to use it, type the -command @kbd{h} now. It brings you to a programmed instruction -sequence. +If you are new to the Info reader and want to learn how to use it, +type the command @kbd{h} now. It brings you to a programmed +instruction sequence. -To learn expert-level Info commands, type @kbd{n} twice. This brings you to -@cite{Info for Experts}, skipping over the `Getting Started' chapter. +To read about expert-level Info commands, type @kbd{n} twice. This +brings you to @cite{Info for Experts}, skipping over the `Getting +Started' chapter. @end ifinfo @end ifnottex @@ -241,15 +241,14 @@ line says that this is node @samp{Help} in the file @file{info}. @cindex header of Info node - The top line of a node is its @dfn{header}. This node's header (look at -it now) says that the @samp{Next} node after this one is the node -called @samp{Help-P}. An advanced Info command lets you go to any node -whose name you know. In the stand-alone Info reader program, the -header line shows the names of this node and the info file as well. -In Emacs, the header line is displayed in a special typeface, and it -doesn't scroll off the screen when you scroll the display. The names -of this node and of its Info file are omitted by Emacs from the header -line. + The top line of a node is its @dfn{header}. This node's header +(look at it now) says that the @samp{Next} node after this one is the +node called @samp{Help-P}. An advanced Info command lets you go to +any node whose name you know. In the stand-alone Info reader program, +the header line shows the names of this node and the info file as +well. In Emacs, the header line is duplicated in a special typeface, +and the duplicate remains at the top of the window all the time even +if you scroll through the node. Besides a @samp{Next}, a node can have a @samp{Previous} or an @samp{Up} links, or both. As you can see, this node has all of these @@ -268,7 +267,7 @@ @format >> If you have a mouse, and if you already practiced typing @kbd{n} - to get to the next node, click now with the right mouse button on + to get to the next node, click now with the middle mouse button on the @samp{Next} link to do the same ``the mouse way''. @end format @@ -280,30 +279,29 @@ This node is called @samp{Help-P}. The @samp{Previous} node, as you see, is @samp{Help}, which is the one you just came from using the @kbd{n} command. Another @kbd{n} command now would take you to the next -node, @samp{Help-^L}. In Emacs, @kbd{n} runs the Emacs command -@code{Info-next}, and @kbd{p} runs @code{Info-prev}. +node, @samp{Help-^L}. @format >> But do not type @kbd{n} yet. First, try the @kbd{p} command, - or click the mouse on the @samp{Prev} link, which takes you to the - @samp{Previous} node. When you get there, you can do an @kbd{n} - again to return here. + or click the middle mouse button on the @samp{Prev} link. That + takes you to the @samp{Previous} node. Then use @kbd{n} to return here. @end format If you read this in Emacs, you will see an @samp{Info} item in the -menu bar, close to its right edge. Clicking your mouse on the +menu bar, close to its right edge. Clicking the mouse on the @samp{Info} menu-bar item opens a menu of commands which include @samp{Next} and @samp{Prev} (and also some others which you didn't yet learn about). - This all probably seems insultingly simple so far, but @emph{do not} be -led into skimming. Things will get more complicated soon. Also, -do not try a new command until you are told it is time to. Otherwise, -you may make Info skip past an important warning that was coming up. + This all probably seems insultingly simple so far, but @emph{please +don't} start skimming. Things will get complicated soon enough! +Also, please do not try a new command until you are told it is time +to. You could make Info skip past an important warning that was +coming up. @format ->> Now do an @kbd{n}, or click the mouse on the @samp{Next} link, to - get to the node @samp{Help-^L} and learn more. +>> Now do an @kbd{n}, or click the middle mouse button on the @samp{Next} + link, to get to the node @samp{Help-^L} and learn more. @end format @node Help-^L, Help-M, Help-P, Getting Started @@ -336,9 +334,7 @@ screen at once. @key{SPC} moves forward, to show what was below the bottom of the screen. @key{DEL} or @key{BACKSPACE} moves backward, to show what was above the top of the screen (there is not anything above -the top until you have typed some spaces). In Emacs, @key{SPC} runs -the command @code{Info-scroll-up}, while @key{BACKSPACE} runs -@code{Info-scroll-down}. +the top until you have typed some spaces). @format >> Now try typing a @key{SPC} (afterward, type a @key{BACKSPACE} to @@ -354,31 +350,34 @@ If you are reading this in Emacs, note that the header line is always visible, never scrolling off the display. That way, you can always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you -can conveniently go to one of these links from anywhere in the node by -clicking the mouse on one of these links. +can conveniently go to one of these links at any time by +clicking the middle mouse button on the link. @cindex reading Info documents top to bottom @cindex Info documents as tutorials @key{SPC} and @key{DEL} not only move forward and backward through -the current node. When these keys hit the beginning or the end of the -current node, they move to preceding or subsequent nodes. -Specifically, they scroll through all the nodes in an Info file as a -single logical sequence. In this sequence, a node's subnodes appear -following their parent. If a node has a menu, @key{SPC} takes you -into the subnodes listed in the menu, one by one. Once you reach the -end of a node, and have seen all of its subnodes, @key{SPC} takes you -to the next node or to the parent's next node. This is so you could -read the entire manual top to bottom by just typing @key{SPC}. +the current node. They also move between nodes. @key{SPC} at the end +of a node moves to the next node; @key{DEL} (or @key{BACKSPACE}) at +the beginning of a node moves to the previous node. In effect, these +commands scroll through all the nodes in an Info file as a single +logical sequence. You can read an entire manual top to bottom by just +typing @key{SPC}, and move backward through the entire manual from +bottom to top by typing @key{DEL} (or @key{BACKSPACE}). + + In this sequence, a node's subnodes appear following their parent. +If a node has a menu, @key{SPC} takes you into the subnodes listed in +the menu, one by one. Once you reach the end of a node, and have seen +all of its subnodes, @key{SPC} takes you to the next node or to the +parent's next node. @kindex PAGEUP @r{(Info mode)} @kindex PAGEDOWN @r{(Info mode)} Many keyboards nowadays have two scroll keys labeled @samp{PageUp} and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your keyboard has these keys, you can use them to move forward and backward -through the text, like with @key{SPC} and @key{BACKSPACE}. However, -unlike @key{SPC} and @key{BACKSPACE}, @key{PAGEUP} and @key{PAGEDOWN} -keys will never scroll beyond the beginning or the end of the current -node. +through the text of one node, like @key{SPC} and @key{BACKSPACE} (or +@key{DEL}). However, @key{PAGEUP} and @key{PAGEDOWN} keys never +scroll beyond the beginning or the end of the current node. @kindex C-l @r{(Info mode)} If your screen is ever garbaged, you can tell Info to display it @@ -391,8 +390,8 @@ @kindex b @r{(Info mode)} To move back to the beginning of the node you are on, you can type -a lot of @key{BACKSPACE} keys. You can also type simply @kbd{b} for -beginning. +the @key{BACKSPACE} key (or @key{DEL}) many times. You can also type +@kbd{b} just once. @kbd{b} stands for ``beginning.'' @format >> Try that now. (We have put in enough verbiage to push this past @@ -401,8 +400,9 @@ Then come back, by typing @key{SPC} one or more times. @end format - If your screen is very tall, all of this node might fit at once. -In that case, @kbd{b} won't do anything. Sorry; what can we do? + If your screen is very tall, all of this node might fit at once. In +that case, @kbd{b} won't do anything. But you could observe the +effect of the @kbd{b} key if you use a smaller window. @kindex ? @r{(Info mode)} @findex Info-summary @@ -429,8 +429,8 @@ the same size screen, it would be impossible to warn you anyway. @format ->> Now type @kbd{n}, or click the mouse on the @samp{Next} link, to - see the description of the @kbd{m} command. +>> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link, + to see the description of the @kbd{m} command. @end format @node Help-M, Help-Xref, Help-^L, Getting Started @@ -494,26 +494,31 @@ @kbd{m} command is not available. @end format +If you keep typing @key{SPC} once the menu appears on the screen, it +will move to another node (the first one in the menu). If that +happens, type @key{BACKSPACE} to come back. + @kindex m @r{(Info mode)} - The command to go to one of the subnodes is @kbd{m}---but @emph{do -not do it yet!} Before you use @kbd{m}, you need to learn about -commands which prompt you for more input. So far, you have learned -several commands that do not need additional input; when you typed -one, Info processed it and was instantly ready for another command. -The @kbd{m} command is different: it is incomplete without the -@dfn{name of the subtopic}. Once you have typed @kbd{m}, Info tries -to read the subtopic name. + The command to go to one of the subnodes is @kbd{m}. This is very +different from the commands you have used: it is a command that +prompts you for more input. + + The Info commands you know do not need additional input; when you +type one of them, Info processes it instantly and then is ready for +another command. The @kbd{m} command is different: it needs to know +the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info +tries to read the subtopic name. Now look for the line containing many dashes near the bottom of the screen. There is one more line beneath that one, but usually it is -blank. If it is empty, Info is ready for a command, such as @kbd{n} +blank. When it is blank, Info is ready for a command, such as @kbd{n} or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains text ending -in a colon, it means Info is trying to read more input for the last -command. At such times, commands do not work, because Info tries to -use them as the input it needs. You must either type your response and -finish the command you started, or type @kbd{Control-g} to cancel the -command. When you have done one of those things, the line becomes -blank again. +in a colon, it means Info is reading more input for the last command. +You can't type an Info command then, because Info is trying to read +input, not commands. You must either give the input and finish the +command you started, or type @kbd{Control-g} to cancel the command. +When you have done one of those things, the input entry line becomes +blank again. Then you can type Info commands again. @findex Info-menu The command to go to a subnode via a menu is @kbd{m}. After you type @@ -532,21 +537,22 @@ the menu. @cindex completion of Info node names - You can also use the @dfn{completion} feature to help enter the subtopic -name. If you type the @key{TAB} key after entering part of a name, it will -magically fill in more of the name---as much as follows uniquely from -what you have entered. + You can also use the @dfn{completion} feature to help enter the +subtopic name. If you type the @key{TAB} key after entering part of a +name, it will fill in more of the name---as much as Info can deduce +from the part you have entered. If you move the cursor to one of the menu subtopic lines, then you do not need to type the argument: you just type a @key{RET}, and it -stands for the subtopic of the line you are on. +stands for the subtopic of the line you are on. You can also click +the middle mouse button directly on the subtopic line to go there. Here is a menu to give you a chance to practice. This menu gives you three ways of going to one place, Help-FOO: @menu * Foo: Help-FOO. A node you can visit for fun. -* Bar: Help-FOO. Strange! two ways to get to the same place. +* Bar: Help-FOO. We have made two ways to get to the same place. * Help-FOO:: And yet another! @end menu @@ -606,18 +612,19 @@ ends the subtopic's brief name. You will see the subtopic's name change its appearance (usually, its background color will change), and the shape of the mouse pointer will change if your platform supports -that. After a while, if you leave the mouse on that spot, a tooltip -will pop up saying ``Mouse-2: go to that node''. (If the tooltips are -turned off or unavailable, this message is displayed in the @dfn{echo -area}, the bottom screen line where you typed the menu subtopics in -response to the prompt.) @kbd{Mouse-2} is the second button of your -mouse counting from the left---the rightmost button for two-button -mice, the middle button for 3-button mice. So pressing @kbd{Mouse-2} -while the mouse pointer is on a menu subtopic goes to that subtopic. +that. After a while, if you leave the mouse on that spot, a small +window will pop up, saying ``Mouse-2: go to that node'', or the same +message may appear at the bottom of the screen. + + @kbd{Mouse-2} is the second button of your mouse counting from the +left---the middle button on a 3-button mouse. (On a 2-button mouse, +you may have to press both buttons together to ``press the middle +button''.) The message tells you pressing @kbd{Mouse-2} with the +current position of the mouse pointer (on subtopic in the menu) will +go to that subtopic. @findex Info-mouse-follow-nearest-node - More generally, @kbd{Mouse-2} in an Info buffer runs the Emacs -command @code{Info-mouse-follow-nearest-node}, which finds the nearest + More generally, @kbd{Mouse-2} in an Info buffer finds the nearest link to another node and goes there. For example, near a cross reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At @@ -655,8 +662,8 @@ (Some Info readers, such as the one built into Emacs, put you at the same place where you were reading in @samp{Help-M}.) - Another way to go Up is to click on the @samp{Up} pointer shown in -the header line (provided that you have a mouse). + Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up} +pointer shown in the header line (provided that you have a mouse). @format >> Now type @kbd{u} to move back up to @samp{Help-M}.