![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to texinfo-4 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [CSRG BSD Unix] / 43BSDReno / contrib / emacs-18.55 / info|
Return to texinfo-4 CVS log | Up to [CSRG BSD Unix] / 43BSDReno / contrib / emacs-18.55 / info |
1.1 ! root 1: Info file ../info/texinfo, produced by Makeinfo, -*- Text -*- from ! 2: input file texinfo.texinfo. ! 3: ! 4: This file documents Texinfo, a documentation system that uses a ! 5: single source file to produce both on-line help and a printed manual. ! 6: ! 7: This is edition 1.1 of the Texinfo documentation, and is for the ! 8: Texinfo that is distributed as part of Version 18 of GNU Emacs. ! 9: ! 10: Copyright (C) 1988 Free Software Foundation, Inc. ! 11: ! 12: Permission is granted to make and distribute verbatim copies of this ! 13: manual provided the copyright notice and this permission notice are ! 14: preserved on all copies. ! 15: ! 16: Permission is granted to copy and distribute modified versions of ! 17: this manual under the conditions for verbatim copying, provided that ! 18: the entire resulting derived work is distributed under the terms of a ! 19: permission notice identical to this one. ! 20: ! 21: Permission is granted to copy and distribute translations of this ! 22: manual into another language, under the above conditions for modified ! 23: versions, except that this permission notice may be stated in a ! 24: translation approved by the Foundation. ! 25: ! 26: ! 27: ! 28: File: texinfo, Node: Using texinfo-show-structure, Next: Running Info-Validate, Prev: Debugging with Tex, Up: Catching Mistakes ! 29: ! 30: Using `texinfo-show-structure' ! 31: ============================== ! 32: ! 33: It is not always easy to keep track of the nodes, chapters, sections ! 34: and subsections of a Texinfo file. This is especially true if you ! 35: are revising or adding to a Texinfo file that someone else has written. ! 36: ! 37: In GNU Emacs, in Texinfo mode, there is a command that will list all ! 38: the lines that begin with the @-commands that specify the structure: ! 39: @node, @chapter, @section, @appendix and so on. This is the ! 40: `texinfo-show-structure' command. It is bound to the keyboard ! 41: command `C-c C-s'. `texinfo-show-structure' displays the lines that ! 42: begin with the node and chapter structuring @-commands in another ! 43: window called the `*Occur*' buffer. For example, when ! 44: `texinfo-show-structure' is run on the first part of this chapter, it ! 45: produces the following: ! 46: ! 47: Lines matching ! 48: "^@\\(chapter\\|unnum\\|appendix\\|sect\\|sub\\|heading\\|major ! 49: \\|node\\)" in buffer new-texinfo-manual.texinfo. ! 50: 2:@node catching mistakes, @-Command Syntax, running info, top ! 51: 4:@chapter Catching Mistakes ! 52: 41:@node debugging with info, debugging with tex, , catching mistakes ! 53: 43:@section Catching errors with Info Formatting ! 54: ! 55: This means that lines 2, 4, 41 and 43 began with `@node', `@chapter', ! 56: `@node', and `@section' respectively. If you move your cursor into ! 57: the `*Occur*' window, you can position the cursor over one of the ! 58: lines and use the `C-c C-c' command (`occur-mode-goto-occurrence'), ! 59: to jump to the corresponding spot in the Texinfo file. *Note : ! 60: (emacs)Other Repeating Search, for more information about ! 61: `occur-mode-goto-occurrence'. ! 62: ! 63: The first line in the `*Occur*' window describes the "regular ! 64: expression" specified by TEXINFO-HEADING-PATTERN. This regular ! 65: expression is the pattern that `texinfo-show-structure' looks for. ! 66: *Note : (emacs)Regexps, for more information. ! 67: ! 68: When you give the `texinfo-show-structure' command, it will show the ! 69: structure of the whole buffer. If you want to see the structure of ! 70: just a part of the buffer, of one chapter, for example, use the `C-x ! 71: n' (`narrow-to-region') command to mark the region. (*Note : ! 72: (emacs)Narrowing.) This is how the example used above was generated. ! 73: (To see the whole buffer again, use `C-x w' (`widen').) ! 74: ! 75: You can remind yourself of the structure of a Texinfo file by looking ! 76: at the list in the `*Occur*' window; and if you have mis-named a node ! 77: or left out a section, you can correct the mistake. ! 78: ! 79: * Menu: ! 80: ! 81: * Using Occur:: ! 82: ! 83: ! 84: ! 85: File: texinfo, Node: Using Occur, Prev: Using texinfo-show-structure, Up: Using texinfo-show-structure ! 86: ! 87: Using `occur' ! 88: ------------- ! 89: ! 90: Sometimes the `texinfo-show-structure' command produces too much ! 91: information. Perhaps you want to remind yourself of the overall ! 92: structure of a Texinfo file, and are overwhelmed by the detailed list ! 93: produced by `texinfo-show-structure'. In this case, you can use the ! 94: `occur' command itself. To do this, type ! 95: ! 96: `M-x occur' ! 97: ! 98: and then, when prompted, type a "regexp", a regular expression for ! 99: the pattern you want to match. (*Note : (emacs)Regexps.) `occur' ! 100: works from the current location of the cursor in the buffer to the ! 101: end of the buffer. If you want to run `occur' on the whole buffer, ! 102: place the cursor at the beginning of the buffer. For example, to see ! 103: all the lines that contain the word `@chapter' in them, just type ! 104: `@chapter'. This will produce a list of the chapters. It will also ! 105: list all the sentences with `@chapter' in the middle of the line. If ! 106: you want to see only those lines that start with the word `@chapter', ! 107: type `^@chapter' when prompted by `occur'. If you want to see all ! 108: the lines that end with a word or phrase, end the last word with a ! 109: `$'; for example, `catching mistakes$'. This can be helpful when you ! 110: want to see all the nodes that are part of the same chapter or ! 111: section and therefore have the same `Up' pointer. ! 112: ! 113: *Note : (emacs)Other Repeating Search, for more information. ! 114: ! 115: ! 116: ! 117: File: texinfo, Node: Running Info-Validate, Prev: Using texinfo-show-structure, Up: Catching Mistakes ! 118: ! 119: Finding Badly Referenced Nodes ! 120: ============================== ! 121: ! 122: You can check whether any of the `Next', `Previous', `Up' or other ! 123: node pointers fail to point to a node with the `Info-validate' command. ! 124: This command checks that every node pointer points to an existing node. ! 125: ! 126: To use this command, you first need to load the `info' library and ! 127: then do `M-x Info-validate'. ! 128: ! 129: `M-x load-library RET info RET' ! 130: `M-x Info-validate' ! 131: ! 132: (Note that all the `Info' commands require an uppercase `I'.) ! 133: ! 134: If your file is ok, you will receive a message that says ``File ! 135: appears valid''. However, if you have a pointer that does not point ! 136: to a node, error messages will be displayed in a buffer called ! 137: `*problems in info file*'. ! 138: ! 139: For example, `Info-validate' was run on a test file that contained ! 140: only the first node of this manual. One of the messages said: ! 141: ! 142: In node "Overview", invalid Next: Texinfo Mode ! 143: ! 144: This meant that the node called `Overview' had a `Next' pointer that ! 145: did not point to anything (which was true in this case, since the ! 146: test file had only one node in it). ! 147: ! 148: Now suppose we add a node named `Texinfo Mode' to our test case but ! 149: we don't specify a `Previous' for this node. Then we will get the ! 150: following error message: ! 151: ! 152: In node "Texinfo Mode", should have Previous: Overview ! 153: ! 154: This is because every `Next' pointer should be matched by a ! 155: `Previous' (in the node where the `Next' points) which points back. ! 156: ! 157: `Info-validate' also checks that all menu items and cross-references ! 158: point to actual nodes. ! 159: ! 160: Significantly, `Info-validate' does not work with large files that ! 161: have been split. (Info thinks of a large file as being over 100,000 ! 162: bytes, approximately.) In order to use `Info-validate' on a large ! 163: file, you must run `texinfo-format-buffer' with an argument so that ! 164: it does not split the Info file, and then create a tag table. ! 165: ! 166: * Menu: ! 167: ! 168: * Info-Validating a Large File:: Running `Info-validate' on a large file. ! 169: * Splitting:: Splitting a file manually. ! 170: ! 171: ! 172: ! 173: File: texinfo, Node: Info-Validating a Large File, Next: Splitting, Prev: Running Info-Validate, Up: Running Info-Validate ! 174: ! 175: Running `Info-validate' on a Large File. ! 176: ---------------------------------------- ! 177: ! 178: You can run `Info-validate' only on a single Info file. The command ! 179: will not work on indirect subfiles that are generated when the master ! 180: file is split. If you have a large file (longer than 100,000 bytes), ! 181: you need to run the `texinfo-format-buffer' command in such a way ! 182: that it does not create indirect subfiles. You will also need to ! 183: create a tag table. When you have done this, you can run ! 184: `Info-validate' and look for badly referenced nodes. ! 185: ! 186: After you have validated the node structure, you can rerun ! 187: `texinfo-format-buffer' in the normal way so it will construct the ! 188: tag table and split the file automatically or, you can make the tag ! 189: table and split the file manually. ! 190: ! 191: To prevent the `texinfo-format-buffer' command from splitting a ! 192: Texinfo file into smaller Info files, give a prefix to the `M-x ! 193: texinfo-format-buffer' command: ! 194: ! 195: C-u M-x texinfo-format-buffer ! 196: ! 197: When you do this, Texinfo will not split the file and will not create ! 198: a tag table for it. ! 199: ! 200: Before you can run `M-x Info-validate' on the Info file, you need to ! 201: create a tag table for it. In order to do this, you first need to ! 202: load the `info' library into Emacs with the following command: ! 203: ! 204: M-x load-library RET info RET ! 205: ! 206: Then you can give the command: ! 207: ! 208: M-x Info-tagify ! 209: ! 210: This creates a file which you can validate. ! 211: ! 212: M-x Info-validate ! 213: ! 214: After you have checked the validity of the nodes, you can either run ! 215: `M-x texinfo-format-buffer' as you would normally, or else tagify and ! 216: split the file manually with the two commands `Info-tagify' and ! 217: `Info-split'. ! 218: ! 219: ! 220: ! 221: File: texinfo, Node: Splitting, Prev: Info-Validating a Large File, Up: Running Info-Validate ! 222: ! 223: Splitting a File Manually ! 224: ------------------------- ! 225: ! 226: If the file has more than 100,000 or so bytes in it, you should split ! 227: it or else let the `texinfo-format-buffer' command do it for you ! 228: automatically. (Generally you will let `texinfo-format-buffer' do ! 229: this job for you. *Note Creating an Info File::.) ! 230: ! 231: The split off files are called the indirect subfiles. ! 232: ! 233: Info files are split to save memory. With smaller files, Emacs does ! 234: not have make such a large buffer to hold the information. This way, ! 235: Emacs can save memory. ! 236: ! 237: If the Info file has more than 30 nodes, you should also make a tag ! 238: table for it. *Note Info-Validating a Large File::, for information ! 239: about creating a tag table. ! 240: ! 241: Before running `Info-split', you need to load the `info' library into ! 242: Emacs by giving the command `M-x load-library RET info RET'. After ! 243: you have done this, you can give the two commands: ! 244: ! 245: M-x Info-tagify ! 246: M-x Info-split ! 247: ! 248: (Note that the `I' in `Info' is uppercase.) ! 249: ! 250: When you use the `Info-split' command, the buffer is modified into a ! 251: (small) Info file which lists the indirect subfiles. This file ! 252: should be saved in place of the original visited file. The indirect ! 253: subfiles are written in the same directory the original file is in, ! 254: with names generated by appending `-' and a number to the original ! 255: file name. ! 256: ! 257: The primary file still functions as an Info file, but it contains ! 258: just the tag table and a directory of subfiles. ! 259: ! 260: ! 261: ! 262: File: texinfo, Node: Command Syntax, Next: Include Files, Prev: Catching Mistakes, Up: Top ! 263: ! 264: @-Command Syntax ! 265: **************** ! 266: ! 267: The character `@' is used to start special Texinfo commands. (It has ! 268: the same meaning that `\' has in plain TeX.) Syntactically, there ! 269: are three classes of @-commands: ! 270: ! 271: 1. Non-alphabetic commands: @ followed by a punctuation character. ! 272: These commands are always part of the text within a paragraph, ! 273: and never take any argument. The two characters (@ and the ! 274: other one) are complete in themselves. For example, `@.', `@:', ! 275: `@{' and `@}'. ! 276: ! 277: 2. Alphabetic commands used within a paragraph. ! 278: These commands have @ followed by a letter or a word, followed ! 279: by an argument within braces. For example, the command `@dfn' ! 280: indicates the introductory or defining use of a term; it is used ! 281: as follows: `In Texinfo, @-commands are @dfn{mark-up} commands.' ! 282: ! 283: 3. Alphabetic commands used outside of paragraphs. ! 284: Each such command occupies an entire line. The line starts with ! 285: @, followed by the name of the command (a word) such as ! 286: `@center' or `@cindex'. If no argument is needed, the word is ! 287: followed by the end of the line. If there is an argument, it is ! 288: separated from the command name by a space. ! 289: ! 290: Thus, the alphabetic commands fall into two classes that have ! 291: different argument syntax. You cannot tell which class a command ! 292: falls in by the appearance of its name, but you can tell by the ! 293: command's meaning: if it makes sense to use the command together with ! 294: other words as part of a paragraph, the command is in class 2 and ! 295: must be followed by an argument in braces; otherwise, it is in class ! 296: 3 and uses the rest of the line as its argument. ! 297: ! 298: The purpose of having different syntax for commands of classes 2 and ! 299: 3 is to make the Texinfo file easier to read, and also to help the ! 300: GNU Emacs paragraph and filling commands work properly. There is ! 301: only one exception to this rule: the command `@refill', which is ! 302: always used at the end of a paragraph immediately following the final ! 303: period or other punctuation character. `@refill' takes no argument. ! 304: `@refill' never confuses the Emacs paragraph commands because it ! 305: cannot start at the beginning of a line. ! 306: ! 307: ! 308: ! 309: File: texinfo, Node: Include Files, Next: TeX Input, Prev: Command Syntax, Up: Top ! 310: ! 311: Include Files ! 312: ************* ! 313: ! 314: When Info was first created, it was customary to create many small ! 315: Info files on one subject. By doing this, Emacs did not have to make ! 316: a large buffer to hold the whole of a large Info file; instead, Emacs ! 317: allocated just enough memory for the small Info file that was needed ! 318: at the time. This way, Emacs could avoid wasting memory. Include ! 319: files were designed as a way to create a single, large printed manual ! 320: out of several smaller Info files. ! 321: ! 322: However, because large Info files can now be split, include files are ! 323: no longer strictly necessary and they are used infrequently. Most ! 324: often, they are now used in projects where several different people ! 325: are writing different sections of a document simultaneously. ! 326: ! 327: How Include Files Work ! 328: ====================== ! 329: ! 330: In a Texinfo file, a line of the form `@include `filename'' is ! 331: ignored when the Info file is generated, but in a printed manual it ! 332: causes the contents of the file `filename' to be processed and ! 333: included in the manual. The contents of the file `filename' can be ! 334: ignored by Info because the first file can refer to `filename' with ! 335: menus as well as cross references. In the Info system, all the ! 336: information is, as it were, `in one place'. However, when two ! 337: printed manuals are made from two separate Texinfo files, the two ! 338: manuals are separate, and even if they give each other as references, ! 339: the references are to separate documents. Consequently, you will ! 340: sometimes want to create a comprehensive, printed manual that ! 341: contains all the necessary information together in one place. ! 342: ! 343: `@include' files are special Texinfo files that are used only for ! 344: making such a comprehensive manual. They are listed inside an outer ! 345: file that contains nothing but the beginning and end matter of a ! 346: Texinfo file and a number of `@include' commands listing the included ! 347: files. ! 348: ! 349: An `@include' file--a file that will be listed inside an outer file ! 350: and processed with the `@include' command--should not start with ! 351: `\input texinfo', as that has already been done by the outer file, ! 352: and the character `\' has already been redefined to generate a ! 353: backslash in the output. Instead, an `@include' file usually begins ! 354: with a node; it lacks the beginning and ending of a Texinfo file that ! 355: are described in the chapters on beginning and ending a file. *Note ! 356: Beginning a File::, and *note Ending a File::. ! 357: ! 358: Likewise, an `@include' file should not end with `@bye', since that ! 359: would terminate TeX processing immediately. ! 360: ! 361: Here is an example of a outer Texinfo file with `@include' files ! 362: within it: ! 363: ! 364: \input texinfo @c -*-texinfo-*- ! 365: @setfilename include ! 366: @settitle Include Manual ! 367: ! 368: @setchapternewpage odd ! 369: @titlepage ! 370: @sp 12 ! 371: @center @titlefont{Include Manual} ! 372: @sp 2 ! 373: @center by Whom Ever ! 374: ! 375: @page ! 376: Copyright @copyright{} 1988 Free Software Foundation, Inc. ! 377: @end titlepage ! 378: ! 379: @include foo.texinfo ! 380: @include bar.texinfo ! 381: ! 382: @unnumbered Concept Index ! 383: @printindex cp ! 384: ! 385: @summarycontents ! 386: @contents ! 387: ! 388: @bye ! 389: ! 390: ! 391: ! 392: File: texinfo, Node: TeX Input, Next: Sample Permissions, Prev: Include Files, Up: Top ! 393: ! 394: TeX Input Initialization ! 395: ************************ ! 396: ! 397: You must put an input command on the first line of every Texinfo file ! 398: to tell TeX to use the `texinfo.tex' file when it is processing the ! 399: Texinfo source file. Otherwise TeX will not know what to do with the ! 400: @-commands. (The TeX input command is written as `\input texinfo'. ! 401: *Note First Line::.) ! 402: ! 403: TeX needs to be told where to find the `texinfo.tex' file that you ! 404: have told it to input. The preferred way to do this is to put ! 405: `texinfo.tex' in the default inputs directory, which is the ! 406: `/usr/lib/tex/macros' directory. If this is done (as it usually is ! 407: when GNU Emacs is installed), TeX will find the file and you don't ! 408: have to do anything. Alternatively, you can put `texinfo.tex' in the ! 409: directory in which the Texinfo source file is located. ! 410: ! 411: However, you may want to specify the location of the `\input' file ! 412: yourself. One way to do this is to write the complete path for the ! 413: file after the `\input' command. Another way is to set the ! 414: `TEXINPUTS' environment variable in your `.cshrc' or `.profile' file. ! 415: The `TEXINPUTS' environment variable will tell TeX where to find the ! 416: `texinfo.tex' file and any other file that you might want TeX to use. ! 417: ! 418: Whether you use a `.cshrc' or `.profile' file depends on whether you ! 419: use `csh' or `sh' for your shell command interpreter. When you use ! 420: `csh', it looks to the `.cshrc' file for initialization information, ! 421: and when you use `sh', it looks to the `.profile' file. ! 422: ! 423: In a `.cshrc' file, you could use the following `csh' command sequence: ! 424: ! 425: setenv TEXINPUTS .:/usr/me/mylib:/usr/lib/tex/macros ! 426: ! 427: In a `.profile' file, you could use the following `sh' command ! 428: sequence: ! 429: ! 430: TEXINPUTS=.:/usr/me/mylib:/usr/lib/tex/macros ! 431: export TEXINPUTS ! 432: ! 433: This would cause TeX to look for `\input' file first in the current ! 434: directory, indicated by the `.', then in a hypothetical user's ! 435: `me/mylib' directory, and finally in the system library. ! 436: ! 437: ! 438: ! 439: File: texinfo, Node: Sample Permissions, Next: Command Index, Prev: TeX Input, Up: Top ! 440: ! 441: Standard text for Copying Permissions ! 442: ************************************* ! 443: ! 444: Texinfo files should contain sections that tell the readers that they ! 445: have the right to copy and distribute the Info file, the printed ! 446: manual and any accompanying software. This appendix contains the ! 447: standard text of the Free Software Foundation copying permission ! 448: notice. For an example of the text that could be used for the ! 449: Distribution, General Public License and NO WARRANTY sections of a ! 450: document, see the latest version of the ``GNU Emacs Manual''. ! 451: ! 452: The texts of the Free Software Foundation copying permission notice ! 453: in the `@ifinfo' section and in the `@titlepage' section are slightly ! 454: different. ! 455: ! 456: The `@ifinfo' section usually begins with a line that says what the ! 457: file documents. This is what a person looking at the file will first ! 458: read if he or she reads the unprocessed Texinfo file or if he or she ! 459: uses the advanced Info command `g *'. *note info: (info)Expert, for ! 460: more information. (If the reader uses the regular Info commands, he ! 461: or she will usually start reading at the first node and skip this ! 462: first section, which is not in a node.) ! 463: ! 464: In the `@ifinfo' section, the summary sentence should be followed by ! 465: a copyright notice and then by the copying permission notice. One of ! 466: the copying permission paragraphs is enclosed in `@ignore' and `@end ! 467: ignore' commands. This paragraph states that the Texinfo file can be ! 468: processed through TeX and printed, provided the printed manual ! 469: carries the proper copying permission notice. This paragraph is not ! 470: made part of the Info file since it is not relevant to the Info file; ! 471: but it is a mandatory part of the Texinfo file since it permits ! 472: people to process the Texinfo file in TeX. ! 473: ! 474: In the printed manual, the Free Software Foundation copying ! 475: permission notice follows the copyright notice and publishing ! 476: information and is located within the region delineated by the ! 477: `@titlepage' and `@end titlepage' commands. The copying permission ! 478: notice is exactly the same as the notice in the `@ifinfo' section ! 479: except that the paragraph enclosed in `@ignore' and `@end ignore' ! 480: commands is not part of the notice. ! 481: ! 482: To make it simpler to copy the permission notice into each section of ! 483: the Texinfo file, the complete permission notices for each section ! 484: are reproduced in full below even though most of the information is ! 485: redundant. ! 486: ! 487: Note that you my have to specify the correct name of a section ! 488: mentioned in the permission notice. For example, in the ``GDB ! 489: Manual'', the name of the section referring to the General Public ! 490: License is called the ``GDB General Public License'', but in the ! 491: sample shown below, that section is referred to generically as the ! 492: ``General Public License''. ! 493: ! 494: * Menu: ! 495: ! 496: * Ifinfo Permissions:: ! 497: * Titlepage Permissions:: ! 498: ! 499: ! 500: ! 501: File: texinfo, Node: Ifinfo Permissions, Next: Titlepage Permissions, Prev: Sample Permissions, Up: Sample Permissions ! 502: ! 503: Ifinfo Copying Permissions ! 504: ========================== ! 505: ! 506: In the `@ifinfo' section of the Texinfo file, the standard Free ! 507: Software Foundation permission notices reads as follows: ! 508: ! 509: This file documents ... ! 510: ! 511: Copyright 1988 Free Software Foundation, Inc. ! 512: ! 513: Permission is granted to make and distribute verbatim copies of ! 514: this manual provided the copyright notice and this permission notice ! 515: are preserved on all copies. ! 516: ! 517: @ignore ! 518: Permission is granted to process this file through TeX and print the ! 519: results, provided the printed document carries a copying permission ! 520: notice identical to this one except for the removal of this paragraph ! 521: (this paragraph not being relevant to the printed manual). ! 522: ! 523: @end ignore ! 524: Permission is granted to copy and distribute modified versions of this ! 525: manual under the conditions for verbatim copying, provided also that the ! 526: sections entitled ``Distribution'' and ``General Public License'' are ! 527: included exactly as in the original, and provided that the entire ! 528: resulting derived work is distributed under the terms of a permission ! 529: notice identical to this one. ! 530: ! 531: Permission is granted to copy and distribute translations of this manual ! 532: into another language, under the above conditions for modified versions, ! 533: except that the sections entitled ``Distribution'' and ``General Public ! 534: License'' may be included in a translation approved by the author instead ! 535: of in the original English. ! 536: ! 537: ! 538: ! 539: File: texinfo, Node: Titlepage Permissions, Prev: Ifinfo Permissions, Up: Sample Permissions ! 540: ! 541: Titlepage Copying Permissions ! 542: ============================= ! 543: ! 544: In the `@titlepage' section of the Texinfo file, the standard Free ! 545: Software Foundation copying permission notices follows the copyright ! 546: notice and publishing information. The standard phrasing is: ! 547: ! 548: Permission is granted to make and distribute verbatim copies of ! 549: this manual provided the copyright notice and this permission notice ! 550: are preserved on all copies. ! 551: ! 552: Permission is granted to copy and distribute modified versions of this ! 553: manual under the conditions for verbatim copying, provided also that the ! 554: sections entitled ``Distribution'' and ``General Public License'' are ! 555: included exactly as in the original, and provided that the entire ! 556: resulting derived work is distributed under the terms of a permission ! 557: notice identical to this one. ! 558: ! 559: Permission is granted to copy and distribute translations of this manual ! 560: into another language, under the above conditions for modified versions, ! 561: except that the sections entitled ``Distribution'' and ``General Public ! 562: License'' may be included in a translation approved by the author instead ! 563: of in the original English. ! 564: ! 565: ! 566: ! 567: File: texinfo, Node: Command Index, Next: Concept Index, Prev: Sample Permissions, Up: Top ! 568: ! 569: Command Index ! 570: ************* ! 571: ! 572: (When used in a Texinfo file, @-commands are preceded by an `@'.) ! 573: ! 574: * Menu: ! 575: ! 576: * *: Line Breaks. ! 577: * TeX: Tex. ! 578: * appendix: Unnumbered and Appendix. ! 579: * appendixsec: Section. ! 580: * appendixsubsec: Subsection. ! 581: * appendixsubsubsec: Subsubsection. ! 582: * asterisk: Line Breaks. ! 583: * at-sign colons: Insert Colon. ! 584: * at-sign periods: Insert Period. ! 585: * at-signs: Inserting An Atsign. ! 586: * b (bold font): Fonts. ! 587: * br (paragraph breaks): Br. ! 588: * bullet: Bullet. ! 589: * bye: Ending a File. ! 590: * center: Center. ! 591: * chapter: Chapter. ! 592: * cite: Cite. ! 593: * code: Code. ! 594: * copyright: Copyright & Printed Permissions. ! 595: * ctrl: Ctrl. ! 596: * dfn: Dfn. ! 597: * display: Display. ! 598: * dots: Dots. ! 599: * emph: Emph and Strong. ! 600: * end: Lists and Tables. ! 601: * end: Quotations and Examples. ! 602: * enumerate: Enumerate. ! 603: * example: Example. ! 604: * file: File. ! 605: * filll: Copyright & Printed Permissions. ! 606: * group: Group. ! 607: * i (italic font): Fonts. ! 608: * ifinfo: Conditionals. ! 609: * iftex: Conditionals. ! 610: * inforef: Inforef. ! 611: * item: Itemize. ! 612: * item: Table. ! 613: * itemize: Itemize. ! 614: * itemx: Itemx. ! 615: * kbd: Kbd. ! 616: * key: Key. ! 617: * left-braces: Insert Left Brace. ! 618: * menu: Menu. ! 619: * need: Need. ! 620: * node: Structuring. ! 621: * noindent: Noindent. ! 622: * page: Page. ! 623: * pxref: Pxref. ! 624: * quotation: Quotation. ! 625: * refill: Refill. ! 626: * right-braces: Insert Left Brace. ! 627: * samp: Samp. ! 628: * section: Section. ! 629: * setchapternewpage: Setchapternewpage. ! 630: * setfilename: Setfilename. ! 631: * settitle: Settitle. ! 632: * sp (line spacing): Sp. ! 633: * start-of-header: Start-of-Header. ! 634: * strong: Emph and Strong. ! 635: * subsection: Subsection. ! 636: * subsubsection: Subsubsection. ! 637: * t (typewriter font): Fonts. ! 638: * table: Table. ! 639: * texindex (for sorting indices): Printing Hardcopy. ! 640: * texinfo-format-buffer: Creating an Info File. ! 641: * texinfo-format-region: Info on a Region. ! 642: * texinfo-show-structure: Using texinfo-show-structure. ! 643: * titlefont: Titlepage. ! 644: * titlepage: Titlepage. ! 645: * unnumbered: Unnumbered and Appendix. ! 646: * unnumberedsec: Section. ! 647: * unnumberedsubsec: Subsection. ! 648: * unnumberedsubsubsec: Subsubsection. ! 649: * var: Var. ! 650: * vskip: Copyright & Printed Permissions. ! 651: * w (preventing a line break): W. ! 652: * xref: Xref. ! 653: ! 654: ! 655: ! 656: ! 657: File: texinfo, Node: Concept Index, Prev: Command Index, Up: Top ! 658: ! 659: Concept Index ! 660: ************* ! 661: ! 662: * Menu: ! 663: ! 664: * @-Command Syntax: Command Syntax. ! 665: * Badly referenced nodes: Running Info-Validate. ! 666: * Beginning a Texinfo file: Beginning a File. ! 667: * Beginning line of a Texinfo file: First Line. ! 668: * Braces, inserting: Braces Atsigns Periods. ! 669: * Breaks in a line: Line Breaks. ! 670: * Breaks in a paragraph: Br. ! 671: * Bullets, inserting: Dots Bullets Tex. ! 672: * Catching errors with Info Formatting: Debugging with Info. ! 673: * Catching errors with TeX Formatting: Debugging with Tex. ! 674: * Catching mistakes: Catching Mistakes. ! 675: * Centering a line: Center. ! 676: * Chapter structuring: Structuring. ! 677: * Characteristics of the Info file: Info File. ! 678: * Characteristics, printed manual: Printed Manual. ! 679: * Checking for badly referenced nodes: Running Info-Validate. ! 680: * Combining Indices: Combining Indices. ! 681: * Commands to insert single characters: Braces Atsigns Periods. ! 682: * Commands, inserting them: Inserting. ! 683: * Commands, specifying them within text: Specifying. ! 684: * Compile command for formatting: Compile-Command. ! 685: * Conditionals: Conditionals. ! 686: * Contents, Table of: Contents. ! 687: * Conventions, syntactic: Conventions. ! 688: * Copying permissions: Sample Permissions. ! 689: * Copyright: Copyright & Printed Permissions. ! 690: * Copyright page: Titlepage & Copyright Page. ! 691: * Correcting mistakes: Catching Mistakes. ! 692: * Creating an on-line Info file: Creating an Info File. ! 693: * Creating indices: Indices. ! 694: * Cross references: Cross References. ! 695: * Cross references using inforef: Inforef. ! 696: * Cross references using pxref: Pxref. ! 697: * Cross references using xref: Xref. ! 698: * Debugger, using the Emacs Lisp: Using the Emacs Lisp Debugger. ! 699: * Debugging the Texinfo structure: Catching Mistakes. ! 700: * Debugging with Info Formatting: Debugging with Info. ! 701: * Debugging with TeX Formatting: Debugging with Tex. ! 702: * Defining the entries of an index: Index Entries. ! 703: * Definitions, specifying them within text: Specifying. ! 704: * Dir directory for Info installation: Installing an Info File. ! 705: * Display: Display. ! 706: * Distribution: License and Distribution. ! 707: * Dots, inserting: Dots Bullets Tex. ! 708: * Dots, inserting: Dots. ! 709: * Emacs: Texinfo Mode. ! 710: * Emacs Lisp debugger: Using the Emacs Lisp Debugger. ! 711: * Emphasizing text: Emphasis. ! 712: * Ending a Texinfo file: Ending a File. ! 713: * Entries for an index: Index Entries. ! 714: * Enumerate: Enumerate. ! 715: * Examples: Example. ! 716: * Examples: Quotations and Examples. ! 717: * File beginning: Beginning a File. ! 718: * File ending: Ending a File. ! 719: * File structure, showing it: Showing the Structure. ! 720: * Files, specifying them within text: Specifying. ! 721: * Finding badly referenced nodes: Running Info-Validate. ! 722: * First line of a Texinfo file: First Line. ! 723: * Formatting a file for Info: Creating an Info File. ! 724: * Formatting paragraphs: Formatting Paragraphs. ! 725: * Formatting requirements: Requirements. ! 726: * Formatting with the compile command: Compile-Command. ! 727: * Frequently used commands, inserting them: Inserting. ! 728: * GNU Emacs: Texinfo Mode. ! 729: * General syntactic conventions: Conventions. ! 730: * Generating menus with indices: Printing Indices & Menus. ! 731: * Group: Group. ! 732: * Hardcopy, printing it: Printing Hardcopy. ! 733: * Header for Texinfo files: Header. ! 734: * Highlighting: Specifying. ! 735: * Holding text together vertically: Group. ! 736: * Ifinfo: Conditionals. ! 737: * Ifinfo permissions: Ifinfo Permissions. ! 738: * Iftex: Conditionals. ! 739: * Include files: Include Files. ! 740: * Index entries: Index Entries. ! 741: * Indices: Indices. ! 742: * Indices, combining them: Combining Indices. ! 743: * Indices, printing: Printing Indices & Menus. ! 744: * Indices, sorting: Printing Hardcopy. ! 745: * Indices, two letter names: Combining Indices. ! 746: * Indirect subfiles: Creating an Info File. ! 747: * Info file characteristics: Info File. ! 748: * Info file installation: Installing an Info File. ! 749: * Info file requirement for @setfilename: Setfilename. ! 750: * Info file, splitting manually: Splitting. ! 751: * Info validating a large file: Info-Validating a Large File. ! 752: * Info, creating an on-line file: Creating an Info File. ! 753: * Info, formatting on a region: Info on a Region. ! 754: * Info-validate, running the command: Running Info-Validate. ! 755: * Inforef for cross references: Inforef. ! 756: * Inserting braces, @ and periods: Braces Atsigns Periods. ! 757: * Inserting dots: Dots. ! 758: * Inserting frequently used commands: Inserting. ! 759: * Installing an Info file: Installing an Info File. ! 760: * Itemize: Itemize. ! 761: * Itemx: Itemx. ! 762: * License agreement: License and Distribution. ! 763: * Line breaks: Line Breaks. ! 764: * Line breaks, preventing: W. ! 765: * Line spacing: Sp. ! 766: * Lists and tables, making them: Lists and Tables. ! 767: * Local variables: Compile-Command. ! 768: * Looking for badly referenced nodes: Running Info-Validate. ! 769: * Making a printed manual: Printing Hardcopy. ! 770: * Making a tag table manually: Info-Validating a Large File. ! 771: * Making cross references: Cross References. ! 772: * Making lists and tables: Lists and Tables. ! 773: * Marking text within a paragraph: Marking Text. ! 774: * Master menu: Top Node. ! 775: * Menus: Menu. ! 776: * Menus generated with indices: Printing Indices & Menus. ! 777: * Mistakes, catching: Catching Mistakes. ! 778: * Mode, using Texinfo: Texinfo Mode. ! 779: * Names for indices: Combining Indices. ! 780: * Need: Need. ! 781: * Node and chapter structuring: Structuring. ! 782: * Node structuring: Structuring. ! 783: * Nodes, catching mistakes: Catching Mistakes. ! 784: * Nodes, checking for badly referenced nodes: Running Info-Validate. ! 785: * Nodes, correcting mistakes: Catching Mistakes. ! 786: * Occur, using the command: Using Occur. ! 787: * Overview of Texinfo: Overview. ! 788: * Page breaks: Page. ! 789: * Pages, starting odd: Setchapternewpage. ! 790: * Paragraph breaks: Br. ! 791: * Paragraphs, formatting: Formatting Paragraphs. ! 792: * Periods, inserting: Braces Atsigns Periods. ! 793: * Permissions: Sample Permissions. ! 794: * Permissions, printed: Copyright & Printed Permissions. ! 795: * Preface: License and Distribution. ! 796: * Preventing indentation in the printed text: Refilling & Noindent. ! 797: * Printed manual characteristics: Printed Manual. ! 798: * Printed permissions: Copyright & Printed Permissions. ! 799: * Printing an index: Printing Indices & Menus. ! 800: * Printing hardcopy: Printing Hardcopy. ! 801: * Problems, catching: Catching Mistakes. ! 802: * Pxref for cross references: Pxref. ! 803: * Quotations: Quotation. ! 804: * Quotations: Quotations and Examples. ! 805: * References: Cross References. ! 806: * Refilling paragraphs automatically: Refilling & Noindent. ! 807: * Requirements for formatting: Requirements. ! 808: * Running Info: Creating an Info File. ! 809: * Running Info on a region: Info on a Region. ! 810: * Running Info-validate: Running Info-Validate. ! 811: * Running Info-validate on a large file: Info-Validating a Large File. ! 812: * Sample texinfo file: Short Sample. ! 813: * Setfilename command: Setfilename. ! 814: * Showing the structure of a file: Using texinfo-show-structure. ! 815: * Showing the structure of a file: Showing the Structure. ! 816: * Single characters, commands to insert: Braces Atsigns Periods. ! 817: * Sorting indices: Printing Hardcopy. ! 818: * Spaces from line to line: Sp. ! 819: * Special typesetting commands: Dots Bullets Tex. ! 820: * Specifying commands, files and the like: Specifying. ! 821: * Splitting an Info file manually: Splitting. ! 822: * Starting chapters: Setchapternewpage. ! 823: * Structure of Texinfo, catching mistakes: Catching Mistakes. ! 824: * Structure of a file, showing it: Showing the Structure. ! 825: * Structuring of nodes and chapters: Structuring. ! 826: * Syntactic conventions: Conventions. ! 827: * TEXINPUTS environment variable: TeX Input. ! 828: * Table of contents: Contents. ! 829: * Tables and lists, making them: Lists and Tables. ! 830: * Tables, making two-column: Table. ! 831: * Tag table, making manually: Info-Validating a Large File. ! 832: * TeX Input Initialization: TeX Input. ! 833: * TeX commands, using them: Using Tex Commands. ! 834: * TeX-logo, inserting: Dots Bullets Tex. ! 835: * Texinfo file beginning: Beginning a File. ! 836: * Texinfo file ending: Ending a File. ! 837: * Texinfo file header: Header. ! 838: * Texinfo file structure, showing it: Showing the Structure. ! 839: * Texinfo mode: Texinfo Mode. ! 840: * Texinfo overview: Overview. ! 841: * Titlepage: Titlepage. ! 842: * Titlepage: Titlepage & Copyright Page. ! 843: * Titlepage permissions: Titlepage Permissions. ! 844: * Top node: Top Node. ! 845: * Two letter names for indices: Combining Indices. ! 846: * Typesetting commands for dots and the like: Dots Bullets Tex. ! 847: * Using TeX commands: Using Tex Commands. ! 848: * Using occur: Using Occur. ! 849: * Using texinfo-show-structure to catch mistakes: Using texinfo-show-structure. ! 850: * Using the Emacs Lisp debugger: Using the Emacs Lisp Debugger. ! 851: * Validating a large file: Info-Validating a Large File. ! 852: * Vertically holding text together: Group. ! 853: * Xref for cross references: Xref. ! 854: * cshrc initialization file: TeX Input. ! 855: * end-of-header: End-of-Header. ! 856: * profile initialization file: TeX Input. ! 857: * start-of-header: Start-of-Header. ! 858: * texinfo-show-structure for catching mistakes: Using texinfo-show-structure. ! 859: ! 860: ! 861: ! 862: Tag Table: ! 863: Node: Top1064 ! 864: Node: License6576 ! 865: Node: Overview8743 ! 866: Node: Info File11940 ! 867: Node: Printed Manual15506 ! 868: Node: Conventions17534 ! 869: Node: Short Sample20789 ! 870: Node: Texinfo Mode23980 ! 871: Node: Info on a Region25451 ! 872: Node: Showing the Structure26069 ! 873: Node: Inserting27213 ! 874: Node: Beginning a File28387 ! 875: Node: Header31572 ! 876: Node: First Line32331 ! 877: Node: Start-of-Header33327 ! 878: Node: Setfilename34275 ! 879: Node: Settitle34783 ! 880: Node: Setchapternewpage35793 ! 881: Node: End-of-Header36462 ! 882: Node: Permissions for Info37260 ! 883: Node: Titlepage & Copyright Page37978 ! 884: Node: Titlepage38728 ! 885: Node: Center39902 ! 886: Node: Copyright & Printed Permissions40150 ! 887: Node: Top Node42158 ! 888: Node: License and Distribution44836 ! 889: Node: Ending a File46334 ! 890: Node: Contents47202 ! 891: Node: Indices48677 ! 892: Node: Index Entries51173 ! 893: Node: Combining Indices53372 ! 894: Node: Printing Indices & Menus55005 ! 895: Node: Structuring57378 ! 896: Node: Chapter62701 ! 897: Node: Unnumbered and Appendix63301 ! 898: Node: Section63769 ! 899: Node: Subsection64358 ! 900: Node: Subsubsection64857 ! 901: Node: Node65384 ! 902: Node: Menu70082 ! 903: Node: Quotations and Examples73145 ! 904: Node: Quotation74083 ! 905: Node: Example74682 ! 906: Node: Display75843 ! 907: Node: Lists and Tables76202 ! 908: Node: Itemize77514 ! 909: Node: Enumerate79396 ! 910: Node: Table80637 ! 911: Node: Itemx83168 ! 912: Node: Cross References85345 ! 913: Node: Xref87174 ! 914: Node: Pxref91449 ! 915: Node: Inforef92382 ! 916: Node: Formatting Paragraphs93005 ! 917: Node: Refilling & Noindent94270 ! 918: Node: Refill95076 ! 919: Node: Noindent96247 ! 920: Node: Breaks Blank-Lines Groups97202 ! 921: Node: Line Breaks98732 ! 922: Node: Sp99144 ! 923: Node: Br99406 ! 924: Node: W99651 ! 925: Node: Page99919 ! 926: Node: Group100153 ! 927: Node: Need100909 ! 928: Node: Marking Text101208 ! 929: Node: Specifying102066 ! 930: Node: Code104535 ! 931: Node: Samp106393 ! 932: Node: File107427 ! 933: Node: Kbd107825 ! 934: Node: Key108829 ! 935: Node: Ctrl109890 ! 936: Node: Var110793 ! 937: Node: Dfn111677 ! 938: Node: Cite112281 ! 939: Node: Braces Atsigns Periods112477 ! 940: Node: Inserting An Atsign113635 ! 941: Node: Insert Left Brace113806 ! 942: Node: Insert Colon114066 ! 943: Node: Insert Period114794 ! 944: Node: Dots Bullets Tex115546 ! 945: Node: Dots116386 ! 946: Node: Bullet116759 ! 947: Node: Tex116962 ! 948: Node: Emphasis117164 ! 949: Node: Emph and Strong117974 ! 950: Node: Fonts118312 ! 951: Node: Conditionals118896 ! 952: Node: Using Tex Commands120430 ! 953: Node: Printing Hardcopy121454 ! 954: Node: Requirements126489 ! 955: Node: Compile-Command129167 ! 956: Node: Creating an Info File129971 ! 957: Node: Installing an Info File133352 ! 958: Node: Catching Mistakes135148 ! 959: Node: Debugging with Info136382 ! 960: Node: Using the Emacs Lisp Debugger139555 ! 961: Node: Debugging with Tex141746 ! 962: Node: Using texinfo-show-structure145281 ! 963: Node: Using Occur147903 ! 964: Node: Running Info-Validate149366 ! 965: Node: Info-Validating a Large File151476 ! 966: Node: Splitting153240 ! 967: Node: Command Syntax154772 ! 968: Node: Include Files157027 ! 969: Node: TeX Input160191 ! 970: Node: Sample Permissions162224 ! 971: Node: Ifinfo Permissions165095 ! 972: Node: Titlepage Permissions166758 ! 973: Node: Command Index168064 ! 974: Node: Concept Index170213
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.