diff options
| author | Richard M. Stallman | 2001-09-19 20:08:17 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2001-09-19 20:08:17 +0000 |
| commit | e4a9d9e3547c0806fc310d94493313630b729f78 (patch) | |
| tree | 697245b13f7b395a03e1c8743e3bae701d6f569c | |
| parent | 2fc7d480e7c99e2c15395aae79e837ed645a74ea (diff) | |
| download | emacs-e4a9d9e3547c0806fc310d94493313630b729f78.tar.gz emacs-e4a9d9e3547c0806fc310d94493313630b729f78.zip | |
New node Help-Xref broken out from Help-Int.
In Help-Int, describe the i command and add xref
to Info Search.
| -rw-r--r-- | man/info.texi | 113 |
1 files changed, 65 insertions, 48 deletions
diff --git a/man/info.texi b/man/info.texi index e6a57052090..02dd81b16eb 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.13 2001/05/03 14:03:33 karl Exp $ | 9 | @comment $Id: info.texi,v 1.14 2001/09/19 19:58:29 rms Exp $ |
| 10 | 10 | ||
| 11 | @dircategory Texinfo documentation system | 11 | @dircategory Texinfo documentation system |
| 12 | @direntry | 12 | @direntry |
| @@ -142,8 +142,9 @@ the screen. | |||
| 142 | * Help-Small-Screen:: Starting Info on a Small Screen | 142 | * Help-Small-Screen:: Starting Info on a Small Screen |
| 143 | * Help:: How to use Info | 143 | * Help:: How to use Info |
| 144 | * Help-P:: Returning to the Previous node | 144 | * Help-P:: Returning to the Previous node |
| 145 | * Help-^L:: The Space, Rubout, B and ^L commands. | 145 | * Help-^L:: The Space, DEL, B and ^L commands. |
| 146 | * Help-M:: Menus | 146 | * Help-M:: Menus |
| 147 | * Help-Xref:: Following cross-references | ||
| 147 | * Help-Int:: Some intermediate Info commands | 148 | * Help-Int:: Some intermediate Info commands |
| 148 | * Help-Q:: Quitting Info | 149 | * Help-Q:: Quitting Info |
| 149 | @end menu | 150 | @end menu |
| @@ -429,7 +430,7 @@ the same size screen, it would be impossible to warn you anyway. | |||
| 429 | see the description of the @kbd{m} command. | 430 | see the description of the @kbd{m} command. |
| 430 | @end format | 431 | @end format |
| 431 | 432 | ||
| 432 | @node Help-M, Help-Int, Help-^L, Getting Started | 433 | @node Help-M, Help-Xref, Help-^L, Getting Started |
| 433 | @comment node-name, next, previous, up | 434 | @comment node-name, next, previous, up |
| 434 | @section Menus and the @kbd{m} command | 435 | @section Menus and the @kbd{m} command |
| 435 | 436 | ||
| @@ -658,13 +659,73 @@ the header line (provided that you have a mouse). | |||
| 658 | >> Now type @kbd{u} to move back up to @samp{Help-M}. | 659 | >> Now type @kbd{u} to move back up to @samp{Help-M}. |
| 659 | @end format | 660 | @end format |
| 660 | 661 | ||
| 661 | @node Help-Int, Help-Q, Help-M, Getting Started | 662 | @node Help-Xref, Help-Int, Help-M, Getting Started |
| 663 | @comment node-name, next, previous, up | ||
| 664 | @section Following Cross-References | ||
| 665 | |||
| 666 | Sometimes, in Info documentation, you will see a cross reference. | ||
| 667 | Cross references look like this: @xref{Help-Cross, Cross}. That is a | ||
| 668 | real, live cross reference which is named @samp{Cross} and points at | ||
| 669 | the node named @samp{Help-Cross}. | ||
| 670 | |||
| 671 | @kindex f @r{(Info mode)} | ||
| 672 | @findex Info-follow-reference | ||
| 673 | @cindex cross references in Info documents | ||
| 674 | If you wish to follow a cross reference, you must use the @kbd{f} | ||
| 675 | command. The @kbd{f} must be followed by the cross reference name | ||
| 676 | (in this case, @samp{Cross}). If the cursor is on or near the cross | ||
| 677 | reference, Info suggests the name if the nearest reference in | ||
| 678 | parentheses; typing @key{RET} will follow that reference. You can | ||
| 679 | also type a different name, if the default is not what you want. | ||
| 680 | While you enter the name, you can use the @key{DEL} (or | ||
| 681 | @key{BACKSPACE}) key to edit your input. If you change your mind | ||
| 682 | about following any reference, you can use @kbd{Control-g} to cancel | ||
| 683 | the command. | ||
| 684 | |||
| 685 | Completion is available in the @kbd{f} command; you can complete among | ||
| 686 | all the cross reference names in the current node by typing a @key{TAB}. | ||
| 687 | |||
| 688 | @kbd{f} runs @code{Info-follow-reference} in Emacs. | ||
| 689 | |||
| 690 | @format | ||
| 691 | >> Type @kbd{f}, followed by @kbd{Cross}, and a @key{RET}. | ||
| 692 | @end format | ||
| 693 | |||
| 694 | To get a list of all the cross references in the current node, you can | ||
| 695 | type @kbd{?} after an @kbd{f}. The @kbd{f} continues to await a | ||
| 696 | cross reference name even after printing the list, so if you don't | ||
| 697 | actually want to follow a reference, you should type a @kbd{Control-g} | ||
| 698 | to cancel the @kbd{f}. | ||
| 699 | |||
| 700 | @format | ||
| 701 | >> Type @kbd{f?} to get a list of the cross references in this node. Then | ||
| 702 | type a @kbd{Control-g} and see how the @samp{f} gives up. | ||
| 703 | @end format | ||
| 704 | |||
| 705 | The @key{TAB} and @kbd{M-@key{TAB}} key, which move between | ||
| 706 | subtopics in a menu can move between cross references as well. Once | ||
| 707 | the cursor is on a cross reference, you can press @key{RET} to follow | ||
| 708 | that reference, just like you do in a menu. | ||
| 709 | |||
| 710 | @node Help-Int, Help-Q, Help-Xref, Getting Started | ||
| 662 | @comment node-name, next, previous, up | 711 | @comment node-name, next, previous, up |
| 663 | @section Some intermediate Info commands | 712 | @section Some intermediate Info commands |
| 664 | 713 | ||
| 665 | The introductory course is almost over; please continue | 714 | The introductory course is almost over; please continue |
| 666 | a little longer to learn some intermediate-level commands. | 715 | a little longer to learn some intermediate-level commands. |
| 667 | 716 | ||
| 717 | Most Info files have an index, which is actually a large node that | ||
| 718 | contains nothing but a menu. The menu has one menu item for each | ||
| 719 | topic listed in the index. You can find the index node from the main | ||
| 720 | menu of the file, with the @kbd{m} command; then you can use the | ||
| 721 | @kbd{m} command again in the index node to go to the node that | ||
| 722 | describes the topic. | ||
| 723 | |||
| 724 | There is also a short-cut Info command, @kbd{i}, which does all of | ||
| 725 | that for you. It searches the index for a given topic (a string) and | ||
| 726 | goes to the node which is listed in the index for that topic. | ||
| 727 | @xref{Info Search}, for a full explanation. | ||
| 728 | |||
| 668 | @kindex l @r{(Info mode)} | 729 | @kindex l @r{(Info mode)} |
| 669 | @findex Info-last | 730 | @findex Info-last |
| 670 | @cindex going back in Info mode | 731 | @cindex going back in Info mode |
| @@ -716,50 +777,6 @@ This is useful if you want to browse the manual's main menu, or select | |||
| 716 | some specific top-level menu item. The Emacs command run by @kbd{t} | 777 | some specific top-level menu item. The Emacs command run by @kbd{t} |
| 717 | is @code{Info-top-node}. | 778 | is @code{Info-top-node}. |
| 718 | 779 | ||
| 719 | Sometimes, in Info documentation, you will see a cross reference. | ||
| 720 | Cross references look like this: @xref{Help-Cross, Cross}. That is a | ||
| 721 | real, live cross reference which is named @samp{Cross} and points at | ||
| 722 | the node named @samp{Help-Cross}. | ||
| 723 | |||
| 724 | @kindex f @r{(Info mode)} | ||
| 725 | @findex Info-follow-reference | ||
| 726 | @cindex cross references in Info documents | ||
| 727 | If you wish to follow a cross reference, you must use the @kbd{f} | ||
| 728 | command. The @kbd{f} must be followed by the cross reference name | ||
| 729 | (in this case, @samp{Cross}). If the cursor is on or near the cross | ||
| 730 | reference, Info suggests the name if the nearest reference in | ||
| 731 | parentheses; typing @key{RET} will follow that reference. You can | ||
| 732 | also type a different name, if the default is not what you want. | ||
| 733 | While you enter the name, you can use the @key{DEL} (or | ||
| 734 | @key{BACKSPACE}) key to edit your input. If you change your mind | ||
| 735 | about following any reference, you can use @kbd{Control-g} to cancel | ||
| 736 | the command. | ||
| 737 | |||
| 738 | Completion is available in the @kbd{f} command; you can complete among | ||
| 739 | all the cross reference names in the current node by typing a @key{TAB}. | ||
| 740 | |||
| 741 | @kbd{f} runs @code{Info-follow-reference} in Emacs. | ||
| 742 | |||
| 743 | @format | ||
| 744 | >> Type @kbd{f}, followed by @kbd{Cross}, and a @key{RET}. | ||
| 745 | @end format | ||
| 746 | |||
| 747 | To get a list of all the cross references in the current node, you can | ||
| 748 | type @kbd{?} after an @kbd{f}. The @kbd{f} continues to await a | ||
| 749 | cross reference name even after printing the list, so if you don't | ||
| 750 | actually want to follow a reference, you should type a @kbd{Control-g} | ||
| 751 | to cancel the @kbd{f}. | ||
| 752 | |||
| 753 | @format | ||
| 754 | >> Type @kbd{f?} to get a list of the cross references in this node. Then | ||
| 755 | type a @kbd{Control-g} and see how the @samp{f} gives up. | ||
| 756 | @end format | ||
| 757 | |||
| 758 | The @key{TAB} and @kbd{M-@key{TAB}} key, which move between | ||
| 759 | subtopics in a menu can move between cross references as well. Once | ||
| 760 | the cursor is on a cross reference, you can press @key{RET} to follow | ||
| 761 | that reference, just like you do in a menu. | ||
| 762 | |||
| 763 | Clicking @kbd{Mouse-2} on or near a cross reference also follows the | 780 | Clicking @kbd{Mouse-2} on or near a cross reference also follows the |
| 764 | reference. You can see that the cross reference is mouse-sensitive by | 781 | reference. You can see that the cross reference is mouse-sensitive by |
| 765 | moving the mouse pointer to the reference and watching how the | 782 | moving the mouse pointer to the reference and watching how the |