75 |
@node Top |
@node Top |
76 |
@top Info: An Introduction |
@top Info: An Introduction |
77 |
|
|
78 |
Info is a program, which you are using now, for reading documentation of |
The GNU Project distributes most of its on-line manuals in the |
79 |
computer programs. The GNU Project distributes most of its on-line |
@dfn{Info format}, which you read using an @dfn{Info reader}. You are |
80 |
manuals in the Info format, so you need a program called @dfn{Info |
probably using an Info reader to read this now. |
|
reader} to read the manuals. One of such programs you are using now. |
|
81 |
|
|
82 |
@ifinfo |
@ifinfo |
83 |
If you are new to Info and want to learn how to use it, type the |
If you are new to the Info reader and want to learn how to use it, |
84 |
command @kbd{h} now. It brings you to a programmed instruction |
type the command @kbd{h} now. It brings you to a programmed |
85 |
sequence. |
instruction sequence. |
86 |
|
|
87 |
To learn expert-level Info commands, type @kbd{n} twice. This brings you to |
To read about expert-level Info commands, type @kbd{n} twice. This |
88 |
@cite{Info for Experts}, skipping over the `Getting Started' chapter. |
brings you to @cite{Info for Experts}, skipping over the `Getting |
89 |
|
Started' chapter. |
90 |
@end ifinfo |
@end ifinfo |
91 |
@end ifnottex |
@end ifnottex |
92 |
|
|
241 |
line says that this is node @samp{Help} in the file @file{info}. |
line says that this is node @samp{Help} in the file @file{info}. |
242 |
|
|
243 |
@cindex header of Info node |
@cindex header of Info node |
244 |
The top line of a node is its @dfn{header}. This node's header (look at |
The top line of a node is its @dfn{header}. This node's header |
245 |
it now) says that the @samp{Next} node after this one is the node |
(look at it now) says that the @samp{Next} node after this one is the |
246 |
called @samp{Help-P}. An advanced Info command lets you go to any node |
node called @samp{Help-P}. An advanced Info command lets you go to |
247 |
whose name you know. In the stand-alone Info reader program, the |
any node whose name you know. In the stand-alone Info reader program, |
248 |
header line shows the names of this node and the info file as well. |
the header line shows the names of this node and the info file as |
249 |
In Emacs, the header line is displayed in a special typeface, and it |
well. In Emacs, the header line is duplicated in a special typeface, |
250 |
doesn't scroll off the screen when you scroll the display. The names |
and the duplicate remains at the top of the window all the time even |
251 |
of this node and of its Info file are omitted by Emacs from the header |
if you scroll through the node. |
|
line. |
|
252 |
|
|
253 |
Besides a @samp{Next}, a node can have a @samp{Previous} or an |
Besides a @samp{Next}, a node can have a @samp{Previous} or an |
254 |
@samp{Up} links, or both. As you can see, this node has all of these |
@samp{Up} links, or both. As you can see, this node has all of these |
267 |
|
|
268 |
@format |
@format |
269 |
>> If you have a mouse, and if you already practiced typing @kbd{n} |
>> If you have a mouse, and if you already practiced typing @kbd{n} |
270 |
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 |
271 |
the @samp{Next} link to do the same ``the mouse way''. |
the @samp{Next} link to do the same ``the mouse way''. |
272 |
@end format |
@end format |
273 |
|
|
279 |
This node is called @samp{Help-P}. The @samp{Previous} node, as you see, |
This node is called @samp{Help-P}. The @samp{Previous} node, as you see, |
280 |
is @samp{Help}, which is the one you just came from using the @kbd{n} |
is @samp{Help}, which is the one you just came from using the @kbd{n} |
281 |
command. Another @kbd{n} command now would take you to the next |
command. Another @kbd{n} command now would take you to the next |
282 |
node, @samp{Help-^L}. In Emacs, @kbd{n} runs the Emacs command |
node, @samp{Help-^L}. |
|
@code{Info-next}, and @kbd{p} runs @code{Info-prev}. |
|
283 |
|
|
284 |
@format |
@format |
285 |
>> But do not type @kbd{n} yet. First, try the @kbd{p} command, |
>> But do not type @kbd{n} yet. First, try the @kbd{p} command, |
286 |
or click the mouse on the @samp{Prev} link, which takes you to the |
or click the middle mouse button on the @samp{Prev} link. That |
287 |
@samp{Previous} node. When you get there, you can do an @kbd{n} |
takes you to the @samp{Previous} node. Then use @kbd{n} to return here. |
|
again to return here. |
|
288 |
@end format |
@end format |
289 |
|
|
290 |
If you read this in Emacs, you will see an @samp{Info} item in the |
If you read this in Emacs, you will see an @samp{Info} item in the |
291 |
menu bar, close to its right edge. Clicking your mouse on the |
menu bar, close to its right edge. Clicking the mouse on the |
292 |
@samp{Info} menu-bar item opens a menu of commands which include |
@samp{Info} menu-bar item opens a menu of commands which include |
293 |
@samp{Next} and @samp{Prev} (and also some others which you didn't yet |
@samp{Next} and @samp{Prev} (and also some others which you didn't yet |
294 |
learn about). |
learn about). |
295 |
|
|
296 |
This all probably seems insultingly simple so far, but @emph{do not} be |
This all probably seems insultingly simple so far, but @emph{please |
297 |
led into skimming. Things will get more complicated soon. Also, |
don't} start skimming. Things will get complicated soon enough! |
298 |
do not try a new command until you are told it is time to. Otherwise, |
Also, please do not try a new command until you are told it is time |
299 |
you may make Info skip past an important warning that was coming up. |
to. You could make Info skip past an important warning that was |
300 |
|
coming up. |
301 |
|
|
302 |
@format |
@format |
303 |
>> Now do an @kbd{n}, or click the mouse on the @samp{Next} link, to |
>> Now do an @kbd{n}, or click the middle mouse button on the @samp{Next} |
304 |
get to the node @samp{Help-^L} and learn more. |
link, to get to the node @samp{Help-^L} and learn more. |
305 |
@end format |
@end format |
306 |
|
|
307 |
@node Help-^L, Help-M, Help-P, Getting Started |
@node Help-^L, Help-M, Help-P, Getting Started |
334 |
screen at once. @key{SPC} moves forward, to show what was below the |
screen at once. @key{SPC} moves forward, to show what was below the |
335 |
bottom of the screen. @key{DEL} or @key{BACKSPACE} moves backward, to |
bottom of the screen. @key{DEL} or @key{BACKSPACE} moves backward, to |
336 |
show what was above the top of the screen (there is not anything above |
show what was above the top of the screen (there is not anything above |
337 |
the top until you have typed some spaces). In Emacs, @key{SPC} runs |
the top until you have typed some spaces). |
|
the command @code{Info-scroll-up}, while @key{BACKSPACE} runs |
|
|
@code{Info-scroll-down}. |
|
338 |
|
|
339 |
@format |
@format |
340 |
>> Now try typing a @key{SPC} (afterward, type a @key{BACKSPACE} to |
>> Now try typing a @key{SPC} (afterward, type a @key{BACKSPACE} to |
350 |
If you are reading this in Emacs, note that the header line is |
If you are reading this in Emacs, note that the header line is |
351 |
always visible, never scrolling off the display. That way, you can |
always visible, never scrolling off the display. That way, you can |
352 |
always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you |
always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you |
353 |
can conveniently go to one of these links from anywhere in the node by |
can conveniently go to one of these links at any time by |
354 |
clicking the mouse on one of these links. |
clicking the middle mouse button on the link. |
355 |
|
|
356 |
@cindex reading Info documents top to bottom |
@cindex reading Info documents top to bottom |
357 |
@cindex Info documents as tutorials |
@cindex Info documents as tutorials |
358 |
@key{SPC} and @key{DEL} not only move forward and backward through |
@key{SPC} and @key{DEL} not only move forward and backward through |
359 |
the current node. When these keys hit the beginning or the end of the |
the current node. They also move between nodes. @key{SPC} at the end |
360 |
current node, they move to preceding or subsequent nodes. |
of a node moves to the next node; @key{DEL} (or @key{BACKSPACE}) at |
361 |
Specifically, they scroll through all the nodes in an Info file as a |
the beginning of a node moves to the previous node. In effect, these |
362 |
single logical sequence. In this sequence, a node's subnodes appear |
commands scroll through all the nodes in an Info file as a single |
363 |
following their parent. If a node has a menu, @key{SPC} takes you |
logical sequence. You can read an entire manual top to bottom by just |
364 |
into the subnodes listed in the menu, one by one. Once you reach the |
typing @key{SPC}, and move backward through the entire manual from |
365 |
end of a node, and have seen all of its subnodes, @key{SPC} takes you |
bottom to top by typing @key{DEL} (or @key{BACKSPACE}). |
366 |
to the next node or to the parent's next node. This is so you could |
|
367 |
read the entire manual top to bottom by just typing @key{SPC}. |
In this sequence, a node's subnodes appear following their parent. |
368 |
|
If a node has a menu, @key{SPC} takes you into the subnodes listed in |
369 |
|
the menu, one by one. Once you reach the end of a node, and have seen |
370 |
|
all of its subnodes, @key{SPC} takes you to the next node or to the |
371 |
|
parent's next node. |
372 |
|
|
373 |
@kindex PAGEUP @r{(Info mode)} |
@kindex PAGEUP @r{(Info mode)} |
374 |
@kindex PAGEDOWN @r{(Info mode)} |
@kindex PAGEDOWN @r{(Info mode)} |
375 |
Many keyboards nowadays have two scroll keys labeled @samp{PageUp} |
Many keyboards nowadays have two scroll keys labeled @samp{PageUp} |
376 |
and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your |
and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your |
377 |
keyboard has these keys, you can use them to move forward and backward |
keyboard has these keys, you can use them to move forward and backward |
378 |
through the text, like with @key{SPC} and @key{BACKSPACE}. However, |
through the text of one node, like @key{SPC} and @key{BACKSPACE} (or |
379 |
unlike @key{SPC} and @key{BACKSPACE}, @key{PAGEUP} and @key{PAGEDOWN} |
@key{DEL}). However, @key{PAGEUP} and @key{PAGEDOWN} keys never |
380 |
keys will never scroll beyond the beginning or the end of the current |
scroll beyond the beginning or the end of the current node. |
|
node. |
|
381 |
|
|
382 |
@kindex C-l @r{(Info mode)} |
@kindex C-l @r{(Info mode)} |
383 |
If your screen is ever garbaged, you can tell Info to display it |
If your screen is ever garbaged, you can tell Info to display it |
390 |
|
|
391 |
@kindex b @r{(Info mode)} |
@kindex b @r{(Info mode)} |
392 |
To move back to the beginning of the node you are on, you can type |
To move back to the beginning of the node you are on, you can type |
393 |
a lot of @key{BACKSPACE} keys. You can also type simply @kbd{b} for |
the @key{BACKSPACE} key (or @key{DEL}) many times. You can also type |
394 |
beginning. |
@kbd{b} just once. @kbd{b} stands for ``beginning.'' |
395 |
|
|
396 |
@format |
@format |
397 |
>> Try that now. (We have put in enough verbiage to push this past |
>> Try that now. (We have put in enough verbiage to push this past |
400 |
Then come back, by typing @key{SPC} one or more times. |
Then come back, by typing @key{SPC} one or more times. |
401 |
@end format |
@end format |
402 |
|
|
403 |
If your screen is very tall, all of this node might fit at once. |
If your screen is very tall, all of this node might fit at once. In |
404 |
In that case, @kbd{b} won't do anything. Sorry; what can we do? |
that case, @kbd{b} won't do anything. But you could observe the |
405 |
|
effect of the @kbd{b} key if you use a smaller window. |
406 |
|
|
407 |
@kindex ? @r{(Info mode)} |
@kindex ? @r{(Info mode)} |
408 |
@findex Info-summary |
@findex Info-summary |
429 |
the same size screen, it would be impossible to warn you anyway. |
the same size screen, it would be impossible to warn you anyway. |
430 |
|
|
431 |
@format |
@format |
432 |
>> Now type @kbd{n}, or click the mouse on the @samp{Next} link, to |
>> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link, |
433 |
see the description of the @kbd{m} command. |
to see the description of the @kbd{m} command. |
434 |
@end format |
@end format |
435 |
|
|
436 |
@node Help-M, Help-Xref, Help-^L, Getting Started |
@node Help-M, Help-Xref, Help-^L, Getting Started |
494 |
@kbd{m} command is not available. |
@kbd{m} command is not available. |
495 |
@end format |
@end format |
496 |
|
|
497 |
|
If you keep typing @key{SPC} once the menu appears on the screen, it |
498 |
|
will move to another node (the first one in the menu). If that |
499 |
|
happens, type @key{BACKSPACE} to come back. |
500 |
|
|
501 |
@kindex m @r{(Info mode)} |
@kindex m @r{(Info mode)} |
502 |
The command to go to one of the subnodes is @kbd{m}---but @emph{do |
The command to go to one of the subnodes is @kbd{m}. This is very |
503 |
not do it yet!} Before you use @kbd{m}, you need to learn about |
different from the commands you have used: it is a command that |
504 |
commands which prompt you for more input. So far, you have learned |
prompts you for more input. |
505 |
several commands that do not need additional input; when you typed |
|
506 |
one, Info processed it and was instantly ready for another command. |
The Info commands you know do not need additional input; when you |
507 |
The @kbd{m} command is different: it is incomplete without the |
type one of them, Info processes it instantly and then is ready for |
508 |
@dfn{name of the subtopic}. Once you have typed @kbd{m}, Info tries |
another command. The @kbd{m} command is different: it needs to know |
509 |
to read the subtopic name. |
the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info |
510 |
|
tries to read the subtopic name. |
511 |
|
|
512 |
Now look for the line containing many dashes near the bottom of the |
Now look for the line containing many dashes near the bottom of the |
513 |
screen. There is one more line beneath that one, but usually it is |
screen. There is one more line beneath that one, but usually it is |
514 |
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} |
515 |
or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains text ending |
or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains text ending |
516 |
in a colon, it means Info is trying to read more input for the last |
in a colon, it means Info is reading more input for the last command. |
517 |
command. At such times, commands do not work, because Info tries to |
You can't type an Info command then, because Info is trying to read |
518 |
use them as the input it needs. You must either type your response and |
input, not commands. You must either give the input and finish the |
519 |
finish the command you started, or type @kbd{Control-g} to cancel the |
command you started, or type @kbd{Control-g} to cancel the command. |
520 |
command. When you have done one of those things, the line becomes |
When you have done one of those things, the input entry line becomes |
521 |
blank again. |
blank again. Then you can type Info commands again. |
522 |
|
|
523 |
@findex Info-menu |
@findex Info-menu |
524 |
The command to go to a subnode via a menu is @kbd{m}. After you type |
The command to go to a subnode via a menu is @kbd{m}. After you type |
537 |
the menu. |
the menu. |
538 |
|
|
539 |
@cindex completion of Info node names |
@cindex completion of Info node names |
540 |
You can also use the @dfn{completion} feature to help enter the subtopic |
You can also use the @dfn{completion} feature to help enter the |
541 |
name. If you type the @key{TAB} key after entering part of a name, it will |
subtopic name. If you type the @key{TAB} key after entering part of a |
542 |
magically fill in more of the name---as much as follows uniquely from |
name, it will fill in more of the name---as much as Info can deduce |
543 |
what you have entered. |
from the part you have entered. |
544 |
|
|
545 |
If you move the cursor to one of the menu subtopic lines, then you do |
If you move the cursor to one of the menu subtopic lines, then you do |
546 |
not need to type the argument: you just type a @key{RET}, and it |
not need to type the argument: you just type a @key{RET}, and it |
547 |
stands for the subtopic of the line you are on. |
stands for the subtopic of the line you are on. You can also click |
548 |
|
the middle mouse button directly on the subtopic line to go there. |
549 |
|
|
550 |
Here is a menu to give you a chance to practice. This menu gives you |
Here is a menu to give you a chance to practice. This menu gives you |
551 |
three ways of going to one place, Help-FOO: |
three ways of going to one place, Help-FOO: |
552 |
|
|
553 |
@menu |
@menu |
554 |
* Foo: Help-FOO. A node you can visit for fun. |
* Foo: Help-FOO. A node you can visit for fun. |
555 |
* 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. |
556 |
* Help-FOO:: And yet another! |
* Help-FOO:: And yet another! |
557 |
@end menu |
@end menu |
558 |
|
|
612 |
ends the subtopic's brief name. You will see the subtopic's name |
ends the subtopic's brief name. You will see the subtopic's name |
613 |
change its appearance (usually, its background color will change), and |
change its appearance (usually, its background color will change), and |
614 |
the shape of the mouse pointer will change if your platform supports |
the shape of the mouse pointer will change if your platform supports |
615 |
that. After a while, if you leave the mouse on that spot, a tooltip |
that. After a while, if you leave the mouse on that spot, a small |
616 |
will pop up saying ``Mouse-2: go to that node''. (If the tooltips are |
window will pop up, saying ``Mouse-2: go to that node'', or the same |
617 |
turned off or unavailable, this message is displayed in the @dfn{echo |
message may appear at the bottom of the screen. |
618 |
area}, the bottom screen line where you typed the menu subtopics in |
|
619 |
response to the prompt.) @kbd{Mouse-2} is the second button of your |
@kbd{Mouse-2} is the second button of your mouse counting from the |
620 |
mouse counting from the left---the rightmost button for two-button |
left---the middle button on a 3-button mouse. (On a 2-button mouse, |
621 |
mice, the middle button for 3-button mice. So pressing @kbd{Mouse-2} |
you may have to press both buttons together to ``press the middle |
622 |
while the mouse pointer is on a menu subtopic goes to that subtopic. |
button''.) The message tells you pressing @kbd{Mouse-2} with the |
623 |
|
current position of the mouse pointer (on subtopic in the menu) will |
624 |
|
go to that subtopic. |
625 |
|
|
626 |
@findex Info-mouse-follow-nearest-node |
@findex Info-mouse-follow-nearest-node |
627 |
More generally, @kbd{Mouse-2} in an Info buffer runs the Emacs |
More generally, @kbd{Mouse-2} in an Info buffer finds the nearest |
|
command @code{Info-mouse-follow-nearest-node}, which finds the nearest |
|
628 |
link to another node and goes there. For example, near a cross |
link to another node and goes there. For example, near a cross |
629 |
reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the |
reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the |
630 |
node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At |
node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At |
662 |
(Some Info readers, such as the one built into Emacs, put you at the |
(Some Info readers, such as the one built into Emacs, put you at the |
663 |
same place where you were reading in @samp{Help-M}.) |
same place where you were reading in @samp{Help-M}.) |
664 |
|
|
665 |
Another way to go Up is to click on the @samp{Up} pointer shown in |
Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up} |
666 |
the header line (provided that you have a mouse). |
pointer shown in the header line (provided that you have a mouse). |
667 |
|
|
668 |
@format |
@format |
669 |
>> Now type @kbd{u} to move back up to @samp{Help-M}. |
>> Now type @kbd{u} to move back up to @samp{Help-M}. |