Mercurial > emacs
comparison man/info.texi @ 37392:18abdfdd5585
Fix markup of control characters.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Wed, 18 Apr 2001 18:44:01 +0000 |
parents | f3e3f00c30fc |
children | 7615043715cd |
comparison
equal
deleted
inserted
replaced
37391:a8cdf6a9bab1 | 37392:18abdfdd5585 |
---|---|
4 @settitle Info | 4 @settitle Info |
5 @syncodeindex fn cp | 5 @syncodeindex fn cp |
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.10 2001/04/15 08:43:53 eliz Exp $ | 9 @comment $Id: info.texi,v 1.11 2001/04/17 12:13:47 eliz Exp $ |
10 | 10 |
11 @dircategory Texinfo documentation system | 11 @dircategory Texinfo documentation system |
12 @direntry | 12 @direntry |
13 * Info: (info). Documentation browsing system. | 13 * Info: (info). Documentation browsing system. |
14 @end direntry | 14 @end direntry |
402 | 402 |
403 @kindex ? @r{(Info mode)} | 403 @kindex ? @r{(Info mode)} |
404 @findex Info-summary | 404 @findex Info-summary |
405 You have just learned a considerable number of commands. If you | 405 You have just learned a considerable number of commands. If you |
406 want to use one but have trouble remembering which, you should type | 406 want to use one but have trouble remembering which, you should type |
407 a @key{?} (in Emacs it runs the @code{Info-summary} command) which | 407 a @kbd{?} (in Emacs it runs the @code{Info-summary} command) which |
408 prints out a brief list of commands. When you are finished looking at | 408 prints out a brief list of commands. When you are finished looking at |
409 the list, make it go away by typing a @key{SPC} repeatedly. | 409 the list, make it go away by typing a @key{SPC} repeatedly. |
410 | 410 |
411 @format | 411 @format |
412 >> 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 |
1011 this has the advantage that you can also make a printed manual from | 1011 this has the advantage that you can also make a printed manual from |
1012 them. However, if you want to edit an Info file, here is how. | 1012 them. However, if you want to edit an Info file, here is how. |
1013 | 1013 |
1014 @cindex node delimiters | 1014 @cindex node delimiters |
1015 The new node can live in an existing documentation file, or in a new | 1015 The new node can live in an existing documentation file, or in a new |
1016 one. It must have a @key{^_} character before it (invisible to the | 1016 one. It must have a @samp{^_} character before it (invisible to the |
1017 user; this node has one but you cannot see it), and it ends with either | 1017 user; this node has one but you cannot see it), and it ends with either |
1018 a @key{^_}, a @key{^L}, or the end of file.@footnote{If you put in a | 1018 a @samp{^_}, a @samp{^L} (``formfeed''), or the end of file.@footnote{If |
1019 @key{^L} to end a new node, be sure that there is a @key{^_} after it | 1019 you put in a @samp{^L} to end a new node, be sure that there is a |
1020 to start the next one, since @key{^L} cannot @emph{start} a node. | 1020 @samp{^_} after it to start the next one, since @samp{^L} cannot |
1021 Also, a nicer way to make a node boundary be a page boundary as well | 1021 @emph{start} a node. Also, a nicer way to make a node boundary be a |
1022 is to put a @key{^L} @emph{right after} the @key{^_}.} | 1022 page boundary as well is to put a @samp{^L} @emph{right after} the |
1023 | 1023 @samp{^_}.} |
1024 The @key{^_} starting a node must be followed by a newline or a | 1024 |
1025 @key{^L} newline, after which comes the node's header line. The header | 1025 The @samp{^_} starting a node must be followed by a newline or a |
1026 @samp{^L} newline, after which comes the node's header line. The header | |
1026 line must give the node's name (by which Info finds it), and state the | 1027 line must give the node's name (by which Info finds it), and state the |
1027 names of the @samp{Next}, @samp{Previous}, and @samp{Up} nodes (if there | 1028 names of the @samp{Next}, @samp{Previous}, and @samp{Up} nodes (if there |
1028 are any). As you can see, this node's @samp{Up} node is the node | 1029 are any). As you can see, this node's @samp{Up} node is the node |
1029 @samp{Top}, which points at all the documentation for Info. The | 1030 @samp{Top}, which points at all the documentation for Info. The |
1030 @samp{Next} node is @samp{Menus}. | 1031 @samp{Next} node is @samp{Menus}. |
1189 @end example | 1190 @end example |
1190 | 1191 |
1191 @noindent | 1192 @noindent |
1192 Note that it contains one line per node, and this line contains | 1193 Note that it contains one line per node, and this line contains |
1193 the beginning of the node's header (ending just after the node name), | 1194 the beginning of the node's header (ending just after the node name), |
1194 a @key{DEL} character, and the character position in the file of the | 1195 a @samp{DEL} character, and the character position in the file of the |
1195 beginning of the node. | 1196 beginning of the node. |
1196 | 1197 |
1197 | 1198 |
1198 @node Checking, Emacs Info Variables, Tags, Advanced Info | 1199 @node Checking, Emacs Info Variables, Tags, Advanced Info |
1199 @section Checking an Info File | 1200 @section Checking an Info File |
1265 | 1266 |
1266 @item Info-enable-active-nodes | 1267 @item Info-enable-active-nodes |
1267 When set to a non-@code{nil} value, allows Info to execute Lisp code | 1268 When set to a non-@code{nil} value, allows Info to execute Lisp code |
1268 associated with nodes. The Lisp code is executed when the node is | 1269 associated with nodes. The Lisp code is executed when the node is |
1269 selected. The Lisp code to be executed should follow the node | 1270 selected. The Lisp code to be executed should follow the node |
1270 delimiter (the @key{DEL} character) and an @samp{execute: } tag, like | 1271 delimiter (the @samp{DEL} character) and an @samp{execute: } tag, like |
1271 this: | 1272 this: |
1272 | 1273 |
1273 @example | 1274 @example |
1274 ^_execute: (message "This is an active node!") | 1275 ^_execute: (message "This is an active node!") |
1275 @end example | 1276 @end example |