aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2001-04-17 12:13:47 +0000
committerEli Zaretskii2001-04-17 12:13:47 +0000
commit3c7625c9119ed60e0dc37ac617248e2f5bafbf35 (patch)
tree82cd09998892f05edc6bb0257a020de79c1a7769
parent1c8addd0499c3b242c1dab429379261de75fcdee (diff)
downloademacs-3c7625c9119ed60e0dc37ac617248e2f5bafbf35.tar.gz
emacs-3c7625c9119ed60e0dc37ac617248e2f5bafbf35.zip
Fix markup of keys such as Space and Backspace.
-rw-r--r--man/info.texi156
1 files changed, 85 insertions, 71 deletions
diff --git a/man/info.texi b/man/info.texi
index 76161e58d83..2c74d7d979b 100644
--- a/man/info.texi
+++ b/man/info.texi
@@ -6,7 +6,7 @@
6@syncodeindex vr cp 6@syncodeindex vr cp
7@syncodeindex ky cp 7@syncodeindex ky cp
8@comment %**end of header 8@comment %**end of header
9@comment $Id: info.texi,v 1.9 2001/04/14 11:52:21 eliz Exp $ 9@comment $Id: info.texi,v 1.10 2001/04/15 08:43:53 eliz Exp $
10 10
11@dircategory Texinfo documentation system 11@dircategory Texinfo documentation system
12@direntry 12@direntry
@@ -120,12 +120,12 @@ There are two ways of looking at the online version of this manual:
120@enumerate 120@enumerate
121@item 121@item
122Type @code{info} at your shell's command line. This approach uses a 122Type @code{info} at your shell's command line. This approach uses a
123small stand-alone program designed just to read Info files. 123stand-alone program designed just to read Info files.
124 124
125@item 125@item
126Type @code{emacs} at the command line; then type @kbd{C-h i} (Control 126Type @code{emacs} at the command line; then type @kbd{C-h i}
127@kbd{h}, followed by @kbd{i}). This approach uses the Info mode of the 127(@kbd{Control-h}, followed by @kbd{i}). This approach uses the Info
128Emacs program, an editor with many other capabilities. 128mode of the Emacs program, an editor with many other capabilities.
129@end enumerate 129@end enumerate
130 130
131In either case, then type @kbd{mInfo} (just the letters), followed by 131In either case, then type @kbd{mInfo} (just the letters), followed by
@@ -169,7 +169,7 @@ back up, press the key labeled @samp{Backspace} or @samp{DEL} (on some
169keyboards, this key might be labeled @samp{Delete}). 169keyboards, this key might be labeled @samp{Delete}).
170 170
171@ifinfo 171@ifinfo
172Here are 40 lines of junk, so you can try Spaces and DEL and 172Here are 40 lines of junk, so you can try @key{SPC} and @key{DEL} and
173see what they do. At the end are instructions of what you should do 173see what they do. At the end are instructions of what you should do
174next. 174next.
175 175
@@ -217,10 +217,11 @@ This is line 59
217@end format 217@end format
218 218
219If you have managed to get here, go back to the beginning with 219If you have managed to get here, go back to the beginning with
220@kbd{DEL} (or Backspace), and come back here again, then you 220@kbd{DEL} (or @key{BACKSPACE}), and come back here again, then you
221understand Space and DEL. So now type an @kbd{n} ---just one 221understand the about the @samp{Space} and @samp{Backspace} keys. So
222character; don't type the quotes and don't type the Return key 222now type an @kbd{n} ---just one character; don't type the quotes and
223afterward--- to get to the normal start of the course. 223don't type the Return key afterward--- to get to the normal start of
224the course.
224@end ifinfo 225@end ifinfo
225 226
226@node Help, Help-P, Help-Small-Screen, Getting Started 227@node Help, Help-P, Help-Small-Screen, Getting Started
@@ -279,12 +280,18 @@ node, @samp{Help-^L}. In Emacs, @kbd{n} runs the Emacs command
279@code{Info-next}, and @kbd{p} runs @code{Info-prev}. 280@code{Info-next}, and @kbd{p} runs @code{Info-prev}.
280 281
281@format 282@format
282>> But do not do that yet. First, try the @kbd{p} command, or click 283>> But do not type @kbd{n} yet. First, try the @kbd{p} command,
283 the mouse on the @samp{Prev} link, which takes you to the 284 or click the mouse on the @samp{Prev} link, which takes you to the
284 @samp{Previous} node. When you get there, you can do an @kbd{n} 285 @samp{Previous} node. When you get there, you can do an @kbd{n}
285 again to return here. 286 again to return here.
286@end format 287@end format
287 288
289 If you read this in Emacs, you will see an @samp{Info} item in the
290menu bar, close to its right edge. Clicking your mouse on the
291@samp{Info} menu-bar item opens a menu of commands which include
292@samp{Next} and @samp{Prev} (and also some others which you didn't yet
293learn about).
294
288 This all probably seems insultingly simple so far, but @emph{do not} be 295 This all probably seems insultingly simple so far, but @emph{do not} be
289led into skimming. Things will get more complicated soon. Also, 296led into skimming. Things will get more complicated soon. Also,
290do not try a new command until you are told it is time to. Otherwise, 297do not try a new command until you are told it is time to. Otherwise,
@@ -314,27 +321,29 @@ the bottom right corner of the screen.
314@kindex BACKSPACE @r{(Info mode)} 321@kindex BACKSPACE @r{(Info mode)}
315@findex Info-scroll-up 322@findex Info-scroll-up
316@findex Info-scroll-down 323@findex Info-scroll-down
317 The Space, Backspace (or DEL)@footnote{The key which we call 324 The @key{SPC}, @key{BACKSPACE} (or @key{DEL})@footnote{The key which
318``Backspace or DEL'' in this manual is labeled differently on 325we call ``Backspace or DEL'' in this manual is labeled differently on
319different keyboards. Look for a key which is a little ways above the 326different keyboards. Look for a key which is a little ways above the
320@key{ENTER} or @key{RET} key and which you normally use outside Emacs 327@key{ENTER} or @key{RET} key and which you normally use outside Emacs
321to erase the character before the cursor, i.e.@: the character you 328to erase the character before the cursor, i.e.@: the character you
322typed last. It might be labeled @samp{Backspace} or @samp{<-} or 329typed last. It might be labeled @samp{Backspace} or @samp{<-} or
323@samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to 330@samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to
324allow you to ``move around'' in a node that does not all fit on the 331allow you to ``move around'' in a node that does not all fit on the
325screen at once. Space moves forward, to show what was below the 332screen at once. @key{SPC} moves forward, to show what was below the
326bottom of the screen. DEL or Backspace moves backward, to show what 333bottom of the screen. @key{DEL} or @key{BACKSPACE} moves backward, to
327was above the top of the screen (there is not anything above the top 334show what was above the top of the screen (there is not anything above
328until you have typed some spaces). In Emacs, Space runs the command 335the top until you have typed some spaces). In Emacs, @key{SPC} runs
329@code{Info-scroll-up}, while Backspace runs @code{Info-scroll-down}. 336the command @code{Info-scroll-up}, while @key{BACKSPACE} runs
337@code{Info-scroll-down}.
330 338
331@format 339@format
332>> Now try typing a Space (afterward, type a Backspace to return here). 340>> Now try typing a @key{SPC} (afterward, type a @key{BACKSPACE} to
341 return here).
333@end format 342@end format
334 343
335 When you type the Space, the two lines that were at the bottom of 344 When you type the @key{SPC}, the two lines that were at the bottom of
336the screen appear at the top, followed by more lines. DEL or 345the screen appear at the top, followed by more lines. @key{DEL} or
337Backspace takes the two lines from the top and moves them to the 346@key{BACKSPACE} takes the two lines from the top and moves them to the
338bottom, @emph{usually}, but if there are not a full screen's worth of 347bottom, @emph{usually}, but if there are not a full screen's worth of
339lines above them they may not make it all the way to the bottom. 348lines above them they may not make it all the way to the bottom.
340 349
@@ -346,30 +355,31 @@ clicking the mouse on one of these links.
346 355
347@cindex reading Info documents top to bottom 356@cindex reading Info documents top to bottom
348@cindex Info documents as tutorials 357@cindex Info documents as tutorials
349 Space and DEL not only move forward and backward through the current 358 @key{SPC} and @key{DEL} not only move forward and backward through
350node. When these keys hit the beginning or the end of the current 359the current node. When these keys hit the beginning or the end of the
351node, they move to preceding or subsequent nodes. Specifically, they 360current node, they move to preceding or subsequent nodes.
352scroll through all the nodes in an Info file as a single logical 361Specifically, they scroll through all the nodes in an Info file as a
353sequence. In this sequence, a node's subnodes appear following their 362single logical sequence. In this sequence, a node's subnodes appear
354parent. If a node has a menu, Space takes you into the subnodes 363following their parent. If a node has a menu, @key{SPC} takes you
355listed in the menu, one by one. Once you reach the end of a node, and 364into the subnodes listed in the menu, one by one. Once you reach the
356have seen all of its subnodes, Space takes you to the next node or to 365end of a node, and have seen all of its subnodes, @key{SPC} takes you
357the parent's next node. This is so you could read the entire manual 366to the next node or to the parent's next node. This is so you could
358top to bottom by just typing Space. 367read the entire manual top to bottom by just typing @key{SPC}.
359 368
360@kindex PAGEUP @r{(Info mode)} 369@kindex PAGEUP @r{(Info mode)}
361@kindex PAGEDOWN @r{(Info mode)} 370@kindex PAGEDOWN @r{(Info mode)}
362 Many keyboards nowadays have two scroll keys labeled @samp{PageUp} 371 Many keyboards nowadays have two scroll keys labeled @samp{PageUp}
363and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your 372and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your
364keyboard has these keys, you can use them to move forward and backward 373keyboard has these keys, you can use them to move forward and backward
365through the text, like with Space and Backspace. However, unlike 374through the text, like with @key{SPC} and @key{BACKSPACE}. However,
366Space and Backspace, PageUp and PageDown keys will never scroll beyond 375unlike @key{SPC} and @key{BACKSPACE}, @key{PAGEUP} and @key{PAGEDOWN}
367the beginning or the end of the current node. 376keys will never scroll beyond the beginning or the end of the current
377node.
368 378
369@kindex C-l @r{(Info mode)} 379@kindex C-l @r{(Info mode)}
370 If your screen is ever garbaged, you can tell Info to print it out 380 If your screen is ever garbaged, you can tell Info to print it out
371again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down 381again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down
372``Control'' and type an @key{L} or @kbd{l}). 382@key{CTRL} and type @kbd{L} or @kbd{l}).
373 383
374@format 384@format
375>> Type @kbd{C-l} now. 385>> Type @kbd{C-l} now.
@@ -377,13 +387,14 @@ again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down
377 387
378@kindex b @r{(Info mode)} 388@kindex b @r{(Info mode)}
379 To move back to the beginning of the node you are on, you can type 389 To move back to the beginning of the node you are on, you can type
380a lot of Backspaces. You can also type simply @kbd{b} for beginning. 390a lot of @key{BACKSPACE} keys. You can also type simply @kbd{b} for
391beginning.
381 392
382@format 393@format
383>> Try that now. (We have put in enough verbiage to push this past 394>> Try that now. (We have put in enough verbiage to push this past
384 the first screenful, but screens are so big nowadays that perhaps it 395 the first screenful, but screens are so big nowadays that perhaps it
385 isn't enough. You may need to shrink your Emacs or Info window.) 396 isn't enough. You may need to shrink your Emacs or Info window.)
386 Then come back, with Spaces. 397 Then come back, with @key{SCS}s.
387@end format 398@end format
388 399
389 If your screen is very tall, all of this node might fit at once. 400 If your screen is very tall, all of this node might fit at once.
@@ -395,7 +406,7 @@ In that case, @kbd{b} won't do anything. Sorry; what can we do?
395want to use one but have trouble remembering which, you should type 406want to use one but have trouble remembering which, you should type
396a @key{?} (in Emacs it runs the @code{Info-summary} command) which 407a @key{?} (in Emacs it runs the @code{Info-summary} command) which
397prints out a brief list of commands. When you are finished looking at 408prints out a brief list of commands. When you are finished looking at
398the list, make it go away by typing a Space repeatedly. 409the list, make it go away by typing a @key{SPC} repeatedly.
399 410
400@format 411@format
401>> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of 412>> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of
@@ -404,13 +415,13 @@ the list, make it go away by typing a Space repeatedly.
404@end format 415@end format
405 416
406 (If you are using the stand-alone Info reader, type @kbd{C-x 0} to 417 (If you are using the stand-alone Info reader, type @kbd{C-x 0} to
407return here, that is---press and hold ``Control'', type an @kbd{x}, 418return here, that is---press and hold @key{CTRL}, type an @kbd{x},
408then release ``Control'' and @kbd{x}, and press @kbd{0}---a zero, not 419then release @key{CTRL} and @kbd{x}, and press @kbd{0}---a zero, not
409the letter ``o''.) 420the letter ``o''.)
410 421
411 From now on, you will encounter large nodes without warning, and 422 From now on, you will encounter large nodes without warning, and
412will be expected to know how to use Space and Backspace to move 423will be expected to know how to use @key{SPC} and @key{BACKSPACE} to
413around in them without being told. Since not all terminals have 424move around in them without being told. Since not all terminals have
414the same size screen, it would be impossible to warn you anyway. 425the same size screen, it would be impossible to warn you anyway.
415 426
416@format 427@format
@@ -472,8 +483,8 @@ This means that the subtopic name and node name are the same; they are
472both @samp{Foo}. 483both @samp{Foo}.
473 484
474@format 485@format
475>> Now use Spaces to find the menu in this node, then come back to 486>> Now use @key{SPC} to find the menu in this node, then come back to
476 the front with a @kbd{b} and some Spaces. As you see, a menu is 487 the front with a @kbd{b} and some @key{SPC}s. As you see, a menu is
477 actually visible in its node. If you cannot find a menu in a node 488 actually visible in its node. If you cannot find a menu in a node
478 by looking at it, then the node does not have a menu and the 489 by looking at it, then the node does not have a menu and the
479 @kbd{m} command is not available. 490 @kbd{m} command is not available.
@@ -492,7 +503,7 @@ to read the subtopic name.
492 Now look for the line containing many dashes near the bottom of the 503 Now look for the line containing many dashes near the bottom of the
493screen. There is one more line beneath that one, but usually it is 504screen. There is one more line beneath that one, but usually it is
494blank. If it is empty, Info is ready for a command, such as @kbd{n} 505blank. If it is empty, Info is ready for a command, such as @kbd{n}
495or @kbd{b} or Space or @kbd{m}. If that line contains text ending 506or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains text ending
496in a colon, it means Info is trying to read more input for the last 507in a colon, it means Info is trying to read more input for the last
497command. At such times, commands do not work, because Info tries to 508command. At such times, commands do not work, because Info tries to
498use them as the input it needs. You must either type your response and 509use them as the input it needs. You must either type your response and
@@ -518,7 +529,7 @@ the menu.
518 529
519@cindex completion of Info node names 530@cindex completion of Info node names
520 You can also use the @dfn{completion} feature to help enter the subtopic 531 You can also use the @dfn{completion} feature to help enter the subtopic
521name. If you type the Tab key after entering part of a name, it will 532name. If you type the @key{TAB} key after entering part of a name, it will
522magically fill in more of the name---as much as follows uniquely from 533magically fill in more of the name---as much as follows uniquely from
523what you have entered. 534what you have entered.
524 535
@@ -558,7 +569,7 @@ now; the next thing you will type must be the name of a subtopic.
558@end format 569@end format
559 570
560 While you are typing the item name, you can use the @key{DEL} (or 571 While you are typing the item name, you can use the @key{DEL} (or
561Backspace) key to cancel one character at a time if you make a 572@key{BACKSPACE}) key to cancel one character at a time if you make a
562mistake. 573mistake.
563 574
564@format 575@format
@@ -576,9 +587,9 @@ mistake.
576 Another way to move to the menu subtopic lines and between them is 587 Another way to move to the menu subtopic lines and between them is
577to type @key{TAB}. Each time you type a @key{TAB}, you move to the 588to type @key{TAB}. Each time you type a @key{TAB}, you move to the
578next subtopic line. To move to a previous subtopic line, type 589next subtopic line. To move to a previous subtopic line, type
579@kbd{M-@key{TAB}}---that is, press and hold the Meta key and then 590@kbd{M-@key{TAB}}---that is, press and hold the @key{META} key and then
580press @key{TAB}. (On some keyboards, the Meta key might be known as 591press @key{TAB}. (On some keyboards, the @key{META} key might be labeled
581``Alt''.) 592@samp{Alt}.)
582 593
583 Once you move cursor to a subtopic line, press @key{RET} to go to 594 Once you move cursor to a subtopic line, press @key{RET} to go to
584that subtopic's node. 595that subtopic's node.
@@ -594,9 +605,10 @@ the shape of the mouse pointer will change if your platform supports
594that. After a while, if you leave the mouse on that spot, a tooltip 605that. After a while, if you leave the mouse on that spot, a tooltip
595will pop up saying ``Mouse-2: go to that node''. (If the tooltips are 606will pop up saying ``Mouse-2: go to that node''. (If the tooltips are
596turned off or unavailable, this message is printed in the @dfn{echo 607turned off or unavailable, this message is printed in the @dfn{echo
597area}, the last screen line where you typed the menu subtopics in 608area}, the bottom screen line where you typed the menu subtopics in
598response to the prompt.) @kbd{Mouse-2} is the second button of your 609response to the prompt.) @kbd{Mouse-2} is the second button of your
599mouse---normally the rightmost button. So pressing @kbd{Mouse-2} 610mouse counting from the left---the rightmost button for two-button
611mice, the middle button for 3-button mice. So pressing @kbd{Mouse-2}
600while the mouse pointer is on a menu subtopic goes to that subtopic. 612while the mouse pointer is on a menu subtopic goes to that subtopic.
601 613
602@findex Info-mouse-follow-nearest-node 614@findex Info-mouse-follow-nearest-node
@@ -633,7 +645,7 @@ usually used to ``stay on the same level but go backwards''.
633@kindex u @r{(Info mode)} 645@kindex u @r{(Info mode)}
634@findex Info-up 646@findex Info-up
635 You can go back to the node @samp{Help-M} by typing the command 647 You can go back to the node @samp{Help-M} by typing the command
636@kbd{u} for ``Up'' (the Emacs command ruin by @kbd{u} is 648@kbd{u} for ``Up'' (the Emacs command run by @kbd{u} is
637@code{Info-up}). That puts you at the @emph{front} of the node---to 649@code{Info-up}). That puts you at the @emph{front} of the node---to
638get back to where you were reading you have to type some @key{SPC}s. 650get back to where you were reading you have to type some @key{SPC}s.
639(Some Info readers, such as the one built into Emacs, put you at the 651(Some Info readers, such as the one built into Emacs, put you at the
@@ -685,8 +697,8 @@ which the header says is the @samp{Previous} node (from this node, the
685@cindex go to Directory node 697@cindex go to Directory node
686 The @kbd{d} command (@code{Info-directory} in Emacs) gets you 698 The @kbd{d} command (@code{Info-directory} in Emacs) gets you
687instantly to the Directory node. This node, which is the first one 699instantly to the Directory node. This node, which is the first one
688you saw when you entered Info, has a menu which leads (directly, or 700you saw when you entered Info, has a menu which leads (directly or
689indirectly through other menus), to all the nodes that exist. The 701indirectly, through other menus), to all the nodes that exist. The
690Directory node lists all the manuals and other Info documents that 702Directory node lists all the manuals and other Info documents that
691are, or could be, installed on your system. 703are, or could be, installed on your system.
692 704
@@ -717,12 +729,13 @@ command. The @kbd{f} must be followed by the cross reference name
717reference, Info suggests the name if the nearest reference in 729reference, Info suggests the name if the nearest reference in
718parentheses; typing @key{RET} will follow that reference. You can 730parentheses; typing @key{RET} will follow that reference. You can
719also type a different name, if the default is not what you want. 731also type a different name, if the default is not what you want.
720While you enter the name, you can use the DEL (or Backspace) key to 732While you enter the name, you can use the @key{DEL} (or
721edit your input. If you change your mind about following any 733@key{BACKSPACE}) key to edit your input. If you change your mind
722reference, you can use @kbd{Control-g} to cancel the command. 734about following any reference, you can use @kbd{Control-g} to cancel
735the command.
723 736
724 Completion is available in the @kbd{f} command; you can complete among 737 Completion is available in the @kbd{f} command; you can complete among
725all the cross reference names in the current node by typing a Tab. 738all the cross reference names in the current node by typing a @key{TAB}.
726 739
727 @kbd{f} runs @code{Info-follow-reference} in Emacs. 740 @kbd{f} runs @code{Info-follow-reference} in Emacs.
728 741
@@ -1178,7 +1191,7 @@ End Tag Table
1178@noindent 1191@noindent
1179Note that it contains one line per node, and this line contains 1192Note that it contains one line per node, and this line contains
1180the beginning of the node's header (ending just after the node name), 1193the beginning of the node's header (ending just after the node name),
1181a DEL character, and the character position in the file of the 1194a @key{DEL} character, and the character position in the file of the
1182beginning of the node. 1195beginning of the node.
1183 1196
1184 1197
@@ -1241,20 +1254,21 @@ not scroll with the rest of the buffer, making these links always
1241visible. 1254visible.
1242 1255
1243@item Info-scroll-prefer-subnodes 1256@item Info-scroll-prefer-subnodes
1244If set to a non-@code{nil} value, Space and Backspace (or DEL) keys in 1257If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or
1245a menu visit subnodes of the current node before scrolling to its end 1258@key{DEL}) keys in a menu visit subnodes of the current node before
1246or beginning, respectively. For example, if the node's menu appears 1259scrolling to its end or beginning, respectively. For example, if the
1247on the screen, the next Space moves to a subnode indicated by the 1260node's menu appears on the screen, the next @key{SPC} moves to a
1248following menu item. Setting this option to @code{nil} results in 1261subnode indicated by the following menu item. Setting this option to
1249behavior similar to the stand-alone Info reader program, which visits 1262@code{nil} results in behavior similar to the stand-alone Info reader
1250the first subnode from the menu only when you hit the end of the 1263program, which visits the first subnode from the menu only when you
1251current node. The default is @code{t}. 1264hit the end of the current node. The default is @code{t}.
1252 1265
1253@item Info-enable-active-nodes 1266@item Info-enable-active-nodes
1254When set to a non-@code{nil} value, allows Info to execute Lisp code 1267When set to a non-@code{nil} value, allows Info to execute Lisp code
1255associated with nodes. The Lisp code is executed when the node is 1268associated with nodes. The Lisp code is executed when the node is
1256selected. The Lisp code to be executed should follow the node 1269selected. The Lisp code to be executed should follow the node
1257delimiter (the DEL character) and an @samp{execute: } tag, like this: 1270delimiter (the @key{DEL} character) and an @samp{execute: } tag, like
1271this:
1258 1272
1259@example 1273@example
1260^_execute: (message "This is an active node!") 1274^_execute: (message "This is an active node!")