Mercurial > hg > xemacs-beta
diff man/info.texi @ 175:2d532a89d707 r20-3b14
Import from CVS: tag r20-3b14
author | cvs |
---|---|
date | Mon, 13 Aug 2007 09:50:14 +0200 |
parents | cca96a509cfe |
children | 70ad99077275 |
line wrap: on
line diff
--- a/man/info.texi Mon Aug 13 09:49:11 2007 +0200 +++ b/man/info.texi Mon Aug 13 09:50:14 2007 +0200 @@ -1,18 +1,20 @@ \input texinfo @c -*-texinfo-*- @comment %**start of header -@setfilename ../info/info.info +@setfilename info.info @settitle Info 1.0 @comment %**end of header +@comment $Id: info.texi,v 1.3 1997/07/19 22:11:48 steve Exp $ -@iftex -@finalout -@end iftex +@dircategory Texinfo documentation system +@direntry +* Info: (info). Documentation browsing system. +@end direntry @ifinfo This file describes how to use Info, the on-line, menu-driven GNU documentation system. -Copyright (C) 1989, 1992 Free Software Foundation, Inc. +Copyright (C) 1989, 92, 96, 97 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -36,25 +38,19 @@ by the Free Software Foundation. @end ifinfo -@setchapternewpage odd @titlepage -@sp 11 -@center @titlefont{Info} -@sp 2 -@center The -@sp 2 -@center On-line, Menu-driven -@sp 2 -@center GNU Documentation System - +@title Info +@subtitle The online, menu-driven GNU documentation system +@author Brian Fox @page @vskip 0pt plus 1filll -Copyright @copyright{} 1989, 1992, 1993 Free Software Foundation, Inc. +Copyright @copyright{} 1989, 1992, 1993, 1996, 1997 Free Software +Foundation, Inc. @sp 2 Published by the Free Software Foundation @* -675 Massachusetts Avenue, @* -Cambridge, MA 02139 USA @* +59 Temple Place - Suite 330 @* +Boston, MA 02111-1307, USA. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -71,23 +67,21 @@ by the Free Software Foundation. @end titlepage -@paragraphindent 3 @ifinfo -@node Top, Getting Started, (dir), (dir) +@node Top, Getting Started, , (dir) @top Info: An Introduction Info is a program for reading documentation, which you are using now. To learn how to use Info, type the command @kbd{h}. It brings you -to a programmed instruction sequence. If at any time you are ready to -stop using Info, type @samp{q}. +to a programmed instruction sequence. @c Need to make sure that `Info-help' goes to the right node, @c which is the first node of the first chapter. (It should.) @c (Info-find-node "info" -@c (if (< (window-height) 23) -@c "Help-Small-Screen" -@c "Help"))) +@c (if (< (window-height) 23) +@c "Help-Small-Screen" +@c "Help"))) To learn advanced Info commands, type @kbd{n} twice. This brings you to @cite{Info for Experts}, skipping over the `Getting Started' chapter. @@ -97,6 +91,7 @@ * Getting Started:: Getting started using an Info reader. * Advanced Info:: Advanced commands within Info. * Create an Info File:: How to make your own Info file. +* The Standalone Info Program: (info-stnd.info). @end menu @node Getting Started, Advanced Info, Top, Top @@ -122,7 +117,7 @@ @enumerate @item Type @code{info} at your shell's command line. This approach uses a -stand-alone program designed just to read Info files. +small stand-alone program designed just to read Info files. @item Type @code{emacs} at the command line; then type @kbd{C-h i} (Control @@ -144,11 +139,10 @@ * Help-Small-Screen:: Starting Info on a Small Screen * Help:: How to use Info * Help-P:: Returning to the Previous node -* Help-C-l:: The Space, Rubout, B and C-l commands. +* Help-^L:: The Space, Rubout, B and ^L commands. * Help-M:: Menus * Help-Adv:: Some advanced Info commands * Help-Q:: Quitting Info -* Using Stand-alone Info:: How to use the stand-alone Info reader. @end menu @node Help-Small-Screen, Help, , Getting Started @@ -168,54 +162,54 @@ screen. If you see @samp{--Top----} instead, it means that there is more text below that does not fit. To move forward through the text and see another screen full, press the Space bar, @key{SPC}. To move -back up, press the key labeled @samp{Delete} or @key{DEL}. +back up, press the key labeled @samp{Backspace} or @key{Delete}. @ifinfo Here are 40 lines of junk, so you can try Spaces and Deletes and see what they do. At the end are instructions of what you should do next. -@format -This is line 17 -This is line 18 -This is line 19 -This is line 20 -This is line 21 -This is line 22 -This is line 23 -This is line 24 -This is line 25 -This is line 26 -This is line 27 -This is line 28 -This is line 29 -This is line 30 -This is line 31 -This is line 32 -This is line 33 -This is line 34 -This is line 35 -This is line 36 -This is line 37 -This is line 38 -This is line 39 -This is line 40 -This is line 41 -This is line 42 -This is line 43 -This is line 44 -This is line 45 -This is line 46 -This is line 47 -This is line 48 -This is line 49 -This is line 50 -This is line 51 -This is line 52 -This is line 53 -This is line 54 -This is line 55 -This is line 56 -@end format + +This is line 17 @* +This is line 18 @* +This is line 19 @* +This is line 20 @* +This is line 21 @* +This is line 22 @* +This is line 23 @* +This is line 24 @* +This is line 25 @* +This is line 26 @* +This is line 27 @* +This is line 28 @* +This is line 29 @* +This is line 30 @* +This is line 31 @* +This is line 32 @* +This is line 33 @* +This is line 34 @* +This is line 35 @* +This is line 36 @* +This is line 37 @* +This is line 38 @* +This is line 39 @* +This is line 40 @* +This is line 41 @* +This is line 42 @* +This is line 43 @* +This is line 44 @* +This is line 45 @* +This is line 46 @* +This is line 47 @* +This is line 48 @* +This is line 49 @* +This is line 50 @* +This is line 51 @* +This is line 52 @* +This is line 53 @* +This is line 54 @* +This is line 55 @* +This is line 56 @* + If you have managed to get here, go back to the beginning with Delete, and come back here again, then you understand Space and Delete. So now type an @kbd{n} ---just one character; don't type @@ -244,42 +238,36 @@ Now it is time to move on to the @samp{Next} node, named @samp{Help-P}. -@format >> Type @samp{n} to move there. Type just one character; do not type the quotes and do not type a @key{RET} afterward. -@end format @samp{>>} in the margin means it is really time to try a command. -@node Help-P, Help-C-l, Help, Getting Started +@node Help-P, Help-^L, Help, Getting Started @comment node-name, next, previous, up @section Returning to the Previous node 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-C-l}. +node, @samp{Help-^L}. -@format >> But do not do that yet. First, try the @kbd{p} command, which takes you to the @samp{Previous} node. When you get there, you can do an @kbd{n} again to return here. -@end format 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. -@format ->> Now do an @kbd{n} to get to the node @samp{Help-C-l} and learn more. -@end format +>> Now do an @kbd{n} to get to the node @samp{Help-^L} and learn more. -@node Help-C-l, Help-M, Help-P, Getting Started +@node Help-^L, Help-M, Help-P, Getting Started @comment node-name, next, previous, up -@section The Space, Delete, B and C-l commands. +@section The Space, Delete, B and ^L commands. - This node's header tells you that you are now at node @samp{Help-C-l}, and + This node's header tells you that you are now at node @samp{Help-^L}, and that @kbd{p} would get you back to @samp{Help-P}. The node's title is underlined; it says what the node is about (most nodes have titles). @@ -294,9 +282,7 @@ Delete 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). -@format >> Now try typing a Space (afterward, type a Delete to return here). -@end format When you type the space, the two lines that were at the bottom of the screen appear at the top, followed by more lines. Delete takes @@ -312,43 +298,35 @@ again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down ``Control'' and type an @key{L} or @kbd{l}). -@format >> Type @kbd{C-l} now. -@end format To move back to the beginning of the node you are on, you can type a lot of Deletes. You can also type simply @kbd{b} for beginning. -@format >> Try that now. (We have put in enough verbiage to push this past the first screenful, but screens are so big nowadays that perhaps it isn't enough. You may need to shrink your Emacs or Info window.) Then come back, with Spaces. -@end format -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 that case, "b" won't do anything. Sorry; what can we do? You have just learned a considerable number of commands. If you want to use one but have trouble remembering which, you should type a @key{?} which prints out a brief list of commands. When you are -finished looking at the list, make it go away by typing a @key{SPC}. +finished looking at the list, make it go away by pressing @key{SPC} +repeatedly. -@format ->> Type a @key{?} now. After it finishes, type a @key{SPC}. -@end format - - (If you are using the standalone Info reader, type `l' to return here.) +>> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of +>> the list until finished. From now on, you will encounter large nodes without warning, and will be expected to know how to use Space and Delete to move around in them without being told. Since not all terminals have the same size screen, it would be impossible to warn you anyway. -@format >> Now type @kbd{n} to see the description of the @kbd{m} command. -@end format -@node Help-M, Help-Adv, Help-C-l, Getting Started +@node Help-M, Help-Adv, Help-^L, Getting Started @comment node-name, next, previous, up @section Menus @@ -400,13 +378,11 @@ This means that the subtopic name and node name are the same; they are both @samp{Foo}. -@format >> Now use Spaces to find the menu in this node, then come back to the front with a @kbd{b} and some Spaces. As you see, a menu is actually visible in its node. If you cannot find a menu in a node by looking at it, then the node does not have a menu and the @kbd{m} command is not available. -@end format 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 must understand the @@ -453,7 +429,7 @@ Here is a menu to give you a chance to practice. -* Menu: The menu starts here. +* Menu: The menu starts here. This menu gives you three ways of going to one place, Help-FOO. @@ -462,38 +438,30 @@ * Help-FOO:: And yet another!@* -@format >> Now type just an @kbd{m} and see what happens: -@end format Now you are ``inside'' an @kbd{m} command. Commands cannot be used now; the next thing you will type must be the name of a subtopic. You can change your mind about doing the @kbd{m} by typing Control-g. -@format >> Try that now; notice the bottom line clear. >> Then type another @kbd{m}. >> Now type @samp{BAR} item name. Do not type Return yet. -@end format While you are typing the item name, you can use the Delete key to cancel one character at a time if you make a mistake. -@format >> Type one to cancel the @samp{R}. You could type another @samp{R} to replace it. You do not have to, since @samp{BA} is a valid abbreviation. >> Now you are ready to go. Type a @key{RET}. -@end format After visiting Help-FOO, you should return here. -@format >> Type @kbd{n} to see more commands. -@end format @c If a menu appears at the end of this node, remove it. @c It is an accident of the menu updating command. @@ -522,9 +490,7 @@ node---to get back to where you were reading you have to type some @key{SPC}s. -@format >> Now type @kbd{u} to move back up to @samp{Help-M}. -@end format @node Help-Adv, Help-Q, Help-M, Getting Started @comment node-name, next, previous, up @@ -544,10 +510,8 @@ @kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo the @kbd{m} and get you back to @samp{Help-M}. -@format >> Try typing three @kbd{l}'s, pausing in between to see what each @kbd{l} does. -@end format Then follow directions again and you will end up back here. @@ -561,10 +525,8 @@ has a menu which leads (directly, or indirectly through other menus), to all the nodes that exist. -@format >> Try doing a @samp{d}, then do an @kbd{l} to return here (yes, @emph{do} return). -@end format Sometimes, in Info documentation, you will see a cross reference. Cross references look like this: @xref{Help-Cross, Cross}. That is a @@ -580,9 +542,7 @@ Completion is available in the @samp{f} command; you can complete among all the cross reference names in the current node by typing a Tab. -@format >> Type @samp{f}, followed by @samp{Cross}, and a @key{RET}. -@end format To get a list of all the cross references in the current node, you can type @kbd{?} after an @samp{f}. The @samp{f} continues to await a @@ -590,12 +550,10 @@ actually want to follow a reference, you should type a @kbd{Control-g} to cancel the @samp{f}. -@format >> Type "f?" to get a list of the cross references in this node. Then type a @kbd{Control-g} and see how the @samp{f} gives up. >> Now type @kbd{n} to see the last node of the course. -@end format @c If a menu appears at the end of this node, remove it. @c It is an accident of the menu updating command. @@ -613,9 +571,7 @@ where you came from. In general, the @kbd{l} (el) command is the only way to get back there. -@format >> Type @kbd{l} to return to the node where the cross reference was. -@end format @node Help-Q, , Help-Adv, Getting Started @comment node-name, next, previous, up @@ -630,11 +586,9 @@ Info. Finding them will be a good exercise in using Info in the usual manner. -@format >> Type @samp{d} to go to the Info directory node; then type @samp{mInfo} and Return, to get to the node about Info and see what other help is available. -@end format @node Advanced Info, Create an Info File, Getting Started, Top @comment node-name, next, previous, up @@ -732,14 +686,14 @@ The new node can live in an existing documentation file, or in a new one. It must have a @key{^_} character before it (invisible to the user; this node has one but you cannot see it), and it ends with either -a @key{^_}, a @key{C-l}, or the end of file. Note: If you put in a -@key{C-l} to end a new node, be sure that there is a @key{^_} after it -to start the next one, since @key{C-l} cannot @emph{start} a node. +a @key{^_}, a @key{^L}, or the end of file. Note: If you put in a +@key{^L} to end a new node, be sure that there is a @key{^_} after it +to start the next one, since @key{^L} cannot @emph{start} a node. Also, a nicer way to make a node boundary be a page boundary as well -is to put a @key{C-l} @emph{right after} the @key{^_}. +is to put a @key{^L} @emph{right after} the @key{^_}. The @key{^_} starting a node must be followed by a newline or a -@key{C-l} newline, after which comes the node's header line. The +@key{^L} newline, after which comes the node's header line. The header line must give the node's name (by which Info finds it), and state the names of the @samp{Next}, @samp{Previous}, and @samp{Up} nodes (if there are any). As you can see, this node's @samp{Up} node is the node @@ -921,7 +875,7 @@ Variables, Examining and Setting Variables, emacs, The GNU Emacs Manual}. -@table @code +@vtable @code @item Info-enable-edit Set to @code{nil}, disables the @samp{e} (@code{Info-edit}) command. A non-@code{nil} value enables it. @xref{Add, Edit}. @@ -932,16 +886,13 @@ selected. @item Info-directory-list -The list of directories to search for Info files. This variable is set -on startup automatically either from the @code{INFOPATH} environment -variable (if it exists) or, else, @code{Info-default-directory-list}. -Any user settings of this variable will be ignored. +The list of directories to search for Info files. Each element is a +string (directory name) or @code{nil} (try default directory). -@item Info-default-directory-list -List of default directories to search for Info documentation files. -This value is used as the default for @code{Info-directory-list} in the -absence of a setting for the @code{INFOPATH} environment variable. -@end table +@item Info-directory +The standard directory for Info documentation files. Only used when the +function @code{Info-directory} is called. +@end vtable @node Create an Info File, , Advanced Info, Top @comment node-name, next, previous, up @@ -957,11 +908,4 @@ @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format}, to learn how to write a Texinfo file. -@nwnode Using Stand-alone Info, Options, , Top -@chapter Using the Stand-alone Info Reader -@lowersections -@c Make the paragraph indentation match the rest of this file. -@paragraphindent 2 -@include info-stnd.texi -@raisesections @bye