Mercurial > hg > xemacs-beta

comparison man/info.texi @ 367:a4f53d9b3154 r21-1-13

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-1-13
author cvs
date Mon, 13 Aug 2007 11:01:07 +0200
parents 972bbb6d6ca2
children cc15677e0335
comparison
equal deleted inserted replaced
366:83d76f480a59 367:a4f53d9b3154
1 \input texinfo @c -*-texinfo-*- 1 \input texinfo @c -*-texinfo-*-
2 @comment %**start of header 2 @comment %**start of header
3 @setfilename ../info/info.info 3 @setfilename ../info/info.info
4 @settitle Info 1.0 4 @settitle Info 1.0
5 @comment %**end of header 5 @comment %**end of header
6 @comment $Id: info.texi,v 1.5 2000/07/15 00:44:53 vins Exp $ 6 @comment $Id: info.texi,v 1.7 2000/12/17 02:08:28 vins Exp $
7 7
8 @dircategory Texinfo documentation system 8 @dircategory Texinfo documentation system
9 @direntry 9 @direntry
10 * Info: (info). Documentation browsing system. 10 * Info: (info). Documentation browsing system.
11 @end direntry 11 @end direntry
120 small stand-alone program designed just to read Info files. 120 small stand-alone program designed just to read Info files.
121 121
122 @item 122 @item
123 Type @code{emacs} at the command line; then type @kbd{C-h i} (Control 123 Type @code{emacs} at the command line; then type @kbd{C-h i} (Control
124 @kbd{h}, followed by @kbd{i}). This approach uses the Info mode of the 124 @kbd{h}, followed by @kbd{i}). This approach uses the Info mode of the
125 Emacs program, an editor with many other capabilities. 125 XEmacs program, an editor with many other capabilities.
126 @end enumerate 126 @end enumerate
127 127
128 In either case, then type @kbd{mInfo} (just the letters), followed by 128 In either case, then type @kbd{mInfo} (just the letters), followed by
129 @key{RET}---the ``Return'' or ``Enter'' key. At this point, you should 129 @key{RET}---the ``Return'' or ``Enter'' key. At this point, you should
130 be ready to follow the instructions in this manual as you read them on 130 be ready to follow the instructions in this manual as you read them on
302 302
303 To move back to the beginning of the node you are on, you can type 303 To move back to the beginning of the node you are on, you can type
304 a lot of Deletes. You can also type simply @kbd{b} for beginning. 304 a lot of Deletes. You can also type simply @kbd{b} for beginning.
305 >> Try that now. (We have put in enough verbiage to push this past 305 >> Try that now. (We have put in enough verbiage to push this past
306 the first screenful, but screens are so big nowadays that perhaps it 306 the first screenful, but screens are so big nowadays that perhaps it
307 isn't enough. You may need to shrink your Emacs or Info window.) 307 isn't enough. You may need to shrink your XEmacs or Info window.)
308 Then come back, with Spaces. 308 Then come back, with Spaces.
309 309
310 If your screen is very tall, all of this node might fit at once. 310 If your screen is very tall, all of this node might fit at once.
311 In that case, "b" won't do anything. Sorry; what can we do? 311 In that case, "b" won't do anything. Sorry; what can we do?
312 312
606 Also tells what nodes look like. 606 Also tells what nodes look like.
607 * Menus:: How to add to or create menus in Info nodes. 607 * Menus:: How to add to or create menus in Info nodes.
608 * Cross-refs:: How to add cross-references to Info nodes. 608 * Cross-refs:: How to add cross-references to Info nodes.
609 * Tags:: How to make tag tables for Info files. 609 * Tags:: How to make tag tables for Info files.
610 * Checking:: Checking an Info File 610 * Checking:: Checking an Info File
611 * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. 611 * XEmacs Info Variables:: Variables modifying the behavior of XEmacs Info.
612 @end menu 612 @end menu
613 613
614 @node Expert, Add, , Advanced Info 614 @node Expert, Add, , Advanced Info
615 @comment node-name, next, previous, up 615 @comment node-name, next, previous, up
616 @section Advanced Info Commands 616 @section Advanced Info Commands
650 might like to use the commands @kbd{1}, @kbd{2}, @kbd{3}, @kbd{4}, ... 650 might like to use the commands @kbd{1}, @kbd{2}, @kbd{3}, @kbd{4}, ...
651 @kbd{9}. They are short for the @kbd{m} command together with an 651 @kbd{9}. They are short for the @kbd{m} command together with an
652 argument. @kbd{1} goes through the first item in the current node's 652 argument. @kbd{1} goes through the first item in the current node's
653 menu; @kbd{2} goes through the second item, etc. 653 menu; @kbd{2} goes through the second item, etc.
654 654
655 If you display supports multiple fonts, and you are using Emacs' Info 655 If you display supports multiple fonts, and you are using XEmacs' Info
656 mode to read Info files, the @samp{*} for the fifth menu item is 656 mode to read Info files, the @samp{*} for the fifth menu item is
657 underlines, and so is the @samp{*} for the ninth item; these underlines 657 underlines, and so is the @samp{*} for the ninth item; these underlines
658 make it easy to see at a glance which number to use for an item. 658 make it easy to see at a glance which number to use for an item.
659 659
660 On ordinary terminals, you won't have underlining. If you need to 660 On ordinary terminals, you won't have underlining. If you need to
661 actually count items, it is better to use @kbd{m} instead, and specify 661 actually count items, it is better to use @kbd{m} instead, and specify
662 the name. 662 the name.
663 663
664 The Info command @kbd{e} changes from Info mode to an ordinary 664 The Info command @kbd{e} changes from Info mode to an ordinary
665 Emacs editing mode, so that you can edit the text of the current node. 665 XEmacs editing mode, so that you can edit the text of the current node.
666 Type @kbd{C-c C-c} to switch back to Info. The @kbd{e} command is allowed 666 Type @kbd{C-c C-c} to switch back to Info. The @kbd{e} command is allowed
667 only if the variable @code{Info-enable-edit} is non-@code{nil}. 667 only if the variable @code{Info-enable-edit} is non-@code{nil}.
668 668
669 @node Add, Menus, Expert, Advanced Info 669 @node Add, Menus, Expert, Advanced Info
670 @comment node-name, next, previous, up 670 @comment node-name, next, previous, up
817 You can speed up the access to nodes of a large Info file by giving 817 You can speed up the access to nodes of a large Info file by giving
818 it a tag table. Unlike the tag table for a program, the tag table for 818 it a tag table. Unlike the tag table for a program, the tag table for
819 an Info file lives inside the file itself and is used 819 an Info file lives inside the file itself and is used
820 automatically whenever Info reads in the file. 820 automatically whenever Info reads in the file.
821 821
822 To make a tag table, go to a node in the file using Emacs Info mode and type 822 To make a tag table, go to a node in the file using XEmacs Info mode and type
823 @kbd{M-x Info-tagify}. Then you must use @kbd{C-x C-s} to save the 823 @kbd{M-x Info-tagify}. Then you must use @kbd{C-x C-s} to save the
824 file. 824 file.
825 825
826 Once the Info file has a tag table, you must make certain it is up 826 Once the Info file has a tag table, you must make certain it is up
827 to date. If, as a result of deletion of text, any node moves back 827 to date. If, as a result of deletion of text, any node moves back
845 Note that it contains one line per node, and this line contains 845 Note that it contains one line per node, and this line contains
846 the beginning of the node's header (ending just after the node name), 846 the beginning of the node's header (ending just after the node name),
847 a Delete character, and the character position in the file of the 847 a Delete character, and the character position in the file of the
848 beginning of the node. 848 beginning of the node.
849 849
850 @node Checking, Emacs Info Variables, Tags, Advanced Info 850 @node Checking, XEmacs Info Variables, Tags, Advanced Info
851 @comment node-name, next, previous, up 851 @comment node-name, next, previous, up
852 @section Checking an Info File 852 @section Checking an Info File
853 853
854 When creating an Info file, it is easy to forget the name of a node 854 When creating an Info file, it is easy to forget the name of a node
855 when you are making a pointer to it from another node. If you put in 855 when you are making a pointer to it from another node. If you put in
862 reported. Only pointers within the file are checked, because checking 862 reported. Only pointers within the file are checked, because checking
863 pointers to other files would be terribly slow. But those are usually 863 pointers to other files would be terribly slow. But those are usually
864 few. 864 few.
865 865
866 To check an Info file, do @kbd{M-x Info-validate} while looking at 866 To check an Info file, do @kbd{M-x Info-validate} while looking at
867 any node of the file with Emacs Info mode. 867 any node of the file with XEmacs Info mode.
868 868
869 @node Emacs Info Variables, , Checking, Advanced Info 869 @node XEmacs Info Variables, , Checking, Advanced Info
870 @section Emacs Info-mode Variables 870 @section XEmacs Info-mode Variables
871 871
872 The following variables may modify the behaviour of Info-mode in Emacs; 872 The following variables may modify the behaviour of Info-mode in XEmacs;
873 you may wish to set one or several of these variables interactively, or 873 you may wish to set one or several of these variables interactively, or
874 in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting 874 in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting
875 Variables, Examining and Setting Variables, emacs, The GNU Emacs 875 Variables, Examining and Setting Variables, xemacs, The XEmacs
876 Manual}. 876 Manual}.
877 877
878 @vtable @code 878 @vtable @code
879 @item Info-enable-edit 879 @item Info-enable-edit
880 Set to @code{nil}, disables the @samp{e} (@code{Info-edit}) command. A 880 Set to @code{nil}, disables the @samp{e} (@code{Info-edit}) command. A
898 @comment node-name, next, previous, up 898 @comment node-name, next, previous, up
899 @chapter Creating an Info File from a Makeinfo file 899 @chapter Creating an Info File from a Makeinfo file
900 900
901 @code{makeinfo} is a utility that converts a Texinfo file into an Info 901 @code{makeinfo} is a utility that converts a Texinfo file into an Info
902 file; @code{texinfo-format-region} and @code{texinfo-format-buffer} are 902 file; @code{texinfo-format-region} and @code{texinfo-format-buffer} are
903 GNU Emacs functions that do the same. 903 XEmacs functions that do the same.
904 904
905 @xref{Create an Info File, , Creating an Info File, texinfo, the Texinfo 905 @xref{Create an Info File, , Creating an Info File, texinfo, the Texinfo
906 Manual}, to learn how to create an Info file from a Texinfo file. 906 Manual}, to learn how to create an Info file from a Texinfo file.
907 907
908 @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU Documentation 908 @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU Documentation