From: tomo Date: Thu, 6 Jan 2000 07:03:09 +0000 (+0000) Subject: XEmacs 21.2.24 "Hecate". X-Git-Tag: r21-2-24^2 X-Git-Url: http://git.chise.org/gitweb/?a=commitdiff_plain;h=b2d871b1532ba61890c2e01dbede309e7cff9442;p=chise%2Fxemacs-chise.git- XEmacs 21.2.24 "Hecate". --- diff --git a/info/cl.info-6 b/info/cl.info-6 index 57b8a68..6f6dd9c 100644 --- a/info/cl.info-6 +++ b/info/cl.info-6 @@ -125,8 +125,8 @@ Function Index * list-length: List Functions. * load-time-value: Time of Evaluation. * locally: Declarations. -* loop <1>: Iteration. -* loop: Loop Basics. +* loop <1>: Loop Basics. +* loop: Iteration. * macrolet: Macro Bindings. * make-random-state: Random Numbers. * map: Mapping over Sequences. diff --git a/info/internals.info-8 b/info/internals.info-8 index 5467f97..1ed3191 100644 --- a/info/internals.info-8 +++ b/info/internals.info-8 @@ -768,8 +768,8 @@ Index * gc_sweep: gc_sweep. * GNU Emacs 19: GNU Emacs 19. * GNU Emacs 20: GNU Emacs 20. -* Gosling, James <1>: Through Version 18. -* Gosling, James: The Lisp Language. +* Gosling, James <1>: The Lisp Language. +* Gosling, James: Through Version 18. * Great Usenet Renaming: Through Version 18. * Hackers (Steven Levy): A History of Emacs. * hierarchy of windows: Window Hierarchy. diff --git a/info/lispref.info-44 b/info/lispref.info-44 index 82dbb65..af17b43 100644 --- a/info/lispref.info-44 +++ b/info/lispref.info-44 @@ -257,8 +257,8 @@ Index * asynchronous subprocess: Asynchronous Processes. * atan: Math Functions. * atanh: Math Functions. -* atom <1>: Cons Cell Type. -* atom: List-related Predicates. +* atom <1>: List-related Predicates. +* atom: Cons Cell Type. * atomic extent: Atomic Extents. * atoms: List-related Predicates. * attributes of text: Text Properties. @@ -413,8 +413,8 @@ Index * buffer-offer-save <1>: Killing Buffers. * buffer-offer-save: Saving Buffers. * buffer-read-only: Read Only Buffers. -* buffer-saved-size <1>: Auto-Saving. -* buffer-saved-size: Point. +* buffer-saved-size <1>: Point. +* buffer-saved-size: Auto-Saving. * buffer-size: Point. * buffer-string: Buffer Contents. * buffer-substring: Buffer Contents. @@ -558,7 +558,6 @@ Index * character descriptor: Character Descriptors. * character insertion: Commands for Insertion. * character printing: Describing Characters. -* character quote: Syntax Class Table. * character set (in regexp): Syntax of Regexps. * character to string: String Conversion. * character-to-event: Converting Events. @@ -566,6 +565,7 @@ Index * characterp: Predicates for Characters. * characters: Strings and Characters. * characters for interactive codes: Interactive Codes. +* character quote: Syntax Class Table. * charset type: Charset Type. * charset-ccl-program: Charset Property Functions. * charset-chars: Charset Property Functions. @@ -611,8 +611,8 @@ Index * clear-range-table: Working With Range Tables. * clear-visited-file-modtime: Modification Time. * close parenthesis: Blinking. -* close parenthesis character: Syntax Class Table. * close-database: Connecting to a Database. +* close parenthesis character: Syntax Class Table. * closures not available: Extent. * clrhash: Working With Hash Tables. * codes, interactive, description of: Interactive Codes. @@ -660,10 +660,10 @@ Index * commandp: Interactive Call. * commandp example: High-Level Completion. * commands, defining: Defining Commands. -* comment ender: Syntax Class Table. -* comment starter: Syntax Class Table. * comment syntax: Syntax Class Table. * comments: Comments. +* comment ender: Syntax Class Table. +* comment starter: Syntax Class Table. * Common Lisp: Lisp History. * Common Lisp (Edebug): Instrumenting. * compare-buffer-substrings: Comparing Text. @@ -763,10 +763,10 @@ Index * creating buffers: Creating Buffers. * creating keymaps: Creating Keymaps. * ctl-arrow: Usual Display. -* ctl-x-4-map <1>: Prefix Keys. -* ctl-x-4-map: Standard Keymaps. -* ctl-x-5-map <1>: Prefix Keys. -* ctl-x-5-map: Standard Keymaps. +* ctl-x-4-map <1>: Standard Keymaps. +* ctl-x-4-map: Prefix Keys. +* ctl-x-5-map <1>: Standard Keymaps. +* ctl-x-5-map: Prefix Keys. * ctl-x-map <1>: Standard Keymaps. * ctl-x-map: Prefix Keys. * cube-root: Math Functions. @@ -826,8 +826,8 @@ Index * debug-on-next-call: Internals of Debugger. * debug-on-quit: Infinite Loops. * debug-on-signal: Error Debugging. -* debugger <1>: Debugger. -* debugger: Internals of Debugger. +* debugger <1>: Internals of Debugger. +* debugger: Debugger. * debugger command list: Debugger Commands. * debugger-mode-map: Standard Keymaps. * debugging errors: Error Debugging. @@ -896,8 +896,8 @@ Index * defsubst: Inline Functions. * defun: Defining Functions. * defun-prompt-regexp: List Motion. -* defvar <1>: Defining Variables. -* defvar: Domain Specification. +* defvar <1>: Domain Specification. +* defvar: Defining Variables. * defvaralias: Variable Aliases. * deiconify-frame: Visibility of Frames. * delete: Sets And Lists. @@ -950,11 +950,11 @@ Index * detach-extent: Detached Extents. * detached extent: Detached Extents. * detect-coding-region: Detection of Textual Encoding. -* device-baud-rate <1>: Console and Device I/O. -* device-baud-rate: Terminal Output. +* device-baud-rate <1>: Terminal Output. +* device-baud-rate: Console and Device I/O. * device-class: Console Types and Device Classes. -* device-frame-list <1>: Finding All Frames. -* device-frame-list: Basic Device Functions. +* device-frame-list <1>: Basic Device Functions. +* device-frame-list: Finding All Frames. * device-list: Basic Device Functions. * device-live-p: Connecting to a Console or Device. * device-matches-specifier-tag-set-p: Specifier Tag Functions. @@ -1041,36 +1041,36 @@ Index * echo area: The Echo Area. * echo-keystrokes <1>: The Echo Area. * echo-keystrokes: Command Loop Info. -* Edebug: Edebug. * edebug: Embedded Breakpoints. +* Edebug: Edebug. * Edebug execution modes: Edebug Execution Modes. * Edebug mode: Edebug. * Edebug specification list: Specification List. * edebug-`: Debugging Backquote. * edebug-all-defs <1>: Edebug Options. * edebug-all-defs: Instrumenting. -* edebug-all-forms <1>: Instrumenting. -* edebug-all-forms: Edebug Options. +* edebug-all-forms <1>: Edebug Options. +* edebug-all-forms: Instrumenting. * edebug-continue-kbd-macro: Edebug Options. * edebug-display-freq-count: Coverage Testing. * edebug-eval-top-level-form: Instrumenting. -* edebug-global-break-condition <1>: Global Break Condition. -* edebug-global-break-condition: Edebug Options. +* edebug-global-break-condition <1>: Edebug Options. +* edebug-global-break-condition: Global Break Condition. * edebug-initial-mode: Edebug Options. * edebug-on-error <1>: Edebug Options. * edebug-on-error: Trapping Errors. * edebug-on-quit <1>: Edebug Options. * edebug-on-quit: Trapping Errors. -* edebug-print-circle <1>: Printing in Edebug. -* edebug-print-circle: Edebug Options. -* edebug-print-length <1>: Printing in Edebug. -* edebug-print-length: Edebug Options. -* edebug-print-level <1>: Printing in Edebug. -* edebug-print-level: Edebug Options. -* edebug-print-trace-after <1>: Tracing. -* edebug-print-trace-after: Edebug Options. -* edebug-print-trace-before <1>: Tracing. -* edebug-print-trace-before: Edebug Options. +* edebug-print-circle <1>: Edebug Options. +* edebug-print-circle: Printing in Edebug. +* edebug-print-length <1>: Edebug Options. +* edebug-print-length: Printing in Edebug. +* edebug-print-level <1>: Edebug Options. +* edebug-print-level: Printing in Edebug. +* edebug-print-trace-after <1>: Edebug Options. +* edebug-print-trace-after: Tracing. +* edebug-print-trace-before <1>: Edebug Options. +* edebug-print-trace-before: Tracing. * edebug-save-displayed-buffer-points <1>: Edebug Options. * edebug-save-displayed-buffer-points: Edebug Display Update. * edebug-save-windows <1>: Edebug Options. @@ -1082,8 +1082,8 @@ Index * edebug-trace: Tracing. * edebug-tracing: Tracing. * edebug-unwrap: Specification List. -* edebug-unwrap-results <1>: Debugging Backquote. -* edebug-unwrap-results: Edebug Options. +* edebug-unwrap-results <1>: Edebug Options. +* edebug-unwrap-results: Debugging Backquote. * edit-abbrevs-map: Standard Keymaps. * edit-and-eval-command: Object from Minibuffer. * edit-menu-filter: Menu Filters. @@ -1150,8 +1150,8 @@ Index * errors: Errors. * esc-map: Prefix Keys. * ESC-prefix: Prefix Keys. -* escape <1>: Character Type. -* escape: Syntax Class Table. +* escape <1>: Syntax Class Table. +* escape: Character Type. * escape characters: Output Variables. * escape characters in printing: Output Functions. * escape sequence: Character Type. @@ -1236,8 +1236,8 @@ Index * expression prefix: Syntax Class Table. * expt: Math Functions. * extended-command-history: Minibuffer History. -* extent <1>: Variable Scoping. -* extent: Extents. +* extent <1>: Extents. +* extent: Variable Scoping. * extent children: Extent Parents. * extent end position: Extent Endpoints. * extent endpoint: Extent Endpoints. @@ -1479,8 +1479,8 @@ Index * ftruncate: Rounding Operations. * funcall: Calling Functions. * funcall, and debugging: Internals of Debugger. -* function <1>: What Is a Function. -* function: Anonymous Functions. +* function <1>: Anonymous Functions. +* function: What Is a Function. * function call: Function Forms. * function call debugging: Function Debugging. * function cell: Symbol Components. @@ -1506,8 +1506,8 @@ Index * garbage-collect: Garbage Collection. * gc-cons-threshold: Garbage Collection. * gc-message: Garbage Collection. -* gc-pointer-glyph <1>: Mouse Pointer. -* gc-pointer-glyph: Garbage Collection. +* gc-pointer-glyph <1>: Garbage Collection. +* gc-pointer-glyph: Mouse Pointer. * generate-new-buffer: Creating Buffers. * generate-new-buffer-name: Buffer Names. * generic-specifier-p: Specifier Types. @@ -1586,8 +1586,8 @@ Index * help-char: Help Functions. * help-command: Help Functions. * help-form: Help Functions. -* help-map <1>: Help Functions. -* help-map: Standard Keymaps. +* help-map <1>: Standard Keymaps. +* help-map: Help Functions. * Helper-describe-bindings: Help Functions. * Helper-help: Help Functions. * Helper-help-map: Standard Keymaps. @@ -1630,8 +1630,8 @@ Index * image-instance-type-list: Image Instance Types. * image-instance-width: Image Instance Functions. * image-instantiator-format-list: Image Specifiers. -* image-specifier-p <1>: Specifier Types. -* image-specifier-p: Image Specifiers. +* image-specifier-p <1>: Image Specifiers. +* image-specifier-p: Specifier Types. * implicit progn: Sequencing. * inc: Simple Macro. * indent-according-to-mode: Mode-Specific Indent. @@ -1881,8 +1881,8 @@ Index * lisp-mode-abbrev-table: Standard Abbrev Tables. * lisp-mode-map: Standard Keymaps. * lisp-mode.el: Example Major Modes. -* list <1>: Lists. -* list: Building Lists. +* list <1>: Building Lists. +* list: Lists. * list elements: List Elements. * list form evaluation: Classifying Lists. * list in keymap: Key Lookup. @@ -2113,13 +2113,13 @@ Index * minibuffer-frame-plist: Initial Properties. * minibuffer-help-form: Minibuffer Misc. * minibuffer-history: Minibuffer History. -* minibuffer-local-completion-map <1>: Completion Commands. -* minibuffer-local-completion-map: Standard Keymaps. +* minibuffer-local-completion-map <1>: Standard Keymaps. +* minibuffer-local-completion-map: Completion Commands. * minibuffer-local-isearch-map: Standard Keymaps. * minibuffer-local-map <1>: Standard Keymaps. * minibuffer-local-map: Text from Minibuffer. -* minibuffer-local-must-match-map <1>: Completion Commands. -* minibuffer-local-must-match-map: Standard Keymaps. +* minibuffer-local-must-match-map <1>: Standard Keymaps. +* minibuffer-local-must-match-map: Completion Commands. * minibuffer-local-ns-map: Text from Minibuffer. * minibuffer-prompt: Minibuffer Misc. * minibuffer-prompt-width: Minibuffer Misc. @@ -2149,8 +2149,8 @@ Index * modeline construct: Modeline Data. * modeline-buffer-identification: Modeline Variables. * modeline-format: Modeline Data. -* modeline-map <1>: Active Keymaps. -* modeline-map: Standard Keymaps. +* modeline-map <1>: Standard Keymaps. +* modeline-map: Active Keymaps. * modeline-modified: Modeline Variables. * modeline-pointer-glyph: Mouse Pointer. * modeline-process: Modeline Variables. @@ -2189,8 +2189,8 @@ Index * negative-argument: Prefix Command Arguments. * network connection: Network. * new file message: Subroutines of Visiting. -* newline <1>: Character Type. -* newline: Commands for Insertion. +* newline <1>: Commands for Insertion. +* newline: Character Type. * newline and Auto Fill mode: Commands for Insertion. * newline in print: Output Functions. * newline in strings: String Type. @@ -2255,11 +2255,11 @@ Index * old-eq: Equality Predicates. * one-window-p: Splitting Windows. * only-global-abbrevs: Defining Abbrevs. -* open parenthesis character: Syntax Class Table. * open-database: Connecting to a Database. * open-dribble-file: Recording Input. * open-network-stream: Network. * open-termscript: Terminal Output. +* open parenthesis character: Syntax Class Table. * operating system environment: System Environment. * option descriptions: A Sample Variable Description. * optional arguments: Argument List. @@ -2319,10 +2319,10 @@ Index * plist-put: Working With Normal Plists. * plist-remprop: Working With Normal Plists. * plist-to-alist: Converting Plists To/From Alists. -* plists-eq <1>: Working With Normal Plists. -* plists-eq: Other Plists. -* plists-equal <1>: Working With Normal Plists. -* plists-equal: Other Plists. +* plists-eq <1>: Other Plists. +* plists-eq: Working With Normal Plists. +* plists-equal <1>: Other Plists. +* plists-equal: Working With Normal Plists. * point: Point. * point excursion: Excursions. * point in window: Window Point. @@ -2476,8 +2476,8 @@ Index * putf: Other Plists. * puthash: Working With Hash Tables. * query-replace-history: Minibuffer History. -* query-replace-map <1>: Search and Replace. -* query-replace-map: Standard Keymaps. +* query-replace-map <1>: Standard Keymaps. +* query-replace-map: Search and Replace. * querying the user: Yes-or-No Queries. * question mark in character constant: Character Type. * quietly-read-abbrev-file: Abbrev Files. @@ -2916,7 +2916,6 @@ Index * string length: Sequence Functions. * string length, maximum when printing: Output Variables. * string properties: String Properties. -* string quote: Syntax Class Table. * string search: String Search. * string to character: String Conversion. * string to number: String Conversion. @@ -2935,6 +2934,7 @@ Index * strings: Strings and Characters. * strings, formatting them: Formatting Strings. * strings, modifying: Modifying Strings. +* string quote: Syntax Class Table. * subprocess: Processes. * subr: What Is a Function. * subrp: What Is a Function. @@ -2961,7 +2961,6 @@ Index * switching to a buffer: Displaying Buffers. * symbol: Symbols. * symbol components: Symbol Components. -* symbol constituent: Syntax Class Table. * symbol equality: Creating Symbols. * symbol evaluation: Symbol Forms. * symbol function indirection: Function Indirection. @@ -2972,6 +2971,7 @@ Index * symbol-plist: Symbol Plists. * symbol-value: Accessing Variables. * symbolp: Symbols. +* symbol constituent: Syntax Class Table. * synchronous subprocess: Synchronous Processes. * syntax classes: Syntax Descriptors. * syntax descriptor: Syntax Descriptors. @@ -3051,8 +3051,8 @@ Index * toolbar button type: Toolbar Button Type. * toolbar-buttons-captioned-p: Other Toolbar Variables. * toolbar-make-button-list: Toolbar Descriptor Format. -* toolbar-map <1>: Active Keymaps. -* toolbar-map: Standard Keymaps. +* toolbar-map <1>: Standard Keymaps. +* toolbar-map: Active Keymaps. * toolbar-pointer-glyph: Mouse Pointer. * toolbar-specifier-p <1>: Specifier Types. * toolbar-specifier-p: Specifying the Toolbar. @@ -3155,8 +3155,8 @@ Index * valid-specifier-domain-p: Specifier Validation Functions. * valid-specifier-locale-p: Specifier Validation Functions. * valid-specifier-locale-type-p: Specifier Validation Functions. -* valid-specifier-tag-p <1>: Specifier Tag Functions. -* valid-specifier-tag-p: Specifier Validation Functions. +* valid-specifier-tag-p <1>: Specifier Validation Functions. +* valid-specifier-tag-p: Specifier Tag Functions. * valid-specifier-tag-set-p: Specifier Tag Functions. * valid-specifier-type-p: Specifier Validation Functions. * value cell: Symbol Components. @@ -3224,8 +3224,8 @@ Index * window excursions: Excursions. * window ordering, cyclic: Cyclic Window Ordering. * window point: Window Point. -* window position <1>: Window Point. -* window position: Position of Window. +* window position <1>: Position of Window. +* window position: Window Point. * window resizing: Resizing Windows. * window size: Size of Window. * window size, changing: Resizing Windows. @@ -3266,11 +3266,11 @@ Index * with-output-to-temp-buffer: Temporary Displays. * with-selected-frame: Input Focus. * with-temp-file: Excursions. -* word constituent: Syntax Class Table. * word search: String Search. * word-search-backward: String Search. * word-search-forward: String Search. * words-include-escapes: Word Motion. +* word constituent: Syntax Class Table. * write-abbrev-file: Abbrev Files. * write-char: Output Functions. * write-contents-hooks: Saving Buffers. diff --git a/info/new-users-guide.info-2 b/info/new-users-guide.info-2 index 43e84c1..f7ed816 100644 --- a/info/new-users-guide.info-2 +++ b/info/new-users-guide.info-2 @@ -1204,8 +1204,8 @@ Key (Character) Index * C-p: Cursor Position. * C-r: Search and Replace. * C-s: Search and Replace. -* C-SPC <1>: Selecting Text. -* C-SPC: Region Operation. +* C-SPC <1>: Region Operation. +* C-SPC: Selecting Text. * C-t: Cursor Position. * C-u: Numeric Argument. * C-v: Cursor Position. diff --git a/info/new-users-guide.info-3 b/info/new-users-guide.info-3 index 8a26339..7fdf960 100644 --- a/info/new-users-guide.info-3 +++ b/info/new-users-guide.info-3 @@ -38,8 +38,8 @@ Command and Function Index * delete-backward-char: Erase. * delete-char: Erase. * delete-menu-item: Customizing Menus. -* delete-other-windows <1>: Windows and Menus. -* delete-other-windows: XEmacs Window. +* delete-other-windows <1>: XEmacs Window. +* delete-other-windows: Windows and Menus. * delete-window <1>: XEmacs Window. * delete-window: Windows and Menus. * describe-variable: Setting Variables. @@ -144,8 +144,8 @@ Concept Index * cursor control: Cursor Position. * cursor position: Cursor Position. * cursor shapes: Mouse. -* customize <1>: Customization Basics. -* customize: Other Customizations. +* customize <1>: Other Customizations. +* customize: Customization Basics. * customize menus: Customizing Menus. * Cut menu item: Edit menu. * Delete Frame menu item: File menu. @@ -177,8 +177,8 @@ Concept Index * fortran-mode: Major Modes. * fundamental-mode: Major Modes. * goto-line: Cursor Position. -* help <1>: Help. -* help: The Help Menu. +* help <1>: The Help Menu. +* help: Help. * Help menu: Help menu. * hook: Other Customizations. * init file examples: Init File. @@ -254,8 +254,8 @@ Concept Index * visiting files: Visiting. * Weight menu item: Options Menu. * windows <1>: XEmacs Window. -* windows <2>: Entering. -* windows: Windows and Menus. +* windows <2>: Windows and Menus. +* windows: Entering. * yanking: Moving Text. diff --git a/info/termcap.info-3 b/info/termcap.info-3 index 35a54ef..e2e200d 100644 --- a/info/termcap.info-3 +++ b/info/termcap.info-3 @@ -1257,8 +1257,8 @@ Capability Index * ce: Clearing. * ch: Cursor Motion. * cl: Clearing. -* cm: Cursor Motion. * CM: Cursor Motion. +* cm: Cursor Motion. * co: Screen Size. * cr: Cursor Motion. * cS: Scrolling. @@ -1310,8 +1310,8 @@ Capability Index * ka...ku: Keypad. * km: Meta Key. * l0...l9: Keypad. -* le: Cursor Motion. * LE: Cursor Motion. +* le: Cursor Motion. * li: Screen Size. * ll: Cursor Motion. * lm: Scrolling. @@ -1325,8 +1325,8 @@ Capability Index * mo: Meta Key. * mp: Standout. * mr: Standout. -* ms <1>: Standout. -* ms: Underlining. +* ms <1>: Underlining. +* ms: Standout. * nc: Cursor Motion. * nd: Cursor Motion. * nl: Cursor Motion. @@ -1346,12 +1346,12 @@ Capability Index * sa: Standout. * sc: Cursor Motion. * se: Standout. -* sf: Scrolling. * SF: Scrolling. +* sf: Scrolling. * sg: Standout. * so: Standout. -* sr: Scrolling. * SR: Scrolling. +* sr: Scrolling. * st: Initialization. * ta: Cursor Motion. * te: Initialization. @@ -1361,8 +1361,8 @@ Capability Index * ue: Underlining. * ug: Underlining. * ul: Underlining. -* up: Cursor Motion. * UP: Cursor Motion. +* up: Cursor Motion. * us: Underlining. * vb: Bell. * ve: Cursor Visibility. @@ -1373,8 +1373,8 @@ Capability Index * xb: Basic. * xn: Wrapping. * xs: Standout. -* xt <1>: Cursor Motion. -* xt: Standout. +* xt <1>: Standout. +* xt: Cursor Motion.  File: termcap.info, Node: Index, Prev: Cap Index, Up: Top @@ -1407,8 +1407,8 @@ Concept Index * meta key: Meta Key. * names of terminal types: Naming. * overstrike: Basic. -* padding <1>: Padding. -* padding: Pad Specs. +* padding <1>: Pad Specs. +* padding: Padding. * parameters: Parameters. * printer: Printer. * repeat output: Basic. @@ -1426,7 +1426,7 @@ Concept Index * visibility: Cursor Visibility. * visible bell: Bell. * window: Windows. -* wrapping <1>: Naming. -* wrapping: Wrapping. +* wrapping <1>: Wrapping. +* wrapping: Naming. diff --git a/info/texinfo.info-10 b/info/texinfo.info-10 index 9944bfa..aea9a20 100644 --- a/info/texinfo.info-10 +++ b/info/texinfo.info-10 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,1067 +33,1188 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: Command List, Next: Tips, Prev: Creating and Installing Info Files, Up: Top +File: texinfo.info, Node: Tips, Next: Sample Texinfo File, Prev: Command List, Up: Top -@-Command List +Tips and Hints ************** - Here is an alphabetical list of the @-commands in Texinfo. Square -brackets, [ ], indicate optional arguments; an ellipsis, `...', -indicates repeated text. - - -`@WHITESPACE' - An `@' followed by a space, tab, or newline produces a normal, - stretchable, interword space. *Note Multiple Spaces::. - -`@!' - Generate an exclamation point that really does end a sentence - (usually after an end-of-sentence capital letter). *Note Ending a - Sentence::. - -`@"' -`@'' - Generate an umlaut or acute accent, respectively, over the next - character, as in o" and o'. *Note Inserting Accents::. - -`@*' - Force a line break. Do not end a paragraph that uses `@*' with an - `@refill' command. *Note Line Breaks::. - -`@,{C}' - Generate a cedilla accent under C, as in c,. *Note Inserting - Accents::. - -`@-' - Insert a discretionary hyphenation point. *Note - and - hyphenation::. - -`@.' - Produce a period that really does end a sentence (usually after an - end-of-sentence capital letter). *Note Ending a Sentence::. - -`@:' - Indicate to TeX that an immediately preceding period, question - mark, exclamation mark, or colon does not end a sentence. Prevent - TeX from inserting extra whitespace as it does at the end of a - sentence. The command has no effect on the Info file output. - *Note Not Ending a Sentence::. - -`@=' - Generate a macron (bar) accent over the next character, as in o=. - *Note Inserting Accents::. - -`@?' - Generate a question mark that really does end a sentence (usually - after an end-of-sentence capital letter). *Note Ending a - Sentence::. - -`@@' - Stands for an at sign, `@'. *Note Inserting @ and braces: Braces - Atsigns. - -`@^' -`@`' - Generate a circumflex (hat) or grave accent, respectively, over - the next character, as in o^. *Note Inserting Accents::. - -`@{' - Stands for a left brace, `{'. *Note Inserting @ and braces: - Braces Atsigns. - -`@}' - Stands for a right-hand brace, `}'. - *Note Inserting @ and braces: Braces Atsigns. - -`@~' - Generate a tilde accent over the next character, as in N~. *Note - Inserting Accents::. - -`@AA{}' -`@aa{}' - Generate the uppercase and lowercase Scandinavian A-ring letters, - respectively: AA, aa. *Note Inserting Accents::. - -`@acronym{ABBREV}' - Tag ABBREV as an acronym, that is, an abbreviation written in all - capital letters, such as `NASA'. *Note `acronym': acronym. - -`@AE{}' -`@ae{}' - Generate the uppercase and lowercase AE ligatures, respectively: - AE, ae. *Note Inserting Accents::. - -`@afourlatex' -`@afourpaper' -`@afourwide' - Change page dimensions for the A4 paper size. *Note A4 Paper::. - -`@alias NEW=EXISTING' - Make the command `@NEW' an alias for the existing command - `@EXISTING'. *Note alias::. - -`@anchor{NAME}' - Define NAME as the current location for use as a cross-reference - target. *Note `@anchor': anchor. - -`@appendix TITLE' - Begin an appendix. The title appears in the table of contents of - a printed manual. In Info, the title is underlined with - asterisks. *Note The `@unnumbered' and `@appendix' Commands: - unnumbered & appendix. - -`@appendixsec TITLE' -`@appendixsection TITLE' - Begin an appendix section within an appendix. The section title - appears in the table of contents of a printed manual. In Info, - the title is underlined with equal signs. `@appendixsection' is a - longer spelling of the `@appendixsec' command. *Note Section - Commands: unnumberedsec appendixsec heading. - -`@appendixsubsec TITLE' - Begin an appendix subsection within an appendix. The title appears - in the table of contents of a printed manual. In Info, the title - is underlined with hyphens. *Note Subsection Commands: - unnumberedsubsec appendixsubsec subheading. - -`@appendixsubsubsec TITLE' - Begin an appendix subsubsection within an appendix subsection. The - title appears in the table of contents of a printed manual. In - Info, the title is underlined with periods. *Note The `subsub' - Commands: subsubsection. - -`@asis' - Used following `@table', `@ftable', and `@vtable' to print the - table's first column without highlighting ("as is"). *Note Making - a Two-column Table: Two-column Tables. - -`@author AUTHOR' - Typeset AUTHOR flushleft and underline it. *Note The `@title' and - `@author' Commands: title subtitle author. - -`@b{TEXT}' - Print TEXT in bold font. No effect in Info. *Note Fonts::. - -`@bullet{}' - Generate a large round dot, or the closest possible thing to one. - *Note `@bullet': bullet. - -`@bye' - Stop formatting a file. The formatters do not see the contents of - a file following an `@bye' command. *Note Ending a File::. - -`@c COMMENT' - Begin a comment in Texinfo. The rest of the line does not appear - in either the Info file or the printed manual. A synonym for - `@comment'. *Note Comments: Comments. - -`@cartouche' - Highlight an example or quotation by drawing a box with rounded - corners around it. Pair with `@end cartouche'. No effect in - Info. *Note Drawing Cartouches Around Examples: cartouche.) - -`@center LINE-OF-TEXT' - Center the line of text following the command. *Note `@center': - titlefont center sp. - -`@centerchap LINE-OF-TEXT' - Like `@chapter', but centers the chapter title. *Note `@chapter': - chapter. - -`@chapheading TITLE' - Print a chapter-like heading in the text, but not in the table of - contents of a printed manual. In Info, the title is underlined - with asterisks. *Note `@majorheading' and `@chapheading': - majorheading & chapheading. - -`@chapter TITLE' - Begin a chapter. The chapter title appears in the table of - contents of a printed manual. In Info, the title is underlined - with asterisks. *Note `@chapter': chapter. - -`@cindex ENTRY' - Add ENTRY to the index of concepts. *Note Defining the Entries of - an Index: Index Entries. - -`@cite{REFERENCE}' - Highlight the name of a book or other reference that lacks a - companion Info file. *Note `@cite': cite. - -`@clear FLAG' - Unset FLAG, preventing the Texinfo formatting commands from - formatting text between subsequent pairs of `@ifset FLAG' and - `@end ifset' commands, and preventing `@value{FLAG}' from - expanding to the value to which FLAG is set. *Note `@set' - `@clear' `@value': set clear value. - -`@code{SAMPLE-CODE}' - Highlight text that is an expression, a syntactically complete - token of a program, or a program name. *Note `@code': code. - -`@command{COMMAND-NAME}' - Indicate a command name, such as `ls'. *Note `@command': command. - -`@comment COMMENT' - Begin a comment in Texinfo. The rest of the line does not appear - in either the Info file or the printed manual. A synonym for `@c'. - *Note Comments::. - -`@contents' - Print a complete table of contents. Has no effect in Info, which - uses menus instead. *Note Generating a Table of Contents: - Contents. - -`@copyright{}' - Generate a copyright symbol. *Note `@copyright': copyright symbol. - -`@defcodeindex INDEX-NAME' - Define a new index and its indexing command. Print entries in an - `@code' font. *Note Defining New Indices: New Indices. - -`@defcv CATEGORY CLASS NAME' -`@defcvx CATEGORY CLASS NAME' - Format a description for a variable associated with a class in - object-oriented programming. Takes three arguments: the category - of thing being defined, the class to which it belongs, and its - name. *Note Definition Commands::, and *Note Def Cmds in Detail: - deffnx. - -`@deffn CATEGORY NAME ARGUMENTS...' -`@deffnx CATEGORY NAME ARGUMENTS...' - Format a description for a function, interactive command, or - similar entity that may take arguments. `@deffn' takes as - arguments the category of entity being described, the name of this - particular entity, and its arguments, if any. *Note Definition - Commands::. - -`@defindex INDEX-NAME' - Define a new index and its indexing command. Print entries in a - roman font. *Note Defining New Indices: New Indices. - -`@definfoenclose NEWCMD, BEFORE, AFTER,' - Create new @-command NEWCMD for Info that marks text by enclosing - it in strings that precede and follow the text. *Note - definfoenclose::. - -`@defivar CLASS INSTANCE-VARIABLE-NAME' -`@defivarx CLASS INSTANCE-VARIABLE-NAME' - This command formats a description for an instance variable in - object-oriented programming. The command is equivalent to `@defcv - {Instance Variable} ...'. *Note Definition Commands::, and *Note - Def Cmds in Detail: deffnx. - -`@defmac MACRONAME ARGUMENTS...' -`@defmacx MACRONAME ARGUMENTS...' - Format a description for a macro. The command is equivalent to - `@deffn Macro ...'. *Note Definition Commands::, and *Note Def - Cmds in Detail: deffnx. - -`@defmethod CLASS METHOD-NAME ARGUMENTS...' -`@defmethodx CLASS METHOD-NAME ARGUMENTS...' - Format a description for a method in object-oriented programming. - The command is equivalent to `@defop Method ...'. Takes as - arguments the name of the class of the method, the name of the - method, and its arguments, if any. *Note Definition Commands::, - and *Note Def Cmds in Detail: deffnx. - -`@defop CATEGORY CLASS NAME ARGUMENTS...' -`@defopx CATEGORY CLASS NAME ARGUMENTS...' - Format a description for an operation in object-oriented - programming. `@defop' takes as arguments the overall name of the - category of operation, the name of the class of the operation, the - name of the operation, and its arguments, if any. *Note - Definition Commands::, and *Note Abstract Objects::. - -`@defopt OPTION-NAME' -`@defoptx OPTION-NAME' - Format a description for a user option. The command is equivalent - to `@defvr {User Option} ...'. *Note Definition Commands::, and - *Note Def Cmds in Detail: deffnx. - -`@defspec SPECIAL-FORM-NAME ARGUMENTS...' -`@defspecx SPECIAL-FORM-NAME ARGUMENTS...' - Format a description for a special form. The command is - equivalent to `@deffn {Special Form} ...'. *Note Definition - Commands::, and *Note Def Cmds in Detail: deffnx. - -`@deftp CATEGORY NAME-OF-TYPE ATTRIBUTES...' -`@deftpx CATEGORY NAME-OF-TYPE ATTRIBUTES...' - Format a description for a data type. `@deftp' takes as arguments - the category, the name of the type (which is a word like `int' or - `float'), and then the names of attributes of objects of that type. - *Note Definition Commands::, and *Note Data Types::. - -`@deftypefn CLASSIFICATION DATA-TYPE NAME ARGUMENTS...' -`@deftypefnx CLASSIFICATION DATA-TYPE NAME ARGUMENTS...' - Format a description for a function or similar entity that may take - arguments and that is typed. `@deftypefn' takes as arguments the - classification of entity being described, the type, the name of the - entity, and its arguments, if any. *Note Definition Commands::, - and *Note Def Cmds in Detail: deffnx. - -`@deftypefun DATA-TYPE FUNCTION-NAME ARGUMENTS...' -`@deftypefunx DATA-TYPE FUNCTION-NAME ARGUMENTS...' - Format a description for a function in a typed language. The - command is equivalent to `@deftypefn Function ...'. *Note - Definition Commands::, and *Note Def Cmds in Detail: deffnx. - -`@deftypeivar CLASS DATA-TYPE VARIABLE-NAME' -`@deftypeivarx CLASS DATA-TYPE VARIABLE-NAME' - Format a description for a typed instance variable in - object-oriented programming. *Note Definition Commands::, and - *Note Abstract Objects::. - -`@deftypemethod CLASS DATA-TYPE METHOD-NAME ARGUMENTS...' -`@deftypemethodx CLASS DATA-TYPE METHOD-NAME ARGUMENTS...' - Format a description for a typed method in object-oriented - programming. *Note Definition Commands::, and *Note Def Cmds in - Detail: deffnx. - -`@deftypeop CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...' -`@deftypeopx CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...' - Format a description for a typed operation in object-oriented - programming. *Note Definition Commands::, and *Note Abstract - Objects::. - -`@deftypevar DATA-TYPE VARIABLE-NAME' -`@deftypevarx DATA-TYPE VARIABLE-NAME' - Format a description for a variable in a typed language. The - command is equivalent to `@deftypevr Variable ...'. *Note - Definition Commands::, and *Note Def Cmds in Detail: deffnx. - -`@deftypevr CLASSIFICATION DATA-TYPE NAME' -`@deftypevrx CLASSIFICATION DATA-TYPE NAME' - Format a description for something like a variable in a typed - language--an entity that records a value. Takes as arguments the - classification of entity being described, the type, and the name - of the entity. *Note Definition Commands::, and *Note Def Cmds in - Detail: deffnx. - -`@defun FUNCTION-NAME ARGUMENTS...' -`@defunx FUNCTION-NAME ARGUMENTS...' - Format a description for functions. The command is equivalent to - `@deffn Function ...'. *Note Definition Commands::, and *Note Def - Cmds in Detail: deffnx. - -`@defvar VARIABLE-NAME' -`@defvarx VARIABLE-NAME' - Format a description for variables. The command is equivalent to - `@defvr Variable ...'. *Note Definition Commands::, and *Note Def - Cmds in Detail: deffnx. - -`@defvr CATEGORY NAME' -`@defvrx CATEGORY NAME' - Format a description for any kind of variable. `@defvr' takes as - arguments the category of the entity and the name of the entity. - *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. - -`@detailmenu' - Avoid `makeinfo' confusion stemming from the detailed node listing - in a master menu. *Note Master Menu Parts::. - -`@dfn{TERM}' - Highlight the introductory or defining use of a term. *Note - `@dfn': dfn. - -`@dircategory DIRPART' - Specify a part of the Info directory menu where this file's entry - should go. *Note Installing Dir Entries::. - -`@direntry' - Begin the Info directory menu entry for this file. Pair with - `@end direntry'. *Note Installing Dir Entries::. - -`@display' - Begin a kind of example. Like `@example' (indent text, do not - fill), but do not select a new font. Pair with `@end display'. - *Note `@display': display. - -`@dmn{DIMENSION}' - Format a unit of measure, as in 12pt. Causes TeX to insert a thin - space before DIMENSION. No effect in Info. *Note `@dmn': dmn. - -`@documentencoding ENC' - Declare the input encoding as ENC. *Note `@documentencoding': - documentencoding. - -`@documentlanguage CC' - Declare the document language as the two-character ISO-639 - abbreviation CC. *Note `@documentlanguage': documentlanguage. - -`@dotaccent{C}' - Generate a dot accent over the character C, as in o.. *Note - Inserting Accents::. - -`@dots{}' - Insert an ellipsis: `...'. *Note `@dots': dots. - -`@email{ADDRESS[, DISPLAYED-TEXT]}' - Indicate an electronic mail address. *Note `@email': email. - -`@emph{TEXT}' - Highlight TEXT; text is displayed in _italics_ in printed output, - and surrounded by asterisks in Info. *Note Emphasizing Text: - Emphasis. - -`@end ENVIRONMENT' - Ends ENVIRONMENT, as in `@end example'. *Note @-commands: - Formatting Commands. - -`@env{ENVIRONMENT-VARIABLE}' - Indicate an environment variable name, such as `PATH'. *Note - `@env': env. - -`@enddots{}' - Generate an end-of-sentence of ellipsis, like this .... *Note - `@dots{}': dots. - -`@enumerate [NUMBER-OR-LETTER]' - Begin a numbered list, using `@item' for each entry. Optionally, - start list with NUMBER-OR-LETTER. Pair with `@end enumerate'. - *Note `@enumerate': enumerate. - -`@equiv{}' - Indicate to the reader the exact equivalence of two forms with a - glyph: `=='. *Note Equivalence::. - -`@error{}' - Indicate to the reader with a glyph that the following text is an - error message: `error-->'. *Note Error Glyph::. - -`@evenfooting [LEFT] @| [CENTER] @| [RIGHT]' -`@evenheading [LEFT] @| [CENTER] @| [RIGHT]' - Specify page footings resp. headings for even-numbered (left-hand) - pages. Only allowed inside `@iftex'. *Note How to Make Your Own - Headings: Custom Headings. - -`@everyfooting [LEFT] @| [CENTER] @| [RIGHT]' -`@everyheading [LEFT] @| [CENTER] @| [RIGHT]' - Specify page footings resp. headings for every page. Not relevant - to Info. *Note How to Make Your Own Headings: Custom Headings. - -`@example' - Begin an example. Indent text, do not fill, and select - fixed-width font. Pair with `@end example'. *Note `@example': - example. - -`@exampleindent INDENT' - Indent example-like environments by INDENT number of spaces - (perhaps 0). *Note Paragraph Indenting: exampleindent. - -`@exclamdown{}' - Produce an upside-down exclamation point. *Note Inserting - Accents::. - -`@exdent LINE-OF-TEXT' - Remove any indentation a line might have. *Note Undoing the - Indentation of a Line: exdent. - -`@expansion{}' - Indicate the result of a macro expansion to the reader with a - special glyph: `==>'. *Note ==> Indicating an Expansion: - expansion. - -`@file{FILENAME}' - Highlight the name of a file, buffer, node, or directory. *Note - `@file': file. - -`@finalout' - Prevent TeX from printing large black warning rectangles beside - over-wide lines. *Note Overfull hboxes::. - -`@findex ENTRY' - Add ENTRY to the index of functions. *Note Defining the Entries - of an Index: Index Entries. - -`@flushleft' -`@flushright' - Left justify every line but leave the right end ragged. Leave - font as is. Pair with `@end flushleft'. `@flushright' analogous. - *Note `@flushleft' and `@flushright': flushleft & flushright. - -`@footnote{TEXT-OF-FOOTNOTE}' - Enter a footnote. Footnote text is printed at the bottom of the - page by TeX; Info may format in either `End' node or `Separate' - node style. *Note Footnotes::. - -`@footnotestyle STYLE' - Specify an Info file's footnote style, either `end' for the end - node style or `separate' for the separate node style. *Note - Footnotes::. - -`@format' - Begin a kind of example. Like `@display', but do not narrow the - margins. Pair with `@end format'. *Note `@example': example. - -`@ftable FORMATTING-COMMAND' - Begin a two-column table, using `@item' for each entry. - Automatically enter each of the items in the first column into the - index of functions. Pair with `@end ftable'. The same as - `@table', except for indexing. *Note `@ftable' and `@vtable': - ftable vtable. - -`@group' - Hold text together that must appear on one printed page. Pair with - `@end group'. Not relevant to Info. *Note `@group': group. - -`@H{C}' - Generate the long Hungarian umlaut accent over C, as in o''. - -`@heading TITLE' - Print an unnumbered section-like heading in the text, but not in - the table of contents of a printed manual. In Info, the title is - underlined with equal signs. *Note Section Commands: - unnumberedsec appendixsec heading. - -`@headings ON-OFF-SINGLE-DOUBLE' - Turn page headings on or off, and/or specify single-sided or - double-sided page headings for printing. *Note The `@headings' - Command: headings on off. - -`@html' - Enter HTML completely. Pair with `@end html'. *Note Raw - Formatter Commands::. - -`@hyphenation{HY-PHEN-A-TED WORDS}' - Explicitly define hyphenation points. *Note `@-' and - `@hyphenation': - and hyphenation. - -`@i{TEXT}' - Print TEXT in italic font. No effect in Info. *Note Fonts::. - -`@ifclear FLAG' - If FLAG is cleared, the Texinfo formatting commands format text - between `@ifclear FLAG' and the following `@end ifclear' command. - *Note `@set' `@clear' `@value': set clear value. - -`@ifhtml' -`@ifinfo' - Begin a stretch of text that will be ignored by TeX when it - typesets the printed manual. The text appears only in the HTML - resp. Info file. Pair with `@end ifhtml' resp. `@end ifinfo'. - *Note Conditionals::. - -`@ifnothtml' -`@ifnotinfo' -`@ifnottex' - Begin a stretch of text that will be ignored in one output format - but not the others. The text appears only in the format not - specified. Pair with `@end ifnothtml' resp. `@end ifnotinfo' resp. - `@end ifnotinfo'. *Note Conditionals::. - -`@ifset FLAG' - If FLAG is set, the Texinfo formatting commands format text - between `@ifset FLAG' and the following `@end ifset' command. - *Note `@set' `@clear' `@value': set clear value. - -`@iftex' - Begin a stretch of text that will not appear in the Info file, but - will be processed only by TeX. Pair with `@end iftex'. *Note - Conditionally Visible Text: Conditionals. - -`@ignore' - Begin a stretch of text that will not appear in either the Info - file or the printed output. Pair with `@end ignore'. *Note - Comments and Ignored Text: Comments. - -`@image{FILENAME, [WIDTH], [HEIGHT]}' - Include graphics image in external FILENAME scaled to the given - WIDTH and/or HEIGHT. *Note Images::. - -`@include FILENAME' - Incorporate the contents of the file FILENAME into the Info file - or printed document. *Note Include Files::. - -`@inforef{NODE-NAME, [ENTRY-NAME], INFO-FILE-NAME}' - Make a cross reference to an Info file for which there is no - printed manual. *Note Cross references using `@inforef': inforef. - -`\input MACRO-DEFINITIONS-FILE' - Use the specified macro definitions file. This command is used - only in the first line of a Texinfo file to cause TeX to make use - of the `texinfo' macro definitions file. The backslash in `\input' - is used instead of an `@' because TeX does not recognize `@' until - after it has read the definitions file. *Note The Texinfo File - Header: Header. - -`@item' - Indicate the beginning of a marked paragraph for `@itemize' and - `@enumerate'; indicate the beginning of the text of a first column - entry for `@table', `@ftable', and `@vtable'. *Note Lists and - Tables::. - -`@itemize MARK-GENERATING-CHARACTER-OR-COMMAND' - Produce a sequence of indented paragraphs, with a mark inside the - left margin at the beginning of each paragraph. Pair with `@end - itemize'. *Note `@itemize': itemize. - -`@itemx' - Like `@item' but do not generate extra vertical space above the - item text. *Note `@itemx': itemx. - -`@kbd{KEYBOARD-CHARACTERS}' - Indicate text that is characters of input to be typed by users. - *Note `@kbd': kbd. - -`@kbdinputstyle STYLE' - Specify when `@kbd' should use a font distinct from `@code'. - *Note `@kbd': kbd. - -`@key{KEY-NAME}' - Indicate a name for a key on a keyboard. *Note `@key': key. - -`@kindex ENTRY' - Add ENTRY to the index of keys. *Note Defining the Entries of an - Index: Index Entries. - -`@L{}' -`@l{}' - Generate the uppercase and lowercase Polish suppressed-L letters, - respectively: /L, /l. - -`@lisp' - Begin an example of Lisp code. Indent text, do not fill, and - select fixed-width font. Pair with `@end lisp'. *Note `@lisp': - lisp. - -`@lowersections' - Change subsequent chapters to sections, sections to subsections, - and so on. *Note `@raisesections' and `@lowersections': - Raise/lower sections. - -`@macro MACRONAME {PARAMS}' - Define a new Texinfo command `@MACRONAME{PARAMS}'. Only supported - by `makeinfo' and `texi2dvi'. *Note Defining Macros::. - -`@majorheading TITLE' - Print a chapter-like heading in the text, but not in the table of - contents of a printed manual. Generate more vertical whitespace - before the heading than the `@chapheading' command. In Info, the - chapter heading line is underlined with asterisks. *Note - `@majorheading' and `@chapheading': majorheading & chapheading. - -`@math{MATHEMATICAL-EXPRESSION}' - Format a mathematical expression. *Note `@math': Inserting - Mathematical Expressions: math. - -`@menu' - Mark the beginning of a menu of nodes in Info. No effect in a - printed manual. Pair with `@end menu'. *Note Menus::. - -`@minus{}' - Generate a minus sign, `-'. *Note `@minus': minus. - -`@multitable COLUMN-WIDTH-SPEC' - Begin a multi-column table. Pair with `@end multitable'. *Note - Multitable Column Widths::. - -`@need N' - Start a new page in a printed manual if fewer than N mils - (thousandths of an inch) remain on the current page. *Note - `@need': need. - -`@node NAME, NEXT, PREVIOUS, UP' - Define the beginning of a new node in Info, and serve as a locator - for references for TeX. *Note `@node': node. - -`@noindent' - Prevent text from being indented as if it were a new paragraph. - *Note `@noindent': noindent. - -`@novalidate' - Suppress validation of node references, omit creation of auxiliary - files with TeX. Use before `@setfilename'. *Note Pointer - Validation::. - -`@O{}' -`@o{}' - Generate the uppercase and lowercase O-with-slash letters, - respectively: /O, /o. - -`@oddfooting [LEFT] @| [CENTER] @| [RIGHT]' -`@oddheading [LEFT] @| [CENTER] @| [RIGHT]' - Specify page footings resp. headings for odd-numbered (right-hand) - pages. Only allowed inside `@iftex'. *Note How to Make Your Own - Headings: Custom Headings. - -`@OE{}' -`@oe{}' - Generate the uppercase and lowercase OE ligatures, respectively: - OE, oe. *Note Inserting Accents::. - -`@option{OPTION-NAME}' - Indicate a command-line option, such as `-l' or `--help'. *Note - `@option': option. - -`@page' - Start a new page in a printed manual. No effect in Info. *Note - `@page': page. - -`@pagesizes [WIDTH][, HEIGHT]' - Change page dimensions. *Note pagesizes::. - -`@paragraphindent INDENT' - Indent paragraphs by INDENT number of spaces (perhaps 0); preserve - source file indentation if INDENT is `asis'. *Note Paragraph - Indenting: paragraphindent. - -`@pindex ENTRY' - Add ENTRY to the index of programs. *Note Defining the Entries of - an Index: Index Entries. - -`@point{}' - Indicate the position of point in a buffer to the reader with a - glyph: `-!-'. *Note Indicating Point in a Buffer: Point Glyph. - -`@pounds{}' - Generate the pounds sterling currency sign. *Note `@pounds{}': - pounds. - -`@print{}' - Indicate printed output to the reader with a glyph: `-|'. *Note - Print Glyph::. - -`@printindex INDEX-NAME' - Print an alphabetized two-column index in a printed manual or - generate an alphabetized menu of index entries for Info. *Note - Printing Indices & Menus::. - -`@pxref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' - Make a reference that starts with a lower case `see' in a printed - manual. Use within parentheses only. Do not follow command with a - punctuation mark--the Info formatting commands automatically insert - terminating punctuation as needed. Only the first argument is - mandatory. *Note `@pxref': pxref. - -`@questiondown{}' - Generate an upside-down question mark. *Note Inserting Accents::. - -`@quotation' - Narrow the margins to indicate text that is quoted from another - real or imaginary work. Write command on a line of its own. Pair - with `@end quotation'. *Note `@quotation': quotation. - -`@r{TEXT}' - Print TEXT in roman font. No effect in Info. *Note Fonts::. - -`@raisesections' - Change subsequent sections to chapters, subsections to sections, - and so on. *Note `@raisesections' and `@lowersections': - Raise/lower sections. - -`@ref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' - Make a reference. In a printed manual, the reference does not - start with a `See'. Follow command with a punctuation mark. Only - the first argument is mandatory. *Note `@ref': ref. - -`@refill' - In Info, refill and indent the paragraph after all the other - processing has been done. No effect on TeX, which always refills. - This command is no longer needed, since all formatters now - automatically refill. *Note Refilling Paragraphs::. - -`@result{}' - Indicate the result of an expression to the reader with a special - glyph: `=>'. *Note `@result': result. - -`@ringaccent{C}' - Generate a ring accent over the next character, as in o*. *Note - Inserting Accents::. - -`@samp{TEXT}' - Highlight TEXT that is a literal example of a sequence of - characters. Used for single characters, for statements, and often - for entire shell commands. *Note `@samp': samp. - -`@sc{TEXT}' - Set TEXT in a printed output in THE SMALL CAPS FONT and set text - in the Info file in uppercase letters. *Note Smallcaps::. - -`@section TITLE' - Begin a section within a chapter. In a printed manual, the section - title is numbered and appears in the table of contents. In Info, - the title is underlined with equal signs. *Note `@section': - section. - -`@set FLAG [STRING]' - Make FLAG active, causing the Texinfo formatting commands to - format text between subsequent pairs of `@ifset FLAG' and `@end - ifset' commands. Optionally, set value of FLAG to STRING. *Note - `@set' `@clear' `@value': set clear value. - -`@setchapternewpage ON-OFF-ODD' - Specify whether chapters start on new pages, and if so, whether on - odd-numbered (right-hand) new pages. *Note `@setchapternewpage': - setchapternewpage. - -`@setcontentsaftertitlepage' - Put the table of contents after the `@end titlepage' even if the - `@contents' command is not there. *Note Contents::. - -`@setfilename INFO-FILE-NAME' - Provide a name to be used by the Info file. This command is - essential for TeX formatting as well, even though it produces no - output. *Note `@setfilename': setfilename. - -`@setshortcontentsaftertitlepage' - Place the short table of contents after the `@end titlepage' - command even if the `@shortcontents' command is not there. *Note - Contents::. - -`@settitle TITLE' - Provide a title for page headers in a printed manual. *Note - `@settitle': settitle. - -`@shortcontents' - Print a short table of contents. Not relevant to Info, which uses - menus rather than tables of contents. A synonym for - `@summarycontents'. *Note Generating a Table of Contents: - Contents. - -`@shorttitlepage TITLE' - Generate a minimal title page. *Note `@titlepage': titlepage. - -`@smallbook' - Cause TeX to produce a printed manual in a 7 by 9.25 inch format - rather than the regular 8.5 by 11 inch format. *Note Printing - Small Books: smallbook. Also, see *Note small::. - -`@smalldisplay' - Begin a kind of example. Like `@smallexample' (indent text, no - filling), but do not select the fixed-width font. In `@smallbook' - format, print text in a smaller font than with `@display'. Pair - with `@end smalldisplay'. *Note small::. - -`@smallexample' - Indent text to indicate an example. Do not fill, select - fixed-width font. In `@smallbook' format, print text in a smaller - font than with `@example'. Pair with `@end smallexample'. *Note - small::. - -`@smallformat' - Begin a kind of example. Like `@smalldisplay', but do not narrow - the margins and do not select the fixed-width font. In - `@smallbook' format, print text in a smaller font than with - `@format'. Pair with `@end smallformat'. *Note small::. - -`@smalllisp' - Begin an example of Lisp code. Indent text, do not fill, select - fixed-width font. In `@smallbook' format, print text in a smaller - font. Pair with `@end smalllisp'. *Note small::. - -`@sp N' - Skip N blank lines. *Note `@sp': sp. - -`@ss{}' - Generate the German sharp-S es-zet letter, ss. *Note Inserting - Accents::. - -`@strong {TEXT}' - Emphasize TEXT by typesetting it in a *bold* font for the printed - manual and by surrounding it with asterisks for Info. *Note - Emphasizing Text: emph & strong. - -`@subheading TITLE' - Print an unnumbered subsection-like heading in the text, but not in - the table of contents of a printed manual. In Info, the title is - underlined with hyphens. *Note `@unnumberedsubsec' - `@appendixsubsec' `@subheading': unnumberedsubsec appendixsubsec - subheading. - -`@subsection TITLE' - Begin a subsection within a section. In a printed manual, the - subsection title is numbered and appears in the table of contents. - In Info, the title is underlined with hyphens. *Note - `@subsection': subsection. - -`@subsubheading TITLE' - Print an unnumbered subsubsection-like heading in the text, but - not in the table of contents of a printed manual. In Info, the - title is underlined with periods. *Note The `subsub' Commands: - subsubsection. - -`@subsubsection TITLE' - Begin a subsubsection within a subsection. In a printed manual, - the subsubsection title is numbered and appears in the table of - contents. In Info, the title is underlined with periods. *Note - The `subsub' Commands: subsubsection. - -`@subtitle TITLE' - In a printed manual, set a subtitle in a normal sized font flush to - the right-hand side of the page. Not relevant to Info, which does - not have title pages. *Note `@title' `@subtitle' and `@author' - Commands: title subtitle author. - -`@summarycontents' - Print a short table of contents. Not relevant to Info, which uses - menus rather than tables of contents. A synonym for - `@shortcontents'. *Note Generating a Table of Contents: Contents. - -`@syncodeindex FROM-INDEX INTO-INDEX' - Merge the index named in the first argument into the index named in - the second argument, printing the entries from the first index in - `@code' font. *Note Combining Indices::. - -`@synindex FROM-INDEX INTO-INDEX' - Merge the index named in the first argument into the index named in - the second argument. Do not change the font of FROM-INDEX - entries. *Note Combining Indices::. - -`@t{TEXT}' - Print TEXT in a fixed-width, typewriter-like font. No effect in - Info. *Note Fonts::. - -`@tab' - Separate columns in a multitable. *Note Multitable Rows::. - -`@table FORMATTING-COMMAND' - Begin a two-column table, using `@item' for each entry. Write - each first column entry on the same line as `@item'. First column - entries are printed in the font resulting from FORMATTING-COMMAND. - Pair with `@end table'. *Note Making a Two-column Table: - Two-column Tables. Also see *Note `@ftable' and `@vtable': ftable - vtable, and *Note `@itemx': itemx. - -`@TeX{}' - Insert the logo TeX. *Note Inserting TeX and (C): TeX and - copyright. - -`@tex' - Enter TeX completely. Pair with `@end tex'. *Note Raw Formatter - Commands::. + Here are some tips for writing Texinfo documentation: + + * Write in the present tense, not in the past or the future. + + * Write actively! For example, write "We recommend that ..." rather + than "It is recommended that ...". + + * Use 70 or 72 as your fill column. Longer lines are hard to read. + + * Include a copyright notice and copying permissions. + +Index, Index, Index! +.................... + + Write many index entries, in different ways. Readers like indices; +they are helpful and convenient. + + Although it is easiest to write index entries as you write the body of +the text, some people prefer to write entries afterwards. In either +case, write an entry before the paragraph to which it applies. This +way, an index entry points to the first page of a paragraph that is +split across pages. + + Here are more hints we have found valuable: + + * Write each index entry differently, so each entry refers to a + different place in the document. + + * Write index entries only where a topic is discussed significantly. + For example, it is not useful to index "debugging information" in + a chapter on reporting bugs. Someone who wants to know about + debugging information will certainly not find it in that chapter. + + * Consistently capitalize the first word of every concept index + entry, or else consistently use lower case. Terse entries often + call for lower case; longer entries for capitalization. Whichever + case convention you use, please use one or the other consistently! + Mixing the two styles looks bad. + + * Always capitalize or use upper case for those words in an index for + which this is proper, such as names of countries or acronyms. + Always use the appropriate case for case-sensitive names, such as + those in C or Lisp. + + * Write the indexing commands that refer to a whole section + immediately after the section command, and write the indexing + commands that refer to the paragraph before the paragraph. + + In the example that follows, a blank line comes after the index + entry for "Leaping": + + @section The Dog and the Fox + @cindex Jumping, in general + @cindex Leaping + + @cindex Dog, lazy, jumped over + @cindex Lazy dog jumped over + @cindex Fox, jumps over dog + @cindex Quick fox jumps over dog + The quick brown fox jumps over the lazy dog. + + (Note that the example shows entries for the same concept that are + written in different ways--`Lazy dog', and `Dog, lazy'--so readers + can look up the concept in different ways.) + +Blank Lines +........... + + * Insert a blank line between a sectioning command and the first + following sentence or paragraph, or between the indexing commands + associated with the sectioning command and the first following + sentence or paragraph, as shown in the tip on indexing. + Otherwise, a formatter may fold title and paragraph together. + + * Always insert a blank line before an `@table' command and after an + `@end table' command; but never insert a blank line after an + `@table' command or before an `@end table' command. + + For example, + + Types of fox: + + @table @samp + @item Quick + Jump over lazy dogs. + + @item Brown + Also jump over lazy dogs. + @end table + @noindent + On the other hand, ... + + Insert blank lines before and after `@itemize' ... `@end itemize' + and `@enumerate' ... `@end enumerate' in the same way. + +Complete Phrases +................ + + Complete phrases are easier to read than ... + + * Write entries in an itemized list as complete sentences; or at + least, as complete phrases. Incomplete expressions ... awkward + ... like this. + + * Write the prefatory sentence or phrase for a multi-item list or + table as a complete expression. Do not write "You can set:"; + instead, write "You can set these variables:". The former + expression sounds cut off. + +Editions, Dates and Versions +............................ + + Write the edition and version numbers and date in three places in +every manual: + + 1. In the first `@ifinfo' section, for people reading the Texinfo + file. + + 2. In the `@titlepage' section, for people reading the printed manual. + + 3. In the `Top' node, for people reading the Info file. + +Also, it helps to write a note before the first `@ifinfo' section to +explain what you are doing. + +For example: + + @c ===> NOTE! <== + @c Specify the edition and version numbers and date + @c in *three* places: + @c 1. First ifinfo section 2. title page 3. top node + @c To find the locations, search for !!set + + @ifinfo + @c !!set edition, date, version + This is Edition 4.03, January 1992, + of the @cite{GDB Manual} for GDB Version 4.3. + ... + +--or use `@set' and `@value' (*note `@value' Example: value Example.). + +Definition Commands +................... + + Definition commands are `@deffn', `@defun', `@defmac', and the like, +and enable you to write descriptions in a uniform format. + + * Write just one definition command for each entity you define with a + definition command. The automatic indexing feature creates an + index entry that leads the reader to the definition. + + * Use `@table' ... `@end table' in an appendix that contains a + summary of functions, not `@deffn' or other definition commands. + +Capitalization +.............. + + * Capitalize "Texinfo"; it is a name. Do not write the `x' or `i' + in upper case. + + * Capitalize "Info"; it is a name. + + * Write TeX using the `@TeX{}' command. Note the uppercase `T' and + `X'. This command causes the formatters to typeset the name + according to the wishes of Donald Knuth, who wrote TeX. + +Spaces +...... + + Do not use spaces to format a Texinfo file, except inside of +`@example' ... `@end example' and similar commands. + + For example, TeX fills the following: + + @kbd{C-x v} + @kbd{M-x vc-next-action} + Perform the next logical operation + on the version-controlled file + corresponding to the current buffer. + +so it looks like this: + + `C-x v' `M-x vc-next-action' Perform the next logical operation on + the version-controlled file corresponding to the current buffer. + +In this case, the text should be formatted with `@table', `@item', and +`@itemx', to create a table. + +@code, @samp, @var, and `---' +............................. + + * Use `@code' around Lisp symbols, including command names. For + example, + + The main function is @code{vc-next-action}, ... + + * Avoid putting letters such as `s' immediately after an `@code'. + Such letters look bad. + + * Use `@var' around meta-variables. Do not write angle brackets + around them. + + * Use three hyphens in a row, `---', to indicate a long dash. TeX + typesets these as a long dash and the Info formatters reduce three + hyphens to two. + +Periods Outside of Quotes +......................... + + Place periods and other punctuation marks _outside_ of quotations, +unless the punctuation is part of the quotation. This practice goes +against publishing conventions in the United States, but enables the +reader to distinguish between the contents of the quotation and the +whole passage. + + For example, you should write the following sentence with the period +outside the end quotation marks: + + Evidently, `au' is an abbreviation for ``author''. + +since `au' does _not_ serve as an abbreviation for `author.' (with a +period following the word). + +Introducing New Terms +..................... + + * Introduce new terms so that a reader who does not know them can + understand them from context; or write a definition for the term. + + For example, in the following, the terms "check in", "register" and + "delta" are all appearing for the first time; the example sentence + should be rewritten so they are understandable. + + The major function assists you in checking in a file to your + version control system and registering successive sets of + changes to it as deltas. + + * Use the `@dfn' command around a word being introduced, to indicate + that the reader should not expect to know the meaning already, and + should expect to learn the meaning from this passage. + +@pxref +...... + + Absolutely never use `@pxref' except in the special context for which +it is designed: inside parentheses, with the closing parenthesis +following immediately after the closing brace. One formatter +automatically inserts closing punctuation and the other does not. This +means that the output looks right both in printed output and in an Info +file, but only when the command is used inside parentheses. + +Invoking from a Shell +..................... + + You can invoke programs such as Emacs, GCC, and `gawk' from a shell. +The documentation for each program should contain a section that +describes this. Unfortunately, if the node names and titles for these +sections are all different, readers find it hard to search for the +section. + + Name such sections with a phrase beginning with the word +`Invoking ...', as in `Invoking Emacs'; this way users can find the +section easily. + +ANSI C Syntax +............. + + When you use `@example' to describe a C function's calling +conventions, use the ANSI C syntax, like this: + + void dld_init (char *@var{path}); + +And in the subsequent discussion, refer to the argument values by +writing the same argument names, again highlighted with `@var'. + + Avoid the obsolete style that looks like this: + + #include + + dld_init (path) + char *path; + + Also, it is best to avoid writing `#include' above the declaration +just to indicate that the function is declared in a header file. The +practice may give the misimpression that the `#include' belongs near +the declaration of the function. Either state explicitly which header +file holds the declaration or, better yet, name the header file used +for a group of functions at the beginning of the section that describes +the functions. + +Bad Examples +............ + + Here are several examples of bad writing to avoid: + + In this example, say, " ... you must `@dfn'{check in} the new +version." That flows better. + + When you are done editing the file, you must perform a + `@dfn'{check in}. + + In the following example, say, "... makes a unified interface such as +VC mode possible." + + SCCS, RCS and other version-control systems all perform similar + functions in broadly similar ways (it is this resemblance which + makes a unified control mode like this possible). + + And in this example, you should specify what `it' refers to: + + If you are working with other people, it assists in coordinating + everyone's changes so they do not step on each other. + +And Finally ... +............... + + * Pronounce TeX as if the `X' were a Greek `chi', as the last sound + in the name `Bach'. But pronounce Texinfo as in `speck': + "teckinfo". + + * Write notes for yourself at the very end of a Texinfo file after + the `@bye'. None of the formatters process text after the `@bye'; + it is as if the text were within `@ignore' ... `@end ignore'. + + +File: texinfo.info, Node: Sample Texinfo File, Next: Sample Permissions, Prev: Tips, Up: Top + +A Sample Texinfo File +********************* + + Here is a complete, short sample Texinfo file, without any commentary. +You can see this file, with comments, in the first chapter. *Note A +Short Sample Texinfo File: Short Sample. + + + \input texinfo @c -*-texinfo-*- + @c %**start of header + @setfilename sample.info + @settitle Sample Document + @c %**end of header + + @setchapternewpage odd + + @ifinfo + This is a short example of a complete Texinfo file. + + Copyright 1990 Free Software Foundation, Inc. + @end ifinfo + + @titlepage + @sp 10 + @comment The title is printed in a large font. + @center @titlefont{Sample Title} + + @c The following two commands start the copyright page. + @page + @vskip 0pt plus 1filll + Copyright @copyright{} 1990 Free Software Foundation, Inc. + @end titlepage + + @node Top, First Chapter, , (dir) + @comment node-name, next, previous, up + + @menu + * First Chapter:: The first chapter is the + only chapter in this sample. + * Concept Index:: This index has two entries. + @end menu + + @node First Chapter, Concept Index, Top, Top + @comment node-name, next, previous, up + @chapter First Chapter + @cindex Sample index entry + + This is the contents of the first chapter. + @cindex Another sample index entry + + Here is a numbered list. + + @enumerate + @item + This is the first item. + + @item + This is the second item. + @end enumerate + + The @code{makeinfo} and @code{texinfo-format-buffer} + commands transform a Texinfo file such as this into + an Info file; and @TeX{} typesets it for a printed + manual. + + @node Concept Index, , First Chapter, Top + @comment node-name, next, previous, up + @unnumbered Concept Index + + @printindex cp + + @contents + @bye + + +File: texinfo.info, Node: Sample Permissions, Next: Include Files, Prev: Sample Texinfo File, Up: Top + +Sample Permissions +****************** + + Texinfo files should contain sections that tell the readers that they +have the right to copy and distribute the Texinfo file, the Info file, +and the printed manual. + + Also, if you are writing a manual about software, you should explain +that the software is free and either include the GNU General Public +License (GPL) or provide a reference to it. *Note Distribution: +(xemacs)Distrib, for an example of the text that could be used in the +software "Distribution", "General Public License", and "NO WARRANTY" +sections of a document. *Note Texinfo Copying Conditions: Copying, for +an example of a brief explanation of how the copying conditions provide +you with rights. + +* Menu: + +* Inserting Permissions:: How to put permissions in your document. +* ifinfo Permissions:: Sample `ifinfo' copying permissions. +* Titlepage Permissions:: Sample Titlepage copying permissions. + + +File: texinfo.info, Node: Inserting Permissions, Next: ifinfo Permissions, Prev: Sample Permissions, Up: Sample Permissions + +Inserting Permissions +===================== + + In a Texinfo file, the first `@ifinfo' section usually begins with a +line that says what the file documents. This is what a person reading +the unprocessed Texinfo file or using the advanced Info command `g *' +sees first. *note Advanced Info commands: (info)Expert, for more +information. (A reader using the regular Info commands usually starts +reading at the first node and skips this first section, which is not in +a node.) + + In the `@ifinfo' section, the summary sentence is followed by a +copyright notice and then by the copying permission notice. One of the +copying permission paragraphs is enclosed in `@ignore' and `@end +ignore' commands. This paragraph states that the Texinfo file can be +processed through TeX and printed, provided the printed manual carries +the proper copying permission notice. This paragraph is not made part +of the Info file since it is not relevant to the Info file; but it is a +mandatory part of the Texinfo file since it permits people to process +the Texinfo file in TeX and print the results. + + In the printed manual, the Free Software Foundation copying permission +notice follows the copyright notice and publishing information and is +located within the region delineated by the `@titlepage' and `@end +titlepage' commands. The copying permission notice is exactly the same +as the notice in the `@ifinfo' section except that the paragraph +enclosed in `@ignore' and `@end ignore' commands is not part of the +notice. + + To make it simple to insert a permission notice into each section of +the Texinfo file, sample permission notices for each section are +reproduced in full below. + + Note that you may need to specify the correct name of a section +mentioned in the permission notice. For example, in `The GDB Manual', +the name of the section referring to the General Public License is +called the "GDB General Public License", but in the sample shown below, +that section is referred to generically as the "GNU General Public +License". If the Texinfo file does not carry a copy of the General +Public License, leave out the reference to it, but be sure to include +the rest of the sentence. + + +File: texinfo.info, Node: ifinfo Permissions, Next: Titlepage Permissions, Prev: Inserting Permissions, Up: Sample Permissions + +`ifinfo' Copying Permissions +============================ + + In the `@ifinfo' section of a Texinfo file, the standard Free +Software Foundation permission notice reads as follows: + + This file documents ... + + Copyright 1998 Free Software Foundation, Inc. + + Permission is granted to make and distribute verbatim + copies of this manual provided the copyright notice and + this permission notice are preserved on all copies. + + @ignore + Permission is granted to process this file through TeX + and print the results, provided the printed document + carries a copying permission notice identical to this + one except for the removal of this paragraph (this + paragraph not being relevant to the printed manual). + + @end ignore + Permission is granted to copy and distribute modified + versions of this manual under the conditions for + verbatim copying, provided also that the sections + entitled ``Copying'' and ``GNU General Public License'' + are included exactly as in the original, and provided + that the entire resulting derived work is distributed + under the terms of a permission notice identical to this + one. + + Permission is granted to copy and distribute + translations of this manual into another language, + under the above conditions for modified versions, + except that this permission notice may be stated in a + translation approved by the Free Software Foundation. + + +File: texinfo.info, Node: Titlepage Permissions, Prev: ifinfo Permissions, Up: Sample Permissions + +Titlepage Copying Permissions +============================= + + In the `@titlepage' section of a Texinfo file, the standard Free +Software Foundation copying permission notice follows the copyright +notice and publishing information. The standard phrasing is as follows: + + Permission is granted to make and distribute verbatim + copies of this manual provided the copyright notice and + this permission notice are preserved on all copies. + + Permission is granted to copy and distribute modified + versions of this manual under the conditions for + verbatim copying, provided also that the sections + entitled ``Copying'' and ``GNU General Public License'' + are included exactly as in the original, and provided + that the entire resulting derived work is distributed + under the terms of a permission notice identical to this + one. + + Permission is granted to copy and distribute + translations of this manual into another language, + under the above conditions for modified versions, + except that this permission notice may be stated in a + translation approved by the Free Software Foundation. + + +File: texinfo.info, Node: Include Files, Next: Headings, Prev: Sample Permissions, Up: Top + +Include Files +************* + + When TeX or an Info formatting command sees an `@include' command in +a Texinfo file, it processes the contents of the file named by the +command and incorporates them into the DVI or Info file being created. +Index entries from the included file are incorporated into the indices +of the output file. + + Include files let you keep a single large document as a collection of +conveniently small parts. + +* Menu: + +* Using Include Files:: How to use the `@include' command. +* texinfo-multiple-files-update:: How to create and update nodes and + menus when using included files. +* Include File Requirements:: What `texinfo-multiple-files-update' expects. +* Sample Include File:: A sample outer file with included files + within it; and a sample included file. +* Include Files Evolution:: How use of the `@include' command + has changed over time. + + +File: texinfo.info, Node: Using Include Files, Next: texinfo-multiple-files-update, Prev: Include Files, Up: Include Files + +How to Use Include Files +======================== + + To include another file within a Texinfo file, write the `@include' +command at the beginning of a line and follow it on the same line by +the name of a file to be included. For example: + + @include buffers.texi + + An included file should simply be a segment of text that you expect to +be included as is into the overall or "outer" Texinfo file; it should +not contain the standard beginning and end parts of a Texinfo file. In +particular, you should not start an included file with a line saying +`\input texinfo'; if you do, that phrase is inserted into the output +file as is. Likewise, you should not end an included file with an +`@bye' command; nothing after `@bye' is formatted. + + In the past, you were required to write an `@setfilename' line at the +beginning of an included file, but no longer. Now, it does not matter +whether you write such a line. If an `@setfilename' line exists in an +included file, it is ignored. + + Conventionally, an included file begins with an `@node' line that is +followed by an `@chapter' line. Each included file is one chapter. +This makes it easy to use the regular node and menu creating and +updating commands to create the node pointers and menus within the +included file. However, the simple Emacs node and menu creating and +updating commands do not work with multiple Texinfo files. Thus you +cannot use these commands to fill in the `Next', `Previous', and `Up' +pointers of the `@node' line that begins the included file. Also, you +cannot use the regular commands to create a master menu for the whole +file. Either you must insert the menus and the `Next', `Previous', and +`Up' pointers by hand, or you must use the GNU Emacs Texinfo mode +command, `texinfo-multiple-files-update', that is designed for +`@include' files. + + +File: texinfo.info, Node: texinfo-multiple-files-update, Next: Include File Requirements, Prev: Using Include Files, Up: Include Files + +`texinfo-multiple-files-update' +=============================== + + GNU Emacs Texinfo mode provides the `texinfo-multiple-files-update' +command. This command creates or updates `Next', `Previous', and `Up' +pointers of included files as well as those in the outer or overall +Texinfo file, and it creates or updates a main menu in the outer file. +Depending whether you call it with optional arguments, the command +updates only the pointers in the first `@node' line of the included +files or all of them: + +`M-x texinfo-multiple-files-update' + Called without any arguments: + + - Create or update the `Next', `Previous', and `Up' pointers of + the first `@node' line in each file included in an outer or + overall Texinfo file. + + - Create or update the `Top' level node pointers of the outer or + overall file. + + - Create or update a main menu in the outer file. + +`C-u M-x texinfo-multiple-files-update' + Called with `C-u' as a prefix argument: + + - Create or update pointers in the first `@node' line in each + included file. + + - Create or update the `Top' level node pointers of the outer + file. + + - Create and insert a master menu in the outer file. The + master menu is made from all the menus in all the included + files. + +`C-u 8 M-x texinfo-multiple-files-update' + Called with a numeric prefix argument, such as `C-u 8': + + - Create or update *all* the `Next', `Previous', and `Up' + pointers of all the included files. + + - Create or update *all* the menus of all the included files. + + - Create or update the `Top' level node pointers of the outer or + overall file. + + - And then create a master menu in the outer file. This is + similar to invoking `texinfo-master-menu' with an argument + when you are working with just one file. + + Note the use of the prefix argument in interactive use: with a regular +prefix argument, just `C-u', the `texinfo-multiple-files-update' +command inserts a master menu; with a numeric prefix argument, such as +`C-u 8', the command updates *every* pointer and menu in *all* the +files and then inserts a master menu. + + +File: texinfo.info, Node: Include File Requirements, Next: Sample Include File, Prev: texinfo-multiple-files-update, Up: Include Files + +Include File Requirements +========================= + + If you plan to use the `texinfo-multiple-files-update' command, the +outer Texinfo file that lists included files within it should contain +nothing but the beginning and end parts of a Texinfo file, and a number +of `@include' commands listing the included files. It should not even +include indices, which should be listed in an included file of their +own. + + Moreover, each of the included files must contain exactly one highest +level node (conventionally, `@chapter' or equivalent), and this node +must be the first node in the included file. Furthermore, each of +these highest level nodes in each included file must be at the same +hierarchical level in the file structure. Usually, each is an +`@chapter', an `@appendix', or an `@unnumbered' node. Thus, normally, +each included file contains one, and only one, chapter or +equivalent-level node. + + The outer file should contain only _one_ node, the `Top' node. It +should _not_ contain any nodes besides the single `Top' node. The +`texinfo-multiple-files-update' command will not process them. + + +File: texinfo.info, Node: Sample Include File, Next: Include Files Evolution, Prev: Include File Requirements, Up: Include Files + +Sample File with `@include' +=========================== + + Here is an example of a complete outer Texinfo file with `@include' +files within it before running `texinfo-multiple-files-update', which +would insert a main or master menu: + + \input texinfo @c -*-texinfo-*- + @setfilename include-example.info + @settitle Include Example + + @setchapternewpage odd + @titlepage + @sp 12 + @center @titlefont{Include Example} + @sp 2 + @center by Whom Ever + + @page + @vskip 0pt plus 1filll + Copyright @copyright{} 1998 Free Software Foundation, Inc. + @end titlepage + + @ifinfo + @node Top, First, , (dir) + @top Master Menu + @end ifinfo + + @include foo.texinfo + @include bar.texinfo + @include concept-index.texinfo + + @summarycontents + @contents + + @bye + + An included file, such as `foo.texinfo', might look like this: + + @node First, Second, , Top + @chapter First Chapter + + Contents of first chapter ... + + The full contents of `concept-index.texinfo' might be as simple as +this: + + @node Concept Index, , Second, Top + @unnumbered Concept Index + + @printindex cp + + The outer Texinfo source file for `The XEmacs Lisp Reference Manual' +is named `elisp.texi'. This outer file contains a master menu with 417 +entries and a list of 41 `@include' files. + + +File: texinfo.info, Node: Include Files Evolution, Prev: Sample Include File, Up: Include Files + +Evolution of Include Files +========================== + + When Info was first created, it was customary to create many small +Info files on one subject. Each Info file was formatted from its own +Texinfo source file. This custom meant that Emacs did not need to make +a large buffer to hold the whole of a large Info file when someone +wanted information; instead, Emacs allocated just enough memory for the +small Info file that contained the particular information sought. This +way, Emacs could avoid wasting memory. + + References from one file to another were made by referring to the file +name as well as the node name. (*Note Referring to Other Info Files: +Other Info Files. Also, see *Note `@xref' with Four and Five +Arguments: Four and Five Arguments.) + + Include files were designed primarily as a way to create a single, +large printed manual out of several smaller Info files. In a printed +manual, all the references were within the same document, so TeX could +automatically determine the references' page numbers. The Info +formatting commands used include files only for creating joint indices; +each of the individual Texinfo files had to be formatted for Info +individually. (Each, therefore, required its own `@setfilename' line.) + + However, because large Info files are now split automatically, it is +no longer necessary to keep them small. + + Nowadays, multiple Texinfo files are used mostly for large documents, +such as `The XEmacs Lisp Reference Manual', and for projects in which +several different people write different sections of a document +simultaneously. + + In addition, the Info formatting commands have been extended to work +with the `@include' command so as to create a single large Info file +that is split into smaller files if necessary. This means that you can +write menus and cross references without naming the different Texinfo +files. + + +File: texinfo.info, Node: Headings, Next: Catching Mistakes, Prev: Include Files, Up: Top + +Page Headings +************* + + Most printed manuals contain headings along the top of every page +except the title and copyright pages. Some manuals also contain +footings. (Headings and footings have no meaning to Info, which is not +paginated.) + +* Menu: + +* Headings Introduced:: Conventions for using page headings. +* Heading Format:: Standard page heading formats. +* Heading Choice:: How to specify the type of page heading. +* Custom Headings:: How to create your own headings and footings. + + +File: texinfo.info, Node: Headings Introduced, Next: Heading Format, Prev: Headings, Up: Headings + +Headings Introduced +=================== + + Texinfo provides standard page heading formats for manuals that are +printed on one side of each sheet of paper and for manuals that are +printed on both sides of the paper. Typically, you will use these +formats, but you can specify your own format if you wish. + + In addition, you can specify whether chapters should begin on a new +page, or merely continue the same page as the previous chapter; and if +chapters begin on new pages, you can specify whether they must be +odd-numbered pages. + + By convention, a book is printed on both sides of each sheet of paper. +When you open a book, the right-hand page is odd-numbered, and chapters +begin on right-hand pages--a preceding left-hand page is left blank if +necessary. Reports, however, are often printed on just one side of +paper, and chapters begin on a fresh page immediately following the end +of the preceding chapter. In short or informal reports, chapters often +do not begin on a new page at all, but are separated from the preceding +text by a small amount of whitespace. + + The `@setchapternewpage' command controls whether chapters begin on +new pages, and whether one of the standard heading formats is used. In +addition, Texinfo has several heading and footing commands that you can +use to generate your own heading and footing formats. + + In Texinfo, headings and footings are single lines at the tops and +bottoms of pages; you cannot create multiline headings or footings. +Each header or footer line is divided into three parts: a left part, a +middle part, and a right part. Any part, or a whole line, may be left +blank. Text for the left part of a header or footer line is set +flushleft; text for the middle part is centered; and, text for the +right part is set flushright. + + +File: texinfo.info, Node: Heading Format, Next: Heading Choice, Prev: Headings Introduced, Up: Headings + +Standard Heading Formats +======================== + + Texinfo provides two standard heading formats, one for manuals printed +on one side of each sheet of paper, and the other for manuals printed +on both sides of the paper. + + By default, nothing is specified for the footing of a Texinfo file, +so the footing remains blank. + + The standard format for single-sided printing consists of a header +line in which the left-hand part contains the name of the chapter, the +central part is blank, and the right-hand part contains the page number. + + A single-sided page looks like this: + + _______________________ + | | + | chapter page number | + | | + | Start of text ... | + | ... | + | | + + The standard format for two-sided printing depends on whether the page +number is even or odd. By convention, even-numbered pages are on the +left- and odd-numbered pages are on the right. (TeX will adjust the +widths of the left- and right-hand margins. Usually, widths are +correct, but during double-sided printing, it is wise to check that +pages will bind properly--sometimes a printer will produce output in +which the even-numbered pages have a larger right-hand margin than the +odd-numbered pages.) + + In the standard double-sided format, the left part of the left-hand +(even-numbered) page contains the page number, the central part is +blank, and the right part contains the title (specified by the +`@settitle' command). The left part of the right-hand (odd-numbered) +page contains the name of the chapter, the central part is blank, and +the right part contains the page number. + + Two pages, side by side as in an open book, look like this: + + _______________________ _______________________ + | | | | + | page number title | | chapter page number | + | | | | + | Start of text ... | | More text ... | + | ... | | ... | + | | | | + +The chapter name is preceded by the word "Chapter", the chapter number +and a colon. This makes it easier to keep track of where you are in the +manual. + + +File: texinfo.info, Node: Heading Choice, Next: Custom Headings, Prev: Heading Format, Up: Headings + +Specifying the Type of Heading +============================== + + TeX does not begin to generate page headings for a standard Texinfo +file until it reaches the `@end titlepage' command. Thus, the title +and copyright pages are not numbered. The `@end titlepage' command +causes TeX to begin to generate page headings according to a standard +format specified by the `@setchapternewpage' command that precedes the +`@titlepage' section. + + There are four possibilities: + +No `@setchapternewpage' command + Cause TeX to specify the single-sided heading format, with chapters + on new pages. This is the same as `@setchapternewpage on'. + +`@setchapternewpage on' + Specify the single-sided heading format, with chapters on new + pages. + +`@setchapternewpage off' + Cause TeX to start a new chapter on the same page as the last page + of the preceding chapter, after skipping some vertical whitespace. + Also cause TeX to typeset for single-sided printing. (You can + override the headers format with the `@headings double' command; + see *Note The `@headings' Command: headings on off.) + +`@setchapternewpage odd' + Specify the double-sided heading format, with chapters on new + pages. + +Texinfo lacks an `@setchapternewpage even' command. + + +File: texinfo.info, Node: Custom Headings, Prev: Heading Choice, Up: Headings + +How to Make Your Own Headings +============================= + + You can use the standard headings provided with Texinfo or specify +your own. By default, Texinfo has no footers, so if you specify them, +the available page size for the main text will be slightly reduced. + + Texinfo provides six commands for specifying headings and footings. +The `@everyheading' command and `@everyfooting' command generate page +headers and footers that are the same for both even- and odd-numbered +pages. The `@evenheading' command and `@evenfooting' command generate +headers and footers for even-numbered (left-hand) pages; and the +`@oddheading' command and `@oddfooting' command generate headers and +footers for odd-numbered (right-hand) pages. + + Write custom heading specifications in the Texinfo file immediately +after the `@end titlepage' command. Enclose your specifications +between `@iftex' and `@end iftex' commands since the +`texinfo-format-buffer' command may not recognize them. Also, you must +cancel the predefined heading commands with the `@headings off' command +before defining your own specifications. + + Here is how to tell TeX to place the chapter name at the left, the +page number in the center, and the date at the right of every header +for both even- and odd-numbered pages: + + @iftex + @headings off + @everyheading @thischapter @| @thispage @| @today{} + @end iftex + +You need to divide the left part from the central part and the central +part from the right part by inserting `@|' between parts. Otherwise, +the specification command will not be able to tell where the text for +one part ends and the next part begins. + + Each part can contain text or @-commands. The text is printed as if +the part were within an ordinary paragraph in the body of the page. +The @-commands replace themselves with the page number, date, chapter +name, or whatever. + + Here are the six heading and footing commands: + +`@everyheading LEFT @| CENTER @| RIGHT' +`@everyfooting LEFT @| CENTER @| RIGHT' + The `every' commands specify the format for both even- and + odd-numbered pages. These commands are for documents that are + printed on one side of each sheet of paper, or for documents in + which you want symmetrical headers or footers. + +`@evenheading LEFT @| CENTER @| RIGHT' +`@oddheading LEFT @| CENTER @| RIGHT' +`@evenfooting LEFT @| CENTER @| RIGHT' +`@oddfooting LEFT @| CENTER @| RIGHT' + The `even' and `odd' commands specify the format for even-numbered + pages and odd-numbered pages. These commands are for books and + manuals that are printed on both sides of each sheet of paper. + + Use the `@this...' series of @-commands to provide the names of +chapters and sections and the page number. You can use the `@this...' +commands in the left, center, or right portions of headers and footers, +or anywhere else in a Texinfo file so long as they are between `@iftex' +and `@end iftex' commands. + + Here are the `@this...' commands: -`@thischapter' -`@thischaptername' -`@thisfile' `@thispage' + Expands to the current page number. + +`@thischaptername' + Expands to the name of the current chapter. + +`@thischapter' + Expands to the number and name of the current chapter, in the + format `Chapter 1: Title'. + `@thistitle' - Only allowed in a heading or footing. Stands for the number and - name of the current chapter (in the format `Chapter 1: Title'), - the chapter name only, the filename, the current page number, and - the title of the document, respectively. *Note How to Make Your - Own Headings: Custom Headings. - -`@tieaccent{CC}' - Generate a tie-after accent over the next two characters CC, as in - `oo['. *Note Inserting Accents::. - -`@tindex ENTRY' - Add ENTRY to the index of data types. *Note Defining the Entries - of an Index: Index Entries. - -`@title TITLE' - In a printed manual, set a title flush to the left-hand side of the - page in a larger than normal font and underline it with a black - rule. Not relevant to Info, which does not have title pages. - *Note The `@title' `@subtitle' and `@author' Commands: title - subtitle author. - -`@titlefont{TEXT}' - In a printed manual, print TEXT in a larger than normal font. Not - relevant to Info, which does not have title pages. *Note The - `@titlefont' `@center' and `@sp' Commands: titlefont center sp. - -`@titlepage' - Indicate to Texinfo the beginning of the title page. Write - command on a line of its own. Pair with `@end titlepage'. - Nothing between `@titlepage' and `@end titlepage' appears in Info. - *Note `@titlepage': titlepage. - -`@today{}' - Insert the current date, in `1 Jan 1900' style. *Note How to Make - Your Own Headings: Custom Headings. - -`@top TITLE' - In a Texinfo file to be formatted with `makeinfo', identify the - topmost `@node' line in the file, which must be written on the line - immediately preceding the `@top' command. Used for `makeinfo''s - node pointer insertion feature. The title is underlined with - asterisks. Both the `@node' line and the `@top' line normally - should be enclosed by `@ifinfo' and `@end ifinfo'. In TeX and - `texinfo-format-buffer', the `@top' command is merely a synonym - for `@unnumbered'. *Note Creating Pointers with `makeinfo': - makeinfo Pointer Creation. - -`@u{C}' -`@ubaraccent{C}' -`@udotaccent{C}' - Generate a breve, underbar, or underdot accent, respectively, over - or under the character C, as in o(, o_, .o. *Note Inserting - Accents::. - -`@unnumbered TITLE' - In a printed manual, begin a chapter that appears without chapter - numbers of any kind. The title appears in the table of contents - of a printed manual. In Info, the title is underlined with - asterisks. *Note `@unnumbered' and `@appendix': unnumbered & - appendix. - -`@unnumberedsec TITLE' - In a printed manual, begin a section that appears without section - numbers of any kind. The title appears in the table of contents - of a printed manual. In Info, the title is underlined with equal - signs. *Note Section Commands: unnumberedsec appendixsec heading. - -`@unnumberedsubsec TITLE' - In a printed manual, begin an unnumbered subsection within a - chapter. The title appears in the table of contents of a printed - manual. In Info, the title is underlined with hyphens. *Note - `@unnumberedsubsec' `@appendixsubsec' `@subheading': - unnumberedsubsec appendixsubsec subheading. - -`@unnumberedsubsubsec TITLE' - In a printed manual, begin an unnumbered subsubsection within a - chapter. The title appears in the table of contents of a printed - manual. In Info, the title is underlined with periods. *Note The - `subsub' Commands: subsubsection. - -`@uref{URL[, DISPLAYED-TEXT][, REPLACEMENT}' - Define a cross reference to an external uniform resource locator - for the World Wide Web. *Note `@uref': uref. - -`@url{URL}' - Indicate text that is a uniform resource locator for the World Wide - Web. *Note `@url': url. - -`@v{C}' - Generate check accent over the character C, as in o<. *Note - Inserting Accents::. - -`@value{FLAG}' - Replace FLAG with the value to which it is set by `@set FLAG'. - *Note `@set' `@clear' `@value': set clear value. - -`@var{METASYNTACTIC-VARIABLE}' - Highlight a metasyntactic variable, which is something that stands - for another piece of text. *Note Indicating Metasyntactic - Variables: var. - -`@vindex ENTRY' - Add ENTRY to the index of variables. *Note Defining the Entries - of an Index: Index Entries. - -`@vskip AMOUNT' - In a printed manual, insert whitespace so as to push text on the - remainder of the page towards the bottom of the page. Used in - formatting the copyright page with the argument `0pt plus 1filll'. - (Note spelling of `filll'.) `@vskip' may be used only in - contexts ignored for Info. *Note The Copyright Page and Printed - Permissions: Copyright & Permissions. - -`@vtable FORMATTING-COMMAND' - Begin a two-column table, using `@item' for each entry. - Automatically enter each of the items in the first column into the - index of variables. Pair with `@end vtable'. The same as - `@table', except for indexing. *Note `@ftable' and `@vtable': - ftable vtable. - -`@w{TEXT}' - Prevent TEXT from being split across two lines. Do not end a - paragraph that uses `@w' with an `@refill' command. *Note `@w': w. - -`@xref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' - Make a reference that starts with `See' in a printed manual. - Follow command with a punctuation mark. Only the first argument is - mandatory. *Note `@xref': xref. + Expands to the name of the document, as specified by the + `@settitle' command. + +`@thisfile' + For `@include' files only: expands to the name of the current + `@include' file. If the current Texinfo source file is not an + `@include' file, this command has no effect. This command does + _not_ provide the name of the current Texinfo source file unless + it is an `@include' file. (*Note Include Files::, for more + information about `@include' files.) + +You can also use the `@today{}' command, which expands to the current +date, in `1 Jan 1900' format. + + Other @-commands and text are printed in a header or footer just as +if they were in the body of a page. It is useful to incorporate text, +particularly when you are writing drafts: + + @iftex + @headings off + @everyheading @emph{Draft!} @| @thispage @| @thischapter + @everyfooting @| @| Version: 0.27: @today{} + @end iftex + + Beware of overlong titles: they may overlap another part of the +header or footer and blot it out. + + +File: texinfo.info, Node: Catching Mistakes, Next: Refilling Paragraphs, Prev: Headings, Up: Top + +Formatting Mistakes +******************* + + Besides mistakes in the content of your documentation, there are two +kinds of mistake you can make with Texinfo: you can make mistakes with +@-commands, and you can make mistakes with the structure of the nodes +and chapters. + + Emacs has two tools for catching the @-command mistakes and two for +catching structuring mistakes. + + For finding problems with @-commands, you can run TeX or a region +formatting command on the region that has a problem; indeed, you can +run these commands on each region as you write it. + + For finding problems with the structure of nodes and chapters, you +can use `C-c C-s' (`texinfo-show-structure') and the related `occur' +command and you can use the `M-x Info-validate' command. + +* Menu: + +* makeinfo Preferred:: `makeinfo' finds errors. +* Debugging with Info:: How to catch errors with Info formatting. +* Debugging with TeX:: How to catch errors with TeX formatting. +* Using texinfo-show-structure:: How to use `texinfo-show-structure'. +* Using occur:: How to list all lines containing a pattern. +* Running Info-Validate:: How to find badly referenced nodes. + + +File: texinfo.info, Node: makeinfo Preferred, Next: Debugging with Info, Prev: Catching Mistakes, Up: Catching Mistakes + +`makeinfo' Find Errors +====================== + + The `makeinfo' program does an excellent job of catching errors and +reporting them--far better than `texinfo-format-region' or +`texinfo-format-buffer'. In addition, the various functions for +automatically creating and updating node pointers and menus remove many +opportunities for human error. + + If you can, use the updating commands to create and insert pointers +and menus. These prevent many errors. Then use `makeinfo' (or its +Texinfo mode manifestations, `makeinfo-region' and `makeinfo-buffer') +to format your file and check for other errors. This is the best way +to work with Texinfo. But if you cannot use `makeinfo', or your +problem is very puzzling, then you may want to use the tools described +in this appendix. + + +File: texinfo.info, Node: Debugging with Info, Next: Debugging with TeX, Prev: makeinfo Preferred, Up: Catching Mistakes + +Catching Errors with Info Formatting +==================================== + + After you have written part of a Texinfo file, you can use the +`texinfo-format-region' or the `makeinfo-region' command to see whether +the region formats properly. + + Most likely, however, you are reading this section because for some +reason you cannot use the `makeinfo-region' command; therefore, the +rest of this section presumes that you are using +`texinfo-format-region'. + + If you have made a mistake with an @-command, `texinfo-format-region' +will stop processing at or after the error and display an error +message. To see where in the buffer the error occurred, switch to the +`*Info Region*' buffer; the cursor will be in a position that is after +the location of the error. Also, the text will not be formatted after +the place where the error occurred (or more precisely, where it was +detected). + + For example, if you accidentally end a menu with the command `@end +menus' with an `s' on the end, instead of with `@end menu', you will +see an error message that says: + + @end menus is not handled by texinfo + +The cursor will stop at the point in the buffer where the error occurs, +or not long after it. The buffer will look like this: + + ---------- Buffer: *Info Region* ---------- + * Menu: + + * Using texinfo-show-structure:: How to use + `texinfo-show-structure' + to catch mistakes. + * Running Info-Validate:: How to check for + unreferenced nodes. + @end menus + -!- + ---------- Buffer: *Info Region* ---------- + + The `texinfo-format-region' command sometimes provides slightly odd +error messages. For example, the following cross reference fails to +format: + + (@xref{Catching Mistakes, for more info.) + +In this case, `texinfo-format-region' detects the missing closing brace +but displays a message that says `Unbalanced parentheses' rather than +`Unbalanced braces'. This is because the formatting command looks for +mismatches between braces as if they were parentheses. + + Sometimes `texinfo-format-region' fails to detect mistakes. For +example, in the following, the closing brace is swapped with the +closing parenthesis: + + (@xref{Catching Mistakes), for more info.} + +Formatting produces: + (*Note for more info.: Catching Mistakes) + + The only way for you to detect this error is to realize that the +reference should have looked like this: + + (*Note Catching Mistakes::, for more info.) + + Incidentally, if you are reading this node in Info and type `f ' +(`Info-follow-reference'), you will generate an error message that says: + + No such node: "Catching Mistakes) The only way ... + +This is because Info perceives the example of the error as the first +cross reference in this node and if you type a immediately after +typing the Info `f' command, Info will attempt to go to the referenced +node. If you type `f catch ', Info will complete the node +name of the correctly written example and take you to the `Catching +Mistakes' node. (If you try this, you can return from the `Catching +Mistakes' node by typing `l' (`Info-last').) diff --git a/info/texinfo.info-11 b/info/texinfo.info-11 index 385b428..43fe115 100644 --- a/info/texinfo.info-11 +++ b/info/texinfo.info-11 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,1190 +33,817 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: Tips, Next: Sample Texinfo File, Prev: Command List, Up: Top +File: texinfo.info, Node: Debugging with TeX, Next: Using texinfo-show-structure, Prev: Debugging with Info, Up: Catching Mistakes -Tips and Hints -************** +Catching Errors with TeX Formatting +=================================== - Here are some tips for writing Texinfo documentation: + You can also catch mistakes when you format a file with TeX. - * Write in the present tense, not in the past or the future. + Usually, you will want to do this after you have run +`texinfo-format-buffer' (or, better, `makeinfo-buffer') on the same +file, because `texinfo-format-buffer' sometimes displays error messages +that make more sense than TeX. (*Note Debugging with Info::, for more +information.) - * Write actively! For example, write "We recommend that ..." rather - than "It is recommended that ...". + For example, TeX was run on a Texinfo file, part of which is shown +here: - * Use 70 or 72 as your fill column. Longer lines are hard to read. + ---------- Buffer: texinfo.texi ---------- + name of the Texinfo file as an extension. The + @samp{??} are `wildcards' that cause the shell to + substitute all the raw index files. (@xref{sorting + indices, for more information about sorting + indices.)@refill + ---------- Buffer: texinfo.texi ---------- - * Include a copyright notice and copying permissions. +(The cross reference lacks a closing brace.) TeX produced the +following output, after which it stopped: -Index, Index, Index! -.................... - - Write many index entries, in different ways. Readers like indices; -they are helpful and convenient. - - Although it is easiest to write index entries as you write the body of -the text, some people prefer to write entries afterwards. In either -case, write an entry before the paragraph to which it applies. This -way, an index entry points to the first page of a paragraph that is -split across pages. - - Here are more hints we have found valuable: - - * Write each index entry differently, so each entry refers to a - different place in the document. - - * Write index entries only where a topic is discussed significantly. - For example, it is not useful to index "debugging information" in - a chapter on reporting bugs. Someone who wants to know about - debugging information will certainly not find it in that chapter. - - * Consistently capitalize the first word of every concept index - entry, or else consistently use lower case. Terse entries often - call for lower case; longer entries for capitalization. Whichever - case convention you use, please use one or the other consistently! - Mixing the two styles looks bad. - - * Always capitalize or use upper case for those words in an index for - which this is proper, such as names of countries or acronyms. - Always use the appropriate case for case-sensitive names, such as - those in C or Lisp. - - * Write the indexing commands that refer to a whole section - immediately after the section command, and write the indexing - commands that refer to a paragraph before that paragraph. - - In the example that follows, a blank line comes after the index - entry for "Leaping": - - @section The Dog and the Fox - @cindex Jumping, in general - @cindex Leaping - - @cindex Dog, lazy, jumped over - @cindex Lazy dog jumped over - @cindex Fox, jumps over dog - @cindex Quick fox jumps over dog - The quick brown fox jumps over the lazy dog. - - (Note that the example shows entries for the same concept that are - written in different ways--`Lazy dog', and `Dog, lazy'--so readers - can look up the concept in different ways.) - -Blank Lines -........... - - * Insert a blank line between a sectioning command and the first - following sentence or paragraph, or between the indexing commands - associated with the sectioning command and the first following - sentence or paragraph, as shown in the tip on indexing. - Otherwise, a formatter may fold title and paragraph together. - - * Always insert a blank line before an `@table' command and after an - `@end table' command; but never insert a blank line after an - `@table' command or before an `@end table' command. - - For example, - - Types of fox: - - @table @samp - @item Quick - Jump over lazy dogs. - - @item Brown - Also jump over lazy dogs. - @end table - @noindent - On the other hand, ... - - Insert blank lines before and after `@itemize' ... `@end itemize' - and `@enumerate' ... `@end enumerate' in the same way. - -Complete Phrases -................ - - Complete phrases are easier to read than ... - - * Write entries in an itemized list as complete sentences; or at - least, as complete phrases. Incomplete expressions ... awkward - ... like this. - - * Write the prefatory sentence or phrase for a multi-item list or - table as a complete expression. Do not write "You can set:"; - instead, write "You can set these variables:". The former - expression sounds cut off. - -Editions, Dates and Versions -............................ - - Write the edition and version numbers and date in three places in -every manual: - - 1. In the first `@ifinfo' section, for people reading the Texinfo - file. - - 2. In the `@titlepage' section, for people reading the printed manual. - - 3. In the `Top' node, for people reading the Info file. - -Also, it helps to write a note before the first `@ifinfo' section to -explain what you are doing. - -For example: - - @c ===> NOTE! <== - @c Specify the edition and version numbers and date - @c in *three* places: - @c 1. First ifinfo section 2. title page 3. top node - @c To find the locations, search for !!set - - @ifinfo - @c !!set edition, date, version - This is Edition 4.03, January 1992, - of the @cite{GDB Manual} for GDB Version 4.3. - ... - ---or use `@set' and `@value' (*note `@value' Example: value Example.). - -Definition Commands -................... - - Definition commands are `@deffn', `@defun', `@defmac', and the like, -and enable you to write descriptions in a uniform format. - - * Write just one definition command for each entity you define with a - definition command. The automatic indexing feature creates an - index entry that leads the reader to the definition. - - * Use `@table' ... `@end table' in an appendix that contains a - summary of functions, not `@deffn' or other definition commands. - -Capitalization -.............. - - * Capitalize "Texinfo"; it is a name. Do not write the `x' or `i' - in upper case. - - * Capitalize "Info"; it is a name. - - * Write TeX using the `@TeX{}' command. Note the uppercase `T' and - `X'. This command causes the formatters to typeset the name - according to the wishes of Donald Knuth, who wrote TeX. - -Spaces -...... - - Do not use spaces to format a Texinfo file, except inside of -`@example' ... `@end example' and similar commands. - - For example, TeX fills the following: - - @kbd{C-x v} - @kbd{M-x vc-next-action} - Perform the next logical operation - on the version-controlled file - corresponding to the current buffer. - -so it looks like this: - - `C-x v' `M-x vc-next-action' Perform the next logical operation on - the version-controlled file corresponding to the current buffer. - -In this case, the text should be formatted with `@table', `@item', and -`@itemx', to create a table. - -@code, @samp, @var, and `---' -............................. - - * Use `@code' around Lisp symbols, including command names. For - example, - - The main function is @code{vc-next-action}, ... - - * Avoid putting letters such as `s' immediately after an `@code'. - Such letters look bad. - - * Use `@var' around meta-variables. Do not write angle brackets - around them. - - * Use three hyphens in a row, `---', to indicate a long dash. TeX - typesets these as a long dash and the Info formatters reduce three - hyphens to two. - -Periods Outside of Quotes -......................... - - Place periods and other punctuation marks _outside_ of quotations, -unless the punctuation is part of the quotation. This practice goes -against publishing conventions in the United States, but enables the -reader to distinguish between the contents of the quotation and the -whole passage. - - For example, you should write the following sentence with the period -outside the end quotation marks: - - Evidently, `au' is an abbreviation for ``author''. - -since `au' does _not_ serve as an abbreviation for `author.' (with a -period following the word). - -Introducing New Terms -..................... - - * Introduce new terms so that a reader who does not know them can - understand them from context; or write a definition for the term. - - For example, in the following, the terms "check in", "register" and - "delta" are all appearing for the first time; the example sentence - should be rewritten so they are understandable. - - The major function assists you in checking in a file to your - version control system and registering successive sets of - changes to it as deltas. - - * Use the `@dfn' command around a word being introduced, to indicate - that the reader should not expect to know the meaning already, and - should expect to learn the meaning from this passage. - -@pxref -...... - - Absolutely never use `@pxref' except in the special context for which -it is designed: inside parentheses, with the closing parenthesis -following immediately after the closing brace. One formatter -automatically inserts closing punctuation and the other does not. This -means that the output looks right both in printed output and in an Info -file, but only when the command is used inside parentheses. - -Invoking from a Shell -..................... - - You can invoke programs such as Emacs, GCC, and `gawk' from a shell. -The documentation for each program should contain a section that -describes this. Unfortunately, if the node names and titles for these -sections are all different, readers find it hard to search for the -section. - - Name such sections with a phrase beginning with the word -`Invoking ...', as in `Invoking Emacs'; this way users can find the -section easily. - -ANSI C Syntax -............. - - When you use `@example' to describe a C function's calling -conventions, use the ANSI C syntax, like this: - - void dld_init (char *@var{path}); - -And in the subsequent discussion, refer to the argument values by -writing the same argument names, again highlighted with `@var'. - - Avoid the obsolete style that looks like this: - - #include + ---------- Buffer: *tex-shell* ---------- + Runaway argument? + {sorting indices, for more information about sorting + indices.) @refill @ETC. + ! Paragraph ended before @xref was complete. + + @par + l.27 - dld_init (path) - char *path; + ? + ---------- Buffer: *tex-shell* ---------- - Also, it is best to avoid writing `#include' above the declaration -just to indicate that the function is declared in a header file. The -practice may give the misimpression that the `#include' belongs near -the declaration of the function. Either state explicitly which header -file holds the declaration or, better yet, name the header file used -for a group of functions at the beginning of the section that describes -the functions. + In this case, TeX produced an accurate and understandable error +message: -Bad Examples -............ + Paragraph ended before @xref was complete. - Here are several examples of bad writing to avoid: +`@par' is an internal TeX command of no relevance to Texinfo. `l.27' +means that TeX detected the problem on line 27 of the Texinfo file. +The `?' is the prompt TeX uses in this circumstance. - In this example, say, " ... you must `@dfn'{check in} the new -version." That flows better. + Unfortunately, TeX is not always so helpful, and sometimes you must +truly be a Sherlock Holmes to discover what went wrong. - When you are done editing the file, you must perform a - `@dfn'{check in}. + In any case, if you run into a problem like this, you can do one of +three things. - In the following example, say, "... makes a unified interface such as -VC mode possible." + 1. You can tell TeX to continue running and ignore just this error by + typing at the `?' prompt. - SCCS, RCS and other version-control systems all perform similar - functions in broadly similar ways (it is this resemblance which - makes a unified control mode like this possible). + 2. You can tell TeX to continue running and to ignore all errors as + best it can by typing `r ' at the `?' prompt. - And in this example, you should specify what `it' refers to: + This is often the best thing to do. However, beware: the one error + may produce a cascade of additional error messages as its + consequences are felt through the rest of the file. To stop TeX + when it is producing such an avalanche of error messages, type + `C-c' (or `C-c C-c', if you are running a shell inside Emacs). - If you are working with other people, it assists in coordinating - everyone's changes so they do not step on each other. + 3. You can tell TeX to stop this run by typing `x ' at the `?' + prompt. -And Finally ... -............... + Please note that if you are running TeX inside Emacs, you need to +switch to the shell buffer and line at which TeX offers the `?' prompt. - * Pronounce TeX as if the `X' were a Greek `chi', as the last sound - in the name `Bach'. But pronounce Texinfo as in `speck': - "teckinfo". + Sometimes TeX will format a file without producing error messages even +though there is a problem. This usually occurs if a command is not +ended but TeX is able to continue processing anyhow. For example, if +you fail to end an itemized list with the `@end itemize' command, TeX +will write a DVI file that you can print out. The only error message +that TeX will give you is the somewhat mysterious comment that - * Write notes for yourself at the very end of a Texinfo file after - the `@bye'. None of the formatters process text after the `@bye'; - it is as if the text were within `@ignore' ... `@end ignore'. + (@end occurred inside a group at level 1) - -File: texinfo.info, Node: Sample Texinfo File, Next: Sample Permissions, Prev: Tips, Up: Top +However, if you print the DVI file, you will find that the text of the +file that follows the itemized list is entirely indented as if it were +part of the last item in the itemized list. The error message is the +way TeX says that it expected to find an `@end' command somewhere in +the file; but that it could not determine where it was needed. -A Sample Texinfo File -********************* + Another source of notoriously hard-to-find errors is a missing `@end +group' command. If you ever are stumped by incomprehensible errors, +look for a missing `@end group' command first. - Here is a complete, short sample Texinfo file, without any commentary. -You can see this file, with comments, in the first chapter. *Note A -Short Sample Texinfo File: Short Sample. + If the Texinfo file lacks header lines, TeX may stop in the beginning +of its run and display output that looks like the following. The `*' +indicates that TeX is waiting for input. + This is TeX, Version 3.14159 (Web2c 7.0) + (test.texinfo [1]) + * - \input texinfo @c -*-texinfo-*- - @c %**start of header - @setfilename sample.info - @settitle Sample Document - @c %**end of header - - @setchapternewpage odd - - @ifinfo - This is a short example of a complete Texinfo file. - - Copyright 1990 Free Software Foundation, Inc. - @end ifinfo - - @titlepage - @sp 10 - @comment The title is printed in a large font. - @center @titlefont{Sample Title} - - @c The following two commands start the copyright page. - @page - @vskip 0pt plus 1filll - Copyright @copyright{} 1990 Free Software Foundation, Inc. - @end titlepage - - @node Top, First Chapter, , (dir) - @comment node-name, next, previous, up - - @menu - * First Chapter:: The first chapter is the - only chapter in this sample. - * Concept Index:: This index has two entries. - @end menu - - @node First Chapter, Concept Index, Top, Top - @comment node-name, next, previous, up - @chapter First Chapter - @cindex Sample index entry - - This is the contents of the first chapter. - @cindex Another sample index entry - - Here is a numbered list. - - @enumerate - @item - This is the first item. - - @item - This is the second item. - @end enumerate - - The @code{makeinfo} and @code{texinfo-format-buffer} - commands transform a Texinfo file such as this into - an Info file; and @TeX{} typesets it for a printed - manual. - - @node Concept Index, , First Chapter, Top - @comment node-name, next, previous, up - @unnumbered Concept Index - - @printindex cp - - @contents - @bye +In this case, simply type `\end ' after the asterisk. Then write +the header lines in the Texinfo file and run the TeX command again. +(Note the use of the backslash, `\'. TeX uses `\' instead of `@'; and +in this circumstance, you are working directly with TeX, not with +Texinfo.)  -File: texinfo.info, Node: Sample Permissions, Next: Include Files, Prev: Sample Texinfo File, Up: Top - -Sample Permissions -****************** - - Texinfo files should contain sections that tell the readers that they -have the right to copy and distribute the Texinfo file, the Info file, -and the printed manual. +File: texinfo.info, Node: Using texinfo-show-structure, Next: Using occur, Prev: Debugging with TeX, Up: Catching Mistakes - Also, if you are writing a manual about software, you should explain -that the software is free and either include the GNU General Public -License (GPL) or provide a reference to it. *Note Distribution: -(emacs)Distrib, for an example of the text that could be used in the -software "Distribution", "General Public License", and "NO WARRANTY" -sections of a document. *Note Texinfo Copying Conditions: Copying, for -an example of a brief explanation of how the copying conditions provide -you with rights. - -* Menu: - -* Inserting Permissions:: How to put permissions in your document. -* ifinfo Permissions:: Sample `ifinfo' copying permissions. -* Titlepage Permissions:: Sample Titlepage copying permissions. +Using `texinfo-show-structure' +============================== - -File: texinfo.info, Node: Inserting Permissions, Next: ifinfo Permissions, Prev: Sample Permissions, Up: Sample Permissions - -Inserting Permissions -===================== - - In a Texinfo file, the first `@ifinfo' section usually begins with a -line that says what the file documents. This is what a person reading -the unprocessed Texinfo file or using the advanced Info command `g *' -sees first. *note Advanced Info commands: (info)Expert, for more -information. (A reader using the regular Info commands usually starts -reading at the first node and skips this first section, which is not in -a node.) - - In the `@ifinfo' section, the summary sentence is followed by a -copyright notice and then by the copying permission notice. One of the -copying permission paragraphs is enclosed in `@ignore' and `@end -ignore' commands. This paragraph states that the Texinfo file can be -processed through TeX and printed, provided the printed manual carries -the proper copying permission notice. This paragraph is not made part -of the Info file since it is not relevant to the Info file; but it is a -mandatory part of the Texinfo file since it permits people to process -the Texinfo file in TeX and print the results. - - In the printed manual, the Free Software Foundation copying permission -notice follows the copyright notice and publishing information and is -located within the region delineated by the `@titlepage' and `@end -titlepage' commands. The copying permission notice is exactly the same -as the notice in the `@ifinfo' section except that the paragraph -enclosed in `@ignore' and `@end ignore' commands is not part of the -notice. - - To make it simple to insert a permission notice into each section of -the Texinfo file, sample permission notices for each section are -reproduced in full below. - - You may need to specify the correct name of a section mentioned in the -permission notice. For example, in `The GDB Manual', the name of the -section referring to the General Public License is called the "GDB -General Public License", but in the sample shown below, that section is -referred to generically as the "GNU General Public License". If the -Texinfo file does not carry a copy of the General Public License, leave -out the reference to it, but be sure to include the rest of the -sentence. + It is not always easy to keep track of the nodes, chapters, sections, +and subsections of a Texinfo file. This is especially true if you are +revising or adding to a Texinfo file that someone else has written. + + In GNU Emacs, in Texinfo mode, the `texinfo-show-structure' command +lists all the lines that begin with the @-commands that specify the +structure: `@chapter', `@section', `@appendix', and so on. With an +argument (`C-u' as prefix argument, if interactive), the command also +shows the `@node' lines. The `texinfo-show-structure' command is bound +to `C-c C-s' in Texinfo mode, by default. + + The lines are displayed in a buffer called the `*Occur*' buffer, +indented by hierarchical level. For example, here is a part of what was +produced by running `texinfo-show-structure' on this manual: + + Lines matching "^@\\(chapter \\|sect\\|subs\\|subh\\| + unnum\\|major\\|chapheading \\|heading \\|appendix\\)" + in buffer texinfo.texi. + ... + 4177:@chapter Nodes + 4198: @heading Two Paths + 4231: @section Node and Menu Illustration + 4337: @section The @code{@@node} Command + 4393: @subheading Choosing Node and Pointer Names + 4417: @subsection How to Write an @code{@@node} Line + 4469: @subsection @code{@@node} Line Tips + ... + + This says that lines 4337, 4393, and 4417 of `texinfo.texi' begin +with the `@section', `@subheading', and `@subsection' commands +respectively. If you move your cursor into the `*Occur*' window, you +can position the cursor over one of the lines and use the `C-c C-c' +command (`occur-mode-goto-occurrence'), to jump to the corresponding +spot in the Texinfo file. *Note Using Occur: (xemacs)Other Repeating +Search, for more information about `occur-mode-goto-occurrence'. + + The first line in the `*Occur*' window describes the "regular +expression" specified by TEXINFO-HEADING-PATTERN. This regular +expression is the pattern that `texinfo-show-structure' looks for. +*Note Using Regular Expressions: (xemacs)Regexps, for more information. + + When you invoke the `texinfo-show-structure' command, Emacs will +display the structure of the whole buffer. If you want to see the +structure of just a part of the buffer, of one chapter, for example, +use the `C-x n n' (`narrow-to-region') command to mark the region. +(*Note Narrowing: (xemacs)Narrowing.) This is how the example used +above was generated. (To see the whole buffer again, use `C-x n w' +(`widen').) + + If you call `texinfo-show-structure' with a prefix argument by typing +`C-u C-c C-s', it will list lines beginning with `@node' as well as the +lines beginning with the @-sign commands for `@chapter', `@section', +and the like. + + You can remind yourself of the structure of a Texinfo file by looking +at the list in the `*Occur*' window; and if you have mis-named a node +or left out a section, you can correct the mistake.  -File: texinfo.info, Node: ifinfo Permissions, Next: Titlepage Permissions, Prev: Inserting Permissions, Up: Sample Permissions +File: texinfo.info, Node: Using occur, Next: Running Info-Validate, Prev: Using texinfo-show-structure, Up: Catching Mistakes -`ifinfo' Copying Permissions -============================ +Using `occur' +============= - In the `@ifinfo' section of a Texinfo file, the standard Free -Software Foundation permission notice reads as follows: + Sometimes the `texinfo-show-structure' command produces too much +information. Perhaps you want to remind yourself of the overall +structure of a Texinfo file, and are overwhelmed by the detailed list +produced by `texinfo-show-structure'. In this case, you can use the +`occur' command directly. To do this, type - This file documents ... - - Copyright 1999 Free Software Foundation, Inc. - - Permission is granted to make and distribute verbatim - copies of this manual provided the copyright notice and - this permission notice are preserved on all copies. - - @ignore - Permission is granted to process this file through TeX - and print the results, provided the printed document - carries a copying permission notice identical to this - one except for the removal of this paragraph (this - paragraph not being relevant to the printed manual). - - @end ignore - Permission is granted to copy and distribute modified - versions of this manual under the conditions for - verbatim copying, provided also that the sections - entitled ``Copying'' and ``GNU General Public License'' - are included exactly as in the original, and provided - that the entire resulting derived work is distributed - under the terms of a permission notice identical to this - one. - - Permission is granted to copy and distribute - translations of this manual into another language, - under the above conditions for modified versions, - except that this permission notice may be stated in a - translation approved by the Free Software Foundation. + M-x occur - -File: texinfo.info, Node: Titlepage Permissions, Prev: ifinfo Permissions, Up: Sample Permissions +and then, when prompted, type a "regexp", a regular expression for the +pattern you want to match. (*Note Regular Expressions: +(xemacs)Regexps.) The `occur' command works from the current location +of the cursor in the buffer to the end of the buffer. If you want to +run `occur' on the whole buffer, place the cursor at the beginning of +the buffer. -Titlepage Copying Permissions -============================= + For example, to see all the lines that contain the word `@chapter' in +them, just type `@chapter'. This will produce a list of the chapters. +It will also list all the sentences with `@chapter' in the middle of +the line. - In the `@titlepage' section of a Texinfo file, the standard Free -Software Foundation copying permission notice follows the copyright -notice and publishing information. The standard phrasing is as follows: + If you want to see only those lines that start with the word +`@chapter', type `^@chapter' when prompted by `occur'. If you want to +see all the lines that end with a word or phrase, end the last word +with a `$'; for example, `catching mistakes$'. This can be helpful +when you want to see all the nodes that are part of the same chapter or +section and therefore have the same `Up' pointer. - Permission is granted to make and distribute verbatim - copies of this manual provided the copyright notice and - this permission notice are preserved on all copies. - - Permission is granted to copy and distribute modified - versions of this manual under the conditions for - verbatim copying, provided also that the sections - entitled ``Copying'' and ``GNU General Public License'' - are included exactly as in the original, and provided - that the entire resulting derived work is distributed - under the terms of a permission notice identical to this - one. - - Permission is granted to copy and distribute - translations of this manual into another language, - under the above conditions for modified versions, - except that this permission notice may be stated in a - translation approved by the Free Software Foundation. + *Note Using Occur: (xemacs)Other Repeating Search, for more +information.  -File: texinfo.info, Node: Include Files, Next: Headings, Prev: Sample Permissions, Up: Top +File: texinfo.info, Node: Running Info-Validate, Prev: Using occur, Up: Catching Mistakes -Include Files -************* +Finding Badly Referenced Nodes +============================== - When TeX or an Info formatting command sees an `@include' command in -a Texinfo file, it processes the contents of the file named by the -command and incorporates them into the DVI or Info file being created. -Index entries from the included file are incorporated into the indices -of the output file. + You can use the `Info-validate' command to check whether any of the +`Next', `Previous', `Up' or other node pointers fail to point to a +node. This command checks that every node pointer points to an +existing node. The `Info-validate' command works only on Info files, +not on Texinfo files. - Include files let you keep a single large document as a collection of -conveniently small parts. + The `makeinfo' program validates pointers automatically, so you do +not need to use the `Info-validate' command if you are using +`makeinfo'. You only may need to use `Info-validate' if you are unable +to run `makeinfo' and instead must create an Info file using +`texinfo-format-region' or `texinfo-format-buffer', or if you write an +Info file from scratch. * Menu: -* Using Include Files:: How to use the `@include' command. -* texinfo-multiple-files-update:: How to create and update nodes and - menus when using included files. -* Include File Requirements:: What `texinfo-multiple-files-update' expects. -* Sample Include File:: A sample outer file with included files - within it; and a sample included file. -* Include Files Evolution:: How use of the `@include' command - has changed over time. +* Using Info-validate:: How to run `Info-validate'. +* Unsplit:: How to create an unsplit file. +* Tagifying:: How to tagify a file. +* Splitting:: How to split a file manually.  -File: texinfo.info, Node: Using Include Files, Next: texinfo-multiple-files-update, Prev: Include Files, Up: Include Files - -How to Use Include Files -======================== - - To include another file within a Texinfo file, write the `@include' -command at the beginning of a line and follow it on the same line by -the name of a file to be included. For example: - - @include buffers.texi - - An included file should simply be a segment of text that you expect to -be included as is into the overall or "outer" Texinfo file; it should -not contain the standard beginning and end parts of a Texinfo file. In -particular, you should not start an included file with a line saying -`\input texinfo'; if you do, that phrase is inserted into the output -file as is. Likewise, you should not end an included file with an -`@bye' command; nothing after `@bye' is formatted. - - In the past, you were required to write an `@setfilename' line at the -beginning of an included file, but no longer. Now, it does not matter -whether you write such a line. If an `@setfilename' line exists in an -included file, it is ignored. - - Conventionally, an included file begins with an `@node' line that is -followed by an `@chapter' line. Each included file is one chapter. -This makes it easy to use the regular node and menu creating and -updating commands to create the node pointers and menus within the -included file. However, the simple Emacs node and menu creating and -updating commands do not work with multiple Texinfo files. Thus you -cannot use these commands to fill in the `Next', `Previous', and `Up' -pointers of the `@node' line that begins the included file. Also, you -cannot use the regular commands to create a master menu for the whole -file. Either you must insert the menus and the `Next', `Previous', and -`Up' pointers by hand, or you must use the GNU Emacs Texinfo mode -command, `texinfo-multiple-files-update', that is designed for -`@include' files. +File: texinfo.info, Node: Using Info-validate, Next: Unsplit, Prev: Running Info-Validate, Up: Running Info-Validate - -File: texinfo.info, Node: texinfo-multiple-files-update, Next: Include File Requirements, Prev: Using Include Files, Up: Include Files +Running `Info-validate' +----------------------- -`texinfo-multiple-files-update' -=============================== + To use `Info-validate', visit the Info file you wish to check and +type: - GNU Emacs Texinfo mode provides the `texinfo-multiple-files-update' -command. This command creates or updates `Next', `Previous', and `Up' -pointers of included files as well as those in the outer or overall -Texinfo file, and it creates or updates a main menu in the outer file. -Depending whether you call it with optional arguments, the command -updates only the pointers in the first `@node' line of the included -files or all of them: + M-x Info-validate -`M-x texinfo-multiple-files-update' - Called without any arguments: +(Note that the `Info-validate' command requires an upper case `I'. You +may also need to create a tag table before running `Info-validate'. +*Note Tagifying::.) - - Create or update the `Next', `Previous', and `Up' pointers of - the first `@node' line in each file included in an outer or - overall Texinfo file. + If your file is valid, you will receive a message that says "File +appears valid". However, if you have a pointer that does not point to +a node, error messages will be displayed in a buffer called `*problems +in info file*'. - - Create or update the `Top' level node pointers of the outer or - overall file. + For example, `Info-validate' was run on a test file that contained +only the first node of this manual. One of the messages said: - - Create or update a main menu in the outer file. + In node "Overview", invalid Next: Texinfo Mode -`C-u M-x texinfo-multiple-files-update' - Called with `C-u' as a prefix argument: +This meant that the node called `Overview' had a `Next' pointer that +did not point to anything (which was true in this case, since the test +file had only one node in it). - - Create or update pointers in the first `@node' line in each - included file. + Now suppose we add a node named `Texinfo Mode' to our test case but +we do not specify a `Previous' for this node. Then we will get the +following error message: - - Create or update the `Top' level node pointers of the outer - file. + In node "Texinfo Mode", should have Previous: Overview - - Create and insert a master menu in the outer file. The - master menu is made from all the menus in all the included - files. +This is because every `Next' pointer should be matched by a `Previous' +(in the node where the `Next' points) which points back. -`C-u 8 M-x texinfo-multiple-files-update' - Called with a numeric prefix argument, such as `C-u 8': + `Info-validate' also checks that all menu entries and cross references +point to actual nodes. - - Create or update *all* the `Next', `Previous', and `Up' - pointers of all the included files. + Note that `Info-validate' requires a tag table and does not work with +files that have been split. (The `texinfo-format-buffer' command +automatically splits large files.) In order to use `Info-validate' on +a large file, you must run `texinfo-format-buffer' with an argument so +that it does not split the Info file; and you must create a tag table +for the unsplit file. - - Create or update *all* the menus of all the included files. - - - Create or update the `Top' level node pointers of the outer or - overall file. + +File: texinfo.info, Node: Unsplit, Next: Tagifying, Prev: Using Info-validate, Up: Running Info-Validate - - And then create a master menu in the outer file. This is - similar to invoking `texinfo-master-menu' with an argument - when you are working with just one file. +Creating an Unsplit File +------------------------ - Note the use of the prefix argument in interactive use: with a regular -prefix argument, just `C-u', the `texinfo-multiple-files-update' -command inserts a master menu; with a numeric prefix argument, such as -`C-u 8', the command updates *every* pointer and menu in *all* the -files and then inserts a master menu. + You can run `Info-validate' only on a single Info file that has a tag +table. The command will not work on the indirect subfiles that are +generated when a master file is split. If you have a large file +(longer than 70,000 bytes or so), you need to run the +`texinfo-format-buffer' or `makeinfo-buffer' command in such a way that +it does not create indirect subfiles. You will also need to create a +tag table for the Info file. After you have done this, you can run +`Info-validate' and look for badly referenced nodes. - -File: texinfo.info, Node: Include File Requirements, Next: Sample Include File, Prev: texinfo-multiple-files-update, Up: Include Files - -Include File Requirements -========================= - - If you plan to use the `texinfo-multiple-files-update' command, the -outer Texinfo file that lists included files within it should contain -nothing but the beginning and end parts of a Texinfo file, and a number -of `@include' commands listing the included files. It should not even -include indices, which should be listed in an included file of their -own. - - Moreover, each of the included files must contain exactly one highest -level node (conventionally, `@chapter' or equivalent), and this node -must be the first node in the included file. Furthermore, each of -these highest level nodes in each included file must be at the same -hierarchical level in the file structure. Usually, each is an -`@chapter', an `@appendix', or an `@unnumbered' node. Thus, normally, -each included file contains one, and only one, chapter or -equivalent-level node. - - The outer file should contain only _one_ node, the `Top' node. It -should _not_ contain any nodes besides the single `Top' node. The -`texinfo-multiple-files-update' command will not process them. - - -File: texinfo.info, Node: Sample Include File, Next: Include Files Evolution, Prev: Include File Requirements, Up: Include Files + The first step is to create an unsplit Info file. To prevent +`texinfo-format-buffer' from splitting a Texinfo file into smaller Info +files, give a prefix to the `M-x texinfo-format-buffer' command: -Sample File with `@include' -=========================== + C-u M-x texinfo-format-buffer - Here is an example of a complete outer Texinfo file with `@include' -files within it before running `texinfo-multiple-files-update', which -would insert a main or master menu: +or else - \input texinfo @c -*-texinfo-*- - @setfilename include-example.info - @settitle Include Example - - @setchapternewpage odd - @titlepage - @sp 12 - @center @titlefont{Include Example} - @sp 2 - @center by Whom Ever - - @page - @vskip 0pt plus 1filll - Copyright @copyright{} 1999 Free Software Foundation, Inc. - @end titlepage - - @ifinfo - @node Top, First, , (dir) - @top Master Menu - @end ifinfo - - @include foo.texinfo - @include bar.texinfo - @include concept-index.texinfo - - @summarycontents - @contents - - @bye + C-u C-c C-e C-b - An included file, such as `foo.texinfo', might look like this: +When you do this, Texinfo will not split the file and will not create a +tag table for it. - @node First, Second, , Top - @chapter First Chapter - - Contents of first chapter ... + +File: texinfo.info, Node: Tagifying, Next: Splitting, Prev: Unsplit, Up: Running Info-Validate - The full contents of `concept-index.texinfo' might be as simple as -this: +Tagifying a File +---------------- - @node Concept Index - @unnumbered Concept Index - - @printindex cp + After creating an unsplit Info file, you must create a tag table for +it. Visit the Info file you wish to tagify and type: - The outer Texinfo source file for `The GNU Emacs Lisp Reference -Manual' is named `elisp.texi'. This outer file contains a master menu -with 417 entries and a list of 41 `@include' files. + M-x Info-tagify - -File: texinfo.info, Node: Include Files Evolution, Prev: Sample Include File, Up: Include Files - -Evolution of Include Files -========================== - - When Info was first created, it was customary to create many small -Info files on one subject. Each Info file was formatted from its own -Texinfo source file. This custom meant that Emacs did not need to make -a large buffer to hold the whole of a large Info file when someone -wanted information; instead, Emacs allocated just enough memory for the -small Info file that contained the particular information sought. This -way, Emacs could avoid wasting memory. - - References from one file to another were made by referring to the file -name as well as the node name. (*Note Referring to Other Info Files: -Other Info Files. Also, see *Note `@xref' with Four and Five -Arguments: Four and Five Arguments.) - - Include files were designed primarily as a way to create a single, -large printed manual out of several smaller Info files. In a printed -manual, all the references were within the same document, so TeX could -automatically determine the references' page numbers. The Info -formatting commands used include files only for creating joint indices; -each of the individual Texinfo files had to be formatted for Info -individually. (Each, therefore, required its own `@setfilename' line.) - - However, because large Info files are now split automatically, it is -no longer necessary to keep them small. - - Nowadays, multiple Texinfo files are used mostly for large documents, -such as `The GNU Emacs Lisp Reference Manual', and for projects in -which several different people write different sections of a document -simultaneously. - - In addition, the Info formatting commands have been extended to work -with the `@include' command so as to create a single large Info file -that is split into smaller files if necessary. This means that you can -write menus and cross references without naming the different Texinfo -files. +(Note the upper case `I' in `Info-tagify'.) This creates an Info file +with a tag table that you can validate. - -File: texinfo.info, Node: Headings, Next: Catching Mistakes, Prev: Include Files, Up: Top + The third step is to validate the Info file: -Page Headings -************* + M-x Info-validate - Most printed manuals contain headings along the top of every page -except the title and copyright pages. Some manuals also contain -footings. (Headings and footings have no meaning to Info, which is not -paginated.) +(Note the upper case `I' in `Info-validate'.) In brief, the steps are: -* Menu: + C-u M-x texinfo-format-buffer + M-x Info-tagify + M-x Info-validate -* Headings Introduced:: Conventions for using page headings. -* Heading Format:: Standard page heading formats. -* Heading Choice:: How to specify the type of page heading. -* Custom Headings:: How to create your own headings and footings. + After you have validated the node structure, you can rerun +`texinfo-format-buffer' in the normal way so it will construct a tag +table and split the file automatically, or you can make the tag table +and split the file manually.  -File: texinfo.info, Node: Headings Introduced, Next: Heading Format, Prev: Headings, Up: Headings - -Headings Introduced -=================== - - Texinfo provides standard page heading formats for manuals that are -printed on one side of each sheet of paper and for manuals that are -printed on both sides of the paper. Typically, you will use these -formats, but you can specify your own format if you wish. - - In addition, you can specify whether chapters should begin on a new -page, or merely continue the same page as the previous chapter; and if -chapters begin on new pages, you can specify whether they must be -odd-numbered pages. - - By convention, a book is printed on both sides of each sheet of paper. -When you open a book, the right-hand page is odd-numbered, and chapters -begin on right-hand pages--a preceding left-hand page is left blank if -necessary. Reports, however, are often printed on just one side of -paper, and chapters begin on a fresh page immediately following the end -of the preceding chapter. In short or informal reports, chapters often -do not begin on a new page at all, but are separated from the preceding -text by a small amount of whitespace. - - The `@setchapternewpage' command controls whether chapters begin on -new pages, and whether one of the standard heading formats is used. In -addition, Texinfo has several heading and footing commands that you can -use to generate your own heading and footing formats. - - In Texinfo, headings and footings are single lines at the tops and -bottoms of pages; you cannot create multiline headings or footings. -Each header or footer line is divided into three parts: a left part, a -middle part, and a right part. Any part, or a whole line, may be left -blank. Text for the left part of a header or footer line is set -flushleft; text for the middle part is centered; and, text for the -right part is set flushright. +File: texinfo.info, Node: Splitting, Prev: Tagifying, Up: Running Info-Validate - -File: texinfo.info, Node: Heading Format, Next: Heading Choice, Prev: Headings Introduced, Up: Headings - -Standard Heading Formats -======================== - - Texinfo provides two standard heading formats, one for manuals printed -on one side of each sheet of paper, and the other for manuals printed -on both sides of the paper. - - By default, nothing is specified for the footing of a Texinfo file, -so the footing remains blank. - - The standard format for single-sided printing consists of a header -line in which the left-hand part contains the name of the chapter, the -central part is blank, and the right-hand part contains the page number. - - A single-sided page looks like this: - - _______________________ - | | - | chapter page number | - | | - | Start of text ... | - | ... | - | | - - The standard format for two-sided printing depends on whether the page -number is even or odd. By convention, even-numbered pages are on the -left- and odd-numbered pages are on the right. (TeX will adjust the -widths of the left- and right-hand margins. Usually, widths are -correct, but during double-sided printing, it is wise to check that -pages will bind properly--sometimes a printer will produce output in -which the even-numbered pages have a larger right-hand margin than the -odd-numbered pages.) - - In the standard double-sided format, the left part of the left-hand -(even-numbered) page contains the page number, the central part is -blank, and the right part contains the title (specified by the -`@settitle' command). The left part of the right-hand (odd-numbered) -page contains the name of the chapter, the central part is blank, and -the right part contains the page number. - - Two pages, side by side as in an open book, look like this: - - _______________________ _______________________ - | | | | - | page number title | | chapter page number | - | | | | - | Start of text ... | | More text ... | - | ... | | ... | - | | | | - -The chapter name is preceded by the word "Chapter", the chapter number -and a colon. This makes it easier to keep track of where you are in the -manual. +Splitting a File Manually +------------------------- - -File: texinfo.info, Node: Heading Choice, Next: Custom Headings, Prev: Heading Format, Up: Headings + You should split a large file or else let the `texinfo-format-buffer' +or `makeinfo-buffer' command do it for you automatically. (Generally +you will let one of the formatting commands do this job for you. *Note +Create an Info File::.) -Specifying the Type of Heading -============================== + The split-off files are called the indirect subfiles. - TeX does not begin to generate page headings for a standard Texinfo -file until it reaches the `@end titlepage' command. Thus, the title -and copyright pages are not numbered. The `@end titlepage' command -causes TeX to begin to generate page headings according to a standard -format specified by the `@setchapternewpage' command that precedes the -`@titlepage' section. + Info files are split to save memory. With smaller files, Emacs does +not have make such a large buffer to hold the information. - There are four possibilities: + If an Info file has more than 30 nodes, you should also make a tag +table for it. *Note Using Info-validate::, for information about +creating a tag table. (Again, tag tables are usually created +automatically by the formatting command; you only need to create a tag +table yourself if you are doing the job manually. Most likely, you +will do this for a large, unsplit file on which you have run +`Info-validate'.) -No `@setchapternewpage' command - Cause TeX to specify the single-sided heading format, with chapters - on new pages. This is the same as `@setchapternewpage on'. + Visit the Info file you wish to tagify and split and type the two +commands: -`@setchapternewpage on' - Specify the single-sided heading format, with chapters on new - pages. + M-x Info-tagify + M-x Info-split -`@setchapternewpage off' - Cause TeX to start a new chapter on the same page as the last page - of the preceding chapter, after skipping some vertical whitespace. - Also cause TeX to typeset for single-sided printing. (You can - override the headers format with the `@headings double' command; - see *Note The `@headings' Command: headings on off.) +(Note that the `I' in `Info' is upper case.) -`@setchapternewpage odd' - Specify the double-sided heading format, with chapters on new - pages. + When you use the `Info-split' command, the buffer is modified into a +(small) Info file which lists the indirect subfiles. This file should +be saved in place of the original visited file. The indirect subfiles +are written in the same directory the original file is in, with names +generated by appending `-' and a number to the original file name. -Texinfo lacks an `@setchapternewpage even' command. + The primary file still functions as an Info file, but it contains just +the tag table and a directory of subfiles.  -File: texinfo.info, Node: Custom Headings, Prev: Heading Choice, Up: Headings - -How to Make Your Own Headings -============================= - - You can use the standard headings provided with Texinfo or specify -your own. By default, Texinfo has no footers, so if you specify them, -the available page size for the main text will be slightly reduced. - - Texinfo provides six commands for specifying headings and footings: - * `@everyheading' `@everyfooting' generate page headers and footers - that are the same for both even- and odd-numbered pages. - - * `@evenheading' and `@evenfooting' command generate headers and - footers for even-numbered (left-hand) pages. - - * `@oddheading' and `@oddfooting' generate headers and footers for - odd-numbered (right-hand) pages. - - Write custom heading specifications in the Texinfo file immediately -after the `@end titlepage' command. Enclose your specifications -between `@iftex' and `@end iftex' commands since the -`texinfo-format-buffer' command may not recognize them. Also, you must -cancel the predefined heading commands with the `@headings off' command -before defining your own specifications. - - Here is how to tell TeX to place the chapter name at the left, the -page number in the center, and the date at the right of every header -for both even- and odd-numbered pages: - - @iftex - @headings off - @everyheading @thischapter @| @thispage @| @today{} - @end iftex - -You need to divide the left part from the central part and the central -part from the right part by inserting `@|' between parts. Otherwise, -the specification command will not be able to tell where the text for -one part ends and the next part begins. - - Each part can contain text or @-commands. The text is printed as if -the part were within an ordinary paragraph in the body of the page. -The @-commands replace themselves with the page number, date, chapter -name, or whatever. - - Here are the six heading and footing commands: - -`@everyheading LEFT @| CENTER @| RIGHT' -`@everyfooting LEFT @| CENTER @| RIGHT' - The `every' commands specify the format for both even- and - odd-numbered pages. These commands are for documents that are - printed on one side of each sheet of paper, or for documents in - which you want symmetrical headers or footers. - -`@evenheading LEFT @| CENTER @| RIGHT' -`@oddheading LEFT @| CENTER @| RIGHT' -`@evenfooting LEFT @| CENTER @| RIGHT' -`@oddfooting LEFT @| CENTER @| RIGHT' - The `even' and `odd' commands specify the format for even-numbered - pages and odd-numbered pages. These commands are for books and - manuals that are printed on both sides of each sheet of paper. - - Use the `@this...' series of @-commands to provide the names of -chapters and sections and the page number. You can use the `@this...' -commands in the left, center, or right portions of headers and footers, -or anywhere else in a Texinfo file so long as they are between `@iftex' -and `@end iftex' commands. - - Here are the `@this...' commands: - -`@thispage' - Expands to the current page number. - -`@thischaptername' - Expands to the name of the current chapter. - -`@thischapter' - Expands to the number and name of the current chapter, in the - format `Chapter 1: Title'. - -`@thistitle' - Expands to the name of the document, as specified by the - `@settitle' command. - -`@thisfile' - For `@include' files only: expands to the name of the current - `@include' file. If the current Texinfo source file is not an - `@include' file, this command has no effect. This command does - _not_ provide the name of the current Texinfo source file unless - it is an `@include' file. (*Note Include Files::, for more - information about `@include' files.) - -You can also use the `@today{}' command, which expands to the current -date, in `1 Jan 1900' format. - - Other @-commands and text are printed in a header or footer just as -if they were in the body of a page. It is useful to incorporate text, -particularly when you are writing drafts: - - @iftex - @headings off - @everyheading @emph{Draft!} @| @thispage @| @thischapter - @everyfooting @| @| Version: 0.27: @today{} - @end iftex - - Beware of overlong titles: they may overlap another part of the -header or footer and blot it out. +File: texinfo.info, Node: Refilling Paragraphs, Next: Command Syntax, Prev: Catching Mistakes, Up: Top + +Refilling Paragraphs +******************** + + The `@refill' command refills and, optionally, indents the first line +of a paragraph.(1) (*note Refilling Paragraphs-Footnote-1::) The +`@refill' command is no longer important, but we describe it here +because you once needed it. You will see it in many old Texinfo files. + + Without refilling, paragraphs containing long @-constructs may look +bad after formatting because the formatter removes @-commands and +shortens some lines more than others. In the past, neither the +`texinfo-format-region' command nor the `texinfo-format-buffer' command +refilled paragraphs automatically. The `@refill' command had to be +written at the end of every paragraph to cause these formatters to fill +them. (Both TeX and `makeinfo' have always refilled paragraphs +automatically.) Now, all the Info formatters automatically fill and +indent those paragraphs that need to be filled and indented. + + The `@refill' command causes `texinfo-format-region' and +`texinfo-format-buffer' to refill a paragraph in the Info file _after_ +all the other processing has been done. For this reason, you can not +use `@refill' with a paragraph containing either `@*' or `@w{ ... }' +since the refilling action will override those two commands. + + The `texinfo-format-region' and `texinfo-format-buffer' commands now +automatically append `@refill' to the end of each paragraph that should +be filled. They do not append `@refill' to the ends of paragraphs that +contain `@*' or `@w{ ...}' and therefore do not refill or indent them.  -File: texinfo.info, Node: Catching Mistakes, Next: Refilling Paragraphs, Prev: Headings, Up: Top - -Formatting Mistakes -******************* - - Besides mistakes in the content of your documentation, there are two -kinds of mistake you can make with Texinfo: you can make mistakes with -@-commands, and you can make mistakes with the structure of the nodes -and chapters. - - Emacs has two tools for catching the @-command mistakes and two for -catching structuring mistakes. - - For finding problems with @-commands, you can run TeX or a region -formatting command on the region that has a problem; indeed, you can -run these commands on each region as you write it. - - For finding problems with the structure of nodes and chapters, you -can use `C-c C-s' (`texinfo-show-structure') and the related `occur' -command and you can use the `M-x Info-validate' command. - -* Menu: +File: texinfo.info, Node: Refilling Paragraphs-Footnotes, Up: Refilling Paragraphs -* makeinfo Preferred:: `makeinfo' finds errors. -* Debugging with Info:: How to catch errors with Info formatting. -* Debugging with TeX:: How to catch errors with TeX formatting. -* Using texinfo-show-structure:: How to use `texinfo-show-structure'. -* Using occur:: How to list all lines containing a pattern. -* Running Info-Validate:: How to find badly referenced nodes. + (1) Perhaps the command should have been called the +`@refillandindent' command, but `@refill' is shorter and the name was +chosen before indenting was possible.  -File: texinfo.info, Node: makeinfo Preferred, Next: Debugging with Info, Prev: Catching Mistakes, Up: Catching Mistakes - -`makeinfo' Find Errors -====================== - - The `makeinfo' program does an excellent job of catching errors and -reporting them--far better than `texinfo-format-region' or -`texinfo-format-buffer'. In addition, the various functions for -automatically creating and updating node pointers and menus remove many -opportunities for human error. - - If you can, use the updating commands to create and insert pointers -and menus. These prevent many errors. Then use `makeinfo' (or its -Texinfo mode manifestations, `makeinfo-region' and `makeinfo-buffer') -to format your file and check for other errors. This is the best way -to work with Texinfo. But if you cannot use `makeinfo', or your -problem is very puzzling, then you may want to use the tools described -in this appendix. +File: texinfo.info, Node: Command Syntax, Next: Obtaining TeX, Prev: Refilling Paragraphs, Up: Top + +@-Command Syntax +**************** + + The character `@' is used to start special Texinfo commands. (It has +the same meaning that `\' has in plain TeX.) Texinfo has four types of +@-command: + +1. Non-alphabetic commands. + These commands consist of an @ followed by a punctuation mark or + other character that is not part of the alphabet. Non-alphabetic + commands are almost always part of the text within a paragraph, + and never take any argument. The two characters (@ and the other + one) are complete in themselves; none is followed by braces. The + non-alphabetic commands are: `@.', `@:', `@*', `@SPACE', `@TAB', + `@NL', `@@', `@{', and `@}'. + +2. Alphabetic commands that do not require arguments. + These commands start with @ followed by a word followed by left- + and right-hand braces. These commands insert special symbols in + the document; they do not require arguments. For example, + `@dots{}' => `...', `@equiv{}' => `==', `@TeX{}' => `TeX', and + `@bullet{}' => `*'. + +3. Alphabetic commands that require arguments within braces. + These commands start with @ followed by a letter or a word, + followed by an argument within braces. For example, the command + `@dfn' indicates the introductory or defining use of a term; it is + used as follows: `In Texinfo, @@-commands are @dfn{mark-up} + commands.' + +4. Alphabetic commands that occupy an entire line. + These commands occupy an entire line. The line starts with @, + followed by the name of the command (a word); for example, + `@center' or `@cindex'. If no argument is needed, the word is + followed by the end of the line. If there is an argument, it is + separated from the command name by a space. Braces are not used. + + Thus, the alphabetic commands fall into classes that have different +argument syntaxes. You cannot tell to which class a command belongs by +the appearance of its name, but you can tell by the command's meaning: +if the command stands for a glyph, it is in class 2 and does not +require an argument; if it makes sense to use the command together with +other text as part of a paragraph, the command is in class 3 and must +be followed by an argument in braces; otherwise, it is in class 4 and +uses the rest of the line as its argument. + + The purpose of having a different syntax for commands of classes 3 and +4 is to make Texinfo files easier to read, and also to help the GNU +Emacs paragraph and filling commands work properly. There is only one +exception to this rule: the command `@refill', which is always used at +the end of a paragraph immediately following the final period or other +punctuation character. `@refill' takes no argument and does _not_ +require braces. `@refill' never confuses the Emacs paragraph commands +because it cannot appear at the beginning of a line.  -File: texinfo.info, Node: Debugging with Info, Next: Debugging with TeX, Prev: makeinfo Preferred, Up: Catching Mistakes - -Catching Errors with Info Formatting -==================================== - - After you have written part of a Texinfo file, you can use the -`texinfo-format-region' or the `makeinfo-region' command to see whether -the region formats properly. +File: texinfo.info, Node: Obtaining TeX, Next: Command and Variable Index, Prev: Command Syntax, Up: Top - Most likely, however, you are reading this section because for some -reason you cannot use the `makeinfo-region' command; therefore, the -rest of this section presumes that you are using -`texinfo-format-region'. +How to Obtain TeX +***************** - If you have made a mistake with an @-command, `texinfo-format-region' -will stop processing at or after the error and display an error -message. To see where in the buffer the error occurred, switch to the -`*Info Region*' buffer; the cursor will be in a position that is after -the location of the error. Also, the text will not be formatted after -the place where the error occurred (or more precisely, where it was -detected). + TeX is freely redistributable. You can obtain TeX for Unix systems +via anonymous ftp or on physical media. The core material consists of +the Web2c TeX distribution (`http://tug.org/web2c'). - For example, if you accidentally end a menu with the command `@end -menus' with an `s' on the end, instead of with `@end menu', you will -see an error message that says: + Instructions for retrieval by anonymous ftp and information on other +available distributions: + `ftp://tug.org/tex/unixtex.ftp' + `http://tug.org/unixtex.ftp' - @end menus is not handled by texinfo + The Free Software Foundation provides a core distribution on its +Source Code CD-ROM suitable for printing Texinfo manuals; the +University of Washington maintains and supports a tape distribution; +the TeX Users Group co-sponsors a complete CD-ROM TeX distribution. -The cursor will stop at the point in the buffer where the error occurs, -or not long after it. The buffer will look like this: + * For the FSF Source Code CD-ROM, please contact: - ---------- Buffer: *Info Region* ---------- - * Menu: - - * Using texinfo-show-structure:: How to use - `texinfo-show-structure' - to catch mistakes. - * Running Info-Validate:: How to check for - unreferenced nodes. - @end menus - -!- - ---------- Buffer: *Info Region* ---------- + Free Software Foundation, Inc. + 59 Temple Place Suite 330 + Boston, MA 02111-1307 + USA + + Telephone: +1-617-542-5942 + Fax: (including Japan) +1-617-542-2652 + Free Dial Fax (in Japan): + 0031-13-2473 (KDD) + 0066-3382-0158 (IDC) + Electronic mail: `gnu@gnu.org' - The `texinfo-format-region' command sometimes provides slightly odd -error messages. For example, the following cross reference fails to -format: + * To order a complete distribution on CD-ROM, please see + `http://tug.org/tex-live.html'. (This distribution is also + available by FTP; see the URL's above.) - (@xref{Catching Mistakes, for more info.) + * To order a full distribution from the University of Washington on + either a 1/4in 4-track QIC-24 cartridge or a 4mm DAT cartridge, + send $210 to: -In this case, `texinfo-format-region' detects the missing closing brace -but displays a message that says `Unbalanced parentheses' rather than -`Unbalanced braces'. This is because the formatting command looks for -mismatches between braces as if they were parentheses. + Pierre A. MacKay + Denny Hall, Mail Stop DH-10 + University of Washington + Seattle, WA 98195 + USA + Telephone: +1-206-543-2268 + Electronic mail: `mackay@cs.washington.edu' - Sometimes `texinfo-format-region' fails to detect mistakes. For -example, in the following, the closing brace is swapped with the -closing parenthesis: + Please make checks payable to the University of Washington. + Checks must be in U.S. dollars, drawn on a U.S. bank. Overseas + sites: please add to the base cost, if desired, $20.00 for + shipment via air parcel post, or $30.00 for shipment via courier. - (@xref{Catching Mistakes), for more info.} -Formatting produces: - (*Note for more info.: Catching Mistakes) + Many other TeX distributions are available; see `http://tug.org/'. - The only way for you to detect this error is to realize that the -reference should have looked like this: + +File: texinfo.info, Node: Command and Variable Index, Next: Concept Index, Prev: Obtaining TeX, Up: Top - (*Note Catching Mistakes::, for more info.) +Command and Variable Index +************************** - Incidentally, if you are reading this node in Info and type `f ' -(`Info-follow-reference'), you will generate an error message that says: + This is an alphabetical list of all the @-commands, assorted Emacs +Lisp functions, and several variables. To make the list easier to use, +the commands are listed without their preceding `@'. - No such node: "Catching Mistakes) The only way ... +* Menu: -This is because Info perceives the example of the error as the first -cross reference in this node and if you type a immediately after -typing the Info `f' command, Info will attempt to go to the referenced -node. If you type `f catch ', Info will complete the node -name of the correctly written example and take you to the `Catching -Mistakes' node. (If you try this, you can return from the `Catching -Mistakes' node by typing `l' (`Info-last').) +* ! (end of sentence): Ending a Sentence. +* ": Inserting Accents. +* ': Inserting Accents. +* (newline): Multiple Spaces. +* (space): Multiple Spaces. +* (tab): Multiple Spaces. +* * (force line break): Line Breaks. +* ,: Inserting Accents. +* -: - and hyphenation. +* . (end of sentence): Ending a Sentence. +* : (suppress widening): Not Ending a Sentence. +* =: Inserting Accents. +* ? (end of sentence): Ending a Sentence. +* @ (single @): Inserting An Atsign. +* ^: Inserting Accents. +* `: Inserting Accents. +* AA: Inserting Accents. +* aa: Inserting Accents. +* AE: Inserting Accents. +* ae: Inserting Accents. +* afourpaper: A4 Paper. +* appendix: unnumbered & appendix. +* appendixsec: unnumberedsec appendixsec heading. +* appendixsection: unnumberedsec appendixsec heading. +* appendixsubsec: unnumberedsubsec appendixsubsec subheading. +* appendixsubsubsec: subsubsection. +* apply: Sample Function Definition. +* asis: table. +* author: title subtitle author. +* b (bold font): Fonts. +* buffer-end: Def Cmd Template. +* bullet: bullet. +* bye <1>: File End. +* bye: Ending a File. +* c (comment): Comments. +* cartouche: cartouche. +* center: titlefont center sp. +* centerchap: chapter. +* chapheading: majorheading & chapheading. +* chapter: chapter. +* cindex: Indexing Commands. +* cite: cite. +* clear: ifset ifclear. +* code: code. +* columnfractions: Multitable Column Widths. +* comment: Comments. +* contents: Contents. +* copyright <1>: copyright symbol. +* copyright: Copyright & Permissions. +* cropmarks: Cropmarks and Magnification. +* defcodeindex: New Indices. +* defcv: Abstract Objects. +* deffn: Functions Commands. +* deffnx: deffnx. +* defindex: New Indices. +* definfoenclose: Customized Highlighting. +* defivar: Abstract Objects. +* defmac: Functions Commands. +* defmethod: Abstract Objects. +* defop: Abstract Objects. +* defopt: Variables Commands. +* defspec: Functions Commands. +* deftp: Data Types. +* deftypefn: Typed Functions. +* deftypefun: Typed Functions. +* deftypevar: Typed Variables. +* deftypevr: Typed Variables. +* defun: Functions Commands. +* defvar: Variables Commands. +* defvr: Variables Commands. +* dfn: dfn. +* dircategory: Installing Dir Entries. +* direntry: Installing Dir Entries. +* display: display. +* dmn: dmn. +* dotaccent: Inserting Accents. +* dotless: Inserting Accents. +* dots: dots. +* email: email. +* emph: emph & strong. +* end <1>: Introducing Lists. +* end: Quotations and Examples. +* end titlepage: end titlepage. +* enumerate: enumerate. +* evenfooting: Custom Headings. +* evenheading: Custom Headings. +* everyfooting: Custom Headings. +* everyheading: Custom Headings. +* example: example. +* exclamdown: Inserting Accents. +* exdent: exdent. +* file: file. +* filll: Copyright & Permissions. +* finalout: Overfull hboxes. +* findex: Indexing Commands. +* flushleft: flushleft & flushright. +* flushright: flushleft & flushright. +* foobar: Optional Arguments. +* footnote: Footnotes. +* footnotestyle: Footnote Styles. +* format: format. +* forward-word: Def Cmd Template. +* ftable: ftable vtable. +* group: group. +* H: Inserting Accents. +* heading: unnumberedsec appendixsec heading. +* headings: headings on off. +* html: Raw Formatter Commands. +* hyphenation: - and hyphenation. +* i (italic font): Fonts. +* ifclear: ifset ifclear. +* ifhtml <1>: Raw Formatter Commands. +* ifhtml: Conditional Commands. +* ifinfo: Conditional Commands. +* ifnothtml: Conditional Not Commands. +* ifnotinfo: Conditional Not Commands. +* ifnottex: Conditional Not Commands. +* ifset: ifset ifclear. +* iftex: Conditional Commands. +* ignore: Comments. +* image: Images. +* include: Using Include Files. +* Info-validate: Running Info-Validate. +* inforef: inforef. +* input (TeX command): Minimum. +* isearch-backward: deffnx. +* isearch-forward: deffnx. +* item <1>: Multitable Rows. +* item <2>: table. +* item: itemize. +* itemize: itemize. +* itemx: itemx. +* kbd: kbd. +* kbdinputstyle: kbd. +* key: key. +* kindex: Indexing Commands. +* L: Inserting Accents. +* l: Inserting Accents. +* lisp: Lisp Example. +* lowersections: Raise/lower sections. +* macro: Defining Macros. +* mag (TeX command): Cropmarks and Magnification. +* majorheading: majorheading & chapheading. +* makeinfo-buffer: makeinfo in Emacs. +* makeinfo-kill-job: makeinfo in Emacs. +* makeinfo-recenter-output-buffer: makeinfo in Emacs. +* makeinfo-region: makeinfo in Emacs. +* math: math. +* menu: Menus. +* minus: minus. +* multitable: Multi-column Tables. +* need: need. +* next-error: makeinfo in Emacs. +* noindent: noindent. +* O: Inserting Accents. +* o: Inserting Accents. +* occur: Using occur. +* occur-mode-goto-occurrence: Showing the Structure. +* oddfooting: Custom Headings. +* oddheading: Custom Headings. +* OE: Inserting Accents. +* oe: Inserting Accents. +* page: page. +* paragraphindent: paragraphindent. +* pindex: Indexing Commands. +* pounds: pounds. +* printindex: Printing Indices & Menus. +* pxref: pxref. +* questiondown: Inserting Accents. +* quotation: quotation. +* r (Roman font): Fonts. +* raisesections: Raise/lower sections. +* ref: ref. +* refill: Refilling Paragraphs. +* ringaccent: Inserting Accents. +* samp: samp. +* sc (small caps font): Smallcaps. +* section: section. +* set: ifset ifclear. +* setchapternewpage: setchapternewpage. +* setfilename: setfilename. +* settitle: settitle. +* shortcontents: Contents. +* shorttitlepage: titlepage. +* smallbook: smallbook. +* smallexample: smallexample & smalllisp. +* smalllisp: smallexample & smalllisp. +* sp (line spacing): sp. +* sp (titlepage line spacing): titlefont center sp. +* ss: Inserting Accents. +* strong: emph & strong. +* subheading: unnumberedsubsec appendixsubsec subheading. +* subsection: subsection. +* subsubheading: subsubsection. +* subsubsection: subsubsection. +* subtitle: title subtitle author. +* summarycontents: Contents. +* syncodeindex: syncodeindex. +* synindex: synindex. +* t (typewriter font): Fonts. +* table: Two-column Tables. +* tex: Raw Formatter Commands. +* tex (command): tex. +* texinfo-all-menus-update: Updating Commands. +* texinfo-every-node-update: Updating Commands. +* texinfo-format-buffer <1>: texinfo-format commands. +* texinfo-format-buffer: Info Formatting. +* texinfo-format-region <1>: texinfo-format commands. +* texinfo-format-region: Info Formatting. +* texinfo-indent-menu-description: Other Updating Commands. +* texinfo-insert-@code: Inserting. +* texinfo-insert-@dfn: Inserting. +* texinfo-insert-@end: Inserting. +* texinfo-insert-@example: Inserting. +* texinfo-insert-@item: Inserting. +* texinfo-insert-@kbd: Inserting. +* texinfo-insert-@node: Inserting. +* texinfo-insert-@noindent: Inserting. +* texinfo-insert-@samp: Inserting. +* texinfo-insert-@table: Inserting. +* texinfo-insert-@var: Inserting. +* texinfo-insert-braces: Inserting. +* texinfo-insert-node-lines: Other Updating Commands. +* texinfo-make-menu: Updating Commands. +* texinfo-master-menu: Updating Commands. +* texinfo-multiple-files-update: texinfo-multiple-files-update. +* texinfo-multiple-files-update (in brief): Other Updating Commands. +* texinfo-sequential-node-update: Other Updating Commands. +* texinfo-show-structure <1>: Using texinfo-show-structure. +* texinfo-show-structure: Showing the Structure. +* texinfo-start-menu-description: Inserting. +* texinfo-tex-buffer: Printing. +* texinfo-tex-print: Printing. +* texinfo-tex-region: Printing. +* texinfo-update-node: Updating Commands. +* thischapter: Custom Headings. +* thischaptername: Custom Headings. +* thisfile: Custom Headings. +* thispage: Custom Headings. +* thistitle: Custom Headings. +* tieaccent: Inserting Accents. +* tindex: Indexing Commands. +* title: title subtitle author. +* titlefont: titlefont center sp. +* titlepage: titlepage. +* today: Custom Headings. +* top (@-command): makeinfo top command. +* u: Inserting Accents. +* ubaraccent: Inserting Accents. +* udotaccent: Inserting Accents. +* unmacro: Defining Macros. +* unnumbered: unnumbered & appendix. +* unnumberedsec: unnumberedsec appendixsec heading. +* unnumberedsubsec: unnumberedsubsec appendixsubsec subheading. +* unnumberedsubsubsec: subsubsection. +* up-list: Inserting. +* uref: uref. +* url: url. +* v: Inserting Accents. +* value: value. +* var: var. +* vindex: Indexing Commands. +* vskip: Copyright & Permissions. +* vtable: ftable vtable. +* w (prevent line break): w. +* xref: xref. +* { (single {): Inserting Braces. +* } (single }): Inserting Braces. +* ~: Inserting Accents. diff --git a/info/texinfo.info-12 b/info/texinfo.info-12 index 4db996c..de69019 100644 --- a/info/texinfo.info-12 +++ b/info/texinfo.info-12 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,829 +33,609 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: Debugging with TeX, Next: Using texinfo-show-structure, Prev: Debugging with Info, Up: Catching Mistakes +File: texinfo.info, Node: Concept Index, Prev: Command and Variable Index, Up: Top -Catching Errors with TeX Formatting -=================================== - - You can also catch mistakes when you format a file with TeX. - - Usually, you will want to do this after you have run -`texinfo-format-buffer' (or, better, `makeinfo-buffer') on the same -file, because `texinfo-format-buffer' sometimes displays error messages -that make more sense than TeX. (*Note Debugging with Info::, for more -information.) - - For example, TeX was run on a Texinfo file, part of which is shown -here: - - ---------- Buffer: texinfo.texi ---------- - name of the Texinfo file as an extension. The - @samp{??} are `wildcards' that cause the shell to - substitute all the raw index files. (@xref{sorting - indices, for more information about sorting - indices.)@refill - ---------- Buffer: texinfo.texi ---------- - -(The cross reference lacks a closing brace.) TeX produced the -following output, after which it stopped: - - ---------- Buffer: *tex-shell* ---------- - Runaway argument? - {sorting indices, for more information about sorting - indices.) @refill @ETC. - ! Paragraph ended before @xref was complete. - - @par - l.27 - - ? - ---------- Buffer: *tex-shell* ---------- - - In this case, TeX produced an accurate and understandable error -message: - - Paragraph ended before @xref was complete. - -`@par' is an internal TeX command of no relevance to Texinfo. `l.27' -means that TeX detected the problem on line 27 of the Texinfo file. -The `?' is the prompt TeX uses in this circumstance. - - Unfortunately, TeX is not always so helpful, and sometimes you must -truly be a Sherlock Holmes to discover what went wrong. - - In any case, if you run into a problem like this, you can do one of -three things. - - 1. You can tell TeX to continue running and ignore just this error by - typing at the `?' prompt. - - 2. You can tell TeX to continue running and to ignore all errors as - best it can by typing `r ' at the `?' prompt. - - This is often the best thing to do. However, beware: the one error - may produce a cascade of additional error messages as its - consequences are felt through the rest of the file. To stop TeX - when it is producing such an avalanche of error messages, type - `C-c' (or `C-c C-c', if you are running a shell inside Emacs). - - 3. You can tell TeX to stop this run by typing `x ' at the `?' - prompt. - - If you are running TeX inside Emacs, you need to switch to the shell -buffer and line at which TeX offers the `?' prompt. - - Sometimes TeX will format a file without producing error messages even -though there is a problem. This usually occurs if a command is not -ended but TeX is able to continue processing anyhow. For example, if -you fail to end an itemized list with the `@end itemize' command, TeX -will write a DVI file that you can print out. The only error message -that TeX will give you is the somewhat mysterious comment that - - (@end occurred inside a group at level 1) - -However, if you print the DVI file, you will find that the text of the -file that follows the itemized list is entirely indented as if it were -part of the last item in the itemized list. The error message is the -way TeX says that it expected to find an `@end' command somewhere in -the file; but that it could not determine where it was needed. - - Another source of notoriously hard-to-find errors is a missing `@end -group' command. If you ever are stumped by incomprehensible errors, -look for a missing `@end group' command first. - - If the Texinfo file lacks header lines, TeX may stop in the beginning -of its run and display output that looks like the following. The `*' -indicates that TeX is waiting for input. - - This is TeX, Version 3.14159 (Web2c 7.0) - (test.texinfo [1]) - * - -In this case, simply type `\end ' after the asterisk. Then write -the header lines in the Texinfo file and run the TeX command again. -(Note the use of the backslash, `\'. TeX uses `\' instead of `@'; and -in this circumstance, you are working directly with TeX, not with -Texinfo.) - - -File: texinfo.info, Node: Using texinfo-show-structure, Next: Using occur, Prev: Debugging with TeX, Up: Catching Mistakes - -Using `texinfo-show-structure' -============================== - - It is not always easy to keep track of the nodes, chapters, sections, -and subsections of a Texinfo file. This is especially true if you are -revising or adding to a Texinfo file that someone else has written. - - In GNU Emacs, in Texinfo mode, the `texinfo-show-structure' command -lists all the lines that begin with the @-commands that specify the -structure: `@chapter', `@section', `@appendix', and so on. With an -argument (`C-u' as prefix argument, if interactive), the command also -shows the `@node' lines. The `texinfo-show-structure' command is bound -to `C-c C-s' in Texinfo mode, by default. - - The lines are displayed in a buffer called the `*Occur*' buffer, -indented by hierarchical level. For example, here is a part of what was -produced by running `texinfo-show-structure' on this manual: - - Lines matching "^@\\(chapter \\|sect\\|subs\\|subh\\| - unnum\\|major\\|chapheading \\|heading \\|appendix\\)" - in buffer texinfo.texi. - ... - 4177:@chapter Nodes - 4198: @heading Two Paths - 4231: @section Node and Menu Illustration - 4337: @section The @code{@@node} Command - 4393: @subheading Choosing Node and Pointer Names - 4417: @subsection How to Write an @code{@@node} Line - 4469: @subsection @code{@@node} Line Tips - ... - - This says that lines 4337, 4393, and 4417 of `texinfo.texi' begin -with the `@section', `@subheading', and `@subsection' commands -respectively. If you move your cursor into the `*Occur*' window, you -can position the cursor over one of the lines and use the `C-c C-c' -command (`occur-mode-goto-occurrence'), to jump to the corresponding -spot in the Texinfo file. *Note Using Occur: (emacs)Other Repeating -Search, for more information about `occur-mode-goto-occurrence'. - - The first line in the `*Occur*' window describes the "regular -expression" specified by TEXINFO-HEADING-PATTERN. This regular -expression is the pattern that `texinfo-show-structure' looks for. -*Note Using Regular Expressions: (emacs)Regexps, for more information. - - When you invoke the `texinfo-show-structure' command, Emacs will -display the structure of the whole buffer. If you want to see the -structure of just a part of the buffer, of one chapter, for example, -use the `C-x n n' (`narrow-to-region') command to mark the region. -(*Note Narrowing: (emacs)Narrowing.) This is how the example used -above was generated. (To see the whole buffer again, use `C-x n w' -(`widen').) - - If you call `texinfo-show-structure' with a prefix argument by typing -`C-u C-c C-s', it will list lines beginning with `@node' as well as the -lines beginning with the @-sign commands for `@chapter', `@section', -and the like. - - You can remind yourself of the structure of a Texinfo file by looking -at the list in the `*Occur*' window; and if you have mis-named a node -or left out a section, you can correct the mistake. - - -File: texinfo.info, Node: Using occur, Next: Running Info-Validate, Prev: Using texinfo-show-structure, Up: Catching Mistakes - -Using `occur' -============= - - Sometimes the `texinfo-show-structure' command produces too much -information. Perhaps you want to remind yourself of the overall -structure of a Texinfo file, and are overwhelmed by the detailed list -produced by `texinfo-show-structure'. In this case, you can use the -`occur' command directly. To do this, type - - M-x occur - -and then, when prompted, type a "regexp", a regular expression for the -pattern you want to match. (*Note Regular Expressions: -(emacs)Regexps.) The `occur' command works from the current location -of the cursor in the buffer to the end of the buffer. If you want to -run `occur' on the whole buffer, place the cursor at the beginning of -the buffer. - - For example, to see all the lines that contain the word `@chapter' in -them, just type `@chapter'. This will produce a list of the chapters. -It will also list all the sentences with `@chapter' in the middle of -the line. - - If you want to see only those lines that start with the word -`@chapter', type `^@chapter' when prompted by `occur'. If you want to -see all the lines that end with a word or phrase, end the last word -with a `$'; for example, `catching mistakes$'. This can be helpful -when you want to see all the nodes that are part of the same chapter or -section and therefore have the same `Up' pointer. - - *Note Using Occur: (emacs)Other Repeating Search, for more -information. - - -File: texinfo.info, Node: Running Info-Validate, Prev: Using occur, Up: Catching Mistakes - -Finding Badly Referenced Nodes -============================== - - You can use the `Info-validate' command to check whether any of the -`Next', `Previous', `Up' or other node pointers fail to point to a -node. This command checks that every node pointer points to an -existing node. The `Info-validate' command works only on Info files, -not on Texinfo files. - - The `makeinfo' program validates pointers automatically, so you do -not need to use the `Info-validate' command if you are using -`makeinfo'. You only may need to use `Info-validate' if you are unable -to run `makeinfo' and instead must create an Info file using -`texinfo-format-region' or `texinfo-format-buffer', or if you write an -Info file from scratch. - -* Menu: - -* Using Info-validate:: How to run `Info-validate'. -* Unsplit:: How to create an unsplit file. -* Tagifying:: How to tagify a file. -* Splitting:: How to split a file manually. - - -File: texinfo.info, Node: Using Info-validate, Next: Unsplit, Prev: Running Info-Validate, Up: Running Info-Validate - -Running `Info-validate' ------------------------ - - To use `Info-validate', visit the Info file you wish to check and -type: - - M-x Info-validate - -Note that the `Info-validate' command requires an upper case `I'. You -may also need to create a tag table before running `Info-validate'. -*Note Tagifying::. - - If your file is valid, you will receive a message that says "File -appears valid". However, if you have a pointer that does not point to -a node, error messages will be displayed in a buffer called `*problems -in info file*'. - - For example, `Info-validate' was run on a test file that contained -only the first node of this manual. One of the messages said: - - In node "Overview", invalid Next: Texinfo Mode - -This meant that the node called `Overview' had a `Next' pointer that -did not point to anything (which was true in this case, since the test -file had only one node in it). - - Now suppose we add a node named `Texinfo Mode' to our test case but -we do not specify a `Previous' for this node. Then we will get the -following error message: - - In node "Texinfo Mode", should have Previous: Overview - -This is because every `Next' pointer should be matched by a `Previous' -(in the node where the `Next' points) which points back. - - `Info-validate' also checks that all menu entries and cross references -point to actual nodes. - - `Info-validate' requires a tag table and does not work with files -that have been split. (The `texinfo-format-buffer' command -automatically splits large files.) In order to use `Info-validate' on -a large file, you must run `texinfo-format-buffer' with an argument so -that it does not split the Info file; and you must create a tag table -for the unsplit file. - - -File: texinfo.info, Node: Unsplit, Next: Tagifying, Prev: Using Info-validate, Up: Running Info-Validate - -Creating an Unsplit File ------------------------- - - You can run `Info-validate' only on a single Info file that has a tag -table. The command will not work on the indirect subfiles that are -generated when a master file is split. If you have a large file -(longer than 70,000 bytes or so), you need to run the -`texinfo-format-buffer' or `makeinfo-buffer' command in such a way that -it does not create indirect subfiles. You will also need to create a -tag table for the Info file. After you have done this, you can run -`Info-validate' and look for badly referenced nodes. - - The first step is to create an unsplit Info file. To prevent -`texinfo-format-buffer' from splitting a Texinfo file into smaller Info -files, give a prefix to the `M-x texinfo-format-buffer' command: - - C-u M-x texinfo-format-buffer - -or else - - C-u C-c C-e C-b - -When you do this, Texinfo will not split the file and will not create a -tag table for it. - - -File: texinfo.info, Node: Tagifying, Next: Splitting, Prev: Unsplit, Up: Running Info-Validate - -Tagifying a File ----------------- - - After creating an unsplit Info file, you must create a tag table for -it. Visit the Info file you wish to tagify and type: - - M-x Info-tagify - -(Note the upper case `I' in `Info-tagify'.) This creates an Info file -with a tag table that you can validate. - - The third step is to validate the Info file: - - M-x Info-validate - -(Note the upper case `I' in `Info-validate'.) In brief, the steps are: - - C-u M-x texinfo-format-buffer - M-x Info-tagify - M-x Info-validate - - After you have validated the node structure, you can rerun -`texinfo-format-buffer' in the normal way so it will construct a tag -table and split the file automatically, or you can make the tag table -and split the file manually. - - -File: texinfo.info, Node: Splitting, Prev: Tagifying, Up: Running Info-Validate - -Splitting a File Manually -------------------------- - - You should split a large file or else let the `texinfo-format-buffer' -or `makeinfo-buffer' command do it for you automatically. (Generally -you will let one of the formatting commands do this job for you. *Note -Creating an Info File::.) - - The split-off files are called the indirect subfiles. - - Info files are split to save memory. With smaller files, Emacs does -not have make such a large buffer to hold the information. - - If an Info file has more than 30 nodes, you should also make a tag -table for it. *Note Using Info-validate::, for information about -creating a tag table. (Again, tag tables are usually created -automatically by the formatting command; you only need to create a tag -table yourself if you are doing the job manually. Most likely, you -will do this for a large, unsplit file on which you have run -`Info-validate'.) - - Visit the Info file you wish to tagify and split and type the two -commands: - - M-x Info-tagify - M-x Info-split - -(Note that the `I' in `Info' is upper case.) - - When you use the `Info-split' command, the buffer is modified into a -(small) Info file which lists the indirect subfiles. This file should -be saved in place of the original visited file. The indirect subfiles -are written in the same directory the original file is in, with names -generated by appending `-' and a number to the original file name. - - The primary file still functions as an Info file, but it contains just -the tag table and a directory of subfiles. - - -File: texinfo.info, Node: Refilling Paragraphs, Next: Command Syntax, Prev: Catching Mistakes, Up: Top - -Refilling Paragraphs -******************** - - The `@refill' command refills and, optionally, indents the first line -of a paragraph.(1) (*note Refilling Paragraphs-Footnote-1::) The -`@refill' command is no longer important, but we describe it here -because you once needed it. You will see it in many old Texinfo files. - - Without refilling, paragraphs containing long @-constructs may look -bad after formatting because the formatter removes @-commands and -shortens some lines more than others. In the past, neither the -`texinfo-format-region' command nor the `texinfo-format-buffer' command -refilled paragraphs automatically. The `@refill' command had to be -written at the end of every paragraph to cause these formatters to fill -them. (Both TeX and `makeinfo' have always refilled paragraphs -automatically.) Now, all the Info formatters automatically fill and -indent those paragraphs that need to be filled and indented. - - The `@refill' command causes `texinfo-format-region' and -`texinfo-format-buffer' to refill a paragraph in the Info file _after_ -all the other processing has been done. For this reason, you can not -use `@refill' with a paragraph containing either `@*' or `@w{ ... }' -since the refilling action will override those two commands. - - The `texinfo-format-region' and `texinfo-format-buffer' commands now -automatically append `@refill' to the end of each paragraph that should -be filled. They do not append `@refill' to the ends of paragraphs that -contain `@*' or `@w{ ...}' and therefore do not refill or indent them. - - -File: texinfo.info, Node: Refilling Paragraphs-Footnotes, Up: Refilling Paragraphs - - (1) Perhaps the command should have been called the -`@refillandindent' command, but `@refill' is shorter and the name was -chosen before indenting was possible. - - -File: texinfo.info, Node: Command Syntax, Next: Obtaining TeX, Prev: Refilling Paragraphs, Up: Top - -@-Command Syntax -**************** - - The character `@' is used to start special Texinfo commands. (It has -the same meaning that `\' has in plain TeX.) Texinfo has four types of -@-command: - -1. Non-alphabetic commands. - These commands consist of an @ followed by a punctuation mark or - other character that is not part of the alphabet. Non-alphabetic - commands are almost always part of the text within a paragraph, - and never take any argument. The two characters (@ and the other - one) are complete in themselves; none is followed by braces. The - non-alphabetic commands are: `@.', `@:', `@*', `@SPACE', `@TAB', - `@NL', `@@', `@{', and `@}'. - -2. Alphabetic commands that do not require arguments. - These commands start with @ followed by a word followed by left- - and right-hand braces. These commands insert special symbols in - the document; they do not require arguments. For example, - `@dots{}' => `...', `@equiv{}' => `==', `@TeX{}' => `TeX', and - `@bullet{}' => `*'. - -3. Alphabetic commands that require arguments within braces. - These commands start with @ followed by a letter or a word, - followed by an argument within braces. For example, the command - `@dfn' indicates the introductory or defining use of a term; it is - used as follows: `In Texinfo, @@-commands are @dfn{mark-up} - commands.' - -4. Alphabetic commands that occupy an entire line. - These commands occupy an entire line. The line starts with @, - followed by the name of the command (a word); for example, - `@center' or `@cindex'. If no argument is needed, the word is - followed by the end of the line. If there is an argument, it is - separated from the command name by a space. Braces are not used. - - Thus, the alphabetic commands fall into classes that have different -argument syntaxes. You cannot tell to which class a command belongs by -the appearance of its name, but you can tell by the command's meaning: -if the command stands for a glyph, it is in class 2 and does not -require an argument; if it makes sense to use the command together with -other text as part of a paragraph, the command is in class 3 and must -be followed by an argument in braces; otherwise, it is in class 4 and -uses the rest of the line as its argument. - - The purpose of having a different syntax for commands of classes 3 and -4 is to make Texinfo files easier to read, and also to help the GNU -Emacs paragraph and filling commands work properly. There is only one -exception to this rule: the command `@refill', which is always used at -the end of a paragraph immediately following the final period or other -punctuation character. `@refill' takes no argument and does _not_ -require braces. `@refill' never confuses the Emacs paragraph commands -because it cannot appear at the beginning of a line. - - -File: texinfo.info, Node: Obtaining TeX, Next: Command and Variable Index, Prev: Command Syntax, Up: Top - -How to Obtain TeX -***************** - - TeX is freely redistributable. You can obtain TeX for Unix systems -via anonymous ftp or on physical media. The core material consists of -the Web2c TeX distribution (`http://tug.org/web2c'). - - Instructions for retrieval by anonymous ftp and information on other -available distributions: - `ftp://tug.org/tex/unixtex.ftp' - `http://tug.org/unixtex.ftp' - - The Free Software Foundation provides a core distribution on its -Source Code CD-ROM suitable for printing Texinfo manuals. To order it, -contact: - - Free Software Foundation, Inc. - 59 Temple Place Suite 330 - Boston, MA 02111-1307 - USA - Telephone: +1-617-542-5942 - Fax: (including Japan) +1-617-542-2652 - Free Dial Fax (in Japan): - 0031-13-2473 (KDD) - 0066-3382-0158 (IDC) - Electronic mail: `gnu@gnu.org' - - Many other TeX distributions are available; see `http://tug.org/'. - - -File: texinfo.info, Node: Command and Variable Index, Next: Concept Index, Prev: Obtaining TeX, Up: Top - -Command and Variable Index -************************** - - This is an alphabetical list of all the @-commands, assorted Emacs -Lisp functions, and several variables. To make the list easier to use, -the commands are listed without their preceding `@'. +Concept Index +************* * Menu: -* ! (end of sentence): Ending a Sentence. -* ": Inserting Accents. -* ': Inserting Accents. -* (newline): Multiple Spaces. -* (space): Multiple Spaces. -* (tab): Multiple Spaces. -* * (force line break): Line Breaks. -* ,: Inserting Accents. -* -: - and hyphenation. -* . (end of sentence): Ending a Sentence. -* : (suppress widening): Not Ending a Sentence. -* =: Inserting Accents. -* ? (end of sentence): Ending a Sentence. -* @ (single @): Inserting An Atsign. -* \emergencystretch: Overfull hboxes. -* ^: Inserting Accents. -* `: Inserting Accents. -* aa: Inserting Accents. +* !: Inserting Accents. +* (dir) as Up node of Top node: First Node. +* --delete: Invoking install-info. +* --dir-file=NAME: Invoking install-info. +* --entry=TEXT: Invoking install-info. +* --error-limit=LIMIT: makeinfo options. +* --fill-column=WIDTH: makeinfo options. +* --footnote-style=STYLE: makeinfo options. +* --force: makeinfo options. +* --help <1>: Invoking install-info. +* --help: makeinfo options. +* --info-dir=DIR: Invoking install-info. +* --info-file=FILE: Invoking install-info. +* --item=TEXT: Invoking install-info. +* --no-headers: makeinfo options. +* --no-number-footnotes: makeinfo options. +* --no-pointer-validate: makeinfo options. +* --no-split: makeinfo options. +* --no-validate: makeinfo options. +* --no-warn: makeinfo options. +* --output=FILE: makeinfo options. +* --paragraph-indent=INDENT: makeinfo options. +* --quiet: Invoking install-info. +* --reference-limit=LIMIT: makeinfo options. +* --remove: Invoking install-info. +* --section=SEC: Invoking install-info. +* --verbose: makeinfo options. +* --version <1>: Invoking install-info. +* --version: makeinfo options. +* -D VAR: makeinfo options. +* -I DIR: makeinfo options. +* -o FILE: makeinfo options. +* -P DIR: makeinfo options. +* .cshrc initialization file: Preparing for TeX. +* .profile initialization file: Preparing for TeX. +* /L: Inserting Accents. +* /l: Inserting Accents. +* /O: Inserting Accents. +* /o: Inserting Accents. +* ?: Inserting Accents. +* @-command in nodename: Node Line Requirements. +* @-command list: Command List. +* @-command syntax: Command Syntax. +* @-commands: Formatting Commands. +* @include file sample: Sample Include File. +* @menu parts: Menu Parts. +* @node line writing: Writing a Node. +* A4 paper, printing on: A4 Paper. * AA: Inserting Accents. -* acronym: acronym. -* ae: Inserting Accents. +* aa: Inserting Accents. +* Abbreviations for keys: key. +* Accents, inserting: Inserting Accents. +* Acute accent: Inserting Accents. +* Adding a new info file: New Info File. * AE: Inserting Accents. -* afourlatex: A4 Paper. -* afourpaper: A4 Paper. -* alias: alias. -* anchor: anchor. -* appendix: unnumbered & appendix. -* appendixsec: unnumberedsec appendixsec heading. -* appendixsection: unnumberedsec appendixsec heading. -* appendixsubsec: unnumberedsubsec appendixsubsec subheading. -* appendixsubsubsec: subsubsection. -* apply: Sample Function Definition. -* asis: table. -* author: title subtitle author. -* b (bold font): Fonts. -* buffer-end: Def Cmd Template. -* bullet: bullet. -* bye <1>: File End. -* bye: Ending a File. -* c (comment): Comments. -* cartouche: cartouche. -* center: titlefont center sp. -* centerchap: chapter. -* chapheading: majorheading & chapheading. -* chapter: chapter. -* cindex: Indexing Commands. -* cite: cite. -* clear: ifset ifclear. -* code: code. -* columnfractions: Multitable Column Widths. -* command: command. -* comment: Comments. -* contents: Contents. -* copyright <1>: copyright symbol. -* copyright: Copyright & Permissions. -* cropmarks: Cropmarks and Magnification. -* defcodeindex: New Indices. -* defcv: Abstract Objects. -* deffn: Functions Commands. -* deffnx: deffnx. -* defindex: New Indices. -* definfoenclose: definfoenclose. -* defivar: Abstract Objects. -* defmac: Functions Commands. -* defmethod: Abstract Objects. -* defop: Abstract Objects. -* defopt: Variables Commands. -* defspec: Functions Commands. -* deftp: Data Types. -* deftypefn: Typed Functions. -* deftypefun: Typed Functions. -* deftypeivar: Abstract Objects. -* deftypeop: Abstract Objects. -* deftypevar: Typed Variables. -* deftypevr: Typed Variables. -* defun: Functions Commands. -* defvar: Variables Commands. -* defvr: Variables Commands. -* Development/Docs/Texinfo Customize group: Texinfo Mode Printing. -* dfn: dfn. -* dircategory: Installing Dir Entries. -* direntry: Installing Dir Entries. -* display: display. -* dmn: dmn. -* documentencoding: documentencoding. -* documentlanguage: documentlanguage. -* dotaccent: Inserting Accents. -* dotless: Inserting Accents. -* dots: dots. -* email: email. -* emph: emph & strong. -* end <1>: Introducing Lists. -* end: Quotations and Examples. -* end titlepage: end titlepage. -* enddots: dots. -* enumerate: enumerate. -* env: env. -* equiv: Equivalence. -* error: Error Glyph. -* evenfooting: Custom Headings. -* evenheading: Custom Headings. -* everyfooting: Custom Headings. -* everyheading: Custom Headings. -* example: example. -* exampleindent: exampleindent. -* exclamdown: Inserting Accents. -* exdent: exdent. -* expansion: expansion. -* file: file. -* filll: Copyright & Permissions. -* finalout: Overfull hboxes. -* findex: Indexing Commands. -* flushleft: flushleft & flushright. -* flushright: flushleft & flushright. -* foobar: Optional Arguments. -* footnote: Footnotes. -* footnotestyle: Footnote Styles. -* format: format. -* forward-word: Def Cmd Template. -* ftable: ftable vtable. -* group: group. -* H: Inserting Accents. -* hbox: Overfull hboxes. -* heading: unnumberedsec appendixsec heading. -* headings: headings on off. -* headword: definfoenclose. -* html: Raw Formatter Commands. -* hyphenation: - and hyphenation. -* i (italic font): Fonts. -* ifclear: ifset ifclear. -* ifhtml <1>: Raw Formatter Commands. -* ifhtml: Conditional Commands. -* ifinfo: Conditional Commands. -* ifnothtml: Conditional Not Commands. -* ifnotinfo: Conditional Not Commands. -* ifnottex: Conditional Not Commands. -* ifset: ifset ifclear. -* iftex: Conditional Commands. -* ignore: Comments. -* image: Images. -* include: Using Include Files. -* Info-validate: Running Info-Validate. -* inforef: inforef. -* input (TeX command): Minimum. -* isearch-backward: deffnx. -* isearch-forward: deffnx. -* item <1>: itemize. -* item <2>: table. -* item: Multitable Rows. -* itemize: itemize. -* itemx: itemx. -* kbd: kbd. -* kbdinputstyle: kbd. -* key: key. -* kindex: Indexing Commands. -* l: Inserting Accents. -* L: Inserting Accents. -* lisp: lisp. -* lowersections: Raise/lower sections. -* macro: Defining Macros. -* mag (TeX command): Cropmarks and Magnification. -* majorheading: majorheading & chapheading. -* makeinfo-buffer: makeinfo in Emacs. -* makeinfo-kill-job: makeinfo in Emacs. -* makeinfo-recenter-output-buffer: makeinfo in Emacs. -* makeinfo-region: makeinfo in Emacs. -* math: math. -* menu: Menus. -* minus: minus. -* multitable: Multi-column Tables. -* need: need. -* next-error: makeinfo in Emacs. -* node: node. -* noindent: noindent. -* novalidate: Format with tex/texindex. -* o: Inserting Accents. -* O: Inserting Accents. -* occur: Using occur. -* occur-mode-goto-occurrence: Showing the Structure. -* oddfooting: Custom Headings. -* oddheading: Custom Headings. +* ae: Inserting Accents. +* Alphabetical @-command list: Command List. +* Another Info directory: Other Info Directories. +* Apostrophe in nodename: Node Line Requirements. +* Arguments, repeated and optional: Optional Arguments. +* Aspect ratio of images: Images. +* Automatic pointer creation with makeinfo: makeinfo Pointer Creation. +* Automatically insert nodes, menus: Updating Nodes and Menus. +* Backslash, and macros: Invoking Macros. +* Badly referenced nodes: Running Info-Validate. +* Batch formatting for Info: Batch Formatting. +* Beginning a Texinfo file: Beginning a File. +* Beginning line of a Texinfo file: First Line. +* Berry, Karl: Acknowledgements. +* Big points: Images. +* Black rectangle in hardcopy: Overfull hboxes. +* Blank lines: sp. +* Body of a macro: Defining Macros. +* Book characteristics, printed: Printed Books. +* Book, printing small: smallbook. +* Box with rounded corners: cartouche. +* Braces and argument syntax: Command Syntax. +* Braces, inserting: Braces Atsigns. +* Braces, when to use: Formatting Commands. +* Breaks in a line: Line Breaks. +* Breve accent: Inserting Accents. +* Buffer formatting and printing: Printing. +* Bullets, inserting: Dots Bullets. +* Case in nodename: Node Line Requirements. +* Catching errors with Info formatting: Debugging with Info. +* Catching errors with TeX formatting: Debugging with TeX. +* Catching mistakes: Catching Mistakes. +* Cedilla accent: Inserting Accents. +* Centimeters: Images. +* Chapter structuring: Structuring. +* Characteristics, printed books or manuals: Printed Books. +* Chassell, Robert J.: Acknowledgements. +* Check accent: Inserting Accents. +* Checking for badly referenced nodes: Running Info-Validate. +* Ciceros: Images. +* Circumflex accent: Inserting Accents. +* code, arg to @kbdinputstyle: kbd. +* colon last in INFOPATH: Other Info Directories. +* Column widths, defining for multitables: Multitable Column Widths. +* Combining indices: Combining Indices. +* Comma in nodename: Node Line Requirements. +* Command definitions: Sample Function Definition. +* Commands to insert special characters: Braces Atsigns. +* Commands using raw HTML: Raw Formatter Commands. +* Commands using raw TeX: Raw Formatter Commands. +* Commands, inserting them: Inserting. +* Comments: Comments. +* Compile command for formatting: Compile-Command. +* Conditionally visible text: Conditionals. +* Conditions for copying Texinfo: Copying. +* Contents, Table of: Contents. +* Contents-like outline of file structure: Showing the Structure. +* Conventions for writing definitions: Def Cmd Conventions. +* Conventions, syntactic: Conventions. +* Copying conditions: Copying. +* Copying permissions: Sample Permissions. +* Copying software: Software Copying Permissions. +* Copyright page: Copyright & Permissions. +* Correcting mistakes: Catching Mistakes. +* Create nodes, menus automatically: Updating Nodes and Menus. +* Creating an Info file: Create an Info File. +* Creating an unsplit file: Unsplit. +* Creating index entries: Indexing Commands. +* Creating indices: Indices. +* Creating pointers with makeinfo: makeinfo Pointer Creation. +* Cropmarks for printing: Cropmarks and Magnification. +* Cross reference parts: Cross Reference Parts. +* Cross references: Cross References. +* Cross references using @inforef: inforef. +* Cross references using @pxref: pxref. +* Cross references using @ref: ref. +* Cross references using @xref: xref. +* Customized highlighting: Customized Highlighting. +* Customizing of TeX for Texinfo: Preparing for TeX. +* Debugging the Texinfo structure: Catching Mistakes. +* Debugging with Info formatting: Debugging with Info. +* Debugging with TeX formatting: Debugging with TeX. +* Defining indexing entries: Indexing Commands. +* Defining macros: Defining Macros. +* Defining new indices: New Indices. +* Defining new Texinfo commands: Macros. +* Definition commands: Definition Commands. +* Definition conventions: Def Cmd Conventions. +* Definition template: Def Cmd Template. +* Definitions grouped together: deffnx. +* Description for menu, start: Inserting. +* Dido^t points: Images. +* Different cross reference commands: Cross Reference Commands. +* Dimension formatting: dmn. +* Dimensions and image sizes: Images. +* dir directory for Info installation: Install an Info File. +* dir file listing: New Info File. +* dir, created by install-info: Invoking install-info. +* Display formatting: display. +* distinct, arg to @kbdinputstyle: kbd. +* Distorting images: Images. +* Distribution: Software Copying Permissions. +* Dot accent: Inserting Accents. +* Dotless i, j: Inserting Accents. +* Dots, inserting <1>: dots. +* Dots, inserting: Dots Bullets. +* Double-colon menu entries: Less Cluttered Menu Entry. +* DVI file: Format with tex/texindex. +* Ellipsis, inserting: Dots Bullets. +* Emacs: Texinfo Mode. +* Emacs shell, format, print from: Within Emacs. +* Emphasizing text: Emphasis. +* Emphasizing text, font for: emph & strong. +* Enclosure command for Info: Customized Highlighting. +* End node footnote style: Footnote Styles. +* End of header line: End of Header. +* End titlepage starts headings: end titlepage. +* Ending a Sentence: Ending a Sentence. +* Ending a Texinfo file: Ending a File. +* Entries for an index: Indexing Commands. +* Entries, making index: Index Entries. +* Enumeration: enumerate. +* epsf.tex: Images. +* epsf.tex, installing: Preparing for TeX. +* Equivalence, indicating it: Equivalence. +* Error message, indicating it: Error Glyph. +* Errors, parsing: makeinfo in Emacs. +* Es-zet: Inserting Accents. +* European A4 paper: A4 Paper. +* Evaluation glyph: result. +* Example for a small book: smallexample & smalllisp. +* Example menu: Menu Example. +* example, arg to @kbdinputstyle: kbd. +* Examples, formatting them: example. +* Expansion, indicating it: expansion. +* File beginning: Beginning a File. +* File ending: Ending a File. +* File section structure, showing it: Showing the Structure. +* Filling paragraphs: Refilling Paragraphs. +* Final output: Overfull hboxes. +* Finding badly referenced nodes: Running Info-Validate. +* Fine-tuning, and hyphenation: - and hyphenation. +* First line of a Texinfo file: First Line. +* First node: First Node. +* Floating accents, inserting: Inserting Accents. +* Fonts for indices: syncodeindex. +* Fonts for printing, not for Info: Fonts. +* Footings: Headings. +* Footnotes: Footnotes. +* Format a dimension: dmn. +* Format and print hardcopy: Format/Print Hardcopy. +* Format and print in Texinfo mode: Texinfo Mode Printing. +* Format with the compile command: Compile-Command. +* Format, print from Emacs shell: Within Emacs. +* Formats for images: Images. +* Formatting a file for Info: Create an Info File. +* Formatting commands: Formatting Commands. +* Formatting examples: example. +* Formatting for Info: Info Formatting. +* Formatting for printing: Printing. +* Formatting headings and footings: Headings. +* Formatting requirements: Requirements Summary. +* Formatting with tex and texindex: Format with tex/texindex. +* Frequently used commands, inserting: Inserting. +* Function definitions: Sample Function Definition. +* General syntactic conventions: Conventions. +* Generating menus with indices: Printing Indices & Menus. +* German S: Inserting Accents. +* Globbing: Format with tex/texindex. +* Glyphs: Glyphs. +* GNU Emacs: Texinfo Mode. +* GNU Emacs shell, format, print from: Within Emacs. +* Going to other Info files' nodes: Other Info Files. +* Grave accent: Inserting Accents. +* Group (hold text together vertically): group. +* Grouping two definitions together: deffnx. +* Hardcopy, printing it: Format/Print Hardcopy. +* hboxes, overfull: Overfull hboxes. +* Header for Texinfo files: Header. +* Header of a Texinfo file: First Line. +* Headings: Headings. +* Headings, page, begin to appear: end titlepage. +* Height of images: Images. +* Highlighting text: Indicating. +* Highlighting, customized: Customized Highlighting. +* Hints: Tips. +* Holding text together vertically: group. +* HTML commands, using ordinary: Raw Formatter Commands. +* Hungariam umlaut accent: Inserting Accents. +* Hyphenation, helping TeX do: - and hyphenation. +* Hyphenation, preventing: w. +* i: Inserting Accents. +* If text conditionally visible: Conditionals. +* ifinfo permissions: ifinfo Permissions. +* Ignored before @setfilename: setfilename. +* Ignored text: Comments. +* Image formats: Images. +* Images, inserting: Images. +* Inches: Images. +* Include file requirements: Include File Requirements. +* Include file sample: Sample Include File. +* Include files: Include Files. +* Include files, and section levels: Raise/lower sections. +* Indentation undoing: exdent. +* Indenting paragraphs: paragraphindent. +* Index entries: Indexing Commands. +* Index entries, making: Index Entries. +* Index entry writing: Indexing Commands. +* Index font types: Indexing Commands. +* Indexing commands, predefined: Indexing Commands. +* Indexing table entries automatically: ftable vtable. +* Indicating commands, definitions, etc.: Indicating. +* Indicating evaluation: result. +* Indices: Indices. +* Indices, combining them: Combining Indices. +* Indices, defining new: New Indices. +* Indices, printing and menus: Printing Indices & Menus. +* Indices, sorting: Format/Print Hardcopy. +* Indices, two letter names: syncodeindex. +* Indirect subfiles: Tag and Split Files. +* Info batch formatting: Batch Formatting. +* Info file installation: Install an Info File. +* Info file requires @setfilename: setfilename. +* Info file, listing new one: New Info File. +* Info file, splitting manually: Splitting. +* Info files: Info Files. +* Info formatting: Info Formatting. +* Info installed in another directory: Other Info Directories. +* Info validating a large file: Using Info-validate. +* Info, creating an on-line file: Create an Info File. +* Info-directory-list: Other Info Directories. +* Info; other files' nodes: Other Info Files. +* INFOPATH: Other Info Directories. +* Initialization file for TeX input: Preparing for TeX. +* Insert nodes, menus automatically: Updating Nodes and Menus. +* Inserting @, braces: Braces Atsigns. +* Inserting accents: Inserting Accents. +* Inserting dots <1>: dots. +* Inserting dots: Dots Bullets. +* Inserting ellipsis: Dots Bullets. +* Inserting frequently used commands: Inserting. +* Inserting space: Inserting Space. +* Inserting special characters and symbols: Insertions. +* install-info: Invoking install-info. +* Installing an Info file: Install an Info File. +* Installing Info in another directory: Other Info Directories. +* Introduction, as part of file: Software Copying Permissions. +* Invoking macros: Invoking Macros. +* Itemization: itemize. +* j: Inserting Accents. +* keyboard input: kbd. +* Keys, recommended names: key. +* Knuth, Donald: Printed Books. +* Larger or smaller pages: Cropmarks and Magnification. +* Less cluttered menu entry: Less Cluttered Menu Entry. +* License agreement: Software Copying Permissions. +* Line breaks: Line Breaks. +* Line breaks, preventing: w. +* Line length, column widths as fraction of: Multitable Column Widths. +* Line spacing: sp. +* Lisp example: Lisp Example. +* Lisp example for a small book: smallexample & smalllisp. +* List of @-commands: Command List. +* Listing a new info file: New Info File. +* Lists and tables, making: Lists and Tables. +* Local variables: Compile-Command. +* Location of menus: Menu Location. +* Looking for badly referenced nodes: Running Info-Validate. +* lpr (DVI print command): Print with lpr. +* Macro definitions <1>: Defining Macros. +* Macro definitions: Sample Function Definition. +* Macro invocation: Invoking Macros. +* Macron accent: Inserting Accents. +* Macros: Macros. +* Macros, undefining: Defining Macros. +* Magnified printing: Cropmarks and Magnification. +* mailto link: email. +* makeinfo inside Emacs: makeinfo in Emacs. +* makeinfo options: makeinfo options. +* Making a printed manual: Format/Print Hardcopy. +* Making a tag table automatically: Tag and Split Files. +* Making a tag table manually: Unsplit. +* Making cross references: Cross References. +* Making line and page breaks: Breaks. +* Making lists and tables: Lists and Tables. +* Manual characteristics, printed: Printed Books. +* Marking text within a paragraph: Marking Text. +* Marking words and phrases: Marking Text. +* Master menu: The Top Node. +* Master menu parts: Master Menu Parts. +* Mathematical expressions <1>: Raw Formatter Commands. +* Mathematical expressions: math. +* Menu description, start: Inserting. +* Menu entries with two colons: Less Cluttered Menu Entry. +* Menu example: Menu Example. +* Menu location: Menu Location. +* Menu parts: Menu Parts. +* Menu writing: Writing a Menu. +* Menus: Menus. +* Menus generated with indices: Printing Indices & Menus. +* META key: key. +* Meta-syntactic chars for arguments: Optional Arguments. +* Millimeters: Images. +* Minimal requirements for formatting: Requirements Summary. +* Minimal Texinfo file (requirements): Minimum. +* Mistakes, catching: Catching Mistakes. +* Mode, using Texinfo: Texinfo Mode. +* Multiple spaces: Multiple Spaces. +* Multitable column widths: Multitable Column Widths. +* Multitable rows: Multitable Rows. +* Must have in Texinfo file: Minimum. +* Mutually recursive macros: Defining Macros. +* Names for indices: syncodeindex. +* Names of index files: Format with tex/texindex. +* Names recommended for keys: key. +* Naming a `Top' Node in references: Top Node Naming. +* Need space at page bottom: need. +* New index defining: New Indices. +* New info file, listing it in dir file: New Info File. +* New Texinfo commands, defining: Macros. +* Node line requirements: Node Line Requirements. +* Node line writing: Writing a Node. +* Node, `Top': The Top Node. +* Node, defined: node. +* Nodename must be unique: Node Line Requirements. +* Nodename, cannot contain: Node Line Requirements. +* Nodes for menus are short: Menu Location. +* Nodes in other Info files: Other Info Files. +* Nodes, catching mistakes: Catching Mistakes. +* Nodes, checking for badly referenced: Running Info-Validate. +* Not ending a sentence: Not Ending a Sentence. +* Obtaining TeX: Obtaining TeX. +* Occurrences, listing with @occur: Using occur. * OE: Inserting Accents. * oe: Inserting Accents. -* option: option. -* page: page. -* page, within @titlepage: titlepage. -* pagesizes: pagesizes. -* paragraphindent: paragraphindent. -* phoo: definfoenclose. -* pindex: Indexing Commands. -* point: Point Glyph. -* pounds: pounds. -* print: Print Glyph. -* printindex: Printing Indices & Menus. -* pxref: pxref. -* questiondown: Inserting Accents. -* quotation: quotation. -* r (Roman font): Fonts. -* raisesections: Raise/lower sections. -* ref: ref. -* refill: Refilling Paragraphs. -* result: result. -* ringaccent: Inserting Accents. -* rmacro: Defining Macros. -* samp: samp. -* sc (small caps font): Smallcaps. -* section: section. -* set: ifset ifclear. -* setchapternewpage: setchapternewpage. -* setcontentsaftertitlepage: Contents. -* setfilename: setfilename. -* setshortcontentsaftertitlepage: Contents. -* settitle: settitle. -* shortcontents: Contents. -* shorttitlepage: titlepage. -* smallbook: smallbook. -* smalldisplay <1>: small. -* smalldisplay: display. -* smallexample: small. -* smallformat <1>: small. -* smallformat: format. -* smalllisp: small. -* sp (line spacing): sp. -* sp (titlepage line spacing): titlefont center sp. +* Optional and repeated arguments: Optional Arguments. +* Options for makeinfo: makeinfo options. +* Ordinary HTML commands, using: Raw Formatter Commands. +* Ordinary TeX commands, using: Raw Formatter Commands. +* Other Info files' nodes: Other Info Files. +* Outline of file structure, showing it: Showing the Structure. +* Overfull hboxes: Overfull hboxes. +* Overview of Texinfo: Overview. +* Page breaks: page. +* Page delimiter in Texinfo mode: Showing the Structure. +* Page headings: Headings. +* Page numbering: Headings. +* Page sizes for books: smallbook. +* page-delimiter: Showing the Structure. +* Pages, starting odd: setchapternewpage. +* Paper size, European A4: A4 Paper. +* Paragraph indentation: paragraphindent. +* Paragraph, marking text within: Marking Text. +* Parsing errors: makeinfo in Emacs. +* Part of file formatting and printing: Printing. +* Parts of a cross reference: Cross Reference Parts. +* Parts of a master menu: Master Menu Parts. +* Parts of a menu: Menu Parts. +* Periods, inserting: Not Ending a Sentence. +* Permissions: Sample Permissions. +* Permissions, printed: Copyright & Permissions. +* Picas: Images. +* Pictures, inserting: Images. +* Pinard, Franc,ois: Acknowledgements. +* plain TeX: Raw Formatter Commands. +* Point, indicating it in a buffer: Point Glyph. +* Pointer creation with makeinfo: makeinfo Pointer Creation. +* Pointer validation with makeinfo: Pointer Validation. +* Points (dimension): Images. +* Predefined indexing commands: Indexing Commands. +* Predefined names for indices: syncodeindex. +* Preparing to use TeX: Preparing for TeX. +* Preventing line and page breaks: Breaks. +* Previous node of Top node: First Node. +* Print and format in Texinfo mode: Texinfo Mode Printing. +* Print, format from Emacs shell: Within Emacs. +* Printed book and manual characteristics: Printed Books. +* Printed output, indicating it: Print Glyph. +* Printed permissions: Copyright & Permissions. +* Printing a region or buffer: Printing. +* Printing an index: Printing Indices & Menus. +* Printing cropmarks: Cropmarks and Magnification. +* Problems, catching: Catching Mistakes. +* Prototype row, column widths defined by: Multitable Column Widths. +* Quotations: quotation. +* Raising and lowering sections: Raise/lower sections. +* Raw formatter commands: Raw Formatter Commands. +* Recommended names for keys: key. +* Rectangle, ugly, black in hardcopy: Overfull hboxes. +* Recursion, mutual: Defining Macros. +* References: Cross References. +* References using @inforef: inforef. +* References using @pxref: pxref. +* References using @ref: ref. +* References using @xref: xref. +* Referring to other Info files: Other Info Files. +* Refilling paragraphs: Refilling Paragraphs. +* Region formatting and printing: Printing. +* Region printing in Texinfo mode: Texinfo Mode Printing. +* Repeated and optional arguments: Optional Arguments. +* Required in Texinfo file: Minimum. +* Requirements for formatting: Requirements Summary. +* Requirements for include files: Include File Requirements. +* Requirements for updating commands: Updating Requirements. +* Result of an expression: result. +* ridt.eps: Images. +* Ring accent: Inserting Accents. +* Rows, of a multitable: Multitable Rows. +* Running an Info formatter: Info Formatting. +* Running Info-validate: Using Info-validate. +* Running makeinfo in Emacs: makeinfo in Emacs. +* Sample @include file: Sample Include File. +* Sample function definition: Sample Function Definition. +* Sample Texinfo file: Short Sample. +* Sample Texinfo file, no comments: Sample Texinfo File. +* Scaled points: Images. +* Section structure of a file, showing it: Showing the Structure. +* Sections, raising and lowering: Raise/lower sections. +* Sentence ending punctuation: Ending a Sentence. +* Sentence non-ending punctuation: Not Ending a Sentence. +* Separate footnote style: Footnote Styles. +* Sharp S: Inserting Accents. +* Shell formatting with tex and texindex: Format with tex/texindex. +* Shell, format, print from: Within Emacs. +* Shell, running makeinfo in: makeinfo in Emacs. +* Short nodes for menus: Menu Location. +* Showing the section structure of a file: Showing the Structure. +* Showing the structure of a file: Using texinfo-show-structure. +* Site-wide Texinfo configuration file: Preparing for TeX. +* Size of printed book: smallbook. +* slanted typewriter font, for @kbd: kbd. +* Small book example: smallexample & smalllisp. +* Small book size: smallbook. +* Small caps font: Smallcaps. +* Software copying permissions: Software Copying Permissions. +* Sorting indices: Format/Print Hardcopy. +* Spaces (blank lines): sp. +* Spacing, inserting: Inserting Space. +* Special characters, commands to insert: Braces Atsigns. +* Special insertions: Insertions. +* Special typesetting commands: Dots Bullets. +* Specifying index entries: Indexing Commands. +* Splitting an Info file manually: Splitting. * ss: Inserting Accents. -* strong: emph & strong. -* subheading: unnumberedsubsec appendixsubsec subheading. -* subsection: subsection. -* subsubheading: subsubsection. -* subsubsection: subsubsection. -* subtitle: title subtitle author. -* summarycontents: Contents. -* syncodeindex: syncodeindex. -* synindex: synindex. -* t (typewriter font): Fonts. +* Stallman, Richard M.: Acknowledgements. +* Start of header line: Start of Header. +* Starting chapters: setchapternewpage. +* Structure of a file, showing it: Showing the Structure. +* Structure, catching mistakes in: Catching Mistakes. +* Structuring of chapters: Structuring. +* Subsection-like commands: unnumberedsubsec appendixsubsec subheading. +* Subsub commands: subsubsection. +* Syntactic conventions: Conventions. +* Syntax, optional & repeated arguments: Optional Arguments. * tab: Multitable Rows. -* table: Two-column Tables. -* tex: Raw Formatter Commands. -* tex (command): tex. -* texinfo-all-menus-update: Updating Commands. -* texinfo-every-node-update: Updating Commands. -* texinfo-format-buffer <1>: texinfo-format commands. -* texinfo-format-buffer <2>: Info Formatting. -* texinfo-format-buffer: texinfo-format commands. -* texinfo-format-region <1>: texinfo-format commands. -* texinfo-format-region <2>: Info Formatting. -* texinfo-format-region: texinfo-format commands. -* texinfo-indent-menu-description: Other Updating Commands. -* texinfo-insert-@code: Inserting. -* texinfo-insert-@dfn: Inserting. -* texinfo-insert-@end: Inserting. -* texinfo-insert-@example: Inserting. -* texinfo-insert-@item: Inserting. -* texinfo-insert-@kbd: Inserting. -* texinfo-insert-@node: Inserting. -* texinfo-insert-@noindent: Inserting. -* texinfo-insert-@samp: Inserting. -* texinfo-insert-@table: Inserting. -* texinfo-insert-@var: Inserting. -* texinfo-insert-braces: Inserting. -* texinfo-insert-node-lines: Other Updating Commands. -* texinfo-make-menu: Updating Commands. -* texinfo-master-menu: Updating Commands. -* texinfo-multiple-files-update: texinfo-multiple-files-update. -* texinfo-multiple-files-update (in brief): Other Updating Commands. -* texinfo-sequential-node-update: Other Updating Commands. -* texinfo-show-structure <1>: Using texinfo-show-structure. -* texinfo-show-structure: Showing the Structure. -* texinfo-start-menu-description: Inserting. -* texinfo-tex-buffer: Printing. -* texinfo-tex-print: Printing. -* texinfo-tex-region: Printing. -* texinfo-update-node: Updating Commands. -* thischapter: Custom Headings. -* thischaptername: Custom Headings. -* thisfile: Custom Headings. -* thispage: Custom Headings. -* thistitle: Custom Headings. -* tieaccent: Inserting Accents. -* tindex: Indexing Commands. -* title: title subtitle author. -* titlefont: titlefont center sp. -* titlepage: titlepage. -* today: Custom Headings. -* top (@-command): makeinfo top command. -* u: Inserting Accents. -* ubaraccent: Inserting Accents. -* udotaccent: Inserting Accents. -* unmacro: Defining Macros. -* unnumbered: unnumbered & appendix. -* unnumberedsec: unnumberedsec appendixsec heading. -* unnumberedsubsec: unnumberedsubsec appendixsubsec subheading. -* unnumberedsubsubsec: subsubsection. -* up-list: Inserting. -* uref: uref. -* url: url. -* v: Inserting Accents. -* value: set value. -* var: var. -* vindex: Indexing Commands. -* vskip: Copyright & Permissions. -* vtable: ftable vtable. -* w (prevent line break): w. -* xref: xref. -* { (single {): Inserting Braces. -* } (single }): Inserting Braces. -* ~: Inserting Accents. +* Table of contents: Contents. +* Tables and lists, making: Lists and Tables. +* Tables with indexes: ftable vtable. +* Tables, making multi-column: Multi-column Tables. +* Tables, making two-column: Two-column Tables. +* Tabs; don't use!: Conventions. +* Tag table, making automatically: Tag and Split Files. +* Tag table, making manually: Unsplit. +* Template for a definition: Def Cmd Template. +* TeX commands, using ordinary: Raw Formatter Commands. +* TeX index sorting: Format/Print Hardcopy. +* TeX input initialization: Preparing for TeX. +* TeX, how to obtain: Obtaining TeX. +* texi2dvi: Format with tex/texindex. +* texi2dvi (shell script): Format with texi2dvi. +* texindex <1>: Format with tex/texindex. +* texindex: Format/Print Hardcopy. +* Texinfo commands, defining new: Macros. +* Texinfo file beginning: Beginning a File. +* Texinfo file ending: Ending a File. +* Texinfo file header: Header. +* Texinfo file minimum: Minimum. +* Texinfo file section structure, showing it: Showing the Structure. +* Texinfo mode: Texinfo Mode. +* Texinfo overview: Overview. +* Texinfo printed book characteristics: Printed Books. +* texinfo.cnf <1>: A4 Paper. +* texinfo.cnf: setfilename. +* texinfo.cnf installation: Preparing for TeX. +* texinfo.tex, installing: Preparing for TeX. +* TEXINPUTS: Preparing for TeX. +* TEXINPUTS environment variable: Preparing for TeX. +* Text, conditionally visible: Conditionals. +* Thin space between number, dimension: dmn. +* Tie-after accent: Inserting Accents. +* Tilde accent: Inserting Accents. +* Tips: Tips. +* Title page: titlepage. +* Titlepage end starts headings: end titlepage. +* Titlepage permissions: Titlepage Permissions. +* Top node: The Top Node. +* Top node is first: First Node. +* Top node naming for references: Top Node Naming. +* Top node summary: Top Node Summary. +* Tree structuring: Tree Structuring. +* Two `First' Lines for @deffn: deffnx. +* Two letter names for indices: syncodeindex. +* Two named items for @table: itemx. +* Two part menu entry: Less Cluttered Menu Entry. +* Typesetting commands for dots, etc.: Dots Bullets. +* Umlaut accent: Inserting Accents. +* Uncluttered menu entry: Less Cluttered Menu Entry. +* Undefining macros: Defining Macros. +* Underbar accent: Inserting Accents. +* Underdot accent: Inserting Accents. +* Uniform resource locator, indicating: url. +* Uniform resource locator, referring to: uref. +* Unique nodename requirement: Node Line Requirements. +* Unprocessed text: Comments. +* Unsplit file creation: Unsplit. +* Up node of Top node: First Node. +* Updating nodes and menus: Updating Nodes and Menus. +* Updating requirements: Updating Requirements. +* URL, indicating: url. +* URL, referring to: uref. +* Usage tips: Tips. +* user input: kbd. +* User options, marking: Variables Commands. +* User-defined Texinfo commands: Macros. +* Validating a large file: Using Info-validate. +* Validation of pointers: Pointer Validation. +* Value of an expression, indicating: result. +* version number, finding: Invoking install-info. +* Vertical whitespace (vskip): Copyright & Permissions. +* Vertically holding text together: group. +* Visibility of conditional text: Conditionals. +* Weisshaus, Melissa: Acknowledgements. +* Whitespace, inserting <1>: Multiple Spaces. +* Whitespace, inserting: Inserting Space. +* Width of images: Images. +* Widths, defining multitable column: Multitable Column Widths. +* Wildcards: Format with tex/texindex. +* Words and phrases, marking them: Marking Text. +* Writing a menu: Writing a Menu. +* Writing an @node line: Writing a Node. +* Writing index entries: Indexing Commands. +* Zuhn, David D.: Acknowledgements. + diff --git a/info/texinfo.info-3 b/info/texinfo.info-3 index 53de93d..5eab100 100644 --- a/info/texinfo.info-3 +++ b/info/texinfo.info-3 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,115 +33,21 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: setfilename, Next: settitle, Prev: Start of Header, Up: Header - -`@setfilename' --------------- - - In order to serve as the primary input file for either `makeinfo' or -TeX, a Texinfo file must contain a line that looks like this: - - @setfilename INFO-FILE-NAME - - Write the `@setfilename' command at the beginning of a line and -follow it on the same line by the Info file name. Do not write anything -else on the line; anything on the line after the command is considered -part of the file name, including what would otherwise be a comment. - - The `@setfilename' line specifies the name of the output file to be -generated. This name should be different from the name of the Texinfo -file. There are two conventions for choosing the name: you can either -remove the extension (such as `.texi') from the input file name, or -replace it with the `.info' extension. When producing HTML output, -`makeinfo' will replace any extension with `html', or add `.html' if -the given name has no extension. - - Some operating systems cannot handle long file names. You can run -into a problem even when the file name you specify is itself short -enough. This occurs because the Info formatters split a long Info file -into short indirect subfiles, and name them by appending `-1', `-2', -..., `-10', `-11', and so on, to the original file name. (*Note Tag -Files and Split Files: Tag and Split Files.) The subfile name -`texinfo.info-10', for example, is too long for some systems; so the -Info file name for this document is `texinfo' rather than -`texinfo.info'. When `makeinfo' is running on operating systems such -as MS-DOS which impose grave limits on file names, it will sometimes -remove some characters from the original file name to leave enough -space for the subfile suffix, thus producing files named `texin-10', -`gcc.i12', etc. - - The Info formatting commands ignore everything written before the -`@setfilename' line, which is why the very first line of the file (the -`\input' line) does not show up in the output. - - The `@setfilename' line produces no output when you typeset a manual -with TeX, but it is nevertheless essential: it opens the index, -cross-reference, and other auxiliary files used by Texinfo, and also -reads `texinfo.cnf' if that file is present on your system (*note -Preparing for TeX: Preparing for TeX.). - - -File: texinfo.info, Node: settitle, Next: setchapternewpage, Prev: setfilename, Up: Header - -`@settitle' ------------ - - In order to be made into a printed manual, a Texinfo file must contain -a line that looks like this: - - @settitle TITLE - - Write the `@settitle' command at the beginning of a line and follow -it on the same line by the title. This tells TeX the title to use in a -header or footer. Do not write anything else on the line; anything on -the line after the command is considered part of the title, including a -comment. - - Conventionally, when TeX formats a Texinfo file for double-sided -output, the title is printed in the left-hand (even-numbered) page -headings and the current chapter title is printed in the right-hand -(odd-numbered) page headings. (TeX learns the title of each chapter -from each `@chapter' command.) Page footers are not printed. - - Even if you are printing in a single-sided style, TeX looks for an -`@settitle' command line, in case you include the manual title in the -heading. - - The `@settitle' command should precede everything that generates -actual output in TeX. - - Although the title in the `@settitle' command is usually the same as -the title on the title page, it does not affect the title as it appears -on the title page. Thus, the two do not need not match exactly; and -the title in the `@settitle' command can be a shortened or expanded -version of the title as it appears on the title page. (*Note -`@titlepage': titlepage.) - - TeX prints page headings only for that text that comes after the -`@end titlepage' command in the Texinfo file, or that comes after an -`@headings' command that turns on headings. (*Note The `@headings' -Command: headings on off, for more information.) - - You may, if you wish, create your own, customized headings and -footings. *Note Page Headings: Headings, for a detailed discussion of -this process. - - File: texinfo.info, Node: setchapternewpage, Next: paragraphindent, Prev: settitle, Up: Header `@setchapternewpage' -------------------- - In an officially bound book, text is usually printed on both sides of -the paper, chapters start on right-hand pages, and right-hand pages have + In a book or a manual, text is usually printed on both sides of the +paper, chapters start on right-hand pages, and right-hand pages have odd numbers. But in short reports, text often is printed only on one side of the paper. Also in short reports, chapters sometimes do not start on new pages, but are printed on the same page as the end of the preceding chapter, after a small amount of vertical whitespace. You can use the `@setchapternewpage' command with various arguments -to specify how TeX should start chapters and whether it should format -headers for printing on one or both sides of the paper (single-sided or +to specify how TeX should start chapters and whether it should typeset +pages for printing on one or both sides of the paper (single-sided or double-sided printing). Write the `@setchapternewpage' command at the beginning of a line @@ -163,9 +69,9 @@ start on a fresh odd-numbered page: see *Note The `@headings' Command: headings on off.) `@setchapternewpage on' - Cause TeX to start new chapters on new pages and to format page + Cause TeX to start new chapters on new pages and to typeset page headers for single-sided printing. This is the form most often - used for short reports or personal printing. + used for short reports. This alternative is the default. @@ -174,11 +80,10 @@ start on a fresh odd-numbered page: (right-handed pages) and to typeset for double-sided printing. This is the form most often used for books and manuals. - Texinfo does not have an `@setchapternewpage even' command. +Texinfo does not have an `@setchapternewpage even' command. - You can countermand or modify the effect on headers of an -`@setchapternewpage' command with an `@headings' command. *Note The -`@headings' Command: headings on off. +(You can countermand or modify an `@setchapternewpage' command with an +`@headings' command. *Note The `@headings' Command: headings on off.) At the beginning of a manual or book, pages are not numbered--for example, the title and copyright pages of a book are not numbered. By @@ -188,39 +93,37 @@ and not in sequence with the rest of the document. Since an Info file does not have pages, the `@setchapternewpage' command has no effect on it. - We recommend not including any `@setchapternewpage' command in your -manual sources at all, since the desired output is not intrinsic to the -document. Instead, if you don't want the default option (no blank -pages, same headers on all pages) use the `--texinfo' option to -`texi2dvi' to specify the output you want. + Usually, you do not write an `@setchapternewpage' command for +single-sided printing, but accept the default which is to typeset for +single-sided printing and to start new chapters on new pages. Usually, +you write an `@setchapternewpage odd' command for double-sided printing.  -File: texinfo.info, Node: paragraphindent, Next: exampleindent, Prev: setchapternewpage, Up: Header +File: texinfo.info, Node: paragraphindent, Next: End of Header, Prev: setchapternewpage, Up: Header Paragraph Indenting ------------------- - The Texinfo processors may insert whitespace at the beginning of the -first line of each paragraph, thereby indenting that paragraph. You can -use the `@paragraphindent' command to specify this indentation. Write -an `@paragraphindent' command at the beginning of a line followed by -either `asis' or a number: + The Info formatting commands may insert spaces at the beginning of the +first line of each paragraph, thereby indenting that paragraph. You +can use the `@paragraphindent' command to specify the indentation. +Write an `@paragraphindent' command at the beginning of a line followed +by either `asis' or a number. The template is: @paragraphindent INDENT - The indentation is according to the value of INDENT: + The Info formatting commands indent according to the value of INDENT: -`asis' - Do not change the existing indentation (not implemented in TeX). + * If the value of INDENT is `asis', the Info formatting commands do + not change the existing indentation. -0 - Omit all indentation. + * If the value of INDENT is zero, the Info formatting commands delete + existing indentation. -N - Indent by N space characters in Info output, by N ems in TeX. + * If the value of INDENT is greater than zero, the Info formatting + commands indent the paragraph by that number of spaces. - The default value of INDENT is `asis'. `@paragraphindent' is ignored -for HTML output. + The default value of INDENT is `asis'. Write the `@paragraphindent' command before or shortly after the end-of-header line at the beginning of a Texinfo file. (If you write @@ -230,43 +133,10 @@ region formatting commands indent paragraphs as specified.) A peculiarity of the `texinfo-format-buffer' and `texinfo-format-region' commands is that they do not indent (nor fill) paragraphs that contain `@w' or `@*' commands. *Note Refilling -Paragraphs::, for further information. +Paragraphs::, for a detailed description of what goes on.  -File: texinfo.info, Node: exampleindent, Next: End of Header, Prev: paragraphindent, Up: Header - -`@exampleindent': Environment Indenting ---------------------------------------- - - The Texinfo processors indent each line of `@example' and similar -environments. You can use the `@exampleindent' command to specify this -indentation. Write an `@exampleindent' command at the beginning of a -line followed by either `asis' or a number: - - @exampleindent INDENT - - The indentation is according to the value of INDENT: - -`asis' - Do not change the existing indentation (not implemented in TeX). - -0 - Omit all indentation. - -N - Indent environments by N space characters in Info output, by N ems - in TeX. - - The default value of INDENT is 5. `@exampleindent' is ignored for -HTML output. - - Write the `@exampleindent' command before or shortly after the -end-of-header line at the beginning of a Texinfo file. (If you write -the command between the start-of-header and end-of-header lines, the -region formatting commands indent examples as specified.) - - -File: texinfo.info, Node: End of Header, Prev: exampleindent, Up: Header +File: texinfo.info, Node: End of Header, Prev: paragraphindent, Up: Header End of Header ------------- @@ -333,11 +203,6 @@ Info file. In addition, this part of the beginning of a Texinfo file contains the text of the copying permissions that will appear in the printed manual. - You may wish to include titlepage-like information for plain text -output. Simply place any such leading material between `@ifinfo' and -`@end ifinfo'; `makeinfo' includes this in its plain text output. It -will not show up in the Info readers. - *Note Titlepage Copying Permissions: Titlepage Permissions, for the standard text for the copyright permissions. @@ -369,20 +234,17 @@ on a line by itself. numbering. (*Note Page Headings: Headings, for details about how to generate page headings.) All the material that you want to appear on unnumbered pages should be put between the `@titlepage' and `@end -titlepage' commands. You can force the table of contents to appear -there with the `@setcontentsaftertitlepage' command (*note Contents::). - - By using the `@page' command you can force a page break within the -region delineated by the `@titlepage' and `@end titlepage' commands and -thereby create more than one unnumbered page. This is how the -copyright page is produced. (The `@titlepage' command might perhaps -have been better named the `@titleandadditionalpages' command, but that -would have been rather long!) +titlepage' commands. By using the `@page' command you can force a page +break within the region delineated by the `@titlepage' and `@end +titlepage' commands and thereby create more than one unnumbered page. +This is how the copyright page is produced. (The `@titlepage' command +might perhaps have been better named the `@titleandadditionalpages' +command, but that would have been rather long!) When you write a manual about a computer program, you should write the version of the program to which the manual applies on the title page. -If the manual changes more frequently than the program or is independent -of it, you should also include an edition number(1) (*note +If the manual changes more frequently than the program or is +independent of it, you should also include an edition number(1) (*note titlepage-Footnote-1::) for the manual. This helps readers keep track of which manual is for which version of the program. (The `Top' node should also contain this information; see *Note `@top': makeinfo top.) @@ -396,13 +258,9 @@ commands to create a title page with black rules under the title and author lines and the subtitle text set flush to the right hand side of the page. With this method, you do not specify any of the actual formatting of the title page. You specify the text you want, and -Texinfo does the formatting. - - You may use either method, or you may combine them; see the examples -in the sections below. +Texinfo does the formatting. You may use either method. - For extremely simple applications, and for the bastard title page in -traditional book front matter, Texinfo also provides a command + For extremely simple applications, Texinfo also provides a command `@shorttitlepage' which takes a single argument as the title. The argument is typeset on a page by itself and followed by a blank page. @@ -425,8 +283,7 @@ a title page for a printed document. (This is the first of the two methods for creating a title page in Texinfo.) Use the `@titlefont' command to select a large font suitable for the -title itself. You can use `@titlefont' more than once if you have an -especially long title. +title itself. For example: @@ -459,7 +316,7 @@ for more information about the `@sp' command.) ... @end titlepage - The spacing of the example fits an 8.5 by 11 inch manual. + The spacing of the example fits an 8 1/2 by 11 inch manual.  File: texinfo.info, Node: title subtitle author, Next: Copyright & Permissions, Prev: titlefont center sp, Up: Titlepage & Copyright Page @@ -469,8 +326,8 @@ File: texinfo.info, Node: title subtitle author, Next: Copyright & Permissions You can use the `@title', `@subtitle', and `@author' commands to create a title page in which the vertical and horizontal spacing is -done for you automatically. This contrasts with the method described -in the previous section, in which the `@sp' command is needed to adjust +done for you automatically. This contrasts with the method described in +the previous section, in which the `@sp' command is needed to adjust vertical spacing. Write the `@title', `@subtitle', or `@author' commands at the @@ -478,10 +335,7 @@ beginning of a line followed by the title, subtitle, or author. The `@title' command produces a line in which the title is set flush to the left-hand side of the page in a larger than normal font. The -title is underlined with a black rule. Only a single line is allowed; -the `@*' command may not be used to break the title into two lines. To -handle very long titles, you may find it profitable to use both -`@title' and `@titlefont'; see the final example in this section. +title is underlined with a black rule. The `@subtitle' command sets subtitles in a normal-sized font flush to the right-hand side of the page. @@ -518,20 +372,21 @@ or you can write the names one above each other by using two (or more) ... @end titlepage - You may also combine the `@titlefont' method described in the -previous section and `@title' method described in this one. This may -be useful if you have a very long title. Here is a real-life example: +Contrast this form with the form of a title page written using the +`@sp', `@center', and `@titlefont' commands: @titlepage - @titlefont{GNU Software} + @sp 10 + @center @titlefont{Name of Manual When Printed} + @sp 2 + @center Subtitle, If Any @sp 1 - @title for MS-Windows and MS-DOS - @subtitle Edition @value{edition} for Release @value{cd-edition} - @author by Daniel Hagerty, Melissa Weisshaus - @author and Eli Zaretskii - -(The use of `@value' here is explained in *Note `@value' Example: value -Example.) + @center Second subtitle + @sp 2 + @center Author + @page + ... + @end titlepage  File: texinfo.info, Node: Copyright & Permissions, Next: end titlepage, Prev: title subtitle author, Up: Titlepage & Copyright Page @@ -572,10 +427,10 @@ itself has the following legally defined sequence: It is customary to put information on how to get a manual after the copyright notice, followed by the copying permissions for the manual. - Permissions must be given here as well as in the summary segment -within `@ifinfo' and `@end ifinfo' that immediately follows the header -since this text appears only in the printed manual and the `ifinfo' -text appears only in the Info file. + Note that permissions must be given here as well as in the summary +segment within `@ifinfo' and `@end ifinfo' that immediately follows the +header since this text appears only in the printed manual and the +`ifinfo' text appears only in the Info file. *Note Sample Permissions::, for the standard text. @@ -638,7 +493,6 @@ after the `@end titlepage' command. Turn on page headings appropriate for single-sided printing. `@headings double' -`@headings on' Turn on page headings appropriate for double-sided printing. The two commands, `@headings on' and `@headings double', are synonymous. @@ -700,7 +554,7 @@ Text: Conditionals.) * Master Menu Parts:: A master menu has three or more parts.  -File: texinfo.info, Node: Title of Top Node, Next: Master Menu Parts, Up: The Top Node +File: texinfo.info, Node: Title of Top Node, Next: Master Menu Parts, Prev: The Top Node, Up: The Top Node `Top' Node Title ---------------- @@ -717,7 +571,7 @@ information. It looks like this: ... @end titlepage - @ifnottex + @ifinfo @node Top, Copying, , (dir) @top Texinfo @@ -725,7 +579,7 @@ information. It looks like this: This is edition... ... - @end ifnottex + @end ifinfo @menu * Copying:: Texinfo is freely @@ -837,10 +691,10 @@ File: texinfo.info, Node: Ending a File, Next: Structuring, Prev: Beginning a Ending a Texinfo File ********************* - The end of a Texinfo file should include commands to create indices -and (usually) to generate detailed and summary tables of contents. And -it must include the `@bye' command that marks the last line processed -by TeX. + The end of a Texinfo file should include the commands that create +indices and generate detailed and summary tables of contents. And it +must include the `@bye' command that marks the last line processed by +TeX. For example: @@ -873,9 +727,9 @@ those just cause the raw data for the index to be accumulated. To generate an index, you must include the `@printindex' command at the place in the document where you want the index to appear. Also, as part of the process of creating a printed manual, you must run a -program called `texindex' (*note Hardcopy::) to sort the raw data to -produce a sorted index file. The sorted index file is what is actually -used to print the index. +program called `texindex' (*note Format/Print Hardcopy::) to sort the +raw data to produce a sorted index file. The sorted index file is what +is actually used to print the index. Texinfo offers six different types of predefined index: the concept index, the function index, the variables index, the keystroke index, the @@ -908,10 +762,13 @@ Precede the `@unnumbered' command with an `@node' line. @unnumbered Concept Index @printindex cp + + @summarycontents + @contents + @bye -Readers often prefer that the concept index come last in a book, since -that makes it easiest to find. Having just one index helps readers -also, since then they have only one place to look (*note synindex::). +(Readers often prefer that the concept index come last in a book, since +that makes it easiest to find.)  File: texinfo.info, Node: Contents, Next: File End, Prev: Printing Indices & Menus, Up: Ending a File @@ -922,13 +779,14 @@ Generating a Table of Contents The `@chapter', `@section', and other structuring commands supply the information to make up a table of contents, but they do not cause an actual table to appear in the manual. To do this, you must use the -`@contents' and/or `@summarycontents' command(s). +`@contents' and `@summarycontents' commands: `@contents' Generate a table of contents in a printed manual, including all chapters, sections, subsections, etc., as well as appendices and unnumbered chapters. (Headings generated by the `@heading' series - of commands do not appear in the table of contents.) + of commands do not appear in the table of contents.) The + `@contents' command should be written on a line by itself. `@shortcontents' `@summarycontents' @@ -940,43 +798,33 @@ actual table to appear in the manual. To do this, you must use the subsections and subsubsections. Only a long manual needs a short table of contents in addition to the full table of contents. - Both contents commands should be written on a line by themselves. -The contents commands automatically generate a chapter-like heading at -the top of the first table of contents page, so don't include any -sectioning command such as `@unnumbered' before them. + Write the `@shortcontents' command on a line by itself right + _before_ the `@contents' command. + + The table of contents commands automatically generate a chapter-like +heading at the top of the first table of contents page. Write the table +of contents commands at the very end of a Texinfo file, just before the +`@bye' command, following any index sections--anything in the Texinfo +file after the table of contents commands will be omitted from the +table of contents. + + When you print a manual with a table of contents, the table of +contents are printed last and numbered with roman numerals. You need +to place those pages in their proper place, after the title page, +yourself. (This is the only collating you need to do for a printed +manual. The table of contents is printed last because it is generated +after the rest of the manual is typeset.) + + Here is an example of where to write table of contents commands: + + INDICES... + @shortcontents + @contents + @bye Since an Info file uses menus instead of tables of contents, the Info -formatting commands ignore the contents commands. But the contents are -included in plain text output (generated by `makeinfo --no-headers'). - - The contents commands can be placed either at the very end of the -file, after any indices (see the previous section) and just before the -`@bye' (see the next section), or near the beginning of the file, after -the `@end titlepage' (*note titlepage::). The advantage to the former -is that then the contents output is always up to date, because it -reflects the processing just done. The advantage to the latter is that -the contents are printed in the proper place, thus you do not need to -rearrange the DVI file with `dviselect' or shuffle paper. However, -contents commands at the beginning of the document are ignored when -outputting to standard output. - - As an author, you can put the contents commands wherever you prefer. -But if you are a user simply printing a manual, you may wish to print -the contents after the title page even if the author put the contents -commands at the end of the document (as is the case in most existing -Texinfo documents). You can do this by specifying -`@setcontentsaftertitlepage' and/or `@setshortcontentsaftertitlepage'. -The first prints only the main contents after the `@end titlepage'; the -second prints both the short contents and the main contents. In either -case, any subsequent `@contents' or `@shortcontents' is ignored (unless -no `@end titlepage' is ever encountered). - - You need to include the `@set...contentsaftertitlepage' commands -early in the document (just after `@setfilename', for example). Or, if -you're using `texi2dvi' (*note Format with texi2dvi::), you can use its -`--texinfo' option to specify this without altering the source file at -all. For example: - texi2dvi --texinfo=@setshortcontentsaftertitlepage foo.texi +formatting commands ignore the `@contents' and `@shortcontents' +commands.  File: texinfo.info, Node: File End, Prev: Contents, Up: Ending a File @@ -1035,7 +883,7 @@ heading at the top of each node--but you don't need to. * Raise/lower sections:: How to change commands' hierarchical level.  -File: texinfo.info, Node: Tree Structuring, Next: Structuring Command Types, Up: Structuring +File: texinfo.info, Node: Tree Structuring, Next: Structuring Command Types, Prev: Structuring, Up: Structuring Tree Structure of Sections ========================== @@ -1073,8 +921,8 @@ chapters. (*Note Nodes::, and see *Note Menus::.)  File: texinfo.info, Node: Structuring Command Types, Next: makeinfo top, Prev: Tree Structuring, Up: Structuring -Structuring Command Types -========================= +Types of Structuring Commands +============================= The chapter structuring commands fall into four groups or series, each of which contains structuring commands corresponding to the @@ -1111,14 +959,16 @@ that are listed in the table of contents of a printed book or manual. Here are the four groups of chapter structuring commands: - No new page -Numbered Unnumbered Lettered and numbered Unnumbered -In contents In contents In contents Not in contents - `@top' `@majorheading' -`@chapter' `@unnumbered' `@appendix' `@chapheading' -`@section' `@unnumberedsec' `@appendixsec' `@heading' -`@subsection' `@unnumberedsubsec' `@appendixsubsec' `@subheading' -`@subsubsection'`@unnumberedsubsubsec' `@appendixsubsubsec' `@subsubheading' + + No new pages + Numbered Unnumbered Lettered and numbered Unnumbered + In contents In contents In contents Not in contents + + @top @majorheading + @chapter @unnumbered @appendix @chapheading + @section @unnumberedsec @appendixsec @heading + @subsection @unnumberedsubsec @appendixsubsec @subheading + @subsubsection @unnumberedsubsubsec @appendixsubsubsec @subsubheading  File: texinfo.info, Node: makeinfo top, Next: chapter, Prev: Structuring Command Types, Up: Structuring @@ -1129,15 +979,9 @@ File: texinfo.info, Node: makeinfo top, Next: chapter, Prev: Structuring Comm The `@top' command is a special sectioning command that you use only after an `@node Top' line at the beginning of a Texinfo file. The `@top' command tells the `makeinfo' formatter which node is the `Top' -node, so it can use it as the root of the node tree if your manual uses -implicit pointers. It has the same typesetting effect as `@unnumbered' -(*note `@unnumbered' and `@appendix': unnumbered & appendix.). For -detailed information, see *Note The `@top' Command: makeinfo top -command. - - The `@top' node and its menu (if any) is conventionally wrapped in an -`@ifnottex' conditional so that it will appear only in Info and HTML -output, not TeX. +node. It has the same typesetting effect as `@unnumbered' (*note +`@unnumbered': (`@appendix')unnumbered & appendix.). For detailed +information, see *Note The `@top' Command: makeinfo top command.  File: texinfo.info, Node: chapter, Next: unnumbered & appendix, Prev: makeinfo top, Up: Structuring @@ -1171,8 +1015,8 @@ kind of stylistic choice is not usually offered by Texinfo.  File: texinfo.info, Node: unnumbered & appendix, Next: majorheading & chapheading, Prev: chapter, Up: Structuring -`@unnumbered' and `@appendix' -============================= +`@unnumbered', `@appendix' +========================== Use the `@unnumbered' command to create a chapter that appears in a printed manual without chapter numbers of any kind. Use the @@ -1286,3 +1130,180 @@ produces In a printed manual, subsections are listed in the table of contents and are numbered three levels deep. + +File: texinfo.info, Node: unnumberedsubsec appendixsubsec subheading, Next: subsubsection, Prev: subsection, Up: Structuring + +The `@subsection'-like Commands +=============================== + + The `@unnumberedsubsec', `@appendixsubsec', and `@subheading' +commands are, respectively, the unnumbered, appendix-like, and +heading-like equivalents of the `@subsection' command. (*Note +`@subsection': subsection.) + + In Info, the `@subsection'-like commands generate a title underlined +with hyphens. In a printed manual, an `@subheading' command produces a +heading like that of a subsection except that it is not numbered and +does not appear in the table of contents. Similarly, an +`@unnumberedsubsec' command produces an unnumbered heading like that of +a subsection and an `@appendixsubsec' command produces a +subsection-like heading labelled with a letter and numbers; both of +these commands produce headings that appear in the table of contents. + + +File: texinfo.info, Node: subsubsection, Next: Raise/lower sections, Prev: unnumberedsubsec appendixsubsec subheading, Up: Structuring + +The `subsub' Commands +===================== + + The fourth and lowest level sectioning commands in Texinfo are the +`subsub' commands. They are: + +`@subsubsection' + Subsubsections are to subsections as subsections are to sections. + (*Note `@subsection': subsection.) In a printed manual, + subsubsection titles appear in the table of contents and are + numbered four levels deep. + +`@unnumberedsubsubsec' + Unnumbered subsubsection titles appear in the table of contents of + a printed manual, but lack numbers. Otherwise, unnumbered + subsubsections are the same as subsubsections. In Info, unnumbered + subsubsections look exactly like ordinary subsubsections. + +`@appendixsubsubsec' + Conventionally, appendix commands are used only for appendices and + are lettered and numbered appropriately in a printed manual. They + also appear in the table of contents. In Info, appendix + subsubsections look exactly like ordinary subsubsections. + +`@subsubheading' + The `@subsubheading' command may be used anywhere that you need a + small heading that will not appear in the table of contents. In + Info, subsubheadings look exactly like ordinary subsubsection + headings. + + In Info, `subsub' titles are underlined with periods. For example, + + @subsubsection This is a subsubsection + +produces + + This is a subsubsection + ....................... + + +File: texinfo.info, Node: Raise/lower sections, Prev: subsubsection, Up: Structuring + +`@raisesections' and `@lowersections' +===================================== + + The `@raisesections' and `@lowersections' commands raise and lower +the hierarchical level of chapters, sections, subsections and the like. +The `@raisesections' command changes sections to chapters, subsections +to sections, and so on. The `@lowersections' command changes chapters +to sections, sections to subsections, and so on. + + An `@lowersections' command is useful if you wish to include text +that is written as an outer or standalone Texinfo file in another +Texinfo file as an inner, included file. If you write the command at +the beginning of the file, all your `@chapter' commands are formatted +as if they were `@section' commands, all your `@section' command are +formatted as if they were `@subsection' commands, and so on. + + `@raisesections' raises a command one level in the chapter +structuring hierarchy: + + Change To + + @subsection @section, + @section @chapter, + @heading @chapheading, + etc. + + `@lowersections' lowers a command one level in the chapter +structuring hierarchy: + + Change To + + @chapter @section, + @subsection @subsubsection, + @heading @subheading, + etc. + + An `@raisesections' or `@lowersections' command changes only those +structuring commands that follow the command in the Texinfo file. +Write an `@raisesections' or `@lowersections' command on a line of its +own. + + An `@lowersections' command cancels an `@raisesections' command, and +vice versa. Typically, the commands are used like this: + + @lowersections + @include somefile.texi + @raisesections + + Without the `@raisesections', all the subsequent sections in your +document will be lowered. + + Repeated use of the commands continue to raise or lower the +hierarchical level a step at a time. + + An attempt to raise above `chapters' reproduces chapter commands; an +attempt to lower below `subsubsections' reproduces subsubsection +commands. + + +File: texinfo.info, Node: Nodes, Next: Menus, Prev: Structuring, Up: Top + +Nodes +***** + + "Nodes" are the primary segments of a Texinfo file. They do not +themselves impose a hierarchic or any other kind of structure on a file. +Nodes contain "node pointers" that name other nodes, and can contain +"menus" which are lists of nodes. In Info, the movement commands can +carry you to a pointed-to node or to a node listed in a menu. Node +pointers and menus provide structure for Info files just as chapters, +sections, subsections, and the like, provide structure for printed +books. + +* Menu: + +* Two Paths:: Different commands to structure + Info output and printed output. +* Node Menu Illustration:: A diagram, and sample nodes and menus. +* node:: How to write a node, in detail. +* makeinfo Pointer Creation:: How to create node pointers with `makeinfo'. + + +File: texinfo.info, Node: Two Paths, Next: Node Menu Illustration, Prev: Nodes, Up: Nodes + +Two Paths +========= + + The node and menu commands and the chapter structuring commands are +independent of each other: + + * In Info, node and menu commands provide structure. The chapter + structuring commands generate headings with different kinds of + underlining--asterisks for chapters, hyphens for sections, and so + on; they do nothing else. + + * In TeX, the chapter structuring commands generate chapter and + section numbers and tables of contents. The node and menu + commands provide information for cross references; they do nothing + else. + + You can use node pointers and menus to structure an Info file any way +you want; and you can write a Texinfo file so that its Info output has a +different structure than its printed output. However, most Texinfo +files are written such that the structure for the Info output +corresponds to the structure for the printed output. It is not +convenient to do otherwise. + + Generally, printed output is structured in a tree-like hierarchy in +which the chapters are the major limbs from which the sections branch +out. Similarly, node pointers and menus are organized to create a +matching structure in the Info output. + diff --git a/info/texinfo.info-4 b/info/texinfo.info-4 index 27b9226..8d30a06 100644 --- a/info/texinfo.info-4 +++ b/info/texinfo.info-4 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,184 +33,6 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: unnumberedsubsec appendixsubsec subheading, Next: subsubsection, Prev: subsection, Up: Structuring - -The `@subsection'-like Commands -=============================== - - The `@unnumberedsubsec', `@appendixsubsec', and `@subheading' -commands are, respectively, the unnumbered, appendix-like, and -heading-like equivalents of the `@subsection' command. (*Note -`@subsection': subsection.) - - In Info, the `@subsection'-like commands generate a title underlined -with hyphens. In a printed manual, an `@subheading' command produces a -heading like that of a subsection except that it is not numbered and -does not appear in the table of contents. Similarly, an -`@unnumberedsubsec' command produces an unnumbered heading like that of -a subsection and an `@appendixsubsec' command produces a -subsection-like heading labelled with a letter and numbers; both of -these commands produce headings that appear in the table of contents. - - -File: texinfo.info, Node: subsubsection, Next: Raise/lower sections, Prev: unnumberedsubsec appendixsubsec subheading, Up: Structuring - -The `subsub' Commands -===================== - - The fourth and lowest level sectioning commands in Texinfo are the -`subsub' commands. They are: - -`@subsubsection' - Subsubsections are to subsections as subsections are to sections. - (*Note `@subsection': subsection.) In a printed manual, - subsubsection titles appear in the table of contents and are - numbered four levels deep. - -`@unnumberedsubsubsec' - Unnumbered subsubsection titles appear in the table of contents of - a printed manual, but lack numbers. Otherwise, unnumbered - subsubsections are the same as subsubsections. In Info, unnumbered - subsubsections look exactly like ordinary subsubsections. - -`@appendixsubsubsec' - Conventionally, appendix commands are used only for appendices and - are lettered and numbered appropriately in a printed manual. They - also appear in the table of contents. In Info, appendix - subsubsections look exactly like ordinary subsubsections. - -`@subsubheading' - The `@subsubheading' command may be used anywhere that you need a - small heading that will not appear in the table of contents. In - Info, subsubheadings look exactly like ordinary subsubsection - headings. - - In Info, `subsub' titles are underlined with periods. For example, - - @subsubsection This is a subsubsection - -produces - - This is a subsubsection - ....................... - - -File: texinfo.info, Node: Raise/lower sections, Prev: subsubsection, Up: Structuring - -`@raisesections' and `@lowersections' -===================================== - - The `@raisesections' and `@lowersections' commands raise and lower -the hierarchical level of chapters, sections, subsections and the like. -The `@raisesections' command changes sections to chapters, subsections -to sections, and so on. The `@lowersections' command changes chapters -to sections, sections to subsections, and so on. - - An `@lowersections' command is useful if you wish to include text -that is written as an outer or standalone Texinfo file in another -Texinfo file as an inner, included file. If you write the command at -the beginning of the file, all your `@chapter' commands are formatted -as if they were `@section' commands, all your `@section' command are -formatted as if they were `@subsection' commands, and so on. - - `@raisesections' raises a command one level in the chapter -structuring hierarchy: - - Change To - - @subsection @section, - @section @chapter, - @heading @chapheading, - etc. - - `@lowersections' lowers a command one level in the chapter -structuring hierarchy: - - Change To - - @chapter @section, - @subsection @subsubsection, - @heading @subheading, - etc. - - An `@raisesections' or `@lowersections' command changes only those -structuring commands that follow the command in the Texinfo file. -Write an `@raisesections' or `@lowersections' command on a line of its -own. - - An `@lowersections' command cancels an `@raisesections' command, and -vice versa. Typically, the commands are used like this: - - @lowersections - @include somefile.texi - @raisesections - - Without the `@raisesections', all the subsequent sections in your -document will be lowered. - - Repeated use of the commands continue to raise or lower the -hierarchical level a step at a time. - - An attempt to raise above `chapters' reproduces chapter commands; an -attempt to lower below `subsubsections' reproduces subsubsection -commands. - - -File: texinfo.info, Node: Nodes, Next: Menus, Prev: Structuring, Up: Top - -Nodes -***** - - "Nodes" are the primary segments of a Texinfo file. They do not -themselves impose a hierarchical or any other kind of structure on a -file. Nodes contain "node pointers" that name other nodes, and can -contain "menus" which are lists of nodes. In Info, the movement -commands can carry you to a pointed-to node or to a node listed in a -menu. Node pointers and menus provide structure for Info files just as -chapters, sections, subsections, and the like, provide structure for -printed books. - -* Menu: - -* Two Paths:: Different commands to structure - Info output and printed output. -* Node Menu Illustration:: A diagram, and sample nodes and menus. -* node:: Creating nodes, in detail. -* makeinfo Pointer Creation:: Letting makeinfo determine node pointers. -* anchor:: Defining arbitrary cross-reference targets. - - -File: texinfo.info, Node: Two Paths, Next: Node Menu Illustration, Up: Nodes - -Two Paths -========= - - The node and menu commands and the chapter structuring commands are -technically independent of each other: - - * In Info, node and menu commands provide structure. The chapter - structuring commands generate headings with different kinds of - underlining--asterisks for chapters, hyphens for sections, and so - on; they do nothing else. - - * In TeX, the chapter structuring commands generate chapter and - section numbers and tables of contents. The node and menu - commands provide information for cross references; they do nothing - else. - - You can use node pointers and menus to structure an Info file any way -you want; and you can write a Texinfo file so that its Info output has a -different structure than its printed output. However, virtually all -Texinfo files are written such that the structure for the Info output -corresponds to the structure for the printed output. It is neither -convenient nor understandable to the reader to do otherwise. - - Generally, printed output is structured in a tree-like hierarchy in -which the chapters are the major limbs from which the sections branch -out. Similarly, node pointers and menus are organized to create a -matching structure in the Info output. - - File: texinfo.info, Node: Node Menu Illustration, Next: node, Prev: Two Paths, Up: Nodes Node and Menu Illustration @@ -219,9 +41,9 @@ Node and Menu Illustration Here is a copy of the diagram shown earlier that illustrates a Texinfo file with three chapters, each of which contains two sections. - The "root" is at the top of the diagram and the "leaves" are at the -bottom. This is how such a diagram is drawn conventionally; it -illustrates an upside-down tree. For this reason, the root node is + Note that the "root" is at the top of the diagram and the "leaves" +are at the bottom. This is how such a diagram is drawn conventionally; +it illustrates an upside-down tree. For this reason, the root node is called the `Top' node, and `Up' node pointers carry you closer to the root. @@ -236,27 +58,25 @@ root. Section Section Section Section Section Section 1.1 1.2 2.1 2.2 3.1 3.2 - The fully-written command to start Chapter 2 would be this: + Write the beginning of the node for Chapter 2 like this: - @node Chapter 2, Chapter 3, Chapter 1, Top + @node Chapter 2, Chapter 3, Chapter 1, top @comment node-name, next, previous, up This `@node' line says that the name of this node is "Chapter 2", the name of the `Next' node is "Chapter 3", the name of the `Previous' node -is "Chapter 1", and the name of the `Up' node is "Top". You can omit -writing out these node names if your document is hierarchically -organized (*note makeinfo Pointer Creation::), but the pointer -relationships still obtain. +is "Chapter 1", and the name of the `Up' node is "Top". *Please Note:* `Next' refers to the next node at the same hierarchical level in the manual, not necessarily to the next node within the Texinfo file. In the Texinfo file, the subsequent node - may be at a lower level--a section-level node most often follows a - chapter-level node, for example. `Next' and `Previous' refer to - nodes at the _same_ hierarchical level. (The `Top' node contains - the exception to this rule. Since the `Top' node is the only node - at that level, `Next' refers to the first following node, which is - almost always a chapter or chapter-level node.) + may be at a lower level--a section-level node may follow a + chapter-level node, and a subsection-level node may follow a + section-level node. `Next' and `Previous' refer to nodes at the + _same_ hierarchical level. (The `Top' node contains the exception + to this rule. Since the `Top' node is the only node at that + level, `Next' refers to the first following node, which is almost + always a chapter or chapter-level node.) To go to Sections 2.1 and 2.2 using Info, you need a menu inside Chapter 2. (*Note Menus::.) You would write the menu just before the @@ -315,22 +135,19 @@ chapter usually contains several nodes, one for each section, subsection, and subsubsection. To create a node, write an `@node' command at the beginning of a -line, and follow it with up to four arguments, separated by commas, on -the rest of the same line. The first argument is required; it is the -name of this node. The subsequent arguments are the names of the -`Next', `Previous', and `Up' pointers, in that order, and may be omitted -if your Texinfo document is hierarchically organized (*note makeinfo -Pointer Creation::). - - You may insert spaces before each name if you wish; the spaces are -ignored. You must write the name of the node and the names of the -`Next', `Previous', and `Up' pointers all on the same line. Otherwise, +line, and follow it with four arguments, separated by commas, on the +rest of the same line. These arguments are the name of the node, and +the names of the `Next', `Previous', and `Up' pointers, in that order. +You may insert spaces before each pointer if you wish; the spaces are +ignored. You must write the name of the node, and the names of the +`Next', `Previous', and `Up' pointers, all on the same line. Otherwise, the formatters fail. (*note info: (info)Top, for more information about nodes in Info.) Usually, you write one of the chapter-structuring command lines immediately after an `@node' line--for example, an `@section' or -`@subsection' line. (*Note Structuring Command Types::.) +`@subsection' line. (*Note Types of Structuring Commands: Structuring +Command Types.) *Please note:* The GNU Emacs Texinfo mode updating commands work only with Texinfo files in which `@node' lines are followed by @@ -340,8 +157,8 @@ immediately after an `@node' line--for example, an `@section' or references. For this reason, you must write `@node' lines in a Texinfo file that you intend to format for printing, even if you do not intend to format it for Info. (Cross references, such as the one at the end -of this sentence, are made with `@xref' and related commands; see *Note -Cross References::.) +of this sentence, are made with `@xref' and its related commands; see +*Note Cross References::.) * Menu: @@ -354,7 +171,7 @@ Cross References::.) * Top Node Summary:: Write a brief description for readers.  -File: texinfo.info, Node: Node Names, Next: Writing a Node, Up: node +File: texinfo.info, Node: Node Names, Next: Writing a Node, Prev: node, Up: node Choosing Node and Pointer Names ------------------------------- @@ -378,12 +195,6 @@ Also, it is helpful to include a brief description of the manual in the `Top' node. *Note First Node::, for information on how to write the first node of a Texinfo file. - Even when you explicitly specify all pointers, that does not mean you -can write the nodes in the Texinfo source file in an arbitrary order! -Because TeX processes the file sequentially, irrespective of node -pointers, you must write the nodes in the order you wish them to appear -in the printed output. -  File: texinfo.info, Node: Writing a Node, Next: Node Line Tips, Prev: Node Names, Up: node @@ -409,8 +220,8 @@ proper order. The comment line helps you keep track of which arguments are for which pointers. This comment line is especially useful if you are not familiar with Texinfo. - The template for a fully-written-out node line with `Next', -`Previous', and `Up' pointers looks like this: + The template for a node line with `Next', `Previous', and `Up' +pointers looks like this: @node NODE-NAME, NEXT, PREVIOUS, UP @@ -474,10 +285,8 @@ File: texinfo.info, Node: Node Line Requirements, Next: First Node, Prev: Nod The node to which a pointer points may come before or after the node containing the pointer. - * @-commands used in node names generally confuse Info, so you should - avoid them. For a few rare cases when this is useful, Texinfo has - limited support for using @-commands in node names; see *Note - Pointer Validation::. + * You cannot use any of the Texinfo @-commands in a node name; + @-commands confuse Info. Thus, the beginning of the section called `@chapter' looks like this: @@ -487,9 +296,8 @@ File: texinfo.info, Node: Node Line Requirements, Next: First Node, Prev: Nod @section @code{@@chapter} @findex chapter - * Unfortunately, you cannot use periods, commas, colons or - apostrophes within a node name; these confuse TeX or the Info - formatters. + * You cannot use commas or apostrophes within a node name; these + confuse TeX or the Info formatters. For example, the following is a section title: @@ -590,69 +398,33 @@ include an edition number for the manual. (The title page should also contain this information: see *Note `@titlepage': titlepage.)  -File: texinfo.info, Node: makeinfo Pointer Creation, Next: anchor, Prev: node, Up: Nodes +File: texinfo.info, Node: makeinfo Pointer Creation, Prev: node, Up: Nodes Creating Pointers with `makeinfo' ================================= - The `makeinfo' program has a feature for automatically defining node -pointers for a hierarchically organized file. + The `makeinfo' program has a feature for automatically creating node +pointers for a hierarchically organized file that lacks them. When you take advantage of this feature, you do not need to write the `Next', `Previous', and `Up' pointers after the name of a node. However, you must write a sectioning command, such as `@chapter' or `@section', on the line immediately following each truncated `@node' -line (except that comment lines may intervene). +line. You cannot write a comment line after a node line; the section +line must follow it immediately. In addition, you must follow the `Top' `@node' line with a line -beginning with `@top' to mark the `Top' node in the file. *Note -`@top': makeinfo top. +beginning with `@top' to mark the `Top' node in the file. *Note `@top': +makeinfo top. Finally, you must write the name of each node (except for the `Top' node) in a menu that is one or more hierarchical levels above the node's hierarchical level. - This node pointer insertion feature in `makeinfo' relieves you from -the need to update menus and pointers manually or with Texinfo mode -commands. (*Note Updating Nodes and Menus::.) - - -File: texinfo.info, Node: anchor, Prev: makeinfo Pointer Creation, Up: Nodes - -`@anchor': Defining Arbitrary Cross-reference Targets -===================================================== - - An "anchor" is a position in your document, labeled so that -cross-references can refer to it, just as they can to nodes. You create -an anchor with the `@anchor' command, and give the label as a normal -brace-delimited argument. For example: - - This marks the @anchor{x-spot}spot. - ... - @xref{x-spot,,the spot}. - -produces: - - This marks the spot. - ... - See [the spot], page 1. - - As you can see, the `@anchor' command itself produces no output. -This example defines an anchor `x-spot' just before the word `spot'. -You can refer to it later with an `@xref' or other cross-reference -command, as shown. *Note Cross References::, for details on the -cross-reference commands. - - It is best to put `@anchor' commands just before the position you -wish to refer to; that way, the reader's eye is led on to the correct -text when they jump to the anchor. You can put the `@anchor' command -on a line by itself if that helps readability of the source. Spaces -are always ignored after `@anchor'. - - Anchor names and node names may not conflict. Anchors and nodes are -given similar treatment in some ways; for example, the `goto-node' -command in standalone Info takes either an anchor name or a node name as -an argument. (*Note goto-node: (info-stnd)goto-node.) + This node pointer insertion feature in `makeinfo' is an alternative +to the menu and pointer creation and update commands in Texinfo mode. +(*Note Updating Nodes and Menus::.) It is especially helpful to people +who do not use GNU Emacs for writing Texinfo documents.  File: texinfo.info, Node: Menus, Next: Cross References, Prev: Nodes, Up: Top @@ -665,12 +437,11 @@ Menus-Footnote-1::) In Info, you use menus to go to such nodes. Menus have no effect in printed manuals and do not appear in them. By convention, a menu is put at the end of a node since a reader who -uses the menu may not see text that follows it. Furthermore, a node -that has a menu should not contain much text. If you have a lot of text -and a menu, move most of the text into a new subnode--all but a few -lines. Otherwise, a reader with a terminal that displays only a few -lines may miss the menu and its associated text. As a practical matter, -you should locate a menu within 20 lines of the beginning of the node. +uses the menu may not see text that follows it. + + A node that has a menu should _not_ contain much text. If you have a +lot of text and a menu, move most of the text into a new subnode--all +but a few lines. * Menu: @@ -696,6 +467,12 @@ File: texinfo.info, Node: Menu Location, Next: Writing a Menu, Prev: Menus, Menus Need Short Nodes ====================== + A reader can easily see a menu that is close to the beginning of the +node. The node should be short. As a practical matter, you should +locate a menu within 20 lines of the beginning of the node. Otherwise, +a reader with a terminal that displays only a few lines may miss the +menu and its associated text. + The short text before a menu may look awkward in a printed manual. To avoid this, you can write a menu near the beginning of its node and follow the menu by an `@node' line, and then an `@heading' line located @@ -722,7 +499,7 @@ and title appear only in the Info file, not the printed document. The Texinfo file for this document contains more than a dozen examples of this procedure. One is at the beginning of this chapter; -another is at the beginning of *Note Cross References::. +another is at the beginning of the "Cross References" chapter.  File: texinfo.info, Node: Writing a Menu, Next: Menu Parts, Prev: Menu Location, Up: Menus @@ -749,8 +526,7 @@ command on a line by itself. an `* ' may also appear in a menu. Such a line is not a menu entry but is a menu comment line that appears in the Info file. In the example above, the line `Larger Units of Text' is a menu comment line; the two -lines starting with `* ' are menu entries. Space characters in a menu -are preserved as-is; this allows you to format the menu as you wish. +lines starting with `* ' are menu entries.  File: texinfo.info, Node: Menu Parts, Next: Less Cluttered Menu Entry, Prev: Writing a Menu, Up: Menus @@ -898,9 +674,9 @@ of each Info document. (*Note Install an Info File::.) (The `dir' top level directory for the Info system is an Info file, not a Texinfo file, but a menu entry looks the same in both types of file.) - The GNU Emacs Texinfo mode menu updating commands only work with nodes -within the current buffer, so you cannot use them to create menus that -refer to other files. You must write such menus by hand. + Note that the GNU Emacs Texinfo mode menu updating commands only work +with nodes within the current buffer, so you cannot use them to create +menus that refer to other files. You must write such menus by hand.  File: texinfo.info, Node: Cross References, Next: Marking Text, Prev: Menus, Up: Top @@ -909,8 +685,8 @@ Cross References **************** "Cross references" are used to refer the reader to other parts of the -same or different Texinfo files. In Texinfo, nodes and anchors are the -places to which cross references can refer. +same or different Texinfo files. In Texinfo, nodes are the places to +which cross references can refer. * Menu: @@ -936,7 +712,7 @@ find information that should be presented to them as they need it. However, in any document, some information will be too detailed for the current context, or incidental to it; use cross references to -provide access to such information. Also, an online help system or a +provide access to such information. Also, an on-line help system or a reference manual is not like a novel; few read such documents in sequence from beginning to end. Instead, people look up what they need. For this reason, such creations should contain many cross @@ -951,15 +727,15 @@ reference names that manual. using the Info `f' command. (*note Some advanced Info commands: (info)Help-Adv.) - The various cross reference commands use nodes (or anchors, *note -`@anchor': anchor.) to define cross reference locations. This is -evident in Info, in which a cross reference takes you to the specified -location. TeX also uses nodes to define cross reference locations, but -the action is less obvious. When TeX generates a DVI file, it records -each node's page number and uses the page numbers in making references. -Thus, if you are writing a manual that will only be printed, and will -not be used online, you must nonetheless write `@node' lines to name -the places to which you make cross references. + The various cross reference commands use nodes to define cross +reference locations. This is evident in Info, in which a cross +reference takes you to the specified node. TeX also uses nodes to +define cross reference locations, but the action is less obvious. When +TeX generates a DVI file, it records nodes' page numbers and uses the +page numbers in making references. Thus, if you are writing a manual +that will only be printed, and will not be used on-line, you must +nonetheless write `@node' lines to name the places to which you make +cross references.  File: texinfo.info, Node: Cross Reference Commands, Next: Cross Reference Parts, Prev: References, Up: Cross References @@ -1034,10 +810,10 @@ in a printed book. The five possible arguments for a cross reference are: - 1. The node or anchor name (required). This is the location to which - the cross reference takes you. In a printed document, the - location of the node provides the page reference only for - references within the same document. + 1. The node name (required). This is the node to which the cross + reference takes you. In a printed document, the location of the + node provides the page reference only for references within the + same document. 2. The cross reference name for the Info reference, if it is to be different from the node name. If you include this argument, it @@ -1173,8 +949,6 @@ which produces *Note Tropical Storms::, for more info. -and - See Section 3.1 [Tropical Storms], page 24, for more info. (Note that in the preceding example the closing brace is followed by a @@ -1244,9 +1018,9 @@ a title or other section will divide it into two arguments. In a reference, you need to write a title such as "Clouds, Mist, and Fog" without the commas. - Also, remember to write a comma or period after the closing brace of -an `@xref' to terminate the cross reference. In the following -examples, a clause follows a terminating comma. + Also, remember to write a comma or period after the closing brace of a +`@xref' to terminate the cross reference. In the following examples, a +clause follows a terminating comma. The template is like this: @@ -1294,3 +1068,331 @@ are different. for more information. @xref{Regexp, , Regular Expressions as Patterns}. + +File: texinfo.info, Node: Four and Five Arguments, Prev: Three Arguments, Up: xref + +`@xref' with Four and Five Arguments +------------------------------------ + + In a cross reference, a fourth argument specifies the name of another +Info file, different from the file in which the reference appears, and +a fifth argument specifies its title as a printed manual. + + Remember that a comma or period must follow the closing brace of an +`@xref' command to terminate the cross reference. In the following +examples, a clause follows a terminating comma. + +The template is: + + @xref{NODE-NAME, CROSS-REFERENCE-NAME, TITLE-OR-TOPIC, + INFO-FILE-NAME, PRINTED-MANUAL-TITLE}. + +For example, + + @xref{Electrical Effects, Lightning, Thunder and Lightning, + weather, An Introduction to Meteorology}, for details. + +produces + + *Note Lightning: (weather)Electrical Effects, for details. + +The name of the Info file is enclosed in parentheses and precedes the +name of the node. + +In a printed manual, the reference looks like this: + + See section "Thunder and Lightning" in An Introduction to + Meteorology, for details. + +The title of the printed manual is typeset in italics; and the +reference lacks a page number since TeX cannot know to which page a +reference refers when that reference is to another manual. + + Often, you will leave out the second argument when you use the long +version of `@xref'. In this case, the third argument, the topic +description, will be used as the cross reference name in Info. + +The template looks like this: + + @xref{NODE-NAME, , TITLE-OR-TOPIC, INFO-FILE-NAME, + PRINTED-MANUAL-TITLE}, for details. + +which produces + + *Note TITLE-OR-TOPIC: (INFO-FILE-NAME)NODE-NAME, for details. + +and + + See section TITLE-OR-TOPIC in PRINTED-MANUAL-TITLE, for details. + +For example, + + @xref{Electrical Effects, , Thunder and Lightning, + weather, An Introduction to Meteorology}, for details. + +produces + + *Note Thunder and Lightning: (weather)Electrical Effects, + for details. + +and + + See section "Thunder and Lightning" in An Introduction to + Meteorology, for details. + + On rare occasions, you may want to refer to another Info file that is +within a single printed manual--when multiple Texinfo files are +incorporated into the same TeX run but make separate Info files. In +this case, you need to specify only the fourth argument, and not the +fifth. + + +File: texinfo.info, Node: Top Node Naming, Next: ref, Prev: xref, Up: Cross References + +Naming a `Top' Node +=================== + + In a cross reference, you must always name a node. This means that in +order to refer to a whole manual, you must identify the `Top' node by +writing it as the first argument to the `@xref' command. (This is +different from the way you write a menu entry; see *Note Referring to +Other Info Files: Other Info Files.) At the same time, to provide a +meaningful section topic or title in the printed cross reference +(instead of the word `Top'), you must write an appropriate entry for +the third argument to the `@xref' command. + +Thus, to make a cross reference to `The GNU Make Manual', write: + + @xref{Top, , Overview, make, The GNU Make Manual}. + +which produces + + *Note Overview: (make)Top. + +and + + See section "Overview" in The GNU Make Manual. + +In this example, `Top' is the name of the first node, and `Overview' is +the name of the first section of the manual. + + +File: texinfo.info, Node: ref, Next: pxref, Prev: Top Node Naming, Up: Cross References + +`@ref' +====== + + `@ref' is nearly the same as `@xref' except that it does not generate +a `See' in the printed output, just the reference itself. This makes +it useful as the last part of a sentence. + +For example, + + For more information, see @ref{Hurricanes}. + +produces + + For more information, see *Note Hurricanes. + +and + + For more information, see Section 8.2 [Hurricanes], page 123. + + The `@ref' command sometimes leads writers to express themselves in a +manner that is suitable for a printed manual but looks awkward in the +Info format. Bear in mind that your audience will be using both the +printed and the Info format. + +For example, + + Sea surges are described in @ref{Hurricanes}. + +produces + + Sea surges are described in Section 6.7 [Hurricanes], page 72. + +in a printed document, and the following in Info: + + Sea surges are described in *Note Hurricanes::. + + *Caution:* You _must_ write a period or comma immediately after an + `@ref' command with two or more arguments. Otherwise, Info will + not find the end of the cross reference entry and its attempt to + follow the cross reference will fail. As a general rule, you + should write a period or comma after every `@ref' command. This + looks best in both the printed and the Info output. + + +File: texinfo.info, Node: pxref, Next: inforef, Prev: ref, Up: Cross References + +`@pxref' +======== + + The parenthetical reference command, `@pxref', is nearly the same as +`@xref', but you use it _only_ inside parentheses and you do _not_ type +a comma or period after the command's closing brace. The command +differs from `@xref' in two ways: + + 1. TeX typesets the reference for the printed manual with a lower case + `see' rather than an upper case `See'. + + 2. The Info formatting commands automatically end the reference with a + closing colon or period. + + Because one type of formatting automatically inserts closing +punctuation and the other does not, you should use `@pxref' _only_ +inside parentheses as part of another sentence. Also, you yourself +should not insert punctuation after the reference, as you do with +`@xref'. + + `@pxref' is designed so that the output looks right and works right +between parentheses both in printed output and in an Info file. In a +printed manual, a closing comma or period should not follow a cross +reference within parentheses; such punctuation is wrong. But in an +Info file, suitable closing punctuation must follow the cross reference +so Info can recognize its end. `@pxref' spares you the need to use +complicated methods to put a terminator into one form of the output and +not the other. + +With one argument, a parenthetical cross reference looks like this: + + ... storms cause flooding (@pxref{Hurricanes}) ... + +which produces + + ... storms cause flooding (*Note Hurricanes::) ... + +and + + ... storms cause flooding (see Section 6.7 [Hurricanes], page 72) + ... + + With two arguments, a parenthetical cross reference has this template: + + ... (@pxref{NODE-NAME, CROSS-REFERENCE-NAME}) ... + +which produces + + ... (*Note CROSS-REFERENCE-NAME: NODE-NAME.) ... + +and + + ... (see Section NNN [NODE-NAME], page PPP) ... + + `@pxref' can be used with up to five arguments just like `@xref' +(*note `@xref': xref.). + + *Please note:* Use `@pxref' only as a parenthetical reference. Do + not try to use `@pxref' as a clause in a sentence. It will look + bad in either the Info file, the printed output, or both. + + Also, parenthetical cross references look best at the ends of + sentences. Although you may write them in the middle of a + sentence, that location breaks up the flow of text. + + +File: texinfo.info, Node: inforef, Next: uref, Prev: pxref, Up: Cross References + +`@inforef' +========== + + `@inforef' is used for cross references to Info files for which there +are no printed manuals. Even in a printed manual, `@inforef' generates +a reference directing the user to look in an Info file. + + The command takes either two or three arguments, in the following +order: + + 1. The node name. + + 2. The cross reference name (optional). + + 3. The Info file name. + +Separate the arguments with commas, as with `@xref'. Also, you must +terminate the reference with a comma or period after the `}', as you do +with `@xref'. + +The template is: + + @inforef{NODE-NAME, CROSS-REFERENCE-NAME, INFO-FILE-NAME}, + +Thus, + + @inforef{Expert, Advanced Info commands, info}, + for more information. + +produces + + *Note Advanced Info commands: (info)Expert, + for more information. + +and + + See Info file `info', node `Expert', for more information. + +Similarly, + + @inforef{Expert, , info}, for more information. + +produces + + *Note (info)Expert::, for more information. + +and + + See Info file `info', node `Expert', for more information. + + The converse of `@inforef' is `@cite', which is used to refer to +printed works for which no Info form exists. *Note `@cite': cite. + + +File: texinfo.info, Node: uref, Prev: inforef, Up: Cross References + +`@uref{URL[, DISPLAYED-TEXT]}' +============================== + + `@uref' produces a reference to a uniform resource locator (URL). It +takes one mandatory argument, the URL, and one optional argument, the +text to display (the default is the URL itself). In HTML output, +`@uref' produces a link you can follow. For example: + + The official GNU ftp site is + @uref{ftp://ftp.gnu.ai.mit.edu/pub/gnu} + +produces (in text): + The official GNU ftp site is + `ftp://ftp.gnu.ai.mit.edu/pub/gnu' + +whereas + The official + @uref{ftp://ftp.gnu.ai.mit.edu/pub/gnu, + GNU ftp site} holds programs and texts. + +produces (in text): + The official GNU ftp site (ftp://ftp.gnu.ai.mit.edu/pub/gnu) holds + programs and texts. + +and (in HTML): + The official GNU ftp + site holds programs and texts. + + To merely indicate a URL, use `@url' (*note `@url': url.). + + +File: texinfo.info, Node: Marking Text, Next: Quotations and Examples, Prev: Cross References, Up: Top + +Marking Words and Phrases +************************* + + In Texinfo, you can mark words and phrases in a variety of ways. The +Texinfo formatters use this information to determine how to highlight +the text. You can specify, for example, whether a word or phrase is a +defining occurrence, a metasyntactic variable, or a symbol used in a +program. Also, you can emphasize text. + +* Menu: + +* Indicating:: How to indicate definitions, files, etc. +* Emphasis:: How to emphasize text. + diff --git a/info/texinfo.info-5 b/info/texinfo.info-5 index f0c7587..f285171 100644 --- a/info/texinfo.info-5 +++ b/info/texinfo.info-5 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,367 +33,6 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: Four and Five Arguments, Prev: Three Arguments, Up: xref - -`@xref' with Four and Five Arguments ------------------------------------- - - In a cross reference, a fourth argument specifies the name of another -Info file, different from the file in which the reference appears, and -a fifth argument specifies its title as a printed manual. - - Remember that a comma or period must follow the closing brace of an -`@xref' command to terminate the cross reference. In the following -examples, a clause follows a terminating comma. - -The template is: - - @xref{NODE-NAME, CROSS-REFERENCE-NAME, TITLE-OR-TOPIC, - INFO-FILE-NAME, PRINTED-MANUAL-TITLE}. - -For example, - - @xref{Electrical Effects, Lightning, Thunder and Lightning, - weather, An Introduction to Meteorology}, for details. - -produces - - *Note Lightning: (weather)Electrical Effects, for details. - -The name of the Info file is enclosed in parentheses and precedes the -name of the node. - -In a printed manual, the reference looks like this: - - See section "Thunder and Lightning" in An Introduction to - Meteorology, for details. - -The title of the printed manual is typeset in italics; and the -reference lacks a page number since TeX cannot know to which page a -reference refers when that reference is to another manual. - - Often, you will leave out the second argument when you use the long -version of `@xref'. In this case, the third argument, the topic -description, will be used as the cross reference name in Info. - -The template looks like this: - - @xref{NODE-NAME, , TITLE-OR-TOPIC, INFO-FILE-NAME, - PRINTED-MANUAL-TITLE}, for details. - -which produces - - *Note TITLE-OR-TOPIC: (INFO-FILE-NAME)NODE-NAME, for details. - -and - - See section TITLE-OR-TOPIC in PRINTED-MANUAL-TITLE, for details. - -For example, - - @xref{Electrical Effects, , Thunder and Lightning, - weather, An Introduction to Meteorology}, for details. - -produces - - *Note Thunder and Lightning: (weather)Electrical Effects, - for details. - -and - - See section "Thunder and Lightning" in An Introduction to - Meteorology, for details. - - On rare occasions, you may want to refer to another Info file that is -within a single printed manual--when multiple Texinfo files are -incorporated into the same TeX run but make separate Info files. In -this case, you need to specify only the fourth argument, and not the -fifth. - - -File: texinfo.info, Node: Top Node Naming, Next: ref, Prev: xref, Up: Cross References - -Naming a `Top' Node -=================== - - In a cross reference, you must always name a node. This means that in -order to refer to a whole manual, you must identify the `Top' node by -writing it as the first argument to the `@xref' command. (This is -different from the way you write a menu entry; see *Note Referring to -Other Info Files: Other Info Files.) At the same time, to provide a -meaningful section topic or title in the printed cross reference -(instead of the word `Top'), you must write an appropriate entry for -the third argument to the `@xref' command. - -Thus, to make a cross reference to `The GNU Make Manual', write: - - @xref{Top, , Overview, make, The GNU Make Manual}. - -which produces - - *Note Overview: (make)Top. - -and - - See section "Overview" in The GNU Make Manual. - -In this example, `Top' is the name of the first node, and `Overview' is -the name of the first section of the manual. - - -File: texinfo.info, Node: ref, Next: pxref, Prev: Top Node Naming, Up: Cross References - -`@ref' -====== - - `@ref' is nearly the same as `@xref' except that it does not generate -a `See' in the printed output, just the reference itself. This makes -it useful as the last part of a sentence. - -For example, - - For more information, see @ref{Hurricanes}. - -produces - - For more information, see *Note Hurricanes::. - -and - - For more information, see Section 8.2 [Hurricanes], page 123. - - The `@ref' command sometimes leads writers to express themselves in a -manner that is suitable for a printed manual but looks awkward in the -Info format. Bear in mind that your audience will be using both the -printed and the Info format. - -For example, - - Sea surges are described in @ref{Hurricanes}. - -produces - - Sea surges are described in Section 6.7 [Hurricanes], page 72. - -in a printed document, and the following in Info: - - Sea surges are described in *Note Hurricanes::. - - *Caution:* You _must_ write a period, comma, or right parenthesis - immediately after an `@ref' command with two or more arguments. - Otherwise, Info will not find the end of the cross reference entry - and its attempt to follow the cross reference will fail. As a - general rule, you should write a period or comma after every - `@ref' command. This looks best in both the printed and the Info - output. - - -File: texinfo.info, Node: pxref, Next: inforef, Prev: ref, Up: Cross References - -`@pxref' -======== - - The parenthetical reference command, `@pxref', is nearly the same as -`@xref', but you use it _only_ inside parentheses and you do _not_ type -a comma or period after the command's closing brace. The command -differs from `@xref' in two ways: - - 1. TeX typesets the reference for the printed manual with a lower case - `see' rather than an upper case `See'. - - 2. The Info formatting commands automatically end the reference with a - closing colon or period. - - Because one type of formatting automatically inserts closing -punctuation and the other does not, you should use `@pxref' _only_ -inside parentheses as part of another sentence. Also, you yourself -should not insert punctuation after the reference, as you do with -`@xref'. - - `@pxref' is designed so that the output looks right and works right -between parentheses both in printed output and in an Info file. In a -printed manual, a closing comma or period should not follow a cross -reference within parentheses; such punctuation is wrong. But in an -Info file, suitable closing punctuation must follow the cross reference -so Info can recognize its end. `@pxref' spares you the need to use -complicated methods to put a terminator into one form of the output and -not the other. - -With one argument, a parenthetical cross reference looks like this: - - ... storms cause flooding (@pxref{Hurricanes}) ... - -which produces - - ... storms cause flooding (*Note Hurricanes::) ... - -and - - ... storms cause flooding (see Section 6.7 [Hurricanes], page 72) - ... - - With two arguments, a parenthetical cross reference has this template: - - ... (@pxref{NODE-NAME, CROSS-REFERENCE-NAME}) ... - -which produces - - ... (*Note CROSS-REFERENCE-NAME: NODE-NAME.) ... - -and - - ... (see Section NNN [NODE-NAME], page PPP) ... - - `@pxref' can be used with up to five arguments just like `@xref' -(*note `@xref': xref.). - - *Please note:* Use `@pxref' only as a parenthetical reference. Do - not try to use `@pxref' as a clause in a sentence. It will look - bad in either the Info file, the printed output, or both. - - Also, parenthetical cross references look best at the ends of - sentences. Although you may write them in the middle of a - sentence, that location breaks up the flow of text. - - -File: texinfo.info, Node: inforef, Next: uref, Prev: pxref, Up: Cross References - -`@inforef' -========== - - `@inforef' is used for cross references to Info files for which there -are no printed manuals. Even in a printed manual, `@inforef' generates -a reference directing the user to look in an Info file. - - The command takes either two or three arguments, in the following -order: - - 1. The node name. - - 2. The cross reference name (optional). - - 3. The Info file name. - -Separate the arguments with commas, as with `@xref'. Also, you must -terminate the reference with a comma or period after the `}', as you do -with `@xref'. - -The template is: - - @inforef{NODE-NAME, CROSS-REFERENCE-NAME, INFO-FILE-NAME}, - -Thus, - - @inforef{Expert, Advanced Info commands, info}, - for more information. - -produces - - *Note Advanced Info commands: (info)Expert, - for more information. - -and - - See Info file `info', node `Expert', for more information. - -Similarly, - - @inforef{Expert, , info}, for more information. - -produces - - *Note (info)Expert::, for more information. - -and - - See Info file `info', node `Expert', for more information. - - The converse of `@inforef' is `@cite', which is used to refer to -printed works for which no Info form exists. *Note `@cite': cite. - - -File: texinfo.info, Node: uref, Prev: inforef, Up: Cross References - -`@uref{URL[, TEXT][, REPLACEMENT]}' -=================================== - - `@uref' produces a reference to a uniform resource locator (url). It -takes one mandatory argument, the url, and two optional arguments which -control the text that is displayed. In HTML output, `@uref' produces a -link you can follow. - - The second argument, if specified, is the text to display (the default -is the url itself); in Info and DVI output, but not in HTML output, the -url is also output. - - The third argument, on the other hand, if specified is also the text -to display, but the url is _not_ output in any format. This is useful -when the text is already sufficiently referential, as in a man page. If -the third argument is given, the second argument is ignored. - - The simple one argument form, where the url is both the target and the -text of the link: - - The official GNU ftp site is @uref{ftp://ftp.gnu.org/gnu}. - -produces: - The official GNU ftp site is `ftp://ftp.gnu.org/gnu'. - - An example of the two-argument form: - The official @uref{ftp://ftp.gnu.org/gnu, GNU ftp site} holds - programs and texts. - -produces: - The official GNU ftp site (ftp://ftp.gnu.org/gnu) holds - programs and texts. - -that is, the Info output is this: - The official GNU ftp site (ftp://ftp.gnu.org/gnu) holds - programs and texts. - -and the HTML output is this: - The official GNU ftp site holds - programs and texts. - - An example of the three-argument form: - The @uref{http://example.org/man.cgi/1/ls,,ls(1)} program ... - -produces: - The ls(1) program ... - -but with HTML: - The ls(1) program ... - - To merely indicate a url without creating a link people can follow, -use `@url' (*note `@url': url.). - - Some people prefer to display url's in the unambiguous format: - - - -You can use this form in the input file if you wish. We feel it's not -necessary to clutter up the output with the extra `', -since any software that tries to detect url's in text already has to -detect them without the ` However, that is not the style that Texinfo uses. (You can, of course, -modify the sources to `texinfo.tex' and the Info formatting commands to -output the `<...>' format if you wish.) +modify the sources to TeX and the Info formatting commands to output +the `<...>' format if you wish.)  -File: texinfo.info, Node: env, Next: file, Prev: var, Up: Indicating - -`@env'{ENVIRONMENT-VARIABLE} ----------------------------- - - Use the `@env' command to indicate environment variables, as used by -many operating systems, including GNU. Do not use it for metasyntactic -variables; use `@var' instead (see the previous section). - - `@env' is equivalent to `@code' in its effects. For example: - - The @env{PATH} environment variable sets the search path for commands. - produces - The `PATH' environment variable sets the search path for commands. - - -File: texinfo.info, Node: file, Next: command, Prev: env, Up: Indicating +File: texinfo.info, Node: file, Next: dfn, Prev: var, Up: Indicating `@file'{FILE-NAME} ------------------ @@ -824,47 +420,7 @@ produces The `.el' files are in the `/usr/local/emacs/lisp' directory.  -File: texinfo.info, Node: command, Next: option, Prev: file, Up: Indicating - -`@command'{COMMAND-NAME} ------------------------- - - Use the `@command' command to indicate command names, such as `ls' or -`cc'. - - `@command' is equivalent to `@code' in its effects. For example: - - The command @command{ls} lists directory contents. - produces - The command `ls' lists directory contents. - - You should write the name of a program in the ordinary text font, -rather than using `@command', if you regard it as a new English word, -such as `Emacs' or `Bison'. - - When writing an entire shell command invocation, as in `ls -l', you -should use either `@samp' or `@code' at your discretion. - - -File: texinfo.info, Node: option, Next: dfn, Prev: command, Up: Indicating - -`@option'{OPTION-NAME} ----------------------- - - Use the `@option' command to indicate a command-line option; for -example, `-l' or `--version' or `--output=FILENAME'. - - `@option' is equivalent to `@samp' in its effects. For example: - - The option @option{-l} produces a long listing. - produces - The option `-l' produces a long listing. - - In tables, putting options inside `@code' produces a more pleasing -effect. - - -File: texinfo.info, Node: dfn, Next: cite, Prev: option, Up: Indicating +File: texinfo.info, Node: dfn, Next: cite, Prev: file, Up: Indicating `@dfn'{TERM} ------------ @@ -888,52 +444,33 @@ say explicitly that it is a definition, but it should contain the information of a definition--it should make the meaning clear.  -File: texinfo.info, Node: cite, Next: acronym, Prev: dfn, Up: Indicating +File: texinfo.info, Node: cite, Next: url, Prev: dfn, Up: Indicating `@cite'{REFERENCE} ------------------ Use the `@cite' command for the name of a book that lacks a companion -Info file. The command produces italics in the printed manual, and +Info file. The command produces italics in the printed manual, and quotation marks in the Info file. - If a book is written in Texinfo, it is better to use a cross reference -command since a reader can easily follow such a reference in Info. -*Note `@xref': xref. + (If a book is written in Texinfo, it is better to use a cross +reference command since a reader can easily follow such a reference in +Info. *Note `@xref': xref.)  -File: texinfo.info, Node: acronym, Next: url, Prev: cite, Up: Indicating - -`@acronym'{ACRONYM} -------------------- - - Use the `@acronym' command for abbreviations written in all capital -letters, such as `NASA'. The abbreviation is given as the single -argument in braces, as in `@acronym{NASA}'. As a matter of style, or -for particular abbreviations, you may prefer to use periods, as in -`@acronym{F.B.I.}'. - - In TeX and HTML, the argument is printed in a slightly smaller font -size. In Info or plain text output, this command changes nothing. - - -File: texinfo.info, Node: url, Next: email, Prev: acronym, Up: Indicating +File: texinfo.info, Node: url, Next: email, Prev: cite, Up: Indicating `@url'{UNIFORM-RESOURCE-LOCATOR} -------------------------------- - Use the `@url' command to indicate a uniform resource locator on the -World Wide Web. This is analogous to `@file', `@var', etc., and is -purely for markup purposes. It does not produce a link you can follow -in HTML output (use the `@uref' command for that, *note `@uref': -uref.). It is useful for url's which do not actually exist. For -example: - - For example, the url might be @url{http://example.org/path}. - -which produces: + Use the `@url' to indicate a uniform resource locator on the World +Wide Web. This is analogous to `@file', `@var', etc., and is purely +for markup purposes. It does not produce a link you can follow in HTML +output (the `@uref' command does, *note `@uref': uref.). It is useful +for example URL's which do not actually exist. For example: - For example, the url might be . + For example, the url might be + @url{http://host.domain.org/path}.  File: texinfo.info, Node: email, Prev: url, Up: Indicating @@ -952,7 +489,8 @@ example: Send bug reports to @email{bug-texinfo@@gnu.org}. Send suggestions to the @email{bug-texinfo@@gnu.org, same place}. - produces + +produces Send bug reports to . Send suggestions to the same place . @@ -968,7 +506,7 @@ Most often, this is the best way to mark words. However, sometimes you will want to emphasize text without indicating a category. Texinfo has two commands to do this. Also, Texinfo has several commands that specify the font in which TeX will typeset text. These commands have -no effect on Info and only one of them, the `@r' command, has any +no affect on Info and only one of them, the `@r' command, has any regular use. * Menu: @@ -976,9 +514,10 @@ regular use. * emph & strong:: How to emphasize text in Texinfo. * Smallcaps:: How to use the small caps font. * Fonts:: Various font commands for printed output. +* Customized Highlighting:: How to define highlighting commands.  -File: texinfo.info, Node: emph & strong, Next: Smallcaps, Up: Emphasis +File: texinfo.info, Node: emph & strong, Next: Smallcaps, Prev: Emphasis, Up: Emphasis `@emph'{TEXT} and `@strong'{TEXT} --------------------------------- @@ -996,19 +535,19 @@ produces *bold*. produces: - *Caution*: `rm * .[^.]*' removes _all_ + *Caution*: `rm * .[^.]*' removes *all* files in the directory. The `@strong' command is seldom used except to mark what is, in effect, a typographical element, such as the word `Caution' in the preceding example. - In the Info output, `@emph' surrounds the text with underscores -(`_'), and `@strong' puts asterisks around the text. + In the Info file, both `@emph' and `@strong' put asterisks around the +text. - *Caution:* Do not use `@strong' with the word `Note'; Info will - mistake the combination for a cross reference. Use a phrase such - as *Please note* or *Caution* instead. + *Caution:* Do not use `@emph' or `@strong' with the word `Note'; + Info will mistake the combination for a cross reference. Use a + phrase such as *Please note* or *Caution* instead.  File: texinfo.info, Node: Smallcaps, Next: Fonts, Prev: emph & strong, Up: Emphasis @@ -1016,10 +555,10 @@ File: texinfo.info, Node: Smallcaps, Next: Fonts, Prev: emph & strong, Up: E `@sc'{TEXT}: The Small Caps Font -------------------------------- - Use the `@sc' command to set text in the printed and the HTML output -in A SMALL CAPS FONT and set text in the Info file in upper case -letters. Write the text you want to be in small caps (where possible) -between braces in lower case, like this: + Use the `@sc' command to set text in the printed output in a small +caps font and set text in the Info file in upper case letters. + + Write the text between braces in lower case, like this: The @sc{acm} and @sc{ieee} are technical societies. @@ -1029,15 +568,11 @@ This produces: TeX typesets the small caps font in a manner that prevents the letters from `jumping out at you on the page'. This makes small caps -text easier to read than text in all upper case--but it's usually -better to use regular mixed case anyway. The Info formatting commands -set all small caps text in upper case. In HTML, the text is upper-cased -and a smaller font is used to render it. +text easier to read than text in all upper case. The Info formatting +commands set all small caps text in upper case. - If the text between the braces of an `@sc' command is uppercase, TeX -typesets in FULL-SIZE CAPITALS. Use full-size capitals sparingly, if -ever, and since it's redundant to mark all-uppercase text with `@sc', -`makeinfo' warns about such usage. + If the text between the braces of an `@sc' command is upper case, TeX +typesets in full-size capitals. Use full-size capitals sparingly. You may also use the small caps font for a jargon word such as ATO (a NASA word meaning `abort to orbit'). @@ -1049,7 +584,7 @@ subsequent elements of a list (the CDR of the list), but you should use `@code' when the word refers to the Lisp function of the same spelling.  -File: texinfo.info, Node: Fonts, Prev: Smallcaps, Up: Emphasis +File: texinfo.info, Node: Fonts, Next: Customized Highlighting, Prev: Smallcaps, Up: Emphasis Fonts for Printing, Not Info ---------------------------- @@ -1081,6 +616,91 @@ you need to use one, it probably indicates a gap in the Texinfo language.  +File: texinfo.info, Node: Customized Highlighting, Prev: Fonts, Up: Emphasis + +Customized Highlighting +----------------------- + + You can use regular TeX commands inside of `@iftex' ... `@end iftex' +to create your own customized highlighting commands for Texinfo. The +easiest way to do this is to equate your customized commands with +pre-existing commands, such as those for italics. Such new commands +work only with TeX. + + You can use the `@definfoenclose' command inside of `@ifinfo' ... +`@end ifinfo' to define commands for Info with the same names as new +commands for TeX. `@definfoenclose' creates new commands for Info that +mark text by enclosing it in strings that precede and follow the text. +(1) (*note Customized Highlighting-Footnote-1::) + + Here is how to create a new @-command called `@phoo' that causes TeX +to typeset its argument in italics and causes Info to display the +argument between `//' and `\\'. + + For TeX, write the following to equate the `@phoo' command with the +existing `@i' italics command: + + @iftex + @global@let@phoo=@i + @end iftex + +This defines `@phoo' as a command that causes TeX to typeset the +argument to `@phoo' in italics. `@global@let' tells TeX to equate the +next argument with the argument that follows the equals sign. + + For Info, write the following to tell the Info formatters to enclose +the argument between `//' and `\\': + + @ifinfo + @definfoenclose phoo, //, \\ + @end ifinfo + +Write the `@definfoenclose' command on a line and follow it with three +arguments separated by commas (commas are used as separators in an +`@node' line in the same way). + + * The first argument to `@definfoenclose' is the @-command name + *without* the `@'; + + * the second argument is the Info start delimiter string; and, + + * the third argument is the Info end delimiter string. + +The latter two arguments enclose the highlighted text in the Info file. +A delimiter string may contain spaces. Neither the start nor end +delimiter is required. However, if you do not provide a start +delimiter, you must follow the command name with two commas in a row; +otherwise, the Info formatting commands will misinterpret the end +delimiter string as a start delimiter string. + + After you have defined `@phoo' both for TeX and for Info, you can +then write `@phoo{bar}' to see `//bar\\' in Info and see `bar' in +italics in printed output. + + Note that each definition applies to its own formatter: one for TeX, +the other for Info. + + Here is another example: + + @ifinfo + @definfoenclose headword, , : + @end ifinfo + @iftex + @global@let@headword=@b + @end iftex + +This defines `@headword' as an Info formatting command that inserts +nothing before and a colon after the argument and as a TeX formatting +command to typeset its argument in bold. + + +File: texinfo.info, Node: Customized Highlighting-Footnotes, Up: Customized Highlighting + + (1) Currently, `@definfoenclose' works only with +`texinfo-format-buffer' and `texinfo-format-region', not with +`makeinfo'. + + File: texinfo.info, Node: Quotations and Examples, Next: Lists and Tables, Prev: Marking Text, Up: Top Quotations and Examples @@ -1104,8 +724,8 @@ on a line by itself, at the beginning of that line. * quotation:: How to write a quotation. * example:: How to write an example in a fixed-width font. * noindent:: How to prevent paragraph indentation. -* lisp:: How to illustrate Lisp code. -* small:: Forms for `@smallbook'. +* Lisp Example:: How to illustrate Lisp code. +* smallexample & smalllisp:: Forms for the `@smallbook' option. * display:: How to write an example in the current font. * format:: How to write an example that does not narrow the margins. @@ -1114,13 +734,12 @@ on a line by itself, at the beginning of that line. * cartouche:: How to draw cartouches around examples.  -File: texinfo.info, Node: Block Enclosing Commands, Next: quotation, Up: Quotations and Examples +File: texinfo.info, Node: Block Enclosing Commands, Next: quotation, Prev: Quotations and Examples, Up: Quotations and Examples -Block Enclosing Commands -======================== +The Block Enclosing Commands +============================ - Here are commands for quotations and examples, explained further in -the following sections: + Here are commands for quotations and examples: `@quotation' Indicate text that is quoted. The text is filled, indented, and @@ -1130,31 +749,28 @@ the following sections: Illustrate code, commands, and the like. The text is printed in a fixed-width font, and indented but not filled. -`@smallexample' - Same as `@example', except that in TeX this command typesets text - in a smaller font for the `@smallbook' format than for the default - 8.5 by 11 inch format. - `@lisp' - Like `@example', but specifically for illustrating Lisp code. The - text is printed in a fixed-width font, and indented but not filled. + Illustrate Lisp code. The text is printed in a fixed-width font, + and indented but not filled. + +`@smallexample' + Illustrate code, commands, and the like. Similar to `@example', + except that in TeX this command typesets text in a smaller font + for the smaller `@smallbook' format than for the 8.5 by 11 inch + format. `@smalllisp' - Is to `@lisp' as `@smallexample' is to `@example'. + Illustrate Lisp code. Similar to `@lisp', except that in TeX this + command typesets text in a smaller font for the smaller + `@smallbook' format than for the 8.5 by 11 inch format. `@display' Display illustrative text. The text is indented but not filled, - and no font is selected (so, by default, the font is roman). - -`@smalldisplay' - Is to `@display' as `@smallexample' is to `@example'. + and no font is specified (so, by default, the font is roman). `@format' - Like `@display' (the text is not filled and no font is selected), - but the text is not indented. - -`@smallformat' - Is to `@format' as `@smallexample' is to `@example'. + Print illustrative text. The text is not indented and not filled + and no font is specified (so, by default, the font is roman). The `@exdent' command is used within the above constructs to undo the indentation of a line. @@ -1167,8 +783,9 @@ to prevent the following text from being indented as a new paragraph. You can use the `@cartouche' command within one of the above constructs to highlight the example or quotation by drawing a box with -rounded corners around it. *Note Drawing Cartouches Around Examples: -cartouche. +rounded corners around it. (The `@cartouche' command affects only the +printed manual; it has no effect in the Info file; see *Note Drawing +Cartouches Around Examples: cartouche.)  File: texinfo.info, Node: quotation, Next: example, Prev: Block Enclosing Commands, Up: Quotations and Examples @@ -1226,8 +843,9 @@ part of the running text, such as computer input or output. obtained by indenting each line with five spaces. Write an `@example' command at the beginning of a line by itself. -Mark the end of the example with an `@end example' command, also -written at the beginning of a line by itself. +This line will disappear from the output. Mark the end of the example +with an `@end example' command, also written at the beginning of a line +by itself. The `@end example' will disappear from the output. For example, @@ -1239,11 +857,11 @@ produces mv foo bar - The lines containing `@example' and `@end example' will disappear -from the output. To make the output look good, you should put a blank -line before the `@example' and another blank line after the `@end -example'. Note that blank lines inside the beginning `@example' and -the ending `@end example' will appear in the output. + Since the lines containing `@example' and `@end example' will +disappear, you should put a blank line before the `@example' and +another blank line after the `@end example'. (Remember that blank +lines between the beginning `@example' and the ending `@end example' +will appear in the output.) *Caution:* Do not use tabs in the lines of an example (or anywhere else in Texinfo, for that matter)! TeX treats tabs as single @@ -1252,7 +870,7 @@ the ending `@end example' will appear in the output. convert tabs in a region to multiple spaces.) Examples are often, logically speaking, "in the middle" of a -paragraph, and the text that continues after an example should not be +paragraph, and the text continues after an example should not be indented. The `@noindent' command prevents a piece of text from being indented as if it were a new paragraph. (*Note noindent::.) @@ -1261,7 +879,7 @@ within sentences, not set off from preceding and following text. *Note `@code': code.)  -File: texinfo.info, Node: noindent, Next: lisp, Prev: example, Up: Quotations and Examples +File: texinfo.info, Node: noindent, Next: Lisp Example, Prev: example, Up: Quotations and Examples `@noindent' =========== @@ -1305,7 +923,7 @@ necessary, since `@noindent' is a command used outside of paragraphs (*note Command Syntax::).  -File: texinfo.info, Node: lisp, Next: small, Prev: noindent, Up: Quotations and Examples +File: texinfo.info, Node: Lisp Example, Next: smallexample & smalllisp, Prev: noindent, Up: Quotations and Examples `@lisp' ======= @@ -1319,65 +937,66 @@ File: texinfo.info, Node: lisp, Next: small, Prev: noindent, Up: Quotations Use `@lisp' instead of `@example' to preserve information regarding the nature of the example. This is useful, for example, if you write a function that evaluates only and all the Lisp code in a Texinfo file. -Then you can use the Texinfo file as a Lisp library.(1) (*note -lisp-Footnote-1::) +Then you can use the Texinfo file as a Lisp library.(1) (*note Lisp +Example-Footnote-1::) Mark the end of `@lisp' with `@end lisp' on a line by itself.  -File: texinfo.info, Node: lisp-Footnotes, Up: lisp +File: texinfo.info, Node: Lisp Example-Footnotes, Up: Lisp Example (1) It would be straightforward to extend Texinfo to work in a similar fashion for C, Fortran, or other languages.  -File: texinfo.info, Node: small, Next: display, Prev: lisp, Up: Quotations and Examples +File: texinfo.info, Node: smallexample & smalllisp, Next: display, Prev: Lisp Example, Up: Quotations and Examples -`@small...' Block Commands -========================== +`@smallexample' and `@smalllisp' +================================ In addition to the regular `@example' and `@lisp' commands, Texinfo -has "small" example-style commands. These are `@smalldisplay', -`@smallexample', `@smallformat', and `@smalllisp'. All of these -commands are designed for use with the `@smallbook' command (which -causes TeX to format a printed book for a 7 by 9.25 inch trim size -rather than the default 8.5 by 11 inch size). - - In TeX, the `@small...' commands typeset text in a smaller font for -the smaller `@smallbook' format than for the 8.5 by 11 inch format. -Consequently, many examples containing long lines fit in a narrower, -`@smallbook' page without needing to be shortened. Both commands -typeset in the normal font size when you format for the 8.5 by 11 inch -size. Indeed, in this situation, the `@small...' commands are -equivalent to their non-small versions. - - In Info, the `@small...' commands are also equivalent to their -non-small companion commands. - - Mark the end of an `@small...' block with a corresponding `@end -small...'. For example, pair `@smallexample' with `@end smallexample'. +has two other "example-style" commands. These are the `@smallexample' +and `@smalllisp' commands. Both these commands are designed for use +with the `@smallbook' command that causes TeX to produce a printed +manual in a 7 by 9.25 inch format rather than the regular 8.5 by 11 +inch format. + + In TeX, the `@smallexample' and `@smalllisp' commands typeset text in +a smaller font for the smaller `@smallbook' format than for the 8.5 by +11 inch format. Consequently, many examples containing long lines fit +in a narrower, `@smallbook' page without needing to be shortened. Both +commands typeset in the normal font size when you format for the 8.5 by +11 inch size; indeed, in this situation, the `@smallexample' and +`@smalllisp' commands are defined to be the `@example' and `@lisp' +commands. + + In Info, the `@smallexample' and `@smalllisp' commands are equivalent +to the `@example' and `@lisp' commands, and work exactly the same. + + Mark the end of `@smallexample' or `@smalllisp' with `@end +smallexample' or `@end smalllisp', respectively. This is an example of text written between `@smallexample' and `@end smallexample'. In Info and in an 8.5 by 11 inch manual, this text appears in its normal size; but in a 7 by 9.25 inch manual, this text appears in a smaller font. - The `@small...' commands make it easier to prepare smaller format -manuals without forcing you to edit examples by hand to fit them onto -narrower pages. + The `@smallexample' and `@smalllisp' commands make it easier to +prepare smaller format manuals without forcing you to edit examples by +hand to fit them onto narrower pages. - As a general rule, a printed document looks better if you use only one -of (for example) `@example' or in `@smallexample' consistently within a -chapter. Only occasionally should you mix the two formats. + As a general rule, a printed document looks better if you write all +the examples in a chapter consistently in `@example' or in +`@smallexample'. Only occasionally should you mix the two formats. *Note Printing "Small" Books: smallbook, for more information about the `@smallbook' command.  -File: texinfo.info, Node: display, Next: format, Prev: small, Up: Quotations and Examples +File: texinfo.info, Node: display, Next: format, Prev: smallexample & smalllisp, Up: Quotations and Examples -`@display' and `@smalldisplay' -============================== +`@display' +========== The `@display' command begins a kind of example. It is like the `@example' command except that, in a printed manual, `@display' does @@ -1389,15 +1008,11 @@ appeared in without the `@display' command. and an `@end display' command. The `@display' command indents the text, but does not fill it. - Texinfo also provides a command `@smalldisplay', which is like -`@display' but uses a smaller font in `@smallbook' format. *Note -small::. -  File: texinfo.info, Node: format, Next: exdent, Prev: display, Up: Quotations and Examples -`@format' and `@smallformat' -============================ +`@format' +========= The `@format' command is similar to `@example' except that, in the printed manual, `@format' does not select the fixed-width font and does @@ -1408,10 +1023,6 @@ and an `@end format' command. As you can see from this example, the `@format' command does not fill the text. - Texinfo also provides a command `@smallformat', which is like -`@format' but uses a smaller font in `@smallbook' format. *Note -small::. -  File: texinfo.info, Node: exdent, Next: flushleft & flushright, Prev: format, Up: Quotations and Examples @@ -1485,3 +1096,358 @@ produces right justifies every line but leaves the left end ragged. + +File: texinfo.info, Node: cartouche, Prev: flushleft & flushright, Up: Quotations and Examples + +Drawing Cartouches Around Examples +================================== + + In a printed manual, the `@cartouche' command draws a box with +rounded corners around its contents. You can use this command to +further highlight an example or quotation. For instance, you could +write a manual in which one type of example is surrounded by a cartouche +for emphasis. + + The `@cartouche' command affects only the printed manual; it has no +effect in the Info file. + + For example, + + @example + @cartouche + % pwd + /usr/local/share/emacs + @end cartouche + @end example + +surrounds the two-line example with a box with rounded corners, in the +printed manual. + + +File: texinfo.info, Node: Lists and Tables, Next: Indices, Prev: Quotations and Examples, Up: Top + +Lists and Tables +**************** + + Texinfo has several ways of making lists and tables. Lists can be +bulleted or numbered; two-column tables can highlight the items in the +first column; multi-column tables are also supported. + +* Menu: + +* Introducing Lists:: Texinfo formats lists for you. +* itemize:: How to construct a simple list. +* enumerate:: How to construct a numbered list. +* Two-column Tables:: How to construct a two-column table. +* Multi-column Tables:: How to construct generalized tables. + + +File: texinfo.info, Node: Introducing Lists, Next: itemize, Prev: Lists and Tables, Up: Lists and Tables + +Introducing Lists +================= + + Texinfo automatically indents the text in lists or tables, and numbers +an enumerated list. This last feature is useful if you modify the +list, since you do not need to renumber it yourself. + + Numbered lists and tables begin with the appropriate @-command at the +beginning of a line, and end with the corresponding `@end' command on a +line by itself. The table and itemized-list commands also require that +you write formatting information on the same line as the beginning +@-command. + + Begin an enumerated list, for example, with an `@enumerate' command +and end the list with an `@end enumerate' command. Begin an itemized +list with an `@itemize' command, followed on the same line by a +formatting command such as `@bullet', and end the list with an `@end +itemize' command. + + Precede each element of a list with an `@item' or `@itemx' command. + + +Here is an itemized list of the different kinds of table and lists: + + * Itemized lists with and without bullets. + + * Enumerated lists, using numbers or letters. + + * Two-column tables with highlighting. + + +Here is an enumerated list with the same items: + + 1. Itemized lists with and without bullets. + + 2. Enumerated lists, using numbers or letters. + + 3. Two-column tables with highlighting. + + +And here is a two-column table with the same items and their @-commands: + +`@itemize' + Itemized lists with and without bullets. + +`@enumerate' + Enumerated lists, using numbers or letters. + +`@table' +`@ftable' +`@vtable' + Two-column tables with indexing. + + +File: texinfo.info, Node: itemize, Next: enumerate, Prev: Introducing Lists, Up: Lists and Tables + +Making an Itemized List +======================= + + The `@itemize' command produces sequences of indented paragraphs, +with a bullet or other mark inside the left margin at the beginning of +each paragraph for which such a mark is desired. + + Begin an itemized list by writing `@itemize' at the beginning of a +line. Follow the command, on the same line, with a character or a +Texinfo command that generates a mark. Usually, you will write +`@bullet' after `@itemize', but you can use `@minus', or any character +or any special symbol that results in a single character in the Info +file. (When you write `@bullet' or `@minus' after an `@itemize' +command, you may omit the `{}'.) + + Write the text of the indented paragraphs themselves after the +`@itemize', up to another line that says `@end itemize'. + + Before each paragraph for which a mark in the margin is desired, write +a line that says just `@item'. Do not write any other text on this +line. + + Usually, you should put a blank line before an `@item'. This puts a +blank line in the Info file. (TeX inserts the proper interline +whitespace in either case.) Except when the entries are very brief, +these blank lines make the list look better. + + Here is an example of the use of `@itemize', followed by the output +it produces. Note that `@bullet' produces an `*' in Info and a round +dot in TeX. + + @itemize @bullet + @item + Some text for foo. + + @item + Some text + for bar. + @end itemize + +This produces: + + * Some text for foo. + + * Some text for bar. + + Itemized lists may be embedded within other itemized lists. Here is a +list marked with dashes embedded in a list marked with bullets: + + @itemize @bullet + @item + First item. + + @itemize @minus + @item + Inner item. + + @item + Second inner item. + @end itemize + + @item + Second outer item. + @end itemize + +This produces: + + * First item. + + - Inner item. + + - Second inner item. + + * Second outer item. + + +File: texinfo.info, Node: enumerate, Next: Two-column Tables, Prev: itemize, Up: Lists and Tables + +Making a Numbered or Lettered List +================================== + + `@enumerate' is like `@itemize' (*note `@itemize': itemize.), except +that the labels on the items are successive integers or letters instead +of bullets. + + Write the `@enumerate' command at the beginning of a line. The +command does not require an argument, but accepts either a number or a +letter as an option. Without an argument, `@enumerate' starts the list +with the number `1'. With a numeric argument, such as `3', the command +starts the list with that number. With an upper or lower case letter, +such as `a' or `A', the command starts the list with that letter. + + Write the text of the enumerated list in the same way you write an +itemized list: put `@item' on a line of its own before the start of +each paragraph that you want enumerated. Do not write any other text +on the line beginning with `@item'. + + You should put a blank line between entries in the list. This +generally makes it easier to read the Info file. + + Here is an example of `@enumerate' without an argument: + + @enumerate + @item + Underlying causes. + + @item + Proximate causes. + @end enumerate + +This produces: + + 1. Underlying causes. + + 2. Proximate causes. + + + + Here is an example with an argument of `3': + + + @enumerate 3 + @item + Predisposing causes. + + @item + Precipitating causes. + + @item + Perpetuating causes. + @end enumerate + +This produces: + + 3. Predisposing causes. + + 4. Precipitating causes. + + 5. Perpetuating causes. + + + + Here is a brief summary of the alternatives. The summary is +constructed using `@enumerate' with an argument of `a'. + + + a. `@enumerate' + + Without an argument, produce a numbered list, starting with the + number 1. + + b. `@enumerate POSITIVE-INTEGER' + + With a (positive) numeric argument, start a numbered list with that + number. You can use this to continue a list that you interrupted + with other text. + + c. `@enumerate UPPER-CASE-LETTER' + + With an upper case letter as argument, start a list in which each + item is marked by a letter, beginning with that upper case letter. + + d. `@enumerate LOWER-CASE-LETTER' + + With a lower case letter as argument, start a list in which each + item is marked by a letter, beginning with that lower case letter. + + You can also nest enumerated lists, as in an outline. + + +File: texinfo.info, Node: Two-column Tables, Next: Multi-column Tables, Prev: enumerate, Up: Lists and Tables + +Making a Two-column Table +========================= + + `@table' is similar to `@itemize' (*note `@itemize': itemize.), but +allows you to specify a name or heading line for each item. The +`@table' command is used to produce two-column tables, and is +especially useful for glossaries, explanatory exhibits, and +command-line option summaries. + +* Menu: + +* table:: How to construct a two-column table. +* ftable vtable:: Automatic indexing for two-column tables. +* itemx:: How to put more entries in the first column. + + +File: texinfo.info, Node: table, Next: ftable vtable, Prev: Two-column Tables, Up: Two-column Tables + +Using the `@table' Command +-------------------------- + + Use the `@table' command to produce two-column tables. + + Write the `@table' command at the beginning of a line and follow it +on the same line with an argument that is a Texinfo "indicating" +command such as `@code', `@samp', `@var', or `@kbd' (*note +Indicating::). Although these commands are usually followed by +arguments in braces, in this case you use the command name without an +argument because `@item' will supply the argument. This command will +be applied to the text that goes into the first column of each item and +determines how it will be highlighted. For example, `@code' will cause +the text in the first column to be highlighted with an `@code' command. +(We recommend `@code' for `@table''s of command-line options.) + + You may also choose to use the `@asis' command as an argument to +`@table'. `@asis' is a command that does nothing; if you use this +command after `@table', TeX and the Info formatting commands output the +first column entries without added highlighting ("as is"). + + (The `@table' command may work with other commands besides those +listed here. However, you can only use commands that normally take +arguments in braces.) + + Begin each table entry with an `@item' command at the beginning of a +line. Write the first column text on the same line as the `@item' +command. Write the second column text on the line following the +`@item' line and on subsequent lines. (You do not need to type +anything for an empty second column entry.) You may write as many +lines of supporting text as you wish, even several paragraphs. But +only text on the same line as the `@item' will be placed in the first +column. + + Normally, you should put a blank line before an `@item' line. This +puts a blank like in the Info file. Except when the entries are very +brief, a blank line looks better. + + The following table, for example, highlights the text in the first +column with an `@samp' command: + + @table @samp + @item foo + This is the text for + @samp{foo}. + + @item bar + Text for @samp{bar}. + @end table + +This produces: + +`foo' + This is the text for `foo'. + +`bar' + Text for `bar'. + + If you want to list two or more named items with a single block of +text, use the `@itemx' command. (*Note `@itemx': itemx.) + diff --git a/info/texinfo.info-6 b/info/texinfo.info-6 index 20ec1e1..4bcdc71 100644 --- a/info/texinfo.info-6 +++ b/info/texinfo.info-6 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,361 +33,6 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: cartouche, Prev: flushleft & flushright, Up: Quotations and Examples - -Drawing Cartouches Around Examples -================================== - - In a printed manual, the `@cartouche' command draws a box with -rounded corners around its contents. You can use this command to -further highlight an example or quotation. For instance, you could -write a manual in which one type of example is surrounded by a cartouche -for emphasis. - - `@cartouche' affects only the printed manual; it has no effect in -other output files. - - For example, - - @example - @cartouche - % pwd - /usr/local/share/emacs - @end cartouche - @end example - -surrounds the two-line example with a box with rounded corners, in the -printed manual. - - -File: texinfo.info, Node: Lists and Tables, Next: Indices, Prev: Quotations and Examples, Up: Top - -Lists and Tables -**************** - - Texinfo has several ways of making lists and tables. Lists can be -bulleted or numbered; two-column tables can highlight the items in the -first column; multi-column tables are also supported. - -* Menu: - -* Introducing Lists:: Texinfo formats lists for you. -* itemize:: How to construct a simple list. -* enumerate:: How to construct a numbered list. -* Two-column Tables:: How to construct a two-column table. -* Multi-column Tables:: How to construct generalized tables. - - -File: texinfo.info, Node: Introducing Lists, Next: itemize, Prev: Lists and Tables, Up: Lists and Tables - -Introducing Lists -================= - - Texinfo automatically indents the text in lists or tables, and numbers -an enumerated list. This last feature is useful if you modify the -list, since you do not need to renumber it yourself. - - Numbered lists and tables begin with the appropriate @-command at the -beginning of a line, and end with the corresponding `@end' command on a -line by itself. The table and itemized-list commands also require that -you write formatting information on the same line as the beginning -@-command. - - Begin an enumerated list, for example, with an `@enumerate' command -and end the list with an `@end enumerate' command. Begin an itemized -list with an `@itemize' command, followed on the same line by a -formatting command such as `@bullet', and end the list with an `@end -itemize' command. - - Precede each element of a list with an `@item' or `@itemx' command. - - -Here is an itemized list of the different kinds of table and lists: - - * Itemized lists with and without bullets. - - * Enumerated lists, using numbers or letters. - - * Two-column tables with highlighting. - - -Here is an enumerated list with the same items: - - 1. Itemized lists with and without bullets. - - 2. Enumerated lists, using numbers or letters. - - 3. Two-column tables with highlighting. - - -And here is a two-column table with the same items and their @-commands: - -`@itemize' - Itemized lists with and without bullets. - -`@enumerate' - Enumerated lists, using numbers or letters. - -`@table' -`@ftable' -`@vtable' - Two-column tables, optionally with indexing. - - -File: texinfo.info, Node: itemize, Next: enumerate, Prev: Introducing Lists, Up: Lists and Tables - -`@itemize': Making an Itemized List -=================================== - - The `@itemize' command produces sequences of indented paragraphs, -with a bullet or other mark inside the left margin at the beginning of -each paragraph for which such a mark is desired. - - Begin an itemized list by writing `@itemize' at the beginning of a -line. Follow the command, on the same line, with a character or a -Texinfo command that generates a mark. Usually, you will write -`@bullet' after `@itemize', but you can use `@minus', or any command or -character that results in a single character in the Info file. If you -don't want any mark at all, use `@w'. (When you write the mark command -such as `@bullet' after an `@itemize' command, you may omit the `{}'.) -If you don't specify a mark command, the default is `@bullet'. - - Write the text of the indented paragraphs themselves after the -`@itemize', up to another line that says `@end itemize'. - - Before each paragraph for which a mark in the margin is desired, -write a line that says just `@item'. It is ok to have text following -the `@item'. - - Usually, you should put a blank line before an `@item'. This puts a -blank line in the Info file. (TeX inserts the proper interline -whitespace in either case.) Except when the entries are very brief, -these blank lines make the list look better. - - Here is an example of the use of `@itemize', followed by the output -it produces. `@bullet' produces an `*' in Info and a round dot in TeX. - - @itemize @bullet - @item - Some text for foo. - - @item - Some text - for bar. - @end itemize - -This produces: - - * Some text for foo. - - * Some text for bar. - - Itemized lists may be embedded within other itemized lists. Here is a -list marked with dashes embedded in a list marked with bullets: - - @itemize @bullet - @item - First item. - - @itemize @minus - @item - Inner item. - - @item - Second inner item. - @end itemize - - @item - Second outer item. - @end itemize - -This produces: - - * First item. - - - Inner item. - - - Second inner item. - - * Second outer item. - - -File: texinfo.info, Node: enumerate, Next: Two-column Tables, Prev: itemize, Up: Lists and Tables - -`@enumerate': Making a Numbered or Lettered List -================================================ - - `@enumerate' is like `@itemize' (*note `@itemize': itemize.), except -that the labels on the items are successive integers or letters instead -of bullets. - - Write the `@enumerate' command at the beginning of a line. The -command does not require an argument, but accepts either a number or a -letter as an option. Without an argument, `@enumerate' starts the list -with the number `1'. With a numeric argument, such as `3', the command -starts the list with that number. With an upper or lower case letter, -such as `a' or `A', the command starts the list with that letter. - - Write the text of the enumerated list in the same way you write an -itemized list: put `@item' on a line of its own before the start of -each paragraph that you want enumerated. Do not write any other text -on the line beginning with `@item'. - - You should put a blank line between entries in the list. This -generally makes it easier to read the Info file. - - Here is an example of `@enumerate' without an argument: - - @enumerate - @item - Underlying causes. - - @item - Proximate causes. - @end enumerate - -This produces: - - 1. Underlying causes. - - 2. Proximate causes. - - - - Here is an example with an argument of `3': - - - @enumerate 3 - @item - Predisposing causes. - - @item - Precipitating causes. - - @item - Perpetuating causes. - @end enumerate - -This produces: - - 3. Predisposing causes. - - 4. Precipitating causes. - - 5. Perpetuating causes. - - - - Here is a brief summary of the alternatives. The summary is -constructed using `@enumerate' with an argument of `a'. - - - a. `@enumerate' - - Without an argument, produce a numbered list, starting with the - number 1. - - b. `@enumerate POSITIVE-INTEGER' - - With a (positive) numeric argument, start a numbered list with that - number. You can use this to continue a list that you interrupted - with other text. - - c. `@enumerate UPPER-CASE-LETTER' - - With an upper case letter as argument, start a list in which each - item is marked by a letter, beginning with that upper case letter. - - d. `@enumerate LOWER-CASE-LETTER' - - With a lower case letter as argument, start a list in which each - item is marked by a letter, beginning with that lower case letter. - - You can also nest enumerated lists, as in an outline. - - -File: texinfo.info, Node: Two-column Tables, Next: Multi-column Tables, Prev: enumerate, Up: Lists and Tables - -Making a Two-column Table -========================= - - `@table' is similar to `@itemize' (*note `@itemize': itemize.), but -allows you to specify a name or heading line for each item. The -`@table' command is used to produce two-column tables, and is -especially useful for glossaries, explanatory exhibits, and -command-line option summaries. - -* Menu: - -* table:: How to construct a two-column table. -* ftable vtable:: Automatic indexing for two-column tables. -* itemx:: How to put more entries in the first column. - - -File: texinfo.info, Node: table, Next: ftable vtable, Prev: Two-column Tables, Up: Two-column Tables - -Using the `@table' Command --------------------------- - - Use the `@table' command to produce two-column tables. - - Write the `@table' command at the beginning of a line and follow it -on the same line with an argument that is a Texinfo "indicating" -command such as `@code', `@samp', `@var', or `@kbd' (*note -Indicating::). Although these commands are usually followed by -arguments in braces, in this case you use the command name without an -argument because `@item' will supply the argument. This command will -be applied to the text that goes into the first column of each item and -determines how it will be highlighted. For example, `@code' will cause -the text in the first column to be highlighted with an `@code' command. -(We recommend `@code' for `@table''s of command-line options.) - - You may also choose to use the `@asis' command as an argument to -`@table'. `@asis' is a command that does nothing; if you use this -command after `@table', TeX and the Info formatting commands output the -first column entries without added highlighting ("as is"). - - (The `@table' command may work with other commands besides those -listed here. However, you can only use commands that normally take -arguments in braces.) - - Begin each table entry with an `@item' command at the beginning of a -line. Write the first column text on the same line as the `@item' -command. Write the second column text on the line following the -`@item' line and on subsequent lines. (You do not need to type -anything for an empty second column entry.) You may write as many -lines of supporting text as you wish, even several paragraphs. But -only text on the same line as the `@item' will be placed in the first -column, including any footnote. - - Normally, you should put a blank line before an `@item' line. This -puts a blank like in the Info file. Except when the entries are very -brief, a blank line looks better. - - The following table, for example, highlights the text in the first -column with an `@samp' command: - - @table @samp - @item foo - This is the text for - @samp{foo}. - - @item bar - Text for @samp{bar}. - @end table - -This produces: - -`foo' - This is the text for `foo'. - -`bar' - Text for `bar'. - - If you want to list two or more named items with a single block of -text, use the `@itemx' command. (*Note `@itemx': itemx.) - - File: texinfo.info, Node: ftable vtable, Next: itemx, Prev: table, Up: Two-column Tables `@ftable' and `@vtable' @@ -400,7 +45,8 @@ automatically enters each of the items in the first column of the table into the index of variables. This simplifies the task of creating indices. Only the items on the same line as the `@item' commands are indexed, and they are indexed in exactly the form that they appear on -that line. *Note Indices::, for more information about indices. +that line. *Note Creating Indices: Indices, for more information about +indices. Begin a two-column table using `@ftable' or `@vtable' by writing the @-command at the beginning of a line, followed on the same line by an @@ -464,7 +110,7 @@ completes the table. Details in the sections below. * Multitable Rows:: Defining multitable rows, with examples.  -File: texinfo.info, Node: Multitable Column Widths, Next: Multitable Rows, Up: Multi-column Tables +File: texinfo.info, Node: Multitable Column Widths, Next: Multitable Rows, Prev: Multi-column Tables, Up: Multi-column Tables Multitable Column Widths ------------------------ @@ -482,7 +128,7 @@ entirely on the same line as the `@multitable' command. The fractions need not add up exactly to 1.0, as these do not. This allows you to produce tables that do not need the full line - length. You can use a leading zero if you wish. + length. 2. To specify a prototype row, write the longest entry for each column enclosed in braces after the `@multitable' command. For example: @@ -513,7 +159,7 @@ not special within the table body, and you may break input lines in your source file as necessary. Here is a complete example of a multi-column table (the text is from -`The GNU Emacs Manual', *note Splitting Windows: (emacs)Split Window.): +`The GNU Emacs Manual', *note Splitting Windows: (xemacs)Split Window.): @multitable @columnfractions .15 .45 .4 @item Key @tab Command @tab Description @@ -547,8 +193,8 @@ C-Mouse-2 In the mode line or scroll  File: texinfo.info, Node: Indices, Next: Insertions, Prev: Lists and Tables, Up: Top -Indices -******* +Creating Indices +**************** Using Texinfo, you can generate indices without having to sort and collate entries manually. In an index, the entries are listed in @@ -699,9 +345,21 @@ emphasis (*note Marking Text::). Make an entry in the data type index for DATA TYPE. *Caution:* Do not use a colon in an index entry. In Info, a colon - separates the menu entry name from the node name, so a colon in - the entry itself confuses Info. *Note The Parts of a Menu: Menu - Parts, for more information about the structure of a menu entry. + separates the menu entry name from the node name. An extra colon + confuses Info. *Note The Parts of a Menu: Menu Parts, for more + information about the structure of a menu entry. + + If you write several identical index entries in different places in a +Texinfo file, the index in the printed manual will list all the pages to +which those entries refer. However, the index in the Info file will +list *only* the node that references the *first* of those index +entries. Therefore, it is best to write indices in which each entry +refers to only one place in the Texinfo file. Fortunately, this +constraint is a feature rather than a loss since it means that the index +will be easy to use. Otherwise, you could create an index that lists +several pages for one entry and your reader would not know to which page +to turn. If you have two identical entries for one topic, change the +topics slightly, or qualify them to indicate the difference. You are not actually required to use the predefined indices for their canonical purposes. For example, suppose you wish to index some C @@ -893,7 +551,6 @@ elements that do not correspond to simple characters you can type. * math:: How to format a mathematical expression. * Glyphs:: How to indicate results of evaluation, expansion of macros, errors, etc. -* Footnotes:: How to include footnotes. * Images:: How to include graphics.  @@ -952,20 +609,20 @@ various kinds within and after sentences. * dmn:: How to format a dimension.  -File: texinfo.info, Node: Not Ending a Sentence, Next: Ending a Sentence, Up: Inserting Space +File: texinfo.info, Node: Not Ending a Sentence, Next: Ending a Sentence, Prev: Inserting Space, Up: Inserting Space Not Ending a Sentence --------------------- Depending on whether a period or exclamation point or question mark is inside or at the end of a sentence, less or more space is inserted after -a period in a typeset manual. Since it is not always possible to -determine when a period ends a sentence and when it is used in an -abbreviation, special commands are needed in some circumstances. -Usually, Texinfo can guess how to handle periods, so you do not need to +a period in a typeset manual. Since it is not always possible for +Texinfo to determine when a period ends a sentence and when it is used +in an abbreviation, special commands are needed in some circumstances. +(Usually, Texinfo can guess how to handle periods, so you do not need to use the special commands; you just enter a period as you would if you were using a typewriter, which means you put two spaces after the -period, question mark, or exclamation mark that ends a sentence. +period, question mark, or exclamation mark that ends a sentence.) Use the `@:' command after a period, question mark, exclamation mark, or colon that should not be followed by extra space. For example, use @@ -1012,7 +669,8 @@ for `@!' and `@?'. The meanings of `@:' and `@.' in Texinfo are designed to work well with the Emacs sentence motion commands (*note Sentences: -(emacs)Sentences.). +(xemacs)Sentences.). This made it necessary for them to be +incompatible with some other formatting systems that use @-commands. Do not put braces after any of these commands. @@ -1079,7 +737,7 @@ however, the formatters may insert a line break between the number and the dimension, so use `@w' (*note w::). Also, if you write a period after an abbreviation within a sentence, you should write `@:' after the period to prevent TeX from inserting extra whitespace, as shown -here. *Note Not Ending a Sentence::. +here. *Note Inserting Space::.  File: texinfo.info, Node: Inserting Accents, Next: Dots Bullets, Prev: Inserting Space, Up: Insertions @@ -1114,22 +772,22 @@ Command Output What This table lists the Texinfo commands for inserting other characters commonly used in languages other than English. -@exclamdown{} ! upside-down ! -@questiondown{} ? upside-down ? -@aa{},@AA{} aa,AA a,A with circle -@ae{},@AE{} ae,AE ae,AE ligatures -@dotless{i} i dotless i -@dotless{j} j dotless j -@l{},@L{} /l,/L suppressed-L,l -@o{},@O{} /o,/O O,o with slash -@oe{},@OE{} oe,OE oe,OE ligatures -@ss{} ss es-zet or sharp S +@exclamdown{} ! upside-down ! +@questiondown{} ? upside-down ? +@aa{},@AA{} aa,AA A,a with circle +@ae{},@AE{} ae,AE ae,AE ligatures +@dotless{i} i dotless i +@dotless{j} j dotless j +@l{},@L{} /l,/L suppressed-L,l +@o{},@O{} /o,/O O,o with slash +@oe{},@OE{} oe,OE OE,oe ligatures +@ss{} ss es-zet or sharp S  File: texinfo.info, Node: Dots Bullets, Next: TeX and copyright, Prev: Inserting Accents, Up: Insertions -Inserting Ellipsis and Bullets -============================== +Inserting Ellipsis, Dots, and Bullets +===================================== An "ellipsis" (a line of dots) is not typeset as a string of periods, so a special command is used for ellipsis in Texinfo. The `@bullet' @@ -1146,10 +804,10 @@ information.) * bullet:: How to insert a bullet.  -File: texinfo.info, Node: dots, Next: bullet, Up: Dots Bullets +File: texinfo.info, Node: dots, Next: bullet, Prev: Dots Bullets, Up: Dots Bullets -`@dots'{} (...) and `@enddots'{} (....) ---------------------------------------- +`@dots'{} (...) +--------------- Use the `@dots{}' command to generate an ellipsis, which is three dots in a row, appropriately spaced, like this: `...'. Do not simply @@ -1191,7 +849,7 @@ whitespace between the name of the command and the braces. * copyright symbol:: How to use `@copyright'{}.  -File: texinfo.info, Node: tex, Next: copyright symbol, Up: TeX and copyright +File: texinfo.info, Node: tex, Next: copyright symbol, Prev: TeX and copyright, Up: TeX and copyright `@TeX'{} (TeX) -------------- @@ -1213,7 +871,7 @@ manual, this is a `c' inside a circle, and in Info, this is `(C)'.  File: texinfo.info, Node: pounds, Next: minus, Prev: TeX and copyright, Up: Insertions -`@pounds'{} (#): Pounds Sterling +`@pounds{}' (#): Pounds Sterling ================================ Use the `@pounds{}' command to generate `#'. In a printed manual, @@ -1250,8 +908,8 @@ itemize..)  File: texinfo.info, Node: math, Next: Glyphs, Prev: minus, Up: Insertions -`@math': Inserting Mathematical Expressions -=========================================== +`@math' - Inserting Mathematical Expressions +============================================ You can write a short mathematical expression with the `@math' command. Write the mathematical expression between braces, like this: @@ -1270,7 +928,7 @@ to write the mathematical expression between one or two `$' (dollar-signs) as appropriate.  -File: texinfo.info, Node: Glyphs, Next: Footnotes, Prev: math, Up: Insertions +File: texinfo.info, Node: Glyphs, Next: Images, Prev: math, Up: Insertions Glyphs for Examples =================== @@ -1470,3 +1128,296 @@ produces This indicates that evaluating `(make-sparse-keymap)' produces identical results to evaluating `(list 'keymap)'. + +File: texinfo.info, Node: Point Glyph, Prev: Equivalence, Up: Glyphs + +`@point{}' (-!-): Indicating Point in a Buffer +---------------------------------------------- + + Sometimes you need to show an example of text in an Emacs buffer. In +such examples, the convention is to include the entire contents of the +buffer in question between two lines of dashes containing the buffer +name. + + You can use the `@point{}' command to show the location of point in +the text in the buffer. (The symbol for point, of course, is not part +of the text in the buffer; it indicates the place _between_ two +characters where point is located.) + + The `@point{}' command is displayed as `-!-' in Info and as a small +five pointed star in the printed output. + + The following example shows the contents of buffer `foo' before and +after evaluating a Lisp command to insert the word `changed'. + + ---------- Buffer: foo ---------- + This is the -!-contents of foo. + ---------- Buffer: foo ---------- + + (insert "changed ") + => nil + ---------- Buffer: foo ---------- + This is the changed -!-contents of foo. + ---------- Buffer: foo ---------- + + In a Texinfo source file, the example is written like this: + + @example + ---------- Buffer: foo ---------- + This is the @point{}contents of foo. + ---------- Buffer: foo ---------- + + (insert "changed ") + @result{} nil + ---------- Buffer: foo ---------- + This is the changed @point{}contents of foo. + ---------- Buffer: foo ---------- + @end example + + +File: texinfo.info, Node: Images, Prev: Glyphs, Up: Insertions + +Inserting Images +================ + + You can insert an image in an external file with the `@image' command: + + @image{FILENAME, [WIDTH], [HEIGHT]} + + The FILENAME argument is mandatory, and must not have an extension, +because the different processors support different formats: TeX reads +the file `FILENAME.eps' (Encapsulated PostScript format); `makeinfo' +uses `FILENAME.txt' verbatim for Info output (more or less as if it was +an `@example'). HTML output requires `FILENAME.jpg'. + + The optional WIDTH and HEIGHT arguments specify the size to scale the +image to (they are ignored for Info output). If they are both +specified, the image is presented in its natural size (given in the +file); if only one is specified, the other is scaled proportionately; +and if both are specified, both are respected, thus possibly distorting +the original image by changing its aspect ratio. + + The WIDTH and HEIGHT may be specified using any valid TeX dimension, +namely: + +pt + point (72.27pt = 1in) + +pc + pica (1pc = 12pt) + +bp + big point (72bp = 1in) + +in + inch + +cm + centimeter (2.54cm = 1in) + +mm + millimeter (10mm = 1cm) + +dd + dido^t point (1157dd = 1238pt) + +cc + cicero (1cc = 12dd) + +sp + scaled point (65536sp = 1pt) + + For example, the following will scale a file `ridt.eps' to one inch +vertically, with the width scaled proportionately: + + @image{ridt,,1in} + + For `@image' to work with TeX, the file `epsf.tex' must be installed +somewhere that TeX can find it. This file is included in the Texinfo +distribution and is available from `ftp://ftp.tug.org/tex/epsf.tex'. + + +File: texinfo.info, Node: Breaks, Next: Definition Commands, Prev: Insertions, Up: Top + +Making and Preventing Breaks +**************************** + + Usually, a Texinfo file is processed both by TeX and by one of the +Info formatting commands. Line, paragraph, or page breaks sometimes +occur in the `wrong' place in one or other form of output. You must +ensure that text looks right both in the printed manual and in the Info +file. + + For example, in a printed manual, page breaks may occur awkwardly in +the middle of an example; to prevent this, you can hold text together +using a grouping command that keeps the text from being split across +two pages. Conversely, you may want to force a page break where none +would occur normally. Fortunately, problems like these do not often +arise. When they do, use the break, break prevention, or pagination +commands. + +* Menu: + +* Break Commands:: Cause and prevent splits. +* Line Breaks:: How to force a single line to use two lines. +* - and hyphenation:: How to tell TeX about hyphenation points. +* w:: How to prevent unwanted line breaks. +* sp:: How to insert blank lines. +* page:: How to force the start of a new page. +* group:: How to prevent unwanted page breaks. +* need:: Another way to prevent unwanted page breaks. + + +File: texinfo.info, Node: Break Commands, Next: Line Breaks, Prev: Breaks, Up: Breaks + +The Break Commands +================== + + The break commands create or allow line and paragraph breaks: + +`@*' + Force a line break. + +`@sp N' + Skip N blank lines. + +`@-' + Insert a discretionary hyphen. + +`@hyphenation{HY-PHEN-A-TED WORDS}' + Define hyphen points in HY-PHEN-A-TED WORDS. + + The line-break-prevention command holds text together all on one line: + +`@w{TEXT}' + Prevent TEXT from being split and hyphenated across two lines. + + The pagination commands apply only to printed output, since Info +files do not have pages. + +`@page' + Start a new page in the printed manual. + +`@group' + Hold text together that must appear on one printed page. + +`@need MILS' + Start a new printed page if not enough space on this one. + + +File: texinfo.info, Node: Line Breaks, Next: - and hyphenation, Prev: Break Commands, Up: Breaks + +`@*': Generate Line Breaks +========================== + + The `@*' command forces a line break in both the printed manual and +in Info. + + For example, + + This line @* is broken @*in two places. + +produces + + This line + is broken + in two places. + +(Note that the space after the first `@*' command is faithfully carried +down to the next line.) + + The `@*' command is often used in a file's copyright page: + + This is edition 2.0 of the Texinfo documentation,@* + and is for ... + +In this case, the `@*' command keeps TeX from stretching the line +across the whole page in an ugly manner. + + *Please note:* Do not write braces after an `@*' command; they are + not needed. + + Do not write an `@refill' command at the end of a paragraph + containing an `@*' command; it will cause the paragraph to be + refilled after the line break occurs, negating the effect of the + line break. + + +File: texinfo.info, Node: - and hyphenation, Next: w, Prev: Line Breaks, Up: Breaks + +`@-' and `@hyphenation': Helping TeX hyphenate +============================================== + + Although TeX's hyphenation algorithm is generally pretty good, it +does miss useful hyphenation points from time to time. (Or, far more +rarely, insert an incorrect hyphenation.) So, for documents with an +unusual vocabulary or when fine-tuning for a printed edition, you may +wish to help TeX out. Texinfo supports two commands for this: + +`@-' + Insert a discretionary hyphen, i.e., a place where TeX can (but + does not have to) hyphenate. This is especially useful when you + notice an overfull hbox is due to TeX missing a hyphenation (*note + Overfull hboxes::). TeX will not insert any hyphenation points in + a word containing `@-'. + +`@hyphenation{HY-PHEN-A-TED WORDS}' + Tell TeX how to hyphenate HY-PHEN-A-TED WORDS. As shown, you put + a `-' at each hyphenation point. For example: + @hyphenation{man-u-script man-u-scripts} + + TeX only uses the specified hyphenation points when the words + match exactly, so give all necessary variants. + + Info output is not hyphenated, so these commands have no effect there. + + +File: texinfo.info, Node: w, Next: sp, Prev: - and hyphenation, Up: Breaks + +`@w'{TEXT}: Prevent Line Breaks +=============================== + + `@w{TEXT}' outputs TEXT and prohibits line breaks within TEXT. + + You can use the `@w' command to prevent TeX from automatically +hyphenating a long name or phrase that happens to fall near the end of a +line. + + You can copy GNU software from @w{@samp{ftp.gnu.ai.mit.edu}}. + +produces + + You can copy GNU software from `ftp.gnu.ai.mit.edu'. + + *Caution:* Do not write an `@refill' command at the end of a + paragraph containing an `@w' command; it will cause the paragraph + to be refilled and may thereby negate the effect of the `@w' + command. + + +File: texinfo.info, Node: sp, Next: page, Prev: w, Up: Breaks + +`@sp' N: Insert Blank Lines +=========================== + + A line beginning with and containing only `@sp N' generates N blank +lines of space in both the printed manual and the Info file. `@sp' +also forces a paragraph break. For example, + + @sp 2 + +generates two blank lines. + + The `@sp' command is most often used in the title page. + + +File: texinfo.info, Node: page, Next: group, Prev: sp, Up: Breaks + +`@page': Start a New Page +========================= + + A line containing only `@page' starts a new page in a printed manual. +The command has no effect on Info files since they are not paginated. +An `@page' command is often used in the `@titlepage' section of a +Texinfo file to start the copyright page. + diff --git a/info/texinfo.info-7 b/info/texinfo.info-7 index 1e55bb3..10a127a 100644 --- a/info/texinfo.info-7 +++ b/info/texinfo.info-7 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,448 +33,6 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: Point Glyph, Prev: Equivalence, Up: Glyphs Summary - -`@point{}' (-!-): Indicating Point in a Buffer ----------------------------------------------- - - Sometimes you need to show an example of text in an Emacs buffer. In -such examples, the convention is to include the entire contents of the -buffer in question between two lines of dashes containing the buffer -name. - - You can use the `@point{}' command to show the location of point in -the text in the buffer. (The symbol for point, of course, is not part -of the text in the buffer; it indicates the place _between_ two -characters where point is located.) - - The `@point{}' command is displayed as `-!-' in Info and as a small -five pointed star in the printed output. - - The following example shows the contents of buffer `foo' before and -after evaluating a Lisp command to insert the word `changed'. - - ---------- Buffer: foo ---------- - This is the -!-contents of foo. - ---------- Buffer: foo ---------- - - (insert "changed ") - => nil - ---------- Buffer: foo ---------- - This is the changed -!-contents of foo. - ---------- Buffer: foo ---------- - - In a Texinfo source file, the example is written like this: - - @example - ---------- Buffer: foo ---------- - This is the @point{}contents of foo. - ---------- Buffer: foo ---------- - - (insert "changed ") - @result{} nil - ---------- Buffer: foo ---------- - This is the changed @point{}contents of foo. - ---------- Buffer: foo ---------- - @end example - - -File: texinfo.info, Node: Footnotes, Next: Images, Prev: Glyphs, Up: Insertions - -Footnotes -========= - - A "footnote" is for a reference that documents or elucidates the -primary text.(1) (*note Footnotes-Footnote-1::) - -* Menu: - -* Footnote Commands:: How to write a footnote in Texinfo. -* Footnote Styles:: Controlling how footnotes appear in Info. - - -File: texinfo.info, Node: Footnotes-Footnotes, Up: Footnotes - - (1) A footnote should complement or expand upon the primary text, but -a reader should not need to read a footnote to understand the primary -text. For a thorough discussion of footnotes, see `The Chicago Manual -of Style', which is published by the University of Chicago Press. - - -File: texinfo.info, Node: Footnote Commands, Next: Footnote Styles, Up: Footnotes - -Footnote Commands ------------------ - - In Texinfo, footnotes are created with the `@footnote' command. This -command is followed immediately by a left brace, then by the text of -the footnote, and then by a terminating right brace. Footnotes may be -of any length (they will be broken across pages if necessary), but are -usually short. The template is: - - ordinary text@footnote{TEXT OF FOOTNOTE} - - As shown here, the `@footnote' command should come right after the -text being footnoted, with no intervening space; otherwise, the footnote -marker might end up starting a line. - - For example, this clause is followed by a sample footnote(1) (*note -Footnote Commands-Footnote-1::); in the Texinfo source, it looks like -this: - - ...a sample footnote@footnote{Here is the sample - footnote.}; in the Texinfo source... - - In a printed manual or book, the reference mark for a footnote is a -small, superscripted number; the text of the footnote appears at the -bottom of the page, below a horizontal line. - - In Info, the reference mark for a footnote is a pair of parentheses -with the footnote number between them, like this: `(1)'. The reference -mark is followed by a cross-reference link to the footnote's text. - - In the HTML output, footnote references are marked with a small, -superscripted number which is rendered as a hypertext link to the -footnote text. - - By the way, footnotes in the argument of an `@item' command for a -`@table' must be on the same line as the `@item' (as usual). *Note -Two-column Tables::. - - -File: texinfo.info, Node: Footnote Commands-Footnotes, Up: Footnote Commands - - (1) Here is the sample footnote. - - -File: texinfo.info, Node: Footnote Styles, Prev: Footnote Commands, Up: Footnotes - -Footnote Styles ---------------- - - Info has two footnote styles, which determine where the text of the -footnote is located: - - * In the `End' node style, all the footnotes for a single node are - placed at the end of that node. The footnotes are separated from - the rest of the node by a line of dashes with the word `Footnotes' - within it. Each footnote begins with an `(N)' reference mark. - - Here is an example of a single footnote in the end of node style: - - --------- Footnotes --------- - - (1) Here is a sample footnote. - - * In the `Separate' node style, all the footnotes for a single node - are placed in an automatically constructed node of their own. In - this style, a "footnote reference" follows each `(N)' reference - mark in the body of the node. The footnote reference is actually - a cross reference which you use to reach the footnote node. - - The name of the node with the footnotes is constructed by - appending `-Footnotes' to the name of the node that contains the - footnotes. (Consequently, the footnotes' node for the `Footnotes' - node is `Footnotes-Footnotes'!) The footnotes' node has an `Up' - node pointer that leads back to its parent node. - - Here is how the first footnote in this manual looks after being - formatted for Info in the separate node style: - - File: texinfo.info Node: Overview-Footnotes, Up: Overview - - (1) The first syllable of "Texinfo" is pronounced like "speck", not - "hex". ... - - A Texinfo file may be formatted into an Info file with either footnote -style. - - Use the `@footnotestyle' command to specify an Info file's footnote -style. Write this command at the beginning of a line followed by an -argument, either `end' for the end node style or `separate' for the -separate node style. - - For example, - - @footnotestyle end - -or - @footnotestyle separate - - Write an `@footnotestyle' command before or shortly after the -end-of-header line at the beginning of a Texinfo file. (If you include -the `@footnotestyle' command between the start-of-header and -end-of-header lines, the region formatting commands will format -footnotes as specified.) - - If you do not specify a footnote style, the formatting commands use -their default style. Currently, `texinfo-format-buffer' and -`texinfo-format-region' use the `separate' style and `makeinfo' uses -the `end' style. - - This chapter contains two footnotes. - - -File: texinfo.info, Node: Images, Prev: Footnotes, Up: Insertions - -Inserting Images -================ - - You can insert an image given in an external file with the `@image' -command: - - @image{FILENAME, [WIDTH], [HEIGHT]} - - The FILENAME argument is mandatory, and must not have an extension, -because the different processors support different formats: - * TeX reads the file `FILENAME.eps' (Encapsulated PostScript format). - - * PDFTeX reads `FILENAME.pdf' (Adobe's Portable Document Format). - - * `makeinfo' uses `FILENAME.txt' verbatim for Info output (more or - less as if it was an `@example'). - - * `makeinfo' producing HTML output tries `FILENAME.png'; if that - does not exist, it tries `FILENAME.jpg'. If that does not exist - either, it complains. (We cannot support GIF format due to - patents.) - - The optional WIDTH and HEIGHT arguments specify the size to scale the -image to (they are ignored for Info output). If neither is specified, -the image is presented in its natural size (given in the file); if only -one is specified, the other is scaled proportionately; and if both are -specified, both are respected, thus possibly distorting the original -image by changing its aspect ratio. - - The WIDTH and HEIGHT may be specified using any valid TeX dimension, -namely: - -pt - point (72.27pt = 1in) - -pc - pica (1pc = 12pt) - -bp - big point (72bp = 1in) - -in - inch - -cm - centimeter (2.54cm = 1in) - -mm - millimeter (10mm = 1cm) - -dd - dido^t point (1157dd = 1238pt) - -cc - cicero (1cc = 12dd) - -sp - scaled point (65536sp = 1pt) - - For example, the following will scale a file `ridt.eps' to one inch -vertically, with the width scaled proportionately: - - @image{ridt,,1in} - - For `@image' to work with TeX, the file `epsf.tex' must be installed -somewhere that TeX can find it. (The standard location is -`TEXMF/tex/generic/dvips/epsf.tex', where TEXMF is a root of your TeX -directory tree.) This file is included in the Texinfo distribution and -is available from `ftp://tug.org/tex/epsf.tex'. - - `@image' can be used within a line as well as for displayed figures. -Therefore, if you intend it to be displayed, be sure to leave a blank -line before the command, or the output will run into the preceding text. - - -File: texinfo.info, Node: Breaks, Next: Definition Commands, Prev: Insertions, Up: Top - -Making and Preventing Breaks -**************************** - - Usually, a Texinfo file is processed both by TeX and by one of the -Info formatting commands. Line, paragraph, or page breaks sometimes -occur in the `wrong' place in one or other form of output. You must -ensure that text looks right both in the printed manual and in the Info -file. - - For example, in a printed manual, page breaks may occur awkwardly in -the middle of an example; to prevent this, you can hold text together -using a grouping command that keeps the text from being split across -two pages. Conversely, you may want to force a page break where none -would occur normally. Fortunately, problems like these do not often -arise. When they do, use the break, break prevention, or pagination -commands. - -* Menu: - -* Break Commands:: Cause and prevent splits. -* Line Breaks:: How to force a single line to use two lines. -* - and hyphenation:: How to tell TeX about hyphenation points. -* w:: How to prevent unwanted line breaks. -* sp:: How to insert blank lines. -* page:: How to force the start of a new page. -* group:: How to prevent unwanted page breaks. -* need:: Another way to prevent unwanted page breaks. - - -File: texinfo.info, Node: Break Commands, Next: Line Breaks, Prev: Breaks, Up: Breaks - -Break Commands -============== - - The break commands create or allow line and paragraph breaks: - -`@*' - Force a line break. - -`@sp N' - Skip N blank lines. - -`@-' - Insert a discretionary hyphen. - -`@hyphenation{HY-PHEN-A-TED WORDS}' - Define hyphen points in HY-PHEN-A-TED WORDS. - - The line-break-prevention command holds text together all on one line: - -`@w{TEXT}' - Prevent TEXT from being split and hyphenated across two lines. - - The pagination commands apply only to printed output, since Info -files do not have pages. - -`@page' - Start a new page in the printed manual. - -`@group' - Hold text together that must appear on one printed page. - -`@need MILS' - Start a new printed page if not enough space on this one. - - -File: texinfo.info, Node: Line Breaks, Next: - and hyphenation, Prev: Break Commands, Up: Breaks - -`@*': Generate Line Breaks -========================== - - The `@*' command forces a line break in both the printed manual and -in Info. - - For example, - - This line @* is broken @*in two places. - -produces - - This line - is broken - in two places. - -(Note that the space after the first `@*' command is faithfully carried -down to the next line.) - - The `@*' command is often used in a file's copyright page: - - This is edition 2.0 of the Texinfo documentation,@* - and is for ... - -In this case, the `@*' command keeps TeX from stretching the line -across the whole page in an ugly manner. - - *Please note:* Do not write braces after an `@*' command; they are - not needed. - - Do not write an `@refill' command at the end of a paragraph - containing an `@*' command; it will cause the paragraph to be - refilled after the line break occurs, negating the effect of the - line break. - - -File: texinfo.info, Node: - and hyphenation, Next: w, Prev: Line Breaks, Up: Breaks - -`@-' and `@hyphenation': Helping TeX hyphenate -============================================== - - Although TeX's hyphenation algorithm is generally pretty good, it -does miss useful hyphenation points from time to time. (Or, far more -rarely, insert an incorrect hyphenation.) So, for documents with an -unusual vocabulary or when fine-tuning for a printed edition, you may -wish to help TeX out. Texinfo supports two commands for this: - -`@-' - Insert a discretionary hyphen, i.e., a place where TeX can (but - does not have to) hyphenate. This is especially useful when you - notice an overfull hbox is due to TeX missing a hyphenation (*note - Overfull hboxes::). TeX will not insert any hyphenation points in - a word containing `@-'. - -`@hyphenation{HY-PHEN-A-TED WORDS}' - Tell TeX how to hyphenate HY-PHEN-A-TED WORDS. As shown, you put - a `-' at each hyphenation point. For example: - @hyphenation{man-u-script man-u-scripts} - TeX only uses the specified hyphenation points when the words - match exactly, so give all necessary variants. - - Info output is not hyphenated, so these commands have no effect there. - - -File: texinfo.info, Node: w, Next: sp, Prev: - and hyphenation, Up: Breaks - -`@w'{TEXT}: Prevent Line Breaks -=============================== - - `@w{TEXT}' outputs TEXT and prohibits line breaks within TEXT. - - You can use the `@w' command to prevent TeX from automatically -hyphenating a long name or phrase that happens to fall near the end of a -line. For example: - - You can copy GNU software from @w{@samp{ftp.gnu.org}}. - -produces - - You can copy GNU software from `ftp.gnu.org'. - - You can also use `@w' to produce a non-breakable space: - - None of the formatters will break at this@w{ }space. - - -File: texinfo.info, Node: sp, Next: page, Prev: w, Up: Breaks - -`@sp' N: Insert Blank Lines -=========================== - - A line beginning with and containing only `@sp N' generates N blank -lines of space in both the printed manual and the Info file. `@sp' -also forces a paragraph break. For example, - - @sp 2 - -generates two blank lines. - - The `@sp' command is most often used in the title page. - - -File: texinfo.info, Node: page, Next: group, Prev: sp, Up: Breaks - -`@page': Start a New Page -========================= - - A line containing only `@page' starts a new page in a printed manual. -The command has no effect on Info files since they are not paginated. -An `@page' command is often used in the `@titlepage' section of a -Texinfo file to start the copyright page. - - File: texinfo.info, Node: group, Next: need, Prev: page, Up: Breaks `@group': Prevent Page Breaks @@ -539,7 +97,7 @@ the page. It looks like this: the bottoms of printed pages).  -File: texinfo.info, Node: Definition Commands, Next: Conditionals, Prev: Breaks, Up: Top +File: texinfo.info, Node: Definition Commands, Next: Footnotes, Prev: Breaks, Up: Top Definition Commands ******************* @@ -719,8 +277,8 @@ produces - Interactive Command: isearch-backward These two search commands are similar except ... - Each definition command has an `x' form: `@defunx', `@defvrx', -`@deftypefunx', etc. + Each of the other definition commands has an `x' form: `@defunx', +`@defvrx', `@deftypefunx', etc. The `x' forms work just like `@itemx'; see *Note `@itemx': itemx. @@ -825,7 +383,7 @@ similar entities: `@defspec NAME ARGUMENTS...' The `@defspec' command is the definition command for special forms. (In Lisp, a special form is an entity much like a function, - *note Special Forms: (elisp)Special Forms..) `@defspec' is + *note Special Forms: (lispref)Special Forms..) `@defspec' is equivalent to `@deffn {Special Form} ...' and works like `@defun'.  @@ -841,7 +399,7 @@ Variables and Similar Entities like a variable--an entity that records a value. You must choose a term to describe the category of entity being defined; for example, "Variable" could be used if the entity is a variable. - Write the `@defvr' command at the beginning of a line and follow + Write the `@defvr' command at the beginning of a line and followed it on the same line by the category of the entity and the name of the entity. @@ -887,7 +445,7 @@ Variables and Similar Entities `@defopt NAME' The `@defopt' command is the definition command for "user options", i.e., variables intended for users to change according to - taste; Emacs has many such (*note Variables: (emacs)Variables.). + taste; Emacs has many such (*note Variables: (xemacs)Variables.). `@defopt' is equivalent to `@defvr {User Option} ...' and works like `@defvar'. @@ -1086,7 +644,8 @@ it. Otherwise, it is printed in the usual text font. illustrates how you would write the first line of a definition of the `border-pattern' class option of the class `Window'. - The template is: + The template is + @defcv CATEGORY CLASS NAME ... @end defcv @@ -1099,19 +658,13 @@ it. Otherwise, it is printed in the usual text font. equivalent to `@defcv {Instance Variable} ...' The template is: + @defivar CLASS INSTANCE-VARIABLE-NAME BODY-OF-DEFINITION @end defivar `@defivar' creates an entry in the index of variables. -`@deftypeivar CLASS DATA-TYPE NAME' - The `@deftypeivar' command is the definition command for typed - instance variables in object-oriented programming. It is similar - to `@defivar' with the addition of the DATA-TYPE parameter to - specify the type of the instance variable. `@deftypeivar' creates - an entry in the index of variables. - `@defop CATEGORY CLASS NAME ARGUMENTS...' The `@defop' command is the general definition command for entities that may resemble methods in object-oriented programming. @@ -1147,6 +700,7 @@ it. Otherwise, it is printed in the usual text font. operation, and its arguments, if any. The template is: + @defop CATEGORY CLASS NAME ARGUMENTS... BODY-OF-DEFINITION @end defop @@ -1154,25 +708,20 @@ it. Otherwise, it is printed in the usual text font. `@defop' creates an entry, such as ``expose' on `windows'', in the index of functions. -`@deftypeop CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...' - The `@deftypeop' command is the definition command for typed - operations in object-oriented programming. It is similar to - `@defop' with the addition of the DATA-TYPE parameter to specify - the return type of the method. `@deftypeop' creates an entry in - the index of functions. - `@defmethod CLASS NAME ARGUMENTS...' The `@defmethod' command is the definition command for methods in object-oriented programming. A method is a kind of function that implements an operation for a particular class of objects and its - subclasses. + subclasses. In the Lisp Machine, methods actually were functions, + but they were usually defined with `defmethod'. `@defmethod' is equivalent to `@defop Method ...'. The command is written at the beginning of a line and is followed by the name of the class of the method, the name of the method, and its arguments, if any. - For example: + For example, + @defmethod `bar-class' bar-method argument ... @end defmethod @@ -1254,7 +803,7 @@ A Sample Function Definition The name of the function follows immediately after the `@defun' command and it is followed, on the same line, by the parameter list. - Here is a definition from *Note Calling Functions: (elisp)Calling + Here is a definition from *Note Calling Functions: (lispref)Calling Functions. - Function: apply function &rest arguments @@ -1287,6 +836,7 @@ Functions. In the Texinfo source file, this example looks like this: @defun apply function &rest arguments + @code{apply} calls @var{function} with @var{arguments}, just like @code{funcall} but with one difference: the last of @var{arguments} is a list of @@ -1315,7 +865,7 @@ Functions. @end example An interesting example of using @code{apply} is found - in the description of @code{mapcar}. + in the description of @code{mapcar}.@refill @end defun In this manual, this function is listed in the Command and Variable @@ -1325,27 +875,147 @@ Index under `apply'. that for functions except that variables do not take arguments.  -File: texinfo.info, Node: Conditionals, Next: Internationalization, Prev: Definition Commands, Up: Top +File: texinfo.info, Node: Footnotes, Next: Conditionals, Prev: Definition Commands, Up: Top -Conditionally Visible Text -************************** +Footnotes +********* + + A "footnote" is for a reference that documents or elucidates the +primary text.(1) (*note Footnotes-Footnote-1::) + +* Menu: + +* Footnote Commands:: How to write a footnote in Texinfo. +* Footnote Styles:: Controlling how footnotes appear in Info. + + +File: texinfo.info, Node: Footnotes-Footnotes, Up: Footnotes + + (1) A footnote should complement or expand upon the primary text, but +a reader should not need to read a footnote to understand the primary +text. For a thorough discussion of footnotes, see `The Chicago Manual +of Style', which is published by the University of Chicago Press. + + +File: texinfo.info, Node: Footnote Commands, Next: Footnote Styles, Prev: Footnotes, Up: Footnotes + +Footnote Commands +================= + + In Texinfo, footnotes are created with the `@footnote' command. This +command is followed immediately by a left brace, then by the text of +the footnote, and then by a terminating right brace. Footnotes may be +of any length (they will be broken across pages if necessary), but are +usually short. The template is: + + ordinary text@footnote{TEXT OF FOOTNOTE} + + As shown here, the `@footnote' command should come right after the +text being footnoted, with no intervening space; otherwise, the +formatters the footnote mark might end up starting up a line. + + For example, this clause is followed by a sample footnote(1) (*note +Footnote Commands-Footnote-1::); in the Texinfo source, it looks like +this: + + ...a sample footnote@footnote{Here is the sample + footnote.}; in the Texinfo source... + + *Warning:* Don't use footnotes in the argument of the `@item' command +for a `@table' table. This doesn't work, and because of limitations of +TeX, there is no way to fix it. You must put the footnote into the +body text of the table. + + In a printed manual or book, the reference mark for a footnote is a +small, superscripted number; the text of the footnote appears at the +bottom of the page, below a horizontal line. + + In Info, the reference mark for a footnote is a pair of parentheses +with the footnote number between them, like this: `(1)'. + + +File: texinfo.info, Node: Footnote Commands-Footnotes, Up: Footnote Commands + + (1) Here is the sample footnote. + + +File: texinfo.info, Node: Footnote Styles, Prev: Footnote Commands, Up: Footnotes + +Footnote Styles +=============== + + Info has two footnote styles, which determine where the text of the +footnote is located: + + * In the `End' node style, all the footnotes for a single node are + placed at the end of that node. The footnotes are separated from + the rest of the node by a line of dashes with the word `Footnotes' + within it. Each footnote begins with an `(N)' reference mark. + + Here is an example of a single footnote in the end of node style: + + --------- Footnotes --------- + + (1) Here is a sample footnote. + + * In the `Separate' node style, all the footnotes for a single node + are placed in an automatically constructed node of their own. In + this style, a "footnote reference" follows each `(N)' reference + mark in the body of the node. The footnote reference is actually + a cross reference which you use to reach the footnote node. + + The name of the node containing the footnotes is constructed by + appending `-Footnotes' to the name of the node that contains the + footnotes. (Consequently, the footnotes' node for the `Footnotes' + node is `Footnotes-Footnotes'!) The footnotes' node has an `Up' + node pointer that leads back to its parent node. + + Here is how the first footnote in this manual looks after being + formatted for Info in the separate node style: + + File: texinfo.info Node: Overview-Footnotes, Up: Overview + + (1) Note that the first syllable of "Texinfo" is + pronounced like "speck", not "hex". ... + + A Texinfo file may be formatted into an Info file with either footnote +style. + + Use the `@footnotestyle' command to specify an Info file's footnote +style. Write this command at the beginning of a line followed by an +argument, either `end' for the end node style or `separate' for the +separate node style. + + For example, + + @footnotestyle end - Sometimes it is good to use different text for different output -formats. For example, you can use the "conditional commands" to specify -different text for the printed manual and the Info output. +or + @footnotestyle separate - Conditional commands may not be nested. + Write an `@footnotestyle' command before or shortly after the +end-of-header line at the beginning of a Texinfo file. (If you include +the `@footnotestyle' command between the start-of-header and +end-of-header lines, the region formatting commands will format +footnotes as specified.) - The conditional commands comprise the following categories. + If you do not specify a footnote style, the formatting commands use +their default style. Currently, `texinfo-format-buffer' and +`texinfo-format-region' use the `separate' style and `makeinfo' uses +the `end' style. - * Commands for HTML, Info, or TeX. + This chapter contains two footnotes. - * Commands for not HTML, Info, or TeX. + +File: texinfo.info, Node: Conditionals, Next: Macros, Prev: Footnotes, Up: Top - * Raw TeX or HTML commands. +Conditionally Visible Text +************************** - * Substituting text for all formats, and testing if a flag is set or - clear. + Sometimes it is good to use different text for a printed manual and +its corresponding Info file. In this case, you can use the +"conditional commands" to specify which text is for the printed manual +and which is for the Info file. * Menu: @@ -1357,7 +1027,7 @@ different text for the printed manual and the Info output. flag to a string that you can insert.  -File: texinfo.info, Node: Conditional Commands, Next: Conditional Not Commands, Up: Conditionals +File: texinfo.info, Node: Conditional Commands, Next: Conditional Not Commands, Prev: Conditionals, Up: Conditionals Conditional Commands ==================== @@ -1365,7 +1035,7 @@ Conditional Commands `@ifinfo' begins segments of text that should be ignored by TeX when it typesets the printed manual. The segment of text appears only in the Info file. The `@ifinfo' command should appear on a line by -itself; end the Info-only text with a line containing `@end ifinfo' by +itself; end the Info-only text with a line containing `@end ifinfo' by itself. At the beginning of a Texinfo file, the Info permissions are contained within a region marked by `@ifinfo' and `@end ifinfo'. (*Note Info Summary and Permissions::.) @@ -1384,15 +1054,16 @@ output. @ifinfo However, this text will appear only in Info. @end ifinfo - @ifhtml - And this text will only appear in HTML. - @end ifhtml The preceding example produces the following line: However, this text will appear only in Info. -Notice that you only see one of the input lines, depending on which -version of the manual you are reading. +Note how you only see one of the two lines, depending on whether you +are reading the Info version or the printed version of this manual. + + The `@titlepage' command is a special variant of `@iftex' that is +used for making the title and copyright pages of the printed manual. +(*Note `@titlepage': titlepage.)  File: texinfo.info, Node: Conditional Not Commands, Next: Raw Formatter Commands, Prev: Conditional Commands, Up: Conditionals @@ -1413,6 +1084,317 @@ lines by themselves.) is included. Otherwise, it is ignored. The regions delimited by these commands are ordinary Texinfo source as -with `@iftex', not raw formatter source as with `@tex' (*note Raw -Formatter Commands::). +with `@iftex', not raw formatter source as with `@tex'. + + +File: texinfo.info, Node: Raw Formatter Commands, Next: set clear value, Prev: Conditional Not Commands, Up: Conditionals + +Raw Formatter Commands +====================== + + Inside a region delineated by `@iftex' and `@end iftex', you can +embed some raw TeX commands. Info will ignore these commands since +they are only in that part of the file which is seen by TeX. You can +write the TeX commands as you would write them in a normal TeX file, +except that you must replace the `\' used by TeX with an `@'. For +example, in the `@titlepage' section of a Texinfo file, you can use the +TeX command `@vskip' to format the copyright page. (The `@titlepage' +command causes Info to ignore the region automatically, as it does with +the `@iftex' command.) + + However, many features of plain TeX will not work, as they are +overridden by Texinfo features. + + You can enter plain TeX completely, and use `\' in the TeX commands, +by delineating a region with the `@tex' and `@end tex' commands. (The +`@tex' command also causes Info to ignore the region, like the `@iftex' +command.) The sole exception is that `@' chracter still introduces a +command, so that `@end tex' can be recognized properly. + + For example, here is a mathematical expression written in plain TeX: + + @tex + $$ \chi^2 = \sum_{i=1}^N + \left (y_i - (a + b x_i) + \over \sigma_i\right)^2 $$ + @end tex + +The output of this example will appear only in a printed manual. If +you are reading this in Info, you will not see the equation that appears +in the printed manual. + + Analogously, you can use `@ifhtml ... @end ifhtml' to delimit a +region to be included in HTML output only, and `@html ... @end ifhtml' +for a region of raw HTML (again, except that `@' is still the escape +character, so the `@end' command can be recognized.) + + +File: texinfo.info, Node: set clear value, Prev: Raw Formatter Commands, Up: Conditionals + +`@set', `@clear', and `@value' +============================== + + You can direct the Texinfo formatting commands to format or ignore +parts of a Texinfo file with the `@set', `@clear', `@ifset', and +`@ifclear' commands. + + In addition, you can use the `@set FLAG' command to set the value of +FLAG to a string of characters; and use `@value{FLAG}' to insert that +string. You can use `@set', for example, to set a date and use +`@value' to insert the date in several places in the Texinfo file. + +* Menu: + +* ifset ifclear:: Format a region if a flag is set. +* value:: Replace a flag with a string. +* value Example:: An easy way to update edition information. + + +File: texinfo.info, Node: ifset ifclear, Next: value, Prev: set clear value, Up: set clear value + +`@ifset' and `@ifclear' +----------------------- + + When a FLAG is set, the Texinfo formatting commands format text +between subsequent pairs of `@ifset FLAG' and `@end ifset' commands. +When the FLAG is cleared, the Texinfo formatting commands do _not_ +format the text. + + Use the `@set FLAG' command to turn on, or "set", a FLAG; a "flag" +can be any single word. The format for the command looks like this: + + @set FLAG + + Write the conditionally formatted text between `@ifset FLAG' and +`@end ifset' commands, like this: + + @ifset FLAG + CONDITIONAL-TEXT + @end ifset + + For example, you can create one document that has two variants, such +as a manual for a `large' and `small' model: + + You can use this machine to dig up shrubs + without hurting them. + + @set large + + @ifset large + It can also dig up fully grown trees. + @end ifset + + Remember to replant promptly ... + +In the example, the formatting commands will format the text between +`@ifset large' and `@end ifset' because the `large' flag is set. + + Use the `@clear FLAG' command to turn off, or "clear", a flag. +Clearing a flag is the opposite of setting a flag. The command looks +like this: + + @clear FLAG + +Write the command on a line of its own. + + When FLAG is cleared, the Texinfo formatting commands do _not_ format +the text between `@ifset FLAG' and `@end ifset'; that text is ignored +and does not appear in either printed or Info output. + + For example, if you clear the flag of the preceding example by writing +an `@clear large' command after the `@set large' command (but before +the conditional text), then the Texinfo formatting commands ignore the +text between the `@ifset large' and `@end ifset' commands. In the +formatted output, that text does not appear; in both printed and Info +output, you see only the lines that say, "You can use this machine to +dig up shrubs without hurting them. Remember to replant promptly ...". + + If a flag is cleared with an `@clear FLAG' command, then the +formatting commands format text between subsequent pairs of `@ifclear' +and `@end ifclear' commands. But if the flag is set with `@set FLAG', +then the formatting commands do _not_ format text between an `@ifclear' +and an `@end ifclear' command; rather, they ignore that text. An +`@ifclear' command looks like this: + + @ifclear FLAG + + In brief, the commands are: + +`@set FLAG' + Tell the Texinfo formatting commands that FLAG is set. + +`@clear FLAG' + Tell the Texinfo formatting commands that FLAG is cleared. + +`@ifset FLAG' + If FLAG is set, tell the Texinfo formatting commands to format the + text up to the following `@end ifset' command. + + If FLAG is cleared, tell the Texinfo formatting commands to ignore + text up to the following `@end ifset' command. + +`@ifclear FLAG' + If FLAG is set, tell the Texinfo formatting commands to ignore the + text up to the following `@end ifclear' command. + + If FLAG is cleared, tell the Texinfo formatting commands to format + the text up to the following `@end ifclear' command. + + +File: texinfo.info, Node: value, Next: value Example, Prev: ifset ifclear, Up: set clear value + +`@value' +-------- + + You can use the `@set' command to specify a value for a flag, which +is expanded by the `@value' command. The value is a string a +characters. + + Write the `@set' command like this: + + @set foo This is a string. + +This sets the value of `foo' to "This is a string." + + The Texinfo formatters replace an `@value{FLAG}' command with the +string to which FLAG is set. + + Thus, when `foo' is set as shown above, the Texinfo formatters convert + + @value{foo} +to + This is a string. + + You can write an `@value' command within a paragraph; but you must +write an `@set' command on a line of its own. + + If you write the `@set' command like this: + + @set foo + +without specifying a string, the value of `foo' is an empty string. + + If you clear a previously set flag with an `@clear FLAG' command, a +subsequent `@value{flag}' command is invalid and the string is replaced +with an error message that says `{No value for "FLAG"}'. + + For example, if you set `foo' as follows: + + @set how-much very, very, very + +then the formatters transform + + It is a @value{how-much} wet day. +into + It is a very, very, very wet day. + + If you write + + @clear how-much + +then the formatters transform + + It is a @value{how-much} wet day. +into + It is a {No value for "how-much"} wet day. + + +File: texinfo.info, Node: value Example, Prev: value, Up: set clear value + +`@value' Example +---------------- + + You can use the `@value' command to limit the number of places you +need to change when you record an update to a manual. Here is how it +is done in `The GNU Make Manual': + +Set the flags: + + @set EDITION 0.35 Beta + @set VERSION 3.63 Beta + @set UPDATED 14 August 1992 + @set UPDATE-MONTH August 1992 + +Write text for the first `@ifinfo' section, for people reading the +Texinfo file: + + This is Edition @value{EDITION}, + last updated @value{UPDATED}, + of @cite{The GNU Make Manual}, + for @code{make}, Version @value{VERSION}. + +Write text for the title page, for people reading the printed manual: + + @title GNU Make + @subtitle A Program for Directing Recompilation + @subtitle Edition @value{EDITION}, ... + @subtitle @value{UPDATE-MONTH} + +(On a printed cover, a date listing the month and the year looks less +fussy than a date listing the day as well as the month and year.) + +Write text for the Top node, for people reading the Info file: + + This is Edition @value{EDITION} + of the @cite{GNU Make Manual}, + last updated @value{UPDATED} + for @code{make} Version @value{VERSION}. + + After you format the manual, the text in the first `@ifinfo' section +looks like this: + + This is Edition 0.35 Beta, last updated 14 August 1992, + of `The GNU Make Manual', for `make', Version 3.63 Beta. + + When you update the manual, change only the values of the flags; you +do not need to rewrite the three sections. + + +File: texinfo.info, Node: Macros, Next: Format/Print Hardcopy, Prev: Conditionals, Up: Top + +Macros: Defining New Texinfo Commands +************************************* + + A Texinfo "macro" allows you to define a new Texinfo command as any +sequence of text and/or existing commands (including other macros). The +macro can have any number of "parameters"--text you supply each time +you use the macro. (This has nothing to do with the `@defmac' command, +which is for documenting macros in the subject of the manual; *note Def +Cmd Template::.) + +* Menu: + +* Defining Macros:: Both defining and undefining new commands. +* Invoking Macros:: Using a macro, once you've defined it. + + +File: texinfo.info, Node: Defining Macros, Next: Invoking Macros, Prev: Macros, Up: Macros + +Defining Macros +=============== + + You use the Texinfo `@macro' command to define a macro. For example: + + @macro MACRO-NAME{PARAM1, PARAM2, ...} + TEXT ... \PARAM1\ ... + @end macro + + The "parameters" PARAM1, PARAM2, ... correspond to arguments supplied +when the macro is subsequently used in the document (see the next +section). + + If a macro needs no parameters, you can define it either with an empty +list (`@macro foo {}') or with no braces at all (`@macro foo'). + + The definition or "body" of the macro can contain any Texinfo +commands, including previously-defined macros. (It is not possible to +have mutually recursive Texinfo macros.) In the body, instances of a +parameter name surrounded by backslashes, as in `\PARAM1\' in the +example above, are replaced by the corresponding argument from the +macro invocation. + + You can undefine a macro FOO with `@unmacro FOO'. It is not an error +to undefine a macro that is already undefined. For example: + + @unmacro foo diff --git a/info/texinfo.info-8 b/info/texinfo.info-8 index 9ebe6f2..79ed349 100644 --- a/info/texinfo.info-8 +++ b/info/texinfo.info-8 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,476 +33,7 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: Raw Formatter Commands, Next: set clear value, Prev: Conditional Not Commands, Up: Conditionals - -Raw Formatter Commands -====================== - - Inside a region delineated by `@iftex' and `@end iftex', you can -embed some raw TeX commands. Info will ignore these commands since -they are only in that part of the file which is seen by TeX. You can -write the TeX commands as you would write them in a normal TeX file, -except that you must replace the `\' used by TeX with an `@'. For -example, in the `@titlepage' section of a Texinfo file, you can use the -TeX command `@vskip' to format the copyright page. (The `@titlepage' -command causes Info to ignore the region automatically, as it does with -the `@iftex' command.) - - However, many features of plain TeX will not work, as they are -overridden by Texinfo features. - - You can enter plain TeX completely, and use `\' in the TeX commands, -by delineating a region with the `@tex' and `@end tex' commands. (The -`@tex' command also causes Info to ignore the region, like the `@iftex' -command.) The sole exception is that the `@' character still -introduces a command, so that `@end tex' can be recognized properly. - - For example, here is a mathematical expression written in plain TeX: - - @tex - $$ \chi^2 = \sum_{i=1}^N - \left (y_i - (a + b x_i) - \over \sigma_i\right)^2 $$ - @end tex - -The output of this example will appear only in a printed manual. If -you are reading this in Info, you will not see the equation that appears -in the printed manual. - - Analogously, you can use `@ifhtml ... @end ifhtml' to delimit a -region to be included in HTML output only, and `@html ... @end html' -for a region of raw HTML (again, except that `@' is still the escape -character, so the `@end' command can be recognized.) - - -File: texinfo.info, Node: set clear value, Prev: Raw Formatter Commands, Up: Conditionals - -`@set', `@clear', and `@value' -============================== - - You can direct the Texinfo formatting commands to format or ignore -parts of a Texinfo file with the `@set', `@clear', `@ifset', and -`@ifclear' commands. - - In addition, you can use the `@set FLAG' command to set the value of -FLAG to a string of characters; and use `@value{FLAG}' to insert that -string. You can use `@set', for example, to set a date and use -`@value' to insert the date in several places in the Texinfo file. - -* Menu: - -* ifset ifclear:: Format a region if a flag is set. -* set value:: Expand a flag variable to a string. -* value Example:: An easy way to update edition information. - - -File: texinfo.info, Node: ifset ifclear, Next: set value, Up: set clear value - -`@ifset' and `@ifclear' ------------------------ - - When a FLAG is set, the Texinfo formatting commands format text -between subsequent pairs of `@ifset FLAG' and `@end ifset' commands. -When the FLAG is cleared, the Texinfo formatting commands do _not_ -format the text. - - Use the `@set FLAG' command to turn on, or "set", a FLAG; a "flag" -name can be any single word, containing letters, numerals, hyphens, or -underscores. - - The format for the command looks like this: - - @set FLAG - - Write the conditionally formatted text between `@ifset FLAG' and -`@end ifset' commands, like this: - - @ifset FLAG - CONDITIONAL-TEXT - @end ifset - - For example, you can create one document that has two variants, such -as a manual for a `large' and `small' model: - - You can use this machine to dig up shrubs - without hurting them. - - @set large - - @ifset large - It can also dig up fully grown trees. - @end ifset - - Remember to replant promptly ... - -In the example, the formatting commands will format the text between -`@ifset large' and `@end ifset' because the `large' flag is set. - - Use the `@clear FLAG' command to turn off, or "clear", a flag. -Clearing a flag is the opposite of setting a flag. The command looks -like this: - - @clear FLAG - -Write the command on a line of its own. - - When FLAG is cleared, the Texinfo formatting commands do _not_ format -the text between `@ifset FLAG' and `@end ifset'; that text is ignored -and does not appear in either printed or Info output. - - For example, if you clear the flag of the preceding example by writing -an `@clear large' command after the `@set large' command (but before -the conditional text), then the Texinfo formatting commands ignore the -text between the `@ifset large' and `@end ifset' commands. In the -formatted output, that text does not appear; in both printed and Info -output, you see only the lines that say, "You can use this machine to -dig up shrubs without hurting them. Remember to replant promptly ...". - - If a flag is cleared with an `@clear FLAG' command, then the -formatting commands format text between subsequent pairs of `@ifclear' -and `@end ifclear' commands. But if the flag is set with `@set FLAG', -then the formatting commands do _not_ format text between an `@ifclear' -and an `@end ifclear' command; rather, they ignore that text. An -`@ifclear' command looks like this: - - @ifclear FLAG - - In brief, the commands are: - -`@set FLAG' - Tell the Texinfo formatting commands that FLAG is set. - -`@clear FLAG' - Tell the Texinfo formatting commands that FLAG is cleared. - -`@ifset FLAG' - If FLAG is set, tell the Texinfo formatting commands to format the - text up to the following `@end ifset' command. - - If FLAG is cleared, tell the Texinfo formatting commands to ignore - text up to the following `@end ifset' command. - -`@ifclear FLAG' - If FLAG is set, tell the Texinfo formatting commands to ignore the - text up to the following `@end ifclear' command. - - If FLAG is cleared, tell the Texinfo formatting commands to format - the text up to the following `@end ifclear' command. - - -File: texinfo.info, Node: set value, Next: value Example, Prev: ifset ifclear, Up: set clear value - -`@set' and `@value' -------------------- - - You can use the `@set' command to specify a value for a flag, which -is expanded by the `@value' command. A flag is an identifier; for best -results, use only letters and numerals in a flag name, not `-' or -`_'--they will work in some contexts, but not all, due to limitations -in TeX. The value is just a string of characters, the remainder of the -input line. - - Write the `@set' command like this: - - @set foo This is a string. - -This sets the value of the flag `foo' to "This is a string.". - - The Texinfo formatters then replace an `@value{FLAG}' command with -the string to which FLAG is set. Thus, when `foo' is set as shown -above, the Texinfo formatters convert - - @value{foo} -to - This is a string. - - You can write an `@value' command within a paragraph; but you must -write an `@set' command on a line of its own. - - If you write the `@set' command like this: - - @set foo - -without specifying a string, the value of `foo' is an empty string. - - If you clear a previously set flag with `@clear FLAG', a subsequent -`@value{flag}' command is invalid and the string is replaced with an -error message that says `{No value for "FLAG"}'. - - For example, if you set `foo' as follows: - - @set how-much very, very, very - -then the formatters transform - - It is a @value{how-much} wet day. -into - It is a very, very, very wet day. - - If you write - - @clear how-much - -then the formatters transform - - It is a @value{how-much} wet day. -into - It is a {No value for "how-much"} wet day. - - -File: texinfo.info, Node: value Example, Prev: set value, Up: set clear value - -`@value' Example ----------------- - - You can use the `@value' command to limit the number of places you -need to change when you record an update to a manual. Here is how it is -done in `The GNU Make Manual': - - 1. Set the flags: - - @set EDITION 0.35 Beta - @set VERSION 3.63 Beta - @set UPDATED 14 August 1992 - @set UPDATE-MONTH August 1992 - - 2. Write text for the first `@ifinfo' section, for people reading the - Texinfo file: - - This is Edition @value{EDITION}, - last updated @value{UPDATED}, - of @cite{The GNU Make Manual}, - for @code{make}, version @value{VERSION}. - - 3. Write text for the title page, for people reading the printed - manual: - - @title GNU Make - @subtitle A Program for Directing Recompilation - @subtitle Edition @value{EDITION}, ... - @subtitle @value{UPDATE-MONTH} - - (On a printed cover, a date listing the month and the year looks - less fussy than a date listing the day as well as the month and - year.) - - 4. Write text for the Top node, for people reading the Info file: - - This is Edition @value{EDITION} - of the @cite{GNU Make Manual}, - last updated @value{UPDATED} - for @code{make} Version @value{VERSION}. - - After you format the manual, the text in the first `@ifinfo' - section looks like this: - - This is Edition 0.35 Beta, last updated 14 August 1992, - of `The GNU Make Manual', for `make', Version 3.63 Beta. - - When you update the manual, change only the values of the flags; you -do not need to edit the three sections. - - -File: texinfo.info, Node: Internationalization, Next: Defining New Texinfo Commands, Prev: Conditionals, Up: Top - -Internationalization -******************** - - Texinfo has some support for writing in languages other than English, -although this area still needs considerable work. - - For a list of the various accented and special characters Texinfo -supports, see *Note Inserting Accents::. - -* Menu: - -* documentlanguage:: Declaring the current language. -* documentencoding:: Declaring the input encoding. - - -File: texinfo.info, Node: documentlanguage, Next: documentencoding, Up: Internationalization - -`@documentlanguage CC': Set the Document Language -================================================= - - The `@documentlanguage' command declares the current document -language. Write it on a line by itself, with a two-letter ISO-639 -language code following (list is included below). If you have a -multilingual document, the intent is to be able to use this command -multiple times, to declare each language change. If the command is not -used at all, the default is `en' for English. - - At present, this command is ignored in Info and HTML output. For -TeX, it causes the file `txi-CC.tex' to be read (if it exists). Such a -file appropriately redefines the various English words used in TeX -output, such as `Chapter', `See', and so on. - - It would be good if this command also changed TeX's ideas of the -current hyphenation patterns (via the TeX primitive `\language'), but -this is unfortunately not currently implemented. - - Here is the list of valid language codes. This list comes from the -free translation project -(http://www.iro.umontreal.ca/contrib/po/iso-639). In the future we may -wish to allow the 3-letter POV codes described at -`http://www.sil.org/ethnologue/#contents'. This will be necessary to -support African languages. - -`aa' Afar `ab'Abkhazian `af'Afrikaans -`am' Amharic `ar'Arabic `as'Assamese -`ay' Aymara `az'Azerbaijani `ba'Bashkir -`be' Byelorussian `bg'Bulgarian `bh'Bihari -`bi' Bislama `bn'Bengali; Bangla `bo'Tibetan -`br' Breton `ca'Catalan `co'Corsican -`cs' Czech `cy'Welsh `da'Danish -`de' German `dz'Bhutani `el'Greek -`en' English `eo'Esperanto `es'Spanish -`et' Estonian `eu'Basque `fa'Persian -`fi' Finnish `fj'Fiji `fo'Faroese -`fr' French `fy'Frisian `ga'Irish -`gd' Scots Gaelic `gl'Galician `gn'Guarani -`gu' Gujarati `ha'Hausa `he'Hebrew -`hi' Hindi `hr'Croatian `hu'Hungarian -`hy' Armenian `ia'Interlingua `id'Indonesian -`ie' Interlingue `ik'Inupiak `is'Icelandic -`it' Italian `iu'Inuktitut `ja'Japanese -`jw' Javanese `ka'Georgian `kk'Kazakh -`kl' Greenlandic `km'Cambodian `kn'Kannada -`ks' Kashmiri `ko'Korean `ku'Kurdish -`ky' Kirghiz `la'Latin `ln'Lingala -`lt' Lithuanian `lo'Laothian `lv'Latvian, Lettish -`mg' Malagasy `mi'Maori `mk'Macedonian -`ml' Malayalam `mn'Mongolian `mo'Moldavian -`mr' Marathi `ms'Malay `mt'Maltese -`my' Burmese `na'Nauru `ne'Nepali -`nl' Dutch `no'Norwegian `oc'Occitan -`om' (Afan) Oromo `or'Oriya `pa'Punjabi -`pl' Polish `ps'Pashto, Pushto `pt'Portuguese -`qu' Quechua `rm'Rhaeto-Romance `rn'Kirundi -`ro' Romanian `ru'Russian `rw'Kinyarwanda -`sa' Sanskrit `sd'Sindhi `sg'Sangro -`sh' Serbo-Croatian `si'Sinhalese `sk'Slovak -`sl' Slovenian `sm'Samoan `sn'Shona -`so' Somali `sq'Albanian `sr'Serbian -`ss' Siswati `st'Sesotho `su'Sundanese -`sv' Swedish `sw'Swahili `ta'Tamil -`te' Telugu `tg'Tajik `th'Thai -`ti' Tigrinya `tk'Turkmen `tl'Tagalog -`tn' Setswana `to'Tonga `tr'Turkish -`ts' Tsonga `tt'Tatar `tw'Twi -`ug' Uighur `uk'Ukrainian `ur'Urdu -`uz' Uzbek `vi'Vietnamese `vo'Volapuk -`wo' Wolof `xh'Xhosa `yi'Yiddish -`yo' Yoruba `za'Zhuang `zh'Chinese -`zu' Zulu - - -File: texinfo.info, Node: documentencoding, Prev: documentlanguage, Up: Internationalization - -`@documentencoding ENC': Set Input Encoding -=========================================== - - The `@documentencoding' command declares the input document encoding. -Write it on a line by itself, with a valid encoding specification -following, such as `ISO-8859-1'. - - At present, this is used only in HTML output from `makeinfo'. If a -document encoding ENC is specified, it is used in the `' tag is -included in the `' of the output: - - - - -File: texinfo.info, Node: Defining New Texinfo Commands, Next: Hardcopy, Prev: Internationalization, Up: Top - -Defining New Texinfo Commands -***************************** - - Texinfo provides several ways to define new commands: - - * A Texinfo "macro" allows you to define a new Texinfo command as any - sequence of text and/or existing commands (including other - macros). The macro can have any number of "parameters"--text you - supply each time you use the macro. - - Incidentally, these macros have nothing to do with the `@defmac' - command, which is for documenting macros in the subject of the - manual (*note Def Cmd Template::). - - * `@alias' is a convenient way to define a new name for an existing - command. - - * `@definfoenclose' allows you to define new commands with - customized output in the Info file. - - -* Menu: - -* Defining Macros:: Defining and undefining new commands. -* Invoking Macros:: Using a macro, once you've defined it. -* Macro Details:: Beyond basic macro usage. -* alias:: Command aliases. -* definfoenclose:: Customized highlighting. - - -File: texinfo.info, Node: Defining Macros, Next: Invoking Macros, Up: Defining New Texinfo Commands - -Defining Macros -=============== - - You use the Texinfo `@macro' command to define a macro, like this: - - @macro MACRONAME{PARAM1, PARAM2, ...} - TEXT ... \PARAM1\ ... - @end macro - - The "parameters" PARAM1, PARAM2, ... correspond to arguments supplied -when the macro is subsequently used in the document (described in the -next section). - - For a macro to work with TeX, MACRONAME must consist entirely of -letters: no digits, hyphens, underscores, or other special characters. - - If a macro needs no parameters, you can define it either with an empty -list (`@macro foo {}') or with no braces at all (`@macro foo'). - - The definition or "body" of the macro can contain most Texinfo -commands, including previously-defined macros. Not-yet-defined macro -invocations are not allowed; thus, it is not possible to have mutually -recursive Texinfo macros. Also, a macro definition that defines another -macro does not work in TeX due to limitations in the design of `@macro'. - - In the macro body, instances of a parameter name surrounded by -backslashes, as in `\PARAM1\' in the example above, are replaced by the -corresponding argument from the macro invocation. You can use -parameter names any number of times in the body, including zero. - - To get a single `\' in the macro expansion, use `\\'. Any other use -of `\' in the body yields a warning. - - The newlines after the `@macro' line and before the `@end macro' line -are ignored, that is, not included in the macro body. All other -whitespace is treated according to the usual Texinfo rules. - - To allow a macro to be used recursively, that is, in an argument to a -call to itself, you must define it with `@rmacro', like this: - - @rmacro rmac - a\arg\b - @end rmacro - ... - @rmac{1@rmac{text}2} - - This produces the output `a1atextb2b'. With `@macro' instead of -`@rmacro', an error message is given. - - You can undefine a macro FOO with `@unmacro FOO'. It is not an error -to undefine a macro that is already undefined. For example: - - @unmacro foo - - -File: texinfo.info, Node: Invoking Macros, Next: Macro Details, Prev: Defining Macros, Up: Defining New Texinfo Commands +File: texinfo.info, Node: Invoking Macros, Prev: Defining Macros, Up: Macros Invoking Macros =============== @@ -510,9 +41,9 @@ Invoking Macros After a macro is defined (see the previous section), you can use ("invoke") it in your document like this: - @MACRONAME {ARG1, ARG2, ...} + @MACRO-NAME {ARG1, ARG2, ...} -and the result will be just as if you typed the body of MACRONAME at +and the result will be just as if you typed the body of MACRO-NAME at that spot. For example: @macro foo {p, q} @@ -526,192 +57,32 @@ produces: Thus, the arguments and parameters are separated by commas and delimited by braces; any whitespace after (but not before) a comma is -ignored. The braces are required in the invocation (but not the -definition), even when the macro takes no arguments, consistent with -all other Texinfo commands. For example: - - @macro argless {} - No arguments here. - @end macro - @argless{} - -produces: +ignored. To insert a comma, brace, or backslash in an argument, +prepend a backslash, as in - No arguments here. - - To insert a comma, brace, or backslash in an argument, prepend a -backslash, as in - - @MACNAME {\\\{\}\,} + @MACRO-NAME {\\\{\}\,} which will pass the (almost certainly error-producing) argument `\{},' -to MACNAME. +to MACRO-NAME. If the macro is defined to take a single argument, and is invoked without any braces, the entire rest of the line after the macro name is supplied as the argument. For example: @macro bar {p} - Twice: \p\ & \p\. + Twice: \p\, \p\. @end macro @bar aah produces: - Twice: aah & aah. - - If the macro is defined to take a single argument, and is invoked with -braces, the braced text is passed as the argument, regardless of -commas. For example: - - @macro bar {p} - Twice: \p\ & \p\. - @end macro - @bar{a,b} - -produces: - - Twice: a,b & a,b. - - -File: texinfo.info, Node: Macro Details, Next: alias, Prev: Invoking Macros, Up: Defining New Texinfo Commands - -Macro Details -============= - - Due to unavoidable disparities in the TeX and `makeinfo' -implementations, Texinfo macros have the following limitations. - - * All macros are expanded inside at least one TeX group. This means - that - - * Macros containing a command which must be on a line by itself, - such as a conditional, cannot be invoked in the middle of a line. - - * The TeX implementation cannot construct macros that define macros - in the natural way. To do this, you must use conditionals and raw - TeX. For example: - - @ifinfo - @macro ctor {name, arg} - @macro \name\ - something involving \arg\ somehow - @end macro - @end macro - @end ifinfo - @tex - \gdef\ctor#1{\ctorx#1,} - \gdef\ctorx#1,#2,{\def#1{something involving #2 somehow}} - @end tex - - * It is best to avoid comments inside macro definitions. - - - -File: texinfo.info, Node: alias, Next: definfoenclose, Prev: Macro Details, Up: Defining New Texinfo Commands - -`@alias NEW=EXISTING' -===================== - - The `@alias' command defines a new command to be just like an -existing one. This is useful for defining additional markup names, thus -preserving semantic information in the input even though the output -result may be the same. - - Write the `@alias' command on a line by itself, followed by the new -command name, an equals sign, and the existing command name. -Whitespace around the equals sign is ignored. Thus: - @alias NEW = EXISTING - - For example, if your document contains citations for both books and -some other media (movies, for example), you might like to define a -macro `@moviecite{}' that does the same thing as an ordinary `@cite{}' -but conveys the extra semantic information as well. You'd do this as -follows: - - @alias moviecite = cite - - Macros do not always have the same effect due to vagaries of argument -parsing. Also, aliases are much simpler to define than macros. So the -command is not redundant. (It was also heavily used in the Jargon -File!) - - Aliases must not be recursive, directly or indirectly. + Twice: aah, aah.  -File: texinfo.info, Node: definfoenclose, Prev: alias, Up: Defining New Texinfo Commands - -`definfoenclose': Customized Highlighting -========================================= - - A `@definfoenclose' command may be used to define a highlighting -command for Info, but not for TeX. A command defined using -`@definfoenclose' marks text by enclosing it in strings that precede -and follow the text. You can use this to get closer control of your -Info output. - - Presumably, if you define a command with `@definfoenclose' for Info, -you will create a corresponding command for TeX, either in -`texinfo.tex', `texinfo.cnf', or within an `@iftex' in your document. - - Write a `@definfoenclose' command on a line and follow it with three -arguments separated by commas. The first argument to `@definfoenclose' -is the @-command name (without the `@'); the second argument is the -Info start delimiter string; and the third argument is the Info end -delimiter string. The latter two arguments enclose the highlighted -text in the Info file. A delimiter string may contain spaces. Neither -the start nor end delimiter is required. If you do not want a start -delimiter but do want an end delimiter, you must follow the command -name with two commas in a row; otherwise, the Info formatting commands -will naturally misinterpret the end delimiter string you intended as -the start delimiter string. - - If you do a `@definfoenclose' on the name of a pre-defined macro -(such as `@emph', `@strong', `@t', or `@i'), the enclosure definition -will override the built-in definition. - - An enclosure command defined this way takes one argument in braces; -this is intended for new markup commands (*note Marking Text::). - - For example, you can write: - - @definfoenclose phoo,//,\\ - -near the beginning of a Texinfo file to define `@phoo' as an Info -formatting command that inserts `//' before and `\\' after the argument -to `@phoo'. You can then write `@phoo{bar}' wherever you want -`//bar\\' highlighted in Info. - - Also, for TeX formatting, you could write - - @iftex - @global@let@phoo=@i - @end iftex - -to define `@phoo' as a command that causes TeX to typeset the argument -to `@phoo' in italics. - - Note that each definition applies to its own formatter: one for TeX, -the other for `texinfo-format-buffer' or `texinfo-format-region'. The -`@definfoenclose' command need not be within `@ifinfo', but the raw TeX -commands do need to be in `@iftex'. - - Here is another example: write - - @definfoenclose headword, , : - -near the beginning of the file, to define `@headword' as an Info -formatting command that inserts nothing before and a colon after the -argument to `@headword'. +File: texinfo.info, Node: Format/Print Hardcopy, Next: Create an Info File, Prev: Macros, Up: Top - `@definfoenclose' definitions must not be recursive, directly or -indirectly. - - -File: texinfo.info, Node: Hardcopy, Next: Creating and Installing Info Files, Prev: Defining New Texinfo Commands, Up: Top - -Formatting and Printing Hardcopy -******************************** +Format and Print Hardcopy +************************* There are three major shell commands for making a printed manual from a Texinfo file: one for converting the Texinfo file into a file that @@ -729,43 +100,41 @@ print queue, and delete a job from the print queue. * Menu: * Use TeX:: Use TeX to format for hardcopy. -* Format with tex/texindex:: How to format with explicit shell commands. -* Format with texi2dvi:: A simpler way to format. +* Format with tex/texindex:: How to format in a shell. +* Format with texi2dvi:: A simpler way to use the shell. * Print with lpr:: How to print. * Within Emacs:: How to format and print from an Emacs shell. * Texinfo Mode Printing:: How to format and print in Texinfo mode. * Compile-Command:: How to print using Emacs's compile command. * Requirements Summary:: TeX formatting requirements summary. -* Preparing for TeX:: What to do before you use TeX. +* Preparing for TeX:: What you need to do to use TeX. * Overfull hboxes:: What are and what to do with overfull hboxes. * smallbook:: How to print small format books and manuals. * A4 Paper:: How to print on European A4 paper. -* pagesizes:: How to print with customized page sizes. * Cropmarks and Magnification:: How to print marks to indicate the size of pages and how to print scaled up output. -* PDF Output:: Portable Document Format output.  -File: texinfo.info, Node: Use TeX, Next: Format with tex/texindex, Up: Hardcopy +File: texinfo.info, Node: Use TeX, Next: Format with tex/texindex, Prev: Format/Print Hardcopy, Up: Format/Print Hardcopy Use TeX ======= The typesetting program called TeX is used for formatting a Texinfo -file. TeX is a very powerful typesetting program and, if used -correctly, does an exceptionally good job. (*Note How to Obtain TeX: -Obtaining TeX, for information on how to obtain TeX.) +file. TeX is a very powerful typesetting program and, if used right, +does an exceptionally good job. (*Note How to Obtain TeX: Obtaining +TeX, for information on how to obtain TeX.) The `makeinfo', `texinfo-format-region', and `texinfo-format-buffer' commands read the very same @-commands in the Texinfo file as does TeX, -but process them differently to make an Info file (*note Creating an -Info File::). +but process them differently to make an Info file; see *Note Create an +Info File::.  -File: texinfo.info, Node: Format with tex/texindex, Next: Format with texi2dvi, Prev: Use TeX, Up: Hardcopy +File: texinfo.info, Node: Format with tex/texindex, Next: Format with texi2dvi, Prev: Use TeX, Up: Format/Print Hardcopy -Format with `tex' and `texindex' -================================ +Format using `tex' and `texindex' +================================= Format the Texinfo file with the shell command `tex' followed by the name of the Texinfo file. For example: @@ -775,15 +144,15 @@ name of the Texinfo file. For example: TeX will produce a "DVI file" as well as several auxiliary files containing information for indices, cross references, etc. The DVI file (for "DeVice Independent" file) can be printed on virtually any -device (see the following sections). +printe (see the following sections). The `tex' formatting command itself does not sort the indices; it writes an output file of unsorted index data. (The `texi2dvi' command -automatically generates indices; *note Format with `texi2dvi': Format -with texi2dvi..) To generate a printed index after running the `tex' -command, you first need a sorted index to work from. The `texindex' -command sorts indices. (The source file `texindex.c' comes as part of -the standard Texinfo distribution, among other places.) +automatically generates indices; see *Note Format using `texi2dvi': +Format with texi2dvi.) To generate a printed index after running the +`tex' command, you first need a sorted index to work from. The +`texindex' command sorts indices. (The source file `texindex.c' comes +as part of the standard Texinfo distribution, among other places.) The `tex' formatting command outputs unsorted index files under names that obey a standard convention: the name of your main input file with @@ -807,9 +176,9 @@ ignores such files.) For each file specified, `texindex' generates a sorted index file whose name is made by appending `s' to the input file name. The -`@printindex' command looks for a file with that name (*note Printing -Indices & Menus::). `texindex' does not alter the raw index output -file. +`@printindex' command knows to look for a file of that name (*note +Printing Indices & Menus::). `texindex' does not alter the raw index +output file. After you have sorted the indices, you need to rerun the `tex' formatting command on the Texinfo file. This regenerates the DVI file, @@ -818,7 +187,7 @@ this time with up-to-date index entries. Finally, you may need to run `tex' one more time, to get the page numbers in the cross-references correct. - To summarize, this is a five step process: + To summarize, this is a four step process: 1. Run `tex' on your Texinfo file. This generates a DVI file (with undefined cross-references and no indices), and the raw index files @@ -832,71 +201,36 @@ numbers in the cross-references correct. with page numbers for the cross-references from last time, generally incorrect. - 4. Sort the indices again, with `texindex'. - - 5. Run `tex' one last time. This time the correct page numbers are + 4. Run `tex' one last time. This time the correct page numbers are written for the cross-references. - Alternatively, it's a one-step process: run `texi2dvi' (*note Format -with texi2dvi::). + Alternatively, it's a one-step process: run `texi2dvi'. You need not run `texindex' each time after you run `tex'. If you do not, on the next run, the `tex' formatting command will use whatever sorted index files happen to exist from the previous use of `texindex'. This is usually ok while you are debugging. - Sometimes you may wish to print a document while you know it is -incomplete, or to print just one chapter of a document. In that case, -the usual auxiliary files that TeX creates and warnings TeX gives when -cross-references are not satisfied are just nuisances. You can avoid -them with the `@novalidate' command, which you must give _before_ the -`@setfilename' command (*note `@setfilename': setfilename.). Thus, the -beginning of your file would look approximately like this: - - \input texinfo - @novalidate - @setfilename myfile.info - ... - -`@novalidate' also turns off validation in `makeinfo', just like its -`--no-validate' option (*note Pointer Validation::). -  -File: texinfo.info, Node: Format with texi2dvi, Next: Print with lpr, Prev: Format with tex/texindex, Up: Hardcopy +File: texinfo.info, Node: Format with texi2dvi, Next: Print with lpr, Prev: Format with tex/texindex, Up: Format/Print Hardcopy -Format with `texi2dvi' -====================== +Format using `texi2dvi' +======================= The `texi2dvi' command automatically runs both `tex' and `texindex' -as many times as necessary to produce a DVI file with sorted indices -and all cross-references resolved. It simplifies the -`tex'--`texindex'--`tex'--`tex' sequence described in the previous -section. - - To run `texi2dvi' on an input file `foo.texi', do this (where -`prompt$ ' is your shell prompt): +as many times as necessary to produce a DVI file with up-to-date, +sorted indices. It simplifies the `tex'--`texindex'--`tex' sequence +described in the previous section. - prompt$ texi2dvi foo.texi + The syntax for `texi2dvi' is like this (where `prompt$' is your shell +prompt): - As shown in this example, the input filenames to `texi2dvi' must -include any extension (`.texi', `.texinfo', etc.). Under MS-DOS and -perhaps in other circumstances, you may need to run `sh texi2dvi -foo.texi' instead of relying on the operating system to invoke the -shell on the `texi2dvi' script. + prompt$ texi2dvi FILENAME... - Perhaps the most useful option to `texi2dvi' is `--texinfo=CMD'. -This inserts CMD on a line by itself after the `@setfilename' in a -temporary copy of the input file before running TeX. With this, you -can specify different printing formats, such as `@smallbook' (*note -smallbook::), `@afourpaper' (*note A4 Paper::), or `@pageparams' (*note -pagesizes::), without actually changing the document source. (You can -also do this on a site-wide basis with `texinfo.cnf'; *note Preparing -for TeX: Preparing for TeX.). - - For a list of other options, run `texi2dvi --help'. + For a list of options, run `texi2dvi --help'.  -File: texinfo.info, Node: Print with lpr, Next: Within Emacs, Prev: Format with texi2dvi, Up: Hardcopy +File: texinfo.info, Node: Print with lpr, Next: Within Emacs, Prev: Format with texi2dvi, Up: Format/Print Hardcopy Shell Print Using `lpr -d' ========================== @@ -906,7 +240,7 @@ installation, but `lpr -d' is common. The command may require the DVI file name without any extension or with a `.dvi' extension. (If it is `lpr', you must include the `.dvi'.) - For example, the following commands, will (perhaps) suffice to sort + The following commands, for example, will (probably) suffice to sort the indices, format, and print the `Bison Manual': tex bison.texinfo @@ -922,35 +256,8 @@ these are commonly used versions.) texi2dvi bison.texinfo lpr -d bison.dvi - `lpr' is a standard program on Unix systems, but it is usually absent -on MS-DOS/MS-Windows. Some network packages come with a program named -`lpr', but these are usually limited to sending files to a print server -over the network, and generally don't support the `-d' option. If you -are unfortunate enough to work on one of these systems, you have -several alternative ways of printing DVI files: - - * Find and install a Unix-like `lpr' program, or its clone. If you - can do that, you will be able to print DVI files just like - described above. - - * Send the DVI files to a network printer queue for DVI files. Some - network printers have special queues for printing DVI files. You - should be able to set up your network software to send files to - that queue. In some cases, the version of `lpr' which comes with - your network software will have a special option to send a file to - specific queues, like this: - - lpr -Qdvi -hprint.server.domain bison.dvi - - * Convert the DVI file to a Postscript or PCL file and send it to - your local printer. *Note dvips invocation: (dvips)dvips - invocation, and the man pages for `dvilj', for detailed - description of these tools. Once the DVI file is converted to the - format your local printer understands directly, just send it to - the appropriate port, usually `PRN'. -  -File: texinfo.info, Node: Within Emacs, Next: Texinfo Mode Printing, Prev: Print with lpr, Up: Hardcopy +File: texinfo.info, Node: Within Emacs, Next: Texinfo Mode Printing, Prev: Print with lpr, Up: Format/Print Hardcopy From an Emacs Shell =================== @@ -958,7 +265,7 @@ From an Emacs Shell You can give formatting and printing commands from a shell within GNU Emacs. To create a shell within Emacs, type `M-x shell'. In this shell, you can format and print the document. *Note Format and Print -Hardcopy: Hardcopy, for details. +Hardcopy: Format/Print Hardcopy, for details. You can switch to and from the shell buffer while `tex' is running and do other editing. If you are formatting a long document on a slow @@ -975,7 +282,7 @@ from a shell within Emacs: and printing in Texinfo mode.  -File: texinfo.info, Node: Texinfo Mode Printing, Next: Compile-Command, Prev: Within Emacs, Up: Hardcopy +File: texinfo.info, Node: Texinfo Mode Printing, Next: Compile-Command, Prev: Within Emacs, Up: Format/Print Hardcopy Formatting and Printing in Texinfo Mode ======================================= @@ -1015,9 +322,9 @@ recentering the display of the buffer in which the operations occur. `C-c C-t C-k' `M-x tex-kill-job' - Kill the currently running TeX job started by either - `texinfo-tex-region' or `texinfo-tex-buffer', or any other process - running in the Texinfo shell buffer. + Kill the currently running TeX job started by `texinfo-tex-region' + or `texinfo-tex-buffer', or any other process running in the + Texinfo shell buffer. `C-c C-t C-x' `M-x texinfo-quit-job' @@ -1062,20 +369,13 @@ variables. The default values are: tex-show-queue-command "lpq" You can change the values of these variables with the `M-x -edit-options' command (*note Editing Variable Values: (emacs)Edit +edit-options' command (*note Editing Variable Values: (xemacs)Edit Options.), with the `M-x set-variable' command (*note Examining and -Setting Variables: (emacs)Examining.), or with your `.emacs' -initialization file (*note Init File: (emacs)Init File.). - - Beginning with version 20, GNU Emacs offers a user-friendly interface, -called "Customize", for changing values of user-definable variables. -*Note Easy Customization Interface: (emacs)Easy Customization, for more -details about this. The Texinfo variables can be found in the -`Development/Docs/Texinfo' group, once you invoke the `M-x customize' -command. +Setting Variables: (xemacs)Examining.), or with your `.emacs' +initialization file (*note Init File: (xemacs)Init File.).  -File: texinfo.info, Node: Compile-Command, Next: Requirements Summary, Prev: Texinfo Mode Printing, Up: Hardcopy +File: texinfo.info, Node: Compile-Command, Next: Requirements Summary, Prev: Texinfo Mode Printing, Up: Format/Print Hardcopy Using the Local Variables List ============================== @@ -1093,10 +393,10 @@ Emacs runs the compile command. For example, at the end of the End: This technique is most often used by programmers who also compile -programs this way; see *Note Compilation: (emacs)Compilation. +programs this way; see *Note Compilation: (xemacs)Compilation.  -File: texinfo.info, Node: Requirements Summary, Next: Preparing for TeX, Prev: Compile-Command, Up: Hardcopy +File: texinfo.info, Node: Requirements Summary, Next: Preparing for TeX, Prev: Compile-Command, Up: Format/Print Hardcopy TeX Formatting Requirements Summary =================================== @@ -1105,7 +405,7 @@ TeX Formatting Requirements Summary `\input' command and must contain an `@setfilename' command: \input texinfo - @setfilename ARG-NOT-USED-BY-TEX + @setfilename ARG-NOT-USED-BY-@TEX{} The first command instructs TeX to load the macros it needs to process a Texinfo file and the second command opens auxiliary files. @@ -1124,26 +424,21 @@ command, a title page, a copyright page, and permissions. Besides an `@bye', the end of a file usually includes indices and a table of contents. (And of course most manuals contain a body of text as well.) - For more information, see: - * *Note `@settitle': settitle - - * *Note `@setchapternewpage': setchapternewpage - - * *Note Page Headings: Headings - - * *Note Titlepage & Copyright Page:: - - * *Note Printing Indices & Menus:: - - * *Note Contents:: +For more information, see +*Note `@settitle': settitle, +*Note `@setchapternewpage': setchapternewpage, +*Note Page Headings: Headings, +*Note Titlepage & Copyright Page::, +*Note Printing Indices & Menus::, and +*Note Contents::.  -File: texinfo.info, Node: Preparing for TeX, Next: Overfull hboxes, Prev: Requirements Summary, Up: Hardcopy +File: texinfo.info, Node: Preparing for TeX, Next: Overfull hboxes, Prev: Requirements Summary, Up: Format/Print Hardcopy -Preparing for TeX -================= +Preparing to Use TeX +==================== - TeX needs to know where to find the `texinfo.tex' file that you have +TeX needs to know where to find the `texinfo.tex' file that you have told it to input with the `\input texinfo' command at the beginning of the first line. The `texinfo.tex' file tells TeX how to handle @-commands; it is included in all standard GNU distributions. @@ -1162,14 +457,14 @@ distribution. This file is needed to support the `@image' command (*note Images::). Optionally, you may create an additional `texinfo.cnf', and install -it as well. This file is read by TeX when the `@setfilename' command -is executed (*note `@setfilename': setfilename.). You can put any -commands you like there, according to local site-wide conventions. They -will be read by TeX when processing any Texinfo document. For example, -if `texinfo.cnf' contains the line `@afourpaper' (*note A4 Paper::), -then all Texinfo documents will be processed with that page size in -effect. If you have nothing to put in `texinfo.cnf', you do not need -to create it. +it as well. This file is read by TeX at the `@setfilename' command +(*note `@setfilename': setfilename.). You can put any commands you +like there according to local site-wide conventions, and they will be +read by TeX when processing any Texinfo document. For example, if +`texinfo.cnf' contains the a single line `@afourpaper' (*note A4 +Paper::), then all Texinfo documents will be processed with that page +size in effect. If you have nothing to put in `texinfo.cnf', you do +not need to create it. If neither of the above locations for these system files suffice for you, you can specify the directories explicitly. For `texinfo.tex', @@ -1195,40 +490,12 @@ sequence: TEXINPUTS=.:/home/me/mylib:/usr/lib/tex/macros export TEXINPUTS - On MS-DOS/MS-Windows, you would say it like this(1) (*note Preparing -for TeX-Footnote-1::): - - set TEXINPUTS=.;d:/home/me/mylib;c:/usr/lib/tex/macros - -It is customary for DOS/Windows users to put such commands in the -`autoexec.bat' file, or in the Windows Registry. - -These settings would cause TeX to look for `\input' file first in the -current directory, indicated by the `.', then in a hypothetical user's -`me/mylib' directory, and finally in a system directory -`/usr/lib/tex/macros'. - - Finally, you may wish to dump a `.fmt' file (*note Memory dumps: -(web2c)Memory dumps.) so that TeX can load Texinfo faster. (The -disadvantage is that then updating `texinfo.tex' requires redumping.) -You can do this by running this command, assuming `epsf.tex' is -findable by TeX: - - initex texinfo @dump - - (`@dump' is a TeX primitive.) You'll then need to move `texinfo.fmt' -to wherever your `.fmt' files are found; typically this will be in the -subdirectory `web2c' of your TeX installation, for example, -`/usr/local/share/tex/web2c'. - - -File: texinfo.info, Node: Preparing for TeX-Footnotes, Up: Preparing for TeX - - (1) Note the use of the `;' character, instead of `:', as directory -separator on these systems. +This would cause TeX to look for `\input' file first in the current +directory, indicated by the `.', then in a hypothetical user's +`me/mylib' directory, and finally in a system directory.  -File: texinfo.info, Node: Overfull hboxes, Next: smallbook, Prev: Preparing for TeX, Up: Hardcopy +File: texinfo.info, Node: Overfull hboxes, Next: smallbook, Prev: Preparing for TeX, Up: Format/Print Hardcopy Overfull "hboxes" ================= @@ -1239,39 +506,26 @@ interprets as a long word that it cannot hyphenate, such as an electronic mail network address or a very long title. When this happens, TeX prints an error message like this: - Overfull @hbox (20.76302pt too wide) + Overfull \hbox (20.76302pt too wide) -(In TeX, lines are in "horizontal boxes", hence the term, "hbox". -`@hbox' is a TeX primitive not needed in the Texinfo language.) +(In TeX, lines are in "horizontal boxes", hence the term, "hbox". The +backslash, `\', is the TeX equivalent of `@'.) TeX also provides the line number in the Texinfo source file and the text of the offending line, which is marked at all the places that TeX -considered hyphenation. *Note Catching Errors with TeX Formatting: -Debugging with TeX, for more information about typesetting errors. +knows how to hyphenate words. *Note Catching Errors with TeX +Formatting: Debugging with TeX, for more information about typesetting +errors. If the Texinfo file has an overfull hbox, you can rewrite the sentence so the overfull hbox does not occur, or you can decide to leave it. A small excursion into the right margin often does not matter and may not even be noticeable. - If you have many overfull boxes and/or an antipathy to rewriting, you -can coerce TeX into greatly increasing the allowable interword spacing, -thus (if you're lucky) avoiding many of the bad line breaks, like this: - - @tex - \global\emergencystretch = .9\hsize - @end tex - -(You can adjust the fraction as needed.) This huge value for -`\emergencystretch' cannot be the default, since then the typeset -output would generally be of noticeably lower quality. The default -value is `.15\hsize'. `\hsize' is the TeX dimension containing the -current line width. - - For what overfull boxes you have, however, TeX will print a large, -ugly, black rectangle beside the line that contains the overfull hbox -unless told otherwise. This is so you will notice the location of the -problem if you are correcting a draft. + However, unless told otherwise, TeX will print a large, ugly, black +rectangle beside the line that contains the overfull hbox. This is so +you will notice the location of the problem if you are correcting a +draft. To prevent such a monstrosity from marring your final printout, write the following in the beginning of the Texinfo file on a line of its own, @@ -1280,7 +534,7 @@ before the `@titlepage' command: @finalout  -File: texinfo.info, Node: smallbook, Next: A4 Paper, Prev: Overfull hboxes, Up: Hardcopy +File: texinfo.info, Node: smallbook, Next: A4 Paper, Prev: Overfull hboxes, Up: Format/Print Hardcopy Printing "Small" Books ====================== @@ -1293,20 +547,719 @@ file, before the title page: @smallbook -(Since many books are about 7 by 9.25 inches, this command might better -have been called the `@regularbooksize' command, but it came to be -called the `@smallbook' command by comparison to the 8.5 by 11 inch -format.) +(Since regular sized books are often about 7 by 9.25 inches, this +command might better have been called the `@regularbooksize' command, +but it came to be called the `@smallbook' command by comparison to the +8.5 by 11 inch format.) If you write the `@smallbook' command between the start-of-header and end-of-header lines, the Texinfo mode TeX region formatting command, `texinfo-tex-region', will format the region in "small" book size (*note Start of Header::). - *Note small::, for information about commands that make it easier to -produce examples for a smaller manual. + The Free Software Foundation distributes printed copies of `The GNU +Emacs Manual' and other manuals in the "small" book size. *Note +`@smallexample' and `@smalllisp': smallexample & smalllisp, for +information about commands that make it easier to produce examples for +a smaller manual. + + Alternatively, to avoid embedding this physical paper size in your +document, use `texi2dvi' to format your document (*note Format with +texi2dvi::), and supply `-t @smallbook' as an argument. Then other +people do not have to change the document source file to format it +differently. + + +File: texinfo.info, Node: A4 Paper, Next: Cropmarks and Magnification, Prev: smallbook, Up: Format/Print Hardcopy + +Printing on A4 Paper +==================== + + You can tell TeX to typeset a document for printing on European size +A4 paper with the `@afourpaper' command. Write the command on a line +by itself between `@iftex' and `@end iftex' lines near the beginning of +the Texinfo file, before the title page: + + For example, this is how you would write the header for this manual: + + \input texinfo @c -*-texinfo-*- + @c %**start of header + @setfilename texinfo + @settitle Texinfo + @syncodeindex vr fn + @iftex + @afourpaper + @end iftex + @c %**end of header + + Alternatively, to avoid embedding this physical paper size in your +document, use `texi2dvi' to format your document (*note Format with +texi2dvi::), and supply `-t @afourpaper' as an argument. Then other +people do not have to change the document source file to format it +differently. + + Another alternative: put the `@afourpaper' command in the file +`texinfo.cnf' that TeX will read. (No need for `@iftex' there.) This +will automatically typeset all the Texinfo documents at your site with +that paper size in effect. + + +File: texinfo.info, Node: Cropmarks and Magnification, Prev: A4 Paper, Up: Format/Print Hardcopy + +Cropmarks and Magnification +=========================== + + You can attempt to direct TeX to print cropmarks at the corners of +pages with the `@cropmarks' command. Write the `@cropmarks' command on +a line by itself between `@iftex' and `@end iftex' lines near the +beginning of the Texinfo file, before the title page, like this: + + @iftex + @cropmarks + @end iftex + + This command is mainly for printers that typeset several pages on one +sheet of film; but you can attempt to use it to mark the corners of a +book set to 7 by 9.25 inches with the `@smallbook' command. (Printers +will not produce cropmarks for regular sized output that is printed on +regular sized paper.) Since different printing machines work in +different ways, you should explore the use of this command with a +spirit of adventure. You may have to redefine the command in the +`texinfo.tex' definitions file. + + You can attempt to direct TeX to typeset pages larger or smaller than +usual with the `\mag' TeX command. Everything that is typeset is +scaled proportionally larger or smaller. (`\mag' stands for +"magnification".) This is _not_ a Texinfo @-command, but is a plain +TeX command that is prefixed with a backslash. You have to write this +command between `@tex' and `@end tex' (*note Raw Formatter Commands::). + + Follow the `\mag' command with an `=' and then a number that is 1000 +times the magnification you desire. For example, to print pages at 1.2 +normal size, write the following near the beginning of the Texinfo +file, before the title page: + + @tex + \mag=1200 + @end tex + + With some printing technologies, you can print normal-sized copies +that look better than usual by using a larger-than-normal master. + + Depending on your system, `\mag' may not work or may work only at +certain magnifications. Be prepared to experiment. + + +File: texinfo.info, Node: Create an Info File, Next: Install an Info File, Prev: Format/Print Hardcopy, Up: Top + +Creating an Info File +********************* + + `makeinfo' is a utility that converts a Texinfo file into an Info +file; `texinfo-format-region' and `texinfo-format-buffer' are GNU Emacs +functions that do the same. + + A Texinfo file must contain an `@setfilename' line near its +beginning, otherwise the Info formatting commands will fail. + + For information on installing the Info file in the Info system, see +*Note Install an Info File::. + +* Menu: + +* makeinfo advantages:: `makeinfo' provides better error checking. +* Invoking makeinfo:: How to run `makeinfo' from a shell. +* makeinfo options:: Specify fill-column and other options. +* Pointer Validation:: How to check that pointers point somewhere. +* makeinfo in Emacs:: How to run `makeinfo' from Emacs. +* texinfo-format commands:: Two Info formatting commands written + in Emacs Lisp are an alternative + to `makeinfo'. +* Batch Formatting:: How to format for Info in Emacs Batch mode. +* Tag and Split Files:: How tagged and split files help Info + to run better. + + +File: texinfo.info, Node: makeinfo advantages, Next: Invoking makeinfo, Prev: Create an Info File, Up: Create an Info File + +`makeinfo' Preferred +==================== + + The `makeinfo' utility creates an Info file from a Texinfo source +file more quickly than either of the Emacs formatting commands and +provides better error messages. We recommend it. `makeinfo' is a C +program that is independent of Emacs. You do not need to run Emacs to +use `makeinfo', which means you can use `makeinfo' on machines that are +too small to run Emacs. You can run `makeinfo' in any one of three +ways: from an operating system shell, from a shell inside Emacs, or by +typing a key command in Texinfo mode in Emacs. + + The `texinfo-format-region' and the `texinfo-format-buffer' commands +are useful if you cannot run `makeinfo'. Also, in some circumstances, +they format short regions or buffers more quickly than `makeinfo'. + + +File: texinfo.info, Node: Invoking makeinfo, Next: makeinfo options, Prev: makeinfo advantages, Up: Create an Info File + +Running `makeinfo' from a Shell +=============================== + + To create an Info file from a Texinfo file, type `makeinfo' followed +by the name of the Texinfo file. Thus, to create the Info file for +Bison, type the following to the shell: is the prompt): + + makeinfo bison.texinfo + + (You can run a shell inside Emacs by typing `M-x shell'.) + + Sometimes you will want to specify options. For example, if you wish +to discover which version of `makeinfo' you are using, type: + + makeinfo --version + + *Note makeinfo options::, for more information. + + +File: texinfo.info, Node: makeinfo options, Next: Pointer Validation, Prev: Invoking makeinfo, Up: Create an Info File + +Options for `makeinfo' +====================== + + The `makeinfo' command takes a number of options. Most often, +options are used to set the value of the fill column and specify the +footnote style. Each command line option is a word preceded by `--' or +a letter preceded by `-'. You can use abbreviations for the long +option names as long as they are unique. + + For example, you could use the following shell command to create an +Info file for `bison.texinfo' in which each line is filled to only 68 +columns: + + makeinfo --fill-column=68 bison.texinfo + + You can write two or more options in sequence, like this: + + makeinfo --no-split --fill-column=70 ... + +This would keep the Info file together as one possibly very long file +and would also set the fill column to 70. + + The options are: + +`-D VAR' + Cause the variable VAR to be defined. This is equivalent to `@set + VAR' in the Texinfo file (*note set clear value::). + +`--error-limit=LIMIT' + Set the maximum number of errors that `makeinfo' will report + before exiting (on the assumption that continuing would be + useless); default 100. + +`--fill-column=WIDTH' + Specify the maximum number of columns in a line; this is the + right-hand edge of a line. Paragraphs that are filled will be + filled to this width. (Filling is the process of breaking up and + connecting lines so that lines are the same length as or shorter + than the number specified as the fill column. Lines are broken + between words.) The default value is 72. + +`--footnote-style=STYLE' + Set the footnote style to STYLE, either `end' for the end node + style (the default) or `separate' for the separate node style. + The value set by this option overrides the value set in a Texinfo + file by an `@footnotestyle' command (*note Footnotes::). When the + footnote style is `separate', `makeinfo' makes a new node + containing the footnotes found in the current node. When the + footnote style is `end', `makeinfo' places the footnote references + at the end of the current node. + +`--force' + Ordinarily, if the input file has errors, the output files are not + created. With this option, they are preserved. + +`--help' + Print a usage message listing all available options, then exit + successfully. + +`-I DIR' + Add `dir' to the directory search list for finding files that are + included using the `@include' command. By default, `makeinfo' + searches only the current directory. + +`--no-headers' + Do not include menus or node lines in the output. This results in + an ASCII file that you cannot read in Info since it does not + contain the requisite nodes or menus. It is primarily useful to + extract certain pieces of a manual into separate files to be + included in a distribution, such as `INSTALL' files. + +`--no-split' + Suppress the splitting stage of `makeinfo'. By default, large + output files (where the size is greater than 70k bytes) are split + into smaller subfiles, each one approximately 50k bytes. + +`--no-pointer-validate' +`--no-validate' + Suppress the pointer-validation phase of `makeinfo'. Normally, + after a Texinfo file is processed, some consistency checks are + made to ensure that cross references can be resolved, etc. *Note + Pointer Validation::. + +`--no-warn' + Suppress warning messages (but _not_ error messages). You might + want this if the file you are creating has examples of Texinfo + cross references within it, and the nodes that are referenced do + not actually exist. + +`--no-number-footnotes' + Suppress automatic footnote numbering. By default, `makeinfo' + numbers each footnote sequentially in a single node, resetting the + current footnote number to 1 at the start of each node. + +`--output=FILE' +`-o FILE' + Specify that the output should be directed to FILE and not to the + file name specified in the `@setfilename' command found in the + Texinfo source (*note setfilename::). If FILE is `-', output goes + to standard output and `--no-split' is implied. + +`-P DIR' + Prepend `dir' to the directory search list for `@include'. See + `-I' for more details. + +`--paragraph-indent=INDENT' + Set the paragraph indentation style to INDENT. The value set by + this option overrides the value set in a Texinfo file by an + `@paragraphindent' command (*note paragraphindent::). The value + of INDENT is interpreted as follows: + + `asis' + Preserve any existing indentation at the starts of paragraphs. + + `0' or `none' + Delete any existing indentation. + + NUM + Indent each paragraph by that number of spaces. + +`--reference-limit=LIMIT' + Set the value of the number of references to a node that + `makeinfo' will make without reporting a warning. If a node has + more than this number of references in it, `makeinfo' will make the + references but also report a warning. The default is 1000. + +`-U VAR' + Cause VAR to be undefined. This is equivalent to `@clear VAR' in + the Texinfo file (*note set clear value::). + +`--verbose' + Cause `makeinfo' to display messages saying what it is doing. + Normally, `makeinfo' only outputs messages if there are errors or + warnings. + +`--version' + Print the version number, then exit successfully. + + +File: texinfo.info, Node: Pointer Validation, Next: makeinfo in Emacs, Prev: makeinfo options, Up: Create an Info File + +Pointer Validation +================== + + If you do not suppress pointer-validation, `makeinfo' will check the +validity of the final Info file. Mostly, this means ensuring that +nodes you have referenced really exist. Here is a complete list of what +is checked: + + 1. If a `Next', `Previous', or `Up' node reference is a reference to a + node in the current file and is not an external reference such as + to `(dir)', then the referenced node must exist. + + 2. In every node, if the `Previous' node is different from the `Up' + node, then the `Previous' node must also be pointed to by a `Next' + node. + + 3. Every node except the `Top' node must have an `Up' pointer. + + 4. The node referenced by an `Up' pointer must contain a reference to + the current node in some manner other than through a `Next' + reference. This includes menu entries and cross references. + + 5. If the `Next' reference of a node is not the same as the `Next' + reference of the `Up' reference, then the node referenced by the + `Next' pointer must have a `Previous' pointer that points back to + the current node. This rule allows the last node in a section to + point to the first node of the next chapter. + + +File: texinfo.info, Node: makeinfo in Emacs, Next: texinfo-format commands, Prev: Pointer Validation, Up: Create an Info File + +Running `makeinfo' inside Emacs +=============================== + + You can run `makeinfo' in GNU Emacs Texinfo mode by using either the +`makeinfo-region' or the `makeinfo-buffer' commands. In Texinfo mode, +the commands are bound to `C-c C-m C-r' and `C-c C-m C-b' by default. + +`C-c C-m C-r' +`M-x makeinfo-region' + Format the current region for Info. + +`C-c C-m C-b' +`M-x makeinfo-buffer' + Format the current buffer for Info. + + When you invoke either `makeinfo-region' or `makeinfo-buffer', Emacs +prompts for a file name, offering the name of the visited file as the +default. You can edit the default file name in the minibuffer if you +wish, before pressing to start the `makeinfo' process. + + The Emacs `makeinfo-region' and `makeinfo-buffer' commands run the +`makeinfo' program in a temporary shell buffer. If `makeinfo' finds +any errors, Emacs displays the error messages in the temporary buffer. + + You can parse the error messages by typing `C-x `' (`next-error'). +This causes Emacs to go to and position the cursor on the line in the +Texinfo source that `makeinfo' thinks caused the error. *Note Running +`make' or Compilers Generally: (xemacs)Compilation, for more +information about using the `next-error' command. + + In addition, you can kill the shell in which the `makeinfo' command +is running or make the shell buffer display its most recent output. + +`C-c C-m C-k' +`M-x makeinfo-kill-job' + Kill the current running `makeinfo' job created by + `makeinfo-region' or `makeinfo-buffer'. + +`C-c C-m C-l' +`M-x makeinfo-recenter-output-buffer' + Redisplay the `makeinfo' shell buffer to display its most recent + output. + +(Note that the parallel commands for killing and recentering a TeX job +are `C-c C-t C-k' and `C-c C-t C-l'. *Note Texinfo Mode Printing::.) + + You can specify options for `makeinfo' by setting the +`makeinfo-options' variable with either the `M-x edit-options' or the +`M-x set-variable' command, or by setting the variable in your `.emacs' +initialization file. + + For example, you could write the following in your `.emacs' file: + + (setq makeinfo-options + "--paragraph-indent=0 --no-split + --fill-column=70 --verbose") + +For more information, see +*Note Editing Variable Values: (xemacs)Edit Options, +*Note Examining and Setting Variables: (xemacs)Examining, +*Note Init File: (xemacs)Init File, and +*Note Options for `makeinfo': makeinfo options. + + +File: texinfo.info, Node: texinfo-format commands, Next: Batch Formatting, Prev: makeinfo in Emacs, Up: Create an Info File + +The `texinfo-format...' Commands +================================ + +In GNU Emacs in Texinfo mode, you can format part or all of a Texinfo +file with the `texinfo-format-region' command. This formats the +current region and displays the formatted text in a temporary buffer +called `*Info Region*'. + + Similarly, you can format a buffer with the `texinfo-format-buffer' +command. This command creates a new buffer and generates the Info file +in it. Typing `C-x C-s' will save the Info file under the name +specified by the `@setfilename' line which must be near the beginning +of the Texinfo file. + +`C-c C-e C-r' +``texinfo-format-region'' + Format the current region for Info. + +`C-c C-e C-b' +``texinfo-format-buffer'' + Format the current buffer for Info. + + The `texinfo-format-region' and `texinfo-format-buffer' commands +provide you with some error checking, and other functions can provide +you with further help in finding formatting errors. These procedures +are described in an appendix; see *Note Catching Mistakes::. However, +the `makeinfo' program is often faster and provides better error +checking (*note makeinfo in Emacs::). + + +File: texinfo.info, Node: Batch Formatting, Next: Tag and Split Files, Prev: texinfo-format commands, Up: Create an Info File + +Batch Formatting +================ + + You can format Texinfo files for Info using `batch-texinfo-format' +and Emacs Batch mode. You can run Emacs in Batch mode from any shell, +including a shell inside of Emacs. (*Note Command Line Switches and +Arguments: (xemacs)Command Switches.) + + Here is a shell command to format all the files that end in +`.texinfo' in the current directory: + + emacs -batch -funcall batch-texinfo-format *.texinfo + +Emacs processes all the files listed on the command line, even if an +error occurs while attempting to format some of them. + + Run `batch-texinfo-format' only with Emacs in Batch mode as shown; it +is not interactive. It kills the Batch mode Emacs on completion. + + `batch-texinfo-format' is convenient if you lack `makeinfo' and want +to format several Texinfo files at once. When you use Batch mode, you +create a new Emacs process. This frees your current Emacs, so you can +continue working in it. (When you run `texinfo-format-region' or +`texinfo-format-buffer', you cannot use that Emacs for anything else +until the command finishes.) + + +File: texinfo.info, Node: Tag and Split Files, Prev: Batch Formatting, Up: Create an Info File + +Tag Files and Split Files +========================= + + If a Texinfo file has more than 30,000 bytes, `texinfo-format-buffer' +automatically creates a tag table for its Info file; `makeinfo' always +creates a tag table. With a "tag table", Info can jump to new nodes +more quickly than it can otherwise. + + In addition, if the Texinfo file contains more than about 70,000 +bytes, `texinfo-format-buffer' and `makeinfo' split the large Info file +into shorter "indirect" subfiles of about 50,000 bytes each. Big files +are split into smaller files so that Emacs does not need to make a +large buffer to hold the whole of a large Info file; instead, Emacs +allocates just enough memory for the small, split off file that is +needed at the time. This way, Emacs avoids wasting memory when you run +Info. (Before splitting was implemented, Info files were always kept +short and "include files" were designed as a way to create a single, +large printed manual out of the smaller Info files. *Note Include +Files::, for more information. Include files are still used for very +large documents, such as `The XEmacs Lisp Reference Manual', in which +each chapter is a separate file.) + + When a file is split, Info itself makes use of a shortened version of +the original file that contains just the tag table and references to +the files that were split off. The split off files are called +"indirect" files. + + The split off files have names that are created by appending `-1', +`-2', `-3' and so on to the file name specified by the `@setfilename' +command. The shortened version of the original file continues to have +the name specified by `@setfilename'. + + At one stage in writing this document, for example, the Info file was +saved as `test-texinfo' and that file looked like this: + + Info file: test-texinfo, -*-Text-*- + produced by texinfo-format-buffer + from file: new-texinfo-manual.texinfo + + ^_ + Indirect: + test-texinfo-1: 102 + test-texinfo-2: 50422 + test-texinfo-3: 101300 + ^_^L + Tag table: + (Indirect) + Node: overview^?104 + Node: info file^?1271 + Node: printed manual^?4853 + Node: conventions^?6855 + ... + +(But `test-texinfo' had far more nodes than are shown here.) Each of +the split off, indirect files, `test-texinfo-1', `test-texinfo-2', and +`test-texinfo-3', is listed in this file after the line that says +`Indirect:'. The tag table is listed after the line that says `Tag +table:'. + + In the list of indirect files, the number following the file name +records the cumulative number of bytes in the preceding indirect files, +not counting the file list itself, the tag table, or the permissions +text in each file. In the tag table, the number following the node name +records the location of the beginning of the node, in bytes from the +beginning. + + If you are using `texinfo-format-buffer' to create Info files, you +may want to run the `Info-validate' command. (The `makeinfo' command +does such a good job on its own, you do not need `Info-validate'.) +However, you cannot run the `M-x Info-validate' node-checking command +on indirect files. For information on how to prevent files from being +split and how to validate the structure of the nodes, see *Note Using +Info-validate::. + + +File: texinfo.info, Node: Install an Info File, Next: Command List, Prev: Create an Info File, Up: Top + +Installing an Info File +*********************** + + Info files are usually kept in the `info' directory. You can read +Info files using the standalone Info program or the Info reader built +into Emacs. (*note info: (info)Top, for an introduction to Info.) + +* Menu: + +* Directory file:: The top level menu for all Info files. +* New Info File:: Listing a new info file. +* Other Info Directories:: How to specify Info files that are + located in other directories. +* Installing Dir Entries:: How to specify what menu entry to add + to the Info directory. +* Invoking install-info:: `install-info' options. + + +File: texinfo.info, Node: Directory file, Next: New Info File, Prev: Install an Info File, Up: Install an Info File + +The `dir' File +============== + + For Info to work, the `info' directory must contain a file that +serves as a top level directory for the Info system. By convention, +this file is called `dir'. (You can find the location of this file +within Emacs by typing `C-h i' to enter Info and then typing `C-x C-f' +to see the pathname to the `info' directory.) + + The `dir' file is itself an Info file. It contains the top level +menu for all the Info files in the system. The menu looks like this: + + * Menu: + + * Info: (info). Documentation browsing system. + * Emacs: (emacs). The extensible, self-documenting + text editor. + * Texinfo: (texinfo). With one source file, make + either a printed manual using + TeX or an Info file. + ... + + Each of these menu entries points to the `Top' node of the Info file +that is named in parentheses. (The menu entry does not need to specify +the `Top' node, since Info goes to the `Top' node if no node name is +mentioned. *Note Nodes in Other Info Files: Other Info Files.) + + Thus, the `Info' entry points to the `Top' node of the `info' file +and the `Emacs' entry points to the `Top' node of the `emacs' file. + + In each of the Info files, the `Up' pointer of the `Top' node refers +back to the `dir' file. For example, the line for the `Top' node of +the Emacs manual looks like this in Info: + + File: emacs Node: Top, Up: (DIR), Next: Distrib + +(Note that in this case, the `dir' file name is written in upper case +letters--it can be written in either upper or lower case. Info has a +feature that it will change the case of the file name to lower case if +it cannot find the name as written.) + + +File: texinfo.info, Node: New Info File, Next: Other Info Directories, Prev: Directory file, Up: Install an Info File + +Listing a New Info File +======================= + + To add a new Info file to your system, you must write a menu entry to +add to the menu in the `dir' file in the `info' directory. For +example, if you were adding documentation for GDB, you would write the +following new entry: + + * GDB: (gdb). The source-level C debugger. + +The first part of the menu entry is the menu entry name, followed by a +colon. The second part is the name of the Info file, in parentheses, +followed by a period. The third part is the description. + + The name of an Info file often has a `.info' extension. Thus, the +Info file for GDB might be called either `gdb' or `gdb.info'. The Info +reader programs automatically try the file name both with and without +`.info'; so it is better to avoid clutter and not to write `.info' +explicitly in the menu entry. For example, the GDB menu entry should +use just `gdb' for the file name, not `gdb.info'. + + +File: texinfo.info, Node: Other Info Directories, Next: Installing Dir Entries, Prev: New Info File, Up: Install an Info File + +Info Files in Other Directories +=============================== + + If an Info file is not in the `info' directory, there are three ways +to specify its location: + + * Write the pathname in the `dir' file as the second part of the + menu. + + * If you are using Emacs, list the name of the file in a second `dir' + file, in its directory; and then add the name of that directory to + the `Info-directory-list' variable in your personal or site + initialization file. + + This tells Emacs where to look for `dir' files. Emacs merges the + files named `dir' from each of the listed directories. (In Emacs + version 18, you can set the `Info-directory' variable to the name + of only one directory.) + + * Specify the Info directory name in the `INFOPATH' environment + variable in your `.profile' or `.cshrc' initialization file. + (Only you and others who set this environment variable will be + able to find Info files whose location is specified this way.) + + For example, to reach a test file in the `/home/bob/manuals' +directory, you could add an entry like this to the menu in the `dir' +file: + + * Test: (/home/bob/manuals/info-test). Bob's own test file. + +In this case, the absolute file name of the `info-test' file is written +as the second part of the menu entry. + + Alternatively, you could write the following in your `.emacs' file: + + (setq Info-directory-list + '("/home/bob/manuals" + "/usr/local/info")) + + This tells Emacs to merge the `dir' file from the `/home/bob/manuals' +directory with the `dir' file from the `/usr/local/info' directory. +Info will list the `/home/bob/manuals/info-test' file as a menu entry +in the `/home/bob/manuals/dir' file. + + Finally, you can tell Info where to look by setting the `INFOPATH' +environment variable in your `.cshrc' or `.profile' file. If you use a +Bourne-compatible shell such as `sh' or `bash' for your shell command +interpreter, you set the `INFOPATH' environment variable in the +`.profile' initialization file; but if you use `csh' or `tcsh', you +must set the variable in the `.cshrc' initialization file. The two +types of shells use different syntax. + + * In a `.cshrc' file, you could set the `INFOPATH' variable as + follows: + + setenv INFOPATH .:~/manuals:/usr/local/emacs/info + + * In a `.profile' file, you would achieve the same effect by writing: + + INFOPATH=.:$HOME/manuals:/usr/local/emacs/info + export INFOPATH + +The `.' indicates the current directory as usual. Emacs uses the +`INFOPATH' environment variable to initialize the value of Emacs's own +`Info-directory-list' variable. + + However you set `INFOPATH', if its last character is a colon, this is +replaced by the default (compiled-in) path. This gives you a way to +augment the default path with new directories without having to list all +the standard places. For example (using `sh' syntax: + + INFOPATH=/local/info: + export INFOPATH - *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing -for TeX, for other ways to format with `@smallbook' that do not require -changing the source file. +will search `/local/info' first, then the standard directories. +Leading or doubled colons are not treated specially. diff --git a/info/texinfo.info-9 b/info/texinfo.info-9 index 58344b0..8448388 100644 --- a/info/texinfo.info-9 +++ b/info/texinfo.info-9 @@ -4,19 +4,19 @@ texinfo.texi. INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Update info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. -* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. +* install-info: (texinfo)Invoking install-info. Updating info/dir entries. +* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. +* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. END-INFO-DIR-ENTRY This file documents Texinfo, a documentation system that can produce -both online information and a printed manual from a single source file. +both on-line information and a printed manual from a single source file. - Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software + Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software Foundation, Inc. - This edition is for Texinfo version 4.0, 28 September 1999. + This edition is for Texinfo version 3.12. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -33,930 +33,10 @@ versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.  -File: texinfo.info, Node: A4 Paper, Next: pagesizes, Prev: smallbook, Up: Hardcopy - -Printing on A4 Paper -==================== - - You can tell TeX to format a document for printing on European size -A4 paper with the `@afourpaper' command. Write the command on a line -by itself near the beginning of the Texinfo file, before the title -page. For example, this is how you would write the header for this -manual: - - \input texinfo @c -*-texinfo-*- - @c %**start of header - @setfilename texinfo - @settitle Texinfo - @afourpaper - @c %**end of header - - *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing -for TeX, for other ways to format with `@afourpaper' that do not -require changing the source file. - - You may or may not prefer the formatting that results from the command -`@afourlatex'. There's also `@afourwide' for A4 paper in wide format. - - -File: texinfo.info, Node: pagesizes, Next: Cropmarks and Magnification, Prev: A4 Paper, Up: Hardcopy - -`@pagesizes' [WIDTH][, HEIGHT]: Custom page sizes -================================================= - - You can explicitly specify the height and (optionally) width of the -main text area on the page with the `@pagesizes' command. Write this -on a line by itself near the beginning of the Texinfo file, before the -title page. The height comes first, then the width if desired, -separated by a comma. Examples: - - @pagesizes 200mm,150mm - and - @pagesizes 11.5in - - This would be reasonable for printing on B5-size paper. To emphasize, -this command specifies the size of the _text area_, not the size of the -paper (which is 250mm by 177mm for B5, 14in by 8.5in for legal). - - To make more elaborate changes, such as changing any of the page -margins, you must define a new command in `texinfo.tex' (or -`texinfo.cnf', *note Preparing for TeX: Preparing for TeX.). - - *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing -for TeX, for other ways to specify `@pagesizes' that do not require -changing the source file. - - `@pagesizes' is ignored by `makeinfo'. - - -File: texinfo.info, Node: Cropmarks and Magnification, Next: PDF Output, Prev: pagesizes, Up: Hardcopy - -Cropmarks and Magnification -=========================== - - You can (attempt to) direct TeX to print cropmarks at the corners of -pages with the `@cropmarks' command. Write the `@cropmarks' command on -a line by itself between `@iftex' and `@end iftex' lines near the -beginning of the Texinfo file, before the title page, like this: - - @iftex - @cropmarks - @end iftex - - This command is mainly for printers that typeset several pages on one -sheet of film; but you can attempt to use it to mark the corners of a -book set to 7 by 9.25 inches with the `@smallbook' command. (Printers -will not produce cropmarks for regular sized output that is printed on -regular sized paper.) Since different printing machines work in -different ways, you should explore the use of this command with a -spirit of adventure. You may have to redefine the command in -`texinfo.tex'. - - You can attempt to direct TeX to typeset pages larger or smaller than -usual with the `\mag' TeX command. Everything that is typeset is -scaled proportionally larger or smaller. (`\mag' stands for -"magnification".) This is _not_ a Texinfo @-command, but is a plain -TeX command that is prefixed with a backslash. You have to write this -command between `@tex' and `@end tex' (*note Raw Formatter Commands::). - - Follow the `\mag' command with an `=' and then a number that is 1000 -times the magnification you desire. For example, to print pages at 1.2 -normal size, write the following near the beginning of the Texinfo -file, before the title page: - - @tex - \mag=1200 - @end tex - - With some printing technologies, you can print normal-sized copies -that look better than usual by giving a larger-than-normal master to -your print shop. They do the reduction, thus effectively increasing the -resolution. - - Depending on your system, DVI files prepared with a -nonstandard-`\mag' may not print or may print only with certain -magnifications. Be prepared to experiment. - - -File: texinfo.info, Node: PDF Output, Prev: Cropmarks and Magnification, Up: Hardcopy - -PDF Output -========== - - You can generate a PDF output file from Texinfo source by using the -`pdftex' program to process your file instead of plain `tex'. Just run -`pdftex foo.texi' instead of `tex foo.texi', or give the `--pdf' option -to `texi2dvi'. - - PDF stands for Portable Document Format, and was invented by Adobe -Systems. The file format definition -(http://www.adobe.com/prodindex/acrobat/adobepdf.html) is freely -available, as is a free viewer (http://www.foolabs.com/xpdf/) for the X -window system. Since PDF is a binary format, there is no `@ifpdf' or -`@pdf' command by analogy with the other output formats. - - Despite the `portable' in the name, PDF files are nowhere near as -portable in practice as the plain ASCII formats (Info, HTML) Texinfo -also supports (portability relative to DVI is arguable). They also tend -to be much larger and do not support the bitmap fonts used by TeX (by -default) very well. Nevertheless, a PDF file does preserve an actual -printed document on a screen as faithfully as possible, unlike HTML, -say, so have their place. - - PDF support in Texinfo is fairly rudimentary. - - -File: texinfo.info, Node: Creating and Installing Info Files, Next: Command List, Prev: Hardcopy, Up: Top - -Creating and Installing Info Files -********************************** - - This chapter describes how to create and install info files. *Note -Info Files::, for general information about the file format itself. - -* Menu: - -* Creating an Info File:: -* Install an Info File:: - - -File: texinfo.info, Node: Creating an Info File, Next: Install an Info File, Up: Creating and Installing Info Files - -Creating an Info File -===================== - - `makeinfo' is a program that converts a Texinfo file into an Info -file, HTML file, or plain text. `texinfo-format-region' and -`texinfo-format-buffer' are GNU Emacs functions that convert Texinfo to -Info. - - For information on installing the Info file in the Info system, *note -Install an Info File::. - -* Menu: - -* makeinfo advantages:: `makeinfo' provides better error checking. -* Invoking makeinfo:: How to run `makeinfo' from a shell. -* makeinfo options:: Specify fill-column and other options. -* Pointer Validation:: How to check that pointers point somewhere. -* makeinfo in Emacs:: How to run `makeinfo' from Emacs. -* texinfo-format commands:: Two Info formatting commands written - in Emacs Lisp are an alternative - to `makeinfo'. -* Batch Formatting:: How to format for Info in Emacs Batch mode. -* Tag and Split Files:: How tagged and split files help Info - to run better. -* makeinfo html:: Generating HTML output. - - -File: texinfo.info, Node: makeinfo advantages, Next: Invoking makeinfo, Up: Creating an Info File - -`makeinfo' Preferred --------------------- - - The `makeinfo' utility creates an Info file from a Texinfo source -file more quickly than either of the Emacs formatting commands and -provides better error messages. We recommend it. `makeinfo' is a C -program that is independent of Emacs. You do not need to run Emacs to -use `makeinfo', which means you can use `makeinfo' on machines that are -too small to run Emacs. You can run `makeinfo' in any one of three -ways: from an operating system shell, from a shell inside Emacs, or by -typing the `C-c C-m C-r' or the `C-c C-m C-b' command in Texinfo mode -in Emacs. - - The `texinfo-format-region' and the `texinfo-format-buffer' commands -are useful if you cannot run `makeinfo'. Also, in some circumstances, -they format short regions or buffers more quickly than `makeinfo'. - - -File: texinfo.info, Node: Invoking makeinfo, Next: makeinfo options, Prev: makeinfo advantages, Up: Creating an Info File - -Running `makeinfo' from a Shell -------------------------------- - - To create an Info file from a Texinfo file, type `makeinfo' followed -by the name of the Texinfo file. Thus, to create the Info file for -Bison, type the following to the shell: - - makeinfo bison.texinfo - - (You can run a shell inside Emacs by typing `M-x shell'.) - - Sometimes you will want to specify options. For example, if you wish -to discover which version of `makeinfo' you are using, type: - - makeinfo --version - - *Note makeinfo options::, for more information. - - -File: texinfo.info, Node: makeinfo options, Next: Pointer Validation, Prev: Invoking makeinfo, Up: Creating an Info File - -Options for `makeinfo' ----------------------- - - The `makeinfo' command takes a number of options. Most often, -options are used to set the value of the fill column and specify the -footnote style. Each command line option is a word preceded by `--' or -a letter preceded by `-'. You can use abbreviations for the long -option names as long as they are unique. - - For example, you could use the following shell command to create an -Info file for `bison.texinfo' in which each line is filled to only 68 -columns: - - makeinfo --fill-column=68 bison.texinfo - - You can write two or more options in sequence, like this: - - makeinfo --no-split --fill-column=70 ... - -This would keep the Info file together as one possibly very long file -and would also set the fill column to 70. - - The options are: - -`-D VAR' - Cause the variable VAR to be defined. This is equivalent to `@set - VAR' in the Texinfo file (*note set clear value::). - -`--commands-in-node-names' - Allow `@'-commands in node names. This is not recommended, as it - can probably never be implemented in TeX. It also makes - `makeinfo' much slower. Also, this option is ignored when - `--no-validate' is used. *Note Pointer Validation::, for more - details. - -`--error-limit=LIMIT' -`-e LIMIT' - Set the maximum number of errors that `makeinfo' will report - before exiting (on the assumption that continuing would be - useless); default 100. - -`--fill-column=WIDTH' -`-f WIDTH' - Specify the maximum number of columns in a line; this is the - right-hand edge of a line. Paragraphs that are filled will be - filled to this width. (Filling is the process of breaking up and - connecting lines so that lines are the same length as or shorter - than the number specified as the fill column. Lines are broken - between words.) The default value is 72. Ignored with `--html'. - -`--footnote-style=STYLE' -`-s STYLE' - Set the footnote style to STYLE, either `end' for the end node - style (the default) or `separate' for the separate node style. - The value set by this option overrides the value set in a Texinfo - file by an `@footnotestyle' command (*note Footnotes::). When the - footnote style is `separate', `makeinfo' makes a new node - containing the footnotes found in the current node. When the - footnote style is `end', `makeinfo' places the footnote references - at the end of the current node. Ignored with `--html'. - -`--force' -`-F' - Ordinarily, if the input file has errors, the output files are not - created. With this option, they are preserved. - -`--help' -`-h' - Print a usage message listing all available options, then exit - successfully. - -`--html' - Generate HTML output rather than Info. *Note makeinfo html::. - -`-I DIR' - Append DIR to the directory search list for finding files that are - included using the `@include' command. By default, `makeinfo' - searches only the current directory. If DIR is not given, the - current directory `.' is appended. Note that DIR can actually be - a list of several directories separated by the usual path - separator character (`:' on Unix, `;' on MS-DOS/MS-Windows). - -`--macro-expand=FILE' -`-E FILE' - Output the Texinfo source with all the macros expanded to the named - file. Normally, the results of macro expansion are used - internally by `makeinfo' and then discarded. This option is used - by `texi2dvi' if you are using an old version of `texinfo.tex' - that does not support `@macro'. - -`--no-headers' - For Info output, do not include menus or node lines in the output - and write to standard output (unless `--output' is specified). - This results in an ASCII file that you cannot read in Info since - it does not contain the requisite nodes or menus. It is primarily - useful to extract certain pieces of a manual into separate files - to be included in a distribution, such as `INSTALL' files. - - For HTML output, if `--no-split' is also specified, do not include - a navigation links at the top of each node. *Note makeinfo html::. - -`--no-split' - Suppress the splitting stage of `makeinfo'. By default, large - output files (where the size is greater than 70k bytes) are split - into smaller subfiles. For Info output, each one is approximately - 50k bytes. For HTML output, each file contains one node (*note - makeinfo html::). - -`--no-pointer-validate' -`--no-validate' - Suppress the pointer-validation phase of `makeinfo'. This can also - be done with the `@novalidate' command (*note Use TeX: Use TeX.). - Normally, after a Texinfo file is processed, some consistency - checks are made to ensure that cross references can be resolved, - etc. *Note Pointer Validation::. - -`--no-warn' - Suppress warning messages (but _not_ error messages). You might - want this if the file you are creating has examples of Texinfo - cross references within it, and the nodes that are referenced do - not actually exist. - -`--number-sections' - Output chapter, section, and appendix numbers as in printed - manuals. - -`--no-number-footnotes' - Suppress automatic footnote numbering. By default, `makeinfo' - numbers each footnote sequentially in a single node, resetting the - current footnote number to 1 at the start of each node. - -`--output=FILE' -`-o FILE' - Specify that the output should be directed to FILE and not to the - file name specified in the `@setfilename' command found in the - Texinfo source (*note setfilename::). If FILE is `-', output goes - to standard output and `--no-split' is implied. For split HTML - output, FILE is the name of the output file for the top node - (*note makeinfo html::). - -`-P DIR' - Prepend DIR to the directory search list for `@include'. If DIR - is not given, the current directory `.' is prepended. See `-I' - for more details. - -`--paragraph-indent=INDENT' -`-p INDENT' - Set the paragraph indentation style to INDENT. The value set by - this option overrides the value set in a Texinfo file by an - `@paragraphindent' command (*note paragraphindent::). The value - of INDENT is interpreted as follows: - - `asis' - Preserve any existing indentation at the starts of paragraphs. - - `0' or `none' - Delete any existing indentation. - - NUM - Indent each paragraph by NUM spaces. - -`--reference-limit=LIMIT' -`-r LIMIT' - Set the value of the number of references to a node that - `makeinfo' will make without reporting a warning. If a node has - more than this number of references in it, `makeinfo' will make the - references but also report a warning. The default is 1000. - -`-U VAR' - Cause VAR to be undefined. This is equivalent to `@clear VAR' in - the Texinfo file (*note set clear value::). - -`--verbose' - Cause `makeinfo' to display messages saying what it is doing. - Normally, `makeinfo' only outputs messages if there are errors or - warnings. - -`--version' -`-V' - Print the version number, then exit successfully. - - -File: texinfo.info, Node: Pointer Validation, Next: makeinfo in Emacs, Prev: makeinfo options, Up: Creating an Info File - -Pointer Validation ------------------- - - If you do not suppress pointer validation with the `--no-validate' -option or the `@novalidate' command in the source file (*note Use TeX: -Use TeX.), `makeinfo' will check the validity of the final Info file. -Mostly, this means ensuring that nodes you have referenced really -exist. Here is a complete list of what is checked: - - 1. If a `Next', `Previous', or `Up' node reference is a reference to a - node in the current file and is not an external reference such as - to `(dir)', then the referenced node must exist. - - 2. In every node, if the `Previous' node is different from the `Up' - node, then the node pointed to by the `Previous' field must have a - `Next' field which points back to this node. - - 3. Every node except the `Top' node must have an `Up' pointer. - - 4. The node referenced by an `Up' pointer must itself reference the - current node through a menu item, unless the node referenced by - `Up' has the form `(FILE)'. - - 5. If the `Next' reference of a node is not the same as the `Next' - reference of the `Up' reference, then the node referenced by the - `Next' pointer must have a `Previous' pointer that points back to - the current node. This rule allows the last node in a section to - point to the first node of the next chapter. - - 6. Every node except `Top' should be referenced by at least one other - node, either via the `Previous' or `Next' links, or via a menu or a - cross-reference. - - Some Texinfo documents might fail during the validation phase because -they use commands like `@value' and `@definfoenclose' in node -definitions and cross-references inconsistently. Consider the -following example: - - @set nodename Node 1 - - @node @value{nodename}, Node 2, Top, Top - - This is node 1. - - @node Node 2, , Node 1, Top - - This is node 2. - -Here, the node "Node 1" was referenced both verbatim and through -`@value'. - - By default, `makeinfo' fails such cases, because node names are not -fully expanded until they are written to the output file. You should -always try to reference nodes consistently; e.g., in the above example, -the second `@node' line should have also used `@value'. However, if, -for some reason, you _must_ reference node names inconsistently, and -`makeinfo' fails to validate the file, you can use the -`--commands-in-node-names' option to force `makeinfo' to perform the -expensive expansion of all node names it finds in the document. This -might considerably slow down the program, though; twofold increase in -conversion time was measured for large documents such as the Jargon -file. - - The support for `@'-commands in `@node' directives is not general -enough to be freely used. For example, if the example above redefined -`nodename' somewhere in the document, `makeinfo' will fail to convert -it, even if invoked with the `--commands-in-node-names' option. - - `--commands-in-node-names' has no effect if the `--no-validate' -option is given. - - -File: texinfo.info, Node: makeinfo in Emacs, Next: texinfo-format commands, Prev: Pointer Validation, Up: Creating an Info File - -Running `makeinfo' inside Emacs -------------------------------- - - You can run `makeinfo' in GNU Emacs Texinfo mode by using either the -`makeinfo-region' or the `makeinfo-buffer' commands. In Texinfo mode, -the commands are bound to `C-c C-m C-r' and `C-c C-m C-b' by default. - -`C-c C-m C-r' -`M-x makeinfo-region' - Format the current region for Info. - -`C-c C-m C-b' -`M-x makeinfo-buffer' - Format the current buffer for Info. - - When you invoke either `makeinfo-region' or `makeinfo-buffer', Emacs -prompts for a file name, offering the name of the visited file as the -default. You can edit the default file name in the minibuffer if you -wish, before pressing to start the `makeinfo' process. - - The Emacs `makeinfo-region' and `makeinfo-buffer' commands run the -`makeinfo' program in a temporary shell buffer. If `makeinfo' finds -any errors, Emacs displays the error messages in the temporary buffer. - - You can parse the error messages by typing `C-x `' (`next-error'). -This causes Emacs to go to and position the cursor on the line in the -Texinfo source that `makeinfo' thinks caused the error. *Note Running -`make' or Compilers Generally: (emacs)Compilation, for more information -about using the `next-error' command. - - In addition, you can kill the shell in which the `makeinfo' command -is running or make the shell buffer display its most recent output. - -`C-c C-m C-k' -`M-x makeinfo-kill-job' - Kill the current running `makeinfo' job (from `makeinfo-region' or - `makeinfo-buffer'). - -`C-c C-m C-l' -`M-x makeinfo-recenter-output-buffer' - Redisplay the `makeinfo' shell buffer to display its most recent - output. - -(Note that the parallel commands for killing and recentering a TeX job -are `C-c C-t C-k' and `C-c C-t C-l'. *Note Texinfo Mode Printing::.) - - You can specify options for `makeinfo' by setting the -`makeinfo-options' variable with either the `M-x edit-options' or the -`M-x set-variable' command, or by setting the variable in your `.emacs' -initialization file. - - For example, you could write the following in your `.emacs' file: - - (setq makeinfo-options - "--paragraph-indent=0 --no-split - --fill-column=70 --verbose") - -For more information, see -*Note Editing Variable Values: (emacs)Edit Options, -*Note Examining and Setting Variables: (emacs)Examining, -*Note Init File: (emacs)Init File, and -*Note Options for `makeinfo': makeinfo options. - - -File: texinfo.info, Node: texinfo-format commands, Next: Batch Formatting, Prev: makeinfo in Emacs, Up: Creating an Info File - -The `texinfo-format...' Commands --------------------------------- - -In GNU Emacs in Texinfo mode, you can format part or all of a Texinfo -file with the `texinfo-format-region' command. This formats the -current region and displays the formatted text in a temporary buffer -called `*Info Region*'. - - Similarly, you can format a buffer with the `texinfo-format-buffer' -command. This command creates a new buffer and generates the Info file -in it. Typing `C-x C-s' will save the Info file under the name -specified by the `@setfilename' line which must be near the beginning -of the Texinfo file. - -`C-c C-e C-r' -``texinfo-format-region'' - Format the current region for Info. - -`C-c C-e C-b' -``texinfo-format-buffer'' - Format the current buffer for Info. - - The `texinfo-format-region' and `texinfo-format-buffer' commands -provide you with some error checking, and other functions can provide -you with further help in finding formatting errors. These procedures -are described in an appendix; see *Note Catching Mistakes::. However, -the `makeinfo' program is often faster and provides better error -checking (*note makeinfo in Emacs::). - - -File: texinfo.info, Node: Batch Formatting, Next: Tag and Split Files, Prev: texinfo-format commands, Up: Creating an Info File - -Batch Formatting ----------------- - - You can format Texinfo files for Info using `batch-texinfo-format' -and Emacs Batch mode. You can run Emacs in Batch mode from any shell, -including a shell inside of Emacs. (*Note Command Line Switches and -Arguments: (emacs)Command Switches.) - - Here is a shell command to format all the files that end in -`.texinfo' in the current directory: - - emacs -batch -funcall batch-texinfo-format *.texinfo - -Emacs processes all the files listed on the command line, even if an -error occurs while attempting to format some of them. - - Run `batch-texinfo-format' only with Emacs in Batch mode as shown; it -is not interactive. It kills the Batch mode Emacs on completion. - - `batch-texinfo-format' is convenient if you lack `makeinfo' and want -to format several Texinfo files at once. When you use Batch mode, you -create a new Emacs process. This frees your current Emacs, so you can -continue working in it. (When you run `texinfo-format-region' or -`texinfo-format-buffer', you cannot use that Emacs for anything else -until the command finishes.) - - -File: texinfo.info, Node: Tag and Split Files, Next: makeinfo html, Prev: Batch Formatting, Up: Creating an Info File - -Tag Files and Split Files -------------------------- - - If a Texinfo file has more than 30,000 bytes, `texinfo-format-buffer' -automatically creates a tag table for its Info file; `makeinfo' always -creates a tag table. With a "tag table", Info can jump to new nodes -more quickly than it can otherwise. - - In addition, if the Texinfo file contains more than about 70,000 -bytes, `texinfo-format-buffer' and `makeinfo' split the large Info file -into shorter "indirect" subfiles of about 50,000 bytes each. Big files -are split into smaller files so that Emacs does not need to make a -large buffer to hold the whole of a large Info file; instead, Emacs -allocates just enough memory for the small, split-off file that is -needed at the time. This way, Emacs avoids wasting memory when you run -Info. (Before splitting was implemented, Info files were always kept -short and "include files" were designed as a way to create a single, -large printed manual out of the smaller Info files. *Note Include -Files::, for more information. Include files are still used for very -large documents, such as `The Emacs Lisp Reference Manual', in which -each chapter is a separate file.) - - When a file is split, Info itself makes use of a shortened version of -the original file that contains just the tag table and references to -the files that were split off. The split-off files are called -"indirect" files. - - The split-off files have names that are created by appending `-1', -`-2', `-3' and so on to the file name specified by the `@setfilename' -command. The shortened version of the original file continues to have -the name specified by `@setfilename'. - - At one stage in writing this document, for example, the Info file was -saved as the file `test-texinfo' and that file looked like this: - - Info file: test-texinfo, -*-Text-*- - produced by texinfo-format-buffer - from file: new-texinfo-manual.texinfo - - ^_ - Indirect: - test-texinfo-1: 102 - test-texinfo-2: 50422 - test-texinfo-3: 101300 - ^_^L - Tag table: - (Indirect) - Node: overview^?104 - Node: info file^?1271 - Node: printed manual^?4853 - Node: conventions^?6855 - ... - -(But `test-texinfo' had far more nodes than are shown here.) Each of -the split-off, indirect files, `test-texinfo-1', `test-texinfo-2', and -`test-texinfo-3', is listed in this file after the line that says -`Indirect:'. The tag table is listed after the line that says `Tag -table:'. - - In the list of indirect files, the number following the file name -records the cumulative number of bytes in the preceding indirect files, -not counting the file list itself, the tag table, or the permissions -text in each file. In the tag table, the number following the node name -records the location of the beginning of the node, in bytes from the -beginning of the (unsplit) output. - - If you are using `texinfo-format-buffer' to create Info files, you -may want to run the `Info-validate' command. (The `makeinfo' command -does such a good job on its own, you do not need `Info-validate'.) -However, you cannot run the `M-x Info-validate' node-checking command -on indirect files. For information on how to prevent files from being -split and how to validate the structure of the nodes, see *Note Using -Info-validate::. - - -File: texinfo.info, Node: makeinfo html, Prev: Tag and Split Files, Up: Creating an Info File - -Generating HTML ---------------- - - As an alternative to the normal Info format output you can use the -`--html' option to generate output in HTML format, for installation on -a web site (for example). In this release, HTML output from `makeinfo' -is monolithic, splitting the output by chapter or node is not -supported. We hope to implement this feature soon. - - The HTML output file is named according to `@setfilename', but with -any `.info' extension replaced with `.html'. - - Texinfo input marked up with the `@ifhtml' command will produce -output only with the `--html' option supplied. Input marked up with -the `@html' is passed literally to the output (suppressing the normal -escaping of input `<', `>' and `&' characters which have special -significance in HTML). - - The `--footnote-style' option is currently ignored for HTML output; -footnotes are hyperlinked at the end of the output file. - - The HTML generated is mostly standard (i.e., HTML 2.0, RFC1866). The -exception is that HTML 3.2 tables are generated from the `@multitable' -command, but tagged to degrade as well as possible in browsers without -table support. Please report output from an error-free run of -`makeinfo' which violates the HTML 3.2 DTD as a bug. - - Navigation bars are inserted at the start of nodes, similarly to Info -output. The `--no-headers' option will suppress this if used with -`--no-split'. Header `' elements in split output can support -info-like navigation with browsers like Lynx and Emacs W3 which -implement this HTML 1.0 feature. You still won't normally get the -multi-file regexp and index search facilities provided by Info readers. -Otherwise, hyperlinks are generated from Texinfo commands where -appropriate. `@xref' commands to other documents are generated -assuming the other document is available in HTML form too, and `.html' -is appended to the `@xref' Info file name. This presumably will often -not work. - - -File: texinfo.info, Node: Install an Info File, Prev: Creating an Info File, Up: Creating and Installing Info Files - -Installing an Info File -======================= - - Info files are usually kept in the `info' directory. You can read -Info files using the standalone Info program or the Info reader built -into Emacs. (*note info: (info)Top, for an introduction to Info.) - -* Menu: - -* Directory File:: The top level menu for all Info files. -* New Info File:: Listing a new info file. -* Other Info Directories:: How to specify Info files that are - located in other directories. -* Installing Dir Entries:: How to specify what menu entry to add - to the Info directory. -* Invoking install-info:: `install-info' options. - - -File: texinfo.info, Node: Directory File, Next: New Info File, Up: Install an Info File - -The Directory File `dir' ------------------------- - - For Info to work, the `info' directory must contain a file that -serves as a top level directory for the Info system. By convention, -this file is called `dir'. (You can find the location of this file -within Emacs by typing `C-h i' to enter Info and then typing `C-x C-f' -to see the pathname to the `info' directory.) - - The `dir' file is itself an Info file. It contains the top level -menu for all the Info files in the system. The menu looks like this: - - * Menu: - * Info: (info). Documentation browsing system. - * Emacs: (emacs). The extensible, self-documenting - text editor. - * Texinfo: (texinfo). With one source file, make - either a printed manual using - TeX or an Info file. - ... - - Each of these menu entries points to the `Top' node of the Info file -that is named in parentheses. (The menu entry does not need to specify -the `Top' node, since Info goes to the `Top' node if no node name is -mentioned. *Note Nodes in Other Info Files: Other Info Files.) - - Thus, the `Info' entry points to the `Top' node of the `info' file -and the `Emacs' entry points to the `Top' node of the `emacs' file. - - In each of the Info files, the `Up' pointer of the `Top' node refers -back to the `dir' file. For example, the line for the `Top' node of -the Emacs manual looks like this in Info: - - File: emacs Node: Top, Up: (DIR), Next: Distrib - -In this case, the `dir' file name is written in upper case letters--it -can be written in either upper or lower case. This is not true in -general, it is a special case for `dir'. - - -File: texinfo.info, Node: New Info File, Next: Other Info Directories, Prev: Directory File, Up: Install an Info File - -Listing a New Info File ------------------------ - - To add a new Info file to your system, you must write a menu entry to -add to the menu in the `dir' file in the `info' directory. For -example, if you were adding documentation for GDB, you would write the -following new entry: - - * GDB: (gdb). The source-level C debugger. - -The first part of the menu entry is the menu entry name, followed by a -colon. The second part is the name of the Info file, in parentheses, -followed by a period. The third part is the description. - - The name of an Info file often has a `.info' extension. Thus, the -Info file for GDB might be called either `gdb' or `gdb.info'. The Info -reader programs automatically try the file name both with and without -`.info'(1) (*note New Info File-Footnote-1::); so it is better to avoid -clutter and not to write `.info' explicitly in the menu entry. For -example, the GDB menu entry should use just `gdb' for the file name, -not `gdb.info'. - - -File: texinfo.info, Node: New Info File-Footnotes, Up: New Info File - - (1) On MS-DOS/MS-Windows systems, Info will try the `.inf' extension -as well. - - -File: texinfo.info, Node: Other Info Directories, Next: Installing Dir Entries, Prev: New Info File, Up: Install an Info File - -Info Files in Other Directories -------------------------------- - - If an Info file is not in the `info' directory, there are three ways -to specify its location: - - 1. Write the pathname in the `dir' file as the second part of the - menu. - - 2. If you are using Emacs, list the name of the file in a second `dir' - file, in its directory; and then add the name of that directory to - the `Info-directory-list' variable in your personal or site - initialization file. - - This variable tells Emacs where to look for `dir' files (the files - must be named `dir'). Emacs merges the files named `dir' from - each of the listed directories. (In Emacs version 18, you can set - the `Info-directory' variable to the name of only one directory.) - - 3. Specify the Info directory name in the `INFOPATH' environment - variable in your `.profile' or `.cshrc' initialization file. - (Only you and others who set this environment variable will be - able to find Info files whose location is specified this way.) - - For example, to reach a test file in the `/home/bob/info' directory, -you could add an entry like this to the menu in the standard `dir' file: - - * Test: (/home/bob/info/info-test). Bob's own test file. - -In this case, the absolute file name of the `info-test' file is written -as the second part of the menu entry. - - Alternatively, you could write the following in your `.emacs' file: - - (require 'info) - (setq Info-directory-list - (cons (expand-file-name "/home/bob/info") Info-directory-list)) - - This tells Emacs to merge the `dir' file from the `/home/bob/info' -directory with the system `dir' file. Info will list the -`/home/bob/info/info-test' file as a menu entry in the -`/home/bob/info/dir' file. Emacs does the merging only when `M-x info' -is first run, so if you want to set `Info-directory-list' in an Emacs -session where you've already run `info', you must `(setq -Info-dir-contents nil)' to force Emacs to recompose the `dir' file. - - Finally, you can tell Info where to look by setting the `INFOPATH' -environment variable in your shell startup file, such as `.cshrc', -`.profile' or `autoexec.bat'. If you use a Bourne-compatible shell -such as `sh' or `bash' for your shell command interpreter, you set the -`INFOPATH' environment variable in the `.profile' initialization file; -but if you use `csh' or `tcsh', you set the variable in the `.cshrc' -initialization file. On MS-DOS/MS-Windows systems, you must set -`INFOPATH' in your `autoexec.bat' file or in the Registry. Each type -of shell uses a different syntax. - - * In a `.cshrc' file, you could set the `INFOPATH' variable as - follows: - - setenv INFOPATH .:~/info:/usr/local/emacs/info - - * In a `.profile' file, you would achieve the same effect by writing: - - INFOPATH=.:$HOME/info:/usr/local/emacs/info - export INFOPATH - - * In a `autoexec.bat' file, you write this command(1) (*note Other - Info Directories-Footnote-1::): - - set INFOPATH=.;%HOME%/info;c:/usr/local/emacs/info - -The `.' indicates the current directory as usual. Emacs uses the -`INFOPATH' environment variable to initialize the value of Emacs's own -`Info-directory-list' variable. The stand-alone Info reader merges any -files named `dir' in any directory listed in the `INFOPATH' variable -into a single menu presented to you in the node called `(dir)Top'. - - However you set `INFOPATH', if its last character is a colon(2) -(*note Other Info Directories-Footnote-2::), this is replaced by the -default (compiled-in) path. This gives you a way to augment the -default path with new directories without having to list all the -standard places. For example (using `sh' syntax): - - INFOPATH=/local/info: - export INFOPATH - -will search `/local/info' first, then the standard directories. -Leading or doubled colons are not treated specially. - - When you create your own `dir' file for use with -`Info-directory-list' or `INFOPATH', it's easiest to start by copying -an existing `dir' file and replace all the text after the `* Menu:' -with your desired entries. That way, the punctuation and special -CTRL-_ characters that Info needs will be present. - - -File: texinfo.info, Node: Other Info Directories-Footnotes, Up: Other Info Directories - - (1) Note the use of `;' as the directory separator, and a different -syntax for using values of other environment variables. - - (2) On MS-DOS/MS-Windows systems, use semi-colon instead. - - File: texinfo.info, Node: Installing Dir Entries, Next: Invoking install-info, Prev: Other Info Directories, Up: Install an Info File Installing Info Directory Files -------------------------------- +=============================== When you install an Info file onto your system, you can use the program `install-info' to update the Info directory file `dir'. @@ -964,11 +44,11 @@ Normally the makefile for the package runs `install-info', just after copying the Info file into its proper installed location. In order for the Info file to work with `install-info', you should -use the commands `@dircategory' and `@direntry'...`@end direntry' in -the Texinfo source file. Use `@direntry' to specify the menu entries -to add to the Info directory file, and use `@dircategory' to specify -which part of the Info directory to put it in. Here is how these -commands are used in this manual: +use the commands `@dircategory' and `@direntry' in the Texinfo source +file. Use `@direntry' to specify the menu entry to add to the Info +directory file, and use `@dircategory' to specify which part of the +Info directory to put it in. Here is how these commands are used in +this manual: @dircategory Texinfo documentation system @direntry @@ -994,45 +74,34 @@ beginning of the Texinfo input, before the first `@node' command. If you use them later on in the input, `install-info' will not notice them. If you use `@dircategory' more than once in the Texinfo source, each -usage specifies the `current' category; any subsequent `@direntry' -commands will add to that category. - - Here are some recommended `@dircategory' categories: `GNU packages', -`GNU programming tools', `GNU programming documentation', `GNU Emacs -Lisp', `GNU libraries', `Linux', `TeX', `Individual utilities'. The -idea is to include the `invoking' node for every program installed by a -package under `Individual utilities', and an entry for the manual as a -whole in the appropriate other category. +usage specifies one category; the new menu entry is added to the Info +directory file in each of the categories you specify. If you use +`@direntry' more than once, each usage specifies one menu entry; each +of these menu entries is added to the directory in each of the +specified categories.  File: texinfo.info, Node: Invoking install-info, Prev: Installing Dir Entries, Up: Install an Info File Invoking install-info ---------------------- +===================== `install-info' inserts menu entries from an Info file into the top-level `dir' file in the Info system (see the previous sections for an explanation of how the `dir' file works). It's most often run as -part of software installation, or when constructing a `dir' file for -all manuals on a system. Synopsis: +part of software installation, or when constructing a dir file for all +manuals on a system. Synopsis: install-info [OPTION]... [INFO-FILE [DIR-FILE]] - If INFO-FILE or DIR-FILE are not specified, the options (described -below) that define them must be. There are no compile-time defaults, -and standard input is never used. `install-info' can read only one -Info file and write only one `dir' file per invocation. + If INFO-FILE or DIR-FILE are not specified, the various options +(described below) that define them must be. There are no compile-time +defaults, and standard input is never used. `install-info' can read +only one info file and write only one dir file per invocation. If DIR-FILE (however specified) does not exist, `install-info' creates it if possible (with no entries). - If any input file is compressed with `gzip' (*note Invoking gzip: -(gzip)Invoking gzip.), `install-info' automatically uncompresses it for -reading. And if DIR-FILE is compressed, `install-info' also -automatically leaves it compressed after writing any changes. If -DIR-FILE itself does not exist, `install-info' tries to open -`DIR-FILE.gz'. - Options: `--delete' @@ -1041,12 +110,10 @@ DIR-FILE itself does not exist, `install-info' tries to open `.info' in either one). Don't insert any new entries. `--dir-file=NAME' -`-d NAME' Specify file name of the Info directory file. This is equivalent to using the DIR-FILE argument. `--entry=TEXT' -`-e TEXT' Insert TEXT as an Info directory entry; TEXT should have the form of an Info menu item line plus zero or more extra lines starting with whitespace. If you specify more than one entry, they are all @@ -1054,19 +121,15 @@ DIR-FILE itself does not exist, `install-info' tries to open information in the Info file itself. `--help' -`-h' Display a usage message listing basic usage and all available options, then exit successfully. `--info-file=FILE' -`-i FILE' - Specify Info file to install in the directory. Equivalent to - using the INFO-FILE argument. + Specify Info file to install in the directory. This is equivalent + to using the INFO-FILE argument. `--info-dir=DIR' -`-D DIR' - Specify the directory where `dir' resides. Equivalent to - `--dir-file=DIR/dir'. + Equivalent to `--dir-file=DIR/dir'. `--item=TEXT' Same as `--entry=TEXT'. An Info directory entry is actually a @@ -1076,17 +139,1006 @@ DIR-FILE itself does not exist, `install-info' tries to open Suppress warnings. `--remove' -`-r' Same as `--delete'. `--section=SEC' -`-s SEC' Put this file's entries in section SEC of the directory. If you specify more than one section, all the entries are added in each of the sections. If you don't specify any sections, they are determined from information in the Info file itself. `--version' -`-V' Display version information and exit successfully. + +File: texinfo.info, Node: Command List, Next: Tips, Prev: Install an Info File, Up: Top + +@-Command List +************** + + Here is an alphabetical list of the @-commands in Texinfo. Square +brackets, [ ], indicate optional arguments; an ellipsis, `...', +indicates repeated text. + + +`@WHITESPACE' + An `@' followed by a space, tab, or newline produces a normal, + stretchable, interword space. *Note Multiple Spaces::. + +`@!' + Generate an exclamation point that really does end a sentence + (usually after an end-of-sentence capital letter). *Note Ending a + Sentence::. + +`@"' +`@'' + Generate an umlaut or acute accent, respectively, over the next + character, as in o" and o'. *Note Inserting Accents::. + +`@*' + Force a line break. Do not end a paragraph that uses `@*' with an + `@refill' command. *Note Line Breaks::. + +`@,{C}' + Generate a cedilla accent under C, as in c,. *Note Inserting + Accents::. + +`@-' + Insert a discretionary hyphenation point. *Note - and + hyphenation::. + +`@.' + Produce a period that really does end a sentence (usually after an + end-of-sentence capital letter). *Note Ending a Sentence::. + +`@:' + Indicate to TeX that an immediately preceding period, question + mark, exclamation mark, or colon does not end a sentence. Prevent + TeX from inserting extra whitespace as it does at the end of a + sentence. The command has no effect on the Info file output. + *Note Not Ending a Sentence::. + +`@=' + Generate a macro (bar) accent over the next character, as in o=. + *Note Inserting Accents::. + +`@?' + Generate a question mark that really does end a sentence (usually + after an end-of-sentence capital letter). *Note Ending a + Sentence::. + +`@@' + Stands for an at sign, `@'. *Note Inserting @ and braces: Braces + Atsigns. + +`@^' +`@`' + Generate a circumflex (hat) or grave accent, respectively, over + the next character, as in o^. *Note Inserting Accents::. + +`@{' + Stands for a left brace, `{'. *Note Inserting @ and braces: + Braces Atsigns. + +`@}' + Stands for a right-hand brace, `}'. + *Note Inserting @ and braces: Braces Atsigns. + +`@=' + Generate a tilde accent over the next character, as in N~. *Note + Inserting Accents::. + +`@AA{}' +`@aa{}' + Generate the uppercase and lowercase Scandinavian A-ring letters, + respectively: AA, aa. *Note Inserting Accents::. + +`@AE{}' +`@ae{}' + Generate the uppercase and lowercase AE ligatures, respectively: + AE, ae. *Note Inserting Accents::. + +`@afourpaper' + Change page dimensions for the A4 paper size. Only allowed inside + `@iftex' ... `@end iftex'. *Note A4 Paper::. + +`@appendix TITLE' + Begin an appendix. The title appears in the table of contents of + a printed manual. In Info, the title is underlined with + asterisks. *Note The `@unnumbered' and `@appendix' Commands: + unnumbered & appendix. + +`@appendixsec TITLE' +`@appendixsection TITLE' + Begin an appendix section within an appendix. The section title + appears in the table of contents of a printed manual. In Info, + the title is underlined with equal signs. `@appendixsection' is a + longer spelling of the `@appendixsec' command. *Note Section + Commands: unnumberedsec appendixsec heading. + +`@appendixsubsec TITLE' + Begin an appendix subsection within an appendix. The title appears + in the table of contents of a printed manual. In Info, the title + is underlined with hyphens. *Note Subsection Commands: + unnumberedsubsec appendixsubsec subheading. + +`@appendixsubsubsec TITLE' + Begin an appendix subsubsection within an appendix subsection. The + title appears in the table of contents of a printed manual. In + Info, the title is underlined with periods. *Note The `subsub' + Commands: subsubsection. + +`@asis' + Used following `@table', `@ftable', and `@vtable' to print the + table's first column without highlighting ("as is"). *Note Making + a Two-column Table: Two-column Tables. + +`@author AUTHOR' + Typeset AUTHOR flushleft and underline it. *Note The `@title' and + `@author' Commands: title subtitle author. + +`@b{TEXT}' + Print TEXT in bold font. No effect in Info. *Note Fonts::. + +`@bullet{}' + Generate a large round dot, or the closest possible thing to one. + *Note `@bullet': bullet. + +`@bye' + Stop formatting a file. The formatters do not see the contents of + a file following an `@bye' command. *Note Ending a File::. + +`@c COMMENT' + Begin a comment in Texinfo. The rest of the line does not appear + in either the Info file or the printed manual. A synonym for + `@comment'. *Note Comments: Comments. + +`@cartouche' + Highlight an example or quotation by drawing a box with rounded + corners around it. Pair with `@end cartouche'. No effect in + Info. *Note Drawing Cartouches Around Examples: cartouche.) + +`@center LINE-OF-TEXT' + Center the line of text following the command. *Note `@center': + titlefont center sp. + +`@centerchap LINE-OF-TEXT' + Like `@chapter', but centers the chapter title. *Note `@chapter': + chapter. + +`@chapheading TITLE' + Print a chapter-like heading in the text, but not in the table of + contents of a printed manual. In Info, the title is underlined + with asterisks. *Note `@majorheading' and `@chapheading': + majorheading & chapheading. + +`@chapter TITLE' + Begin a chapter. The chapter title appears in the table of + contents of a printed manual. In Info, the title is underlined + with asterisks. *Note `@chapter': chapter. + +`@cindex ENTRY' + Add ENTRY to the index of concepts. *Note Defining the Entries of + an Index: Index Entries. + +`@cite{REFERENCE}' + Highlight the name of a book or other reference that lacks a + companion Info file. *Note `@cite': cite. + +`@clear FLAG' + Unset FLAG, preventing the Texinfo formatting commands from + formatting text between subsequent pairs of `@ifset FLAG' and + `@end ifset' commands, and preventing `@value{FLAG}' from + expanding to the value to which FLAG is set. *Note `@set' + `@clear' `@value': set clear value. + +`@code{SAMPLE-CODE}' + Highlight text that is an expression, a syntactically complete + token of a program, or a program name. *Note `@code': code. + +`@comment COMMENT' + Begin a comment in Texinfo. The rest of the line does not appear + in either the Info file or the printed manual. A synonym for `@c'. + *Note Comments: Comments. + +`@contents' + Print a complete table of contents. Has no effect in Info, which + uses menus instead. *Note Generating a Table of Contents: + Contents. + +`@copyright{}' + Generate a copyright symbol. *Note `@copyright': copyright symbol. + +`@defcodeindex INDEX-NAME' + Define a new index and its indexing command. Print entries in an + `@code' font. *Note Defining New Indices: New Indices. + +`@defcv CATEGORY CLASS NAME' +`@defcvx CATEGORY CLASS NAME' + Format a description for a variable associated with a class in + object-oriented programming. Takes three arguments: the category + of thing being defined, the class to which it belongs, and its + name. *Note Definition Commands::, and *Note Def Cmds in Detail: + deffnx. + +`@deffn CATEGORY NAME ARGUMENTS...' +`@deffnx CATEGORY NAME ARGUMENTS...' + Format a description for a function, interactive command, or + similar entity that may take arguments. `@deffn' takes as + arguments the category of entity being described, the name of this + particular entity, and its arguments, if any. *Note Definition + Commands::. + +`@defindex INDEX-NAME' + Define a new index and its indexing command. Print entries in a + roman font. *Note Defining New Indices: New Indices. + +`@definfoenclose NEW-COMMAND, BEFORE, AFTER,' + Create new @-command for Info that marks text by enclosing it in + strings that precede and follow the text. Write definition inside + of `@ifinfo' ... `@end ifinfo'. *Note Customized Highlighting::. + +`@defivar CLASS INSTANCE-VARIABLE-NAME' +`@defivarx CLASS INSTANCE-VARIABLE-NAME' + This command formats a description for an instance variable in + object-oriented programming. The command is equivalent to `@defcv + {Instance Variable} ...'. *Note Definition Commands::, and *Note + Def Cmds in Detail: deffnx. + +`@defmac MACRO-NAME ARGUMENTS...' +`@defmacx MACRO-NAME ARGUMENTS...' + Format a description for a macro. The command is equivalent to + `@deffn Macro ...'. *Note Definition Commands::, and *Note Def + Cmds in Detail: deffnx. + +`@defmethod CLASS METHOD-NAME ARGUMENTS...' +`@defmethodx CLASS METHOD-NAME ARGUMENTS...' + Format a description for a method in object-oriented programming. + The command is equivalent to `@defop Method ...'. Takes as + arguments the name of the class of the method, the name of the + method, and its arguments, if any. *Note Definition Commands::, + and *Note Def Cmds in Detail: deffnx. + +`@defop CATEGORY CLASS NAME ARGUMENTS...' +`@defopx CATEGORY CLASS NAME ARGUMENTS...' + Format a description for an operation in object-oriented + programming. `@defop' takes as arguments the overall name of the + category of operation, the name of the class of the operation, the + name of the operation, and its arguments, if any. *Note + Definition Commands::, and *Note Def Cmds in Detail: deffnx. + +`@defopt OPTION-NAME' +`@defoptx OPTION-NAME' + Format a description for a user option. The command is equivalent + to `@defvr {User Option} ...'. *Note Definition Commands::, and + *Note Def Cmds in Detail: deffnx. + +`@defspec SPECIAL-FORM-NAME ARGUMENTS...' +`@defspecx SPECIAL-FORM-NAME ARGUMENTS...' + Format a description for a special form. The command is + equivalent to `@deffn {Special Form} ...'. *Note Definition + Commands::, and *Note Def Cmds in Detail: deffnx. + +`@deftp CATEGORY NAME-OF-TYPE ATTRIBUTES...' +`@deftpx CATEGORY NAME-OF-TYPE ATTRIBUTES...' + Format a description for a data type. `@deftp' takes as arguments + the category, the name of the type (which is a word like `int' or + `float'), and then the names of attributes of objects of that type. + *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. + +`@deftypefn CLASSIFICATION DATA-TYPE NAME ARGUMENTS...' +`@deftypefnx CLASSIFICATION DATA-TYPE NAME ARGUMENTS...' + Format a description for a function or similar entity that may take + arguments and that is typed. `@deftypefn' takes as arguments the + classification of entity being described, the type, the name of the + entity, and its arguments, if any. *Note Definition Commands::, + and *Note Def Cmds in Detail: deffnx. + +`@deftypefun DATA-TYPE FUNCTION-NAME ARGUMENTS...' +`@deftypefunx DATA-TYPE FUNCTION-NAME ARGUMENTS...' + Format a description for a function in a typed language. The + command is equivalent to `@deftypefn Function ...'. *Note + Definition Commands::, and *Note Def Cmds in Detail: deffnx. + +`@deftypemethod CLASS DATA-TYPE METHOD-NAME ARGUMENTS...' +`@deftypemethodx CLASS DATA-TYPE METHOD-NAME ARGUMENTS...' + Format a description for a typed method in object-oriented + programming. Takes as arguments the name of the class of the + method, the return type of the method, the name of the method, and + its arguments, if any. *Note Definition Commands::, and *Note Def + Cmds in Detail: deffnx. + +`@deftypevr CLASSIFICATION DATA-TYPE NAME' +`@deftypevrx CLASSIFICATION DATA-TYPE NAME' + Format a description for something like a variable in a typed + language--an entity that records a value. Takes as arguments the + classification of entity being described, the type, and the name + of the entity. *Note Definition Commands::, and *Note Def Cmds in + Detail: deffnx. + +`@deftypevar DATA-TYPE VARIABLE-NAME' +`@deftypevarx DATA-TYPE VARIABLE-NAME' + Format a description for a variable in a typed language. The + command is equivalent to `@deftypevr Variable ...'. *Note + Definition Commands::, and *Note Def Cmds in Detail: deffnx. + +`@defun FUNCTION-NAME ARGUMENTS...' +`@defunx FUNCTION-NAME ARGUMENTS...' + Format a description for functions. The command is equivalent to + `@deffn Function ...'. *Note Definition Commands::, and *Note Def + Cmds in Detail: deffnx. + +`@defvar VARIABLE-NAME' +`@defvarx VARIABLE-NAME' + Format a description for variables. The command is equivalent to + `@defvr Variable ...'. *Note Definition Commands::, and *Note Def + Cmds in Detail: deffnx. + +`@defvr CATEGORY NAME' +`@defvrx CATEGORY NAME' + Format a description for any kind of variable. `@defvr' takes as + arguments the category of the entity and the name of the entity. + *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. + +`@detailmenu{}' + Avoid `makeinfo' confusion stemming from the detailed node listing + in a master menu. *Note Master Menu Parts::. + +`@dfn{TERM}' + Highlight the introductory or defining use of a term. *Note + `@dfn': dfn. + +`@dircategory DIRPART' + Specify a part of the Info directory menu where this file's entry + should go. *Note Installing Dir Entries::. + +`@direntry' + Begin the Info directory menu entry for this file. *Note + Installing Dir Entries::. + +`@display' + Begin a kind of example. Indent text, do not fill, do not select a + new font. Pair with `@end display'. *Note `@display': display. + +`@dmn{DIMENSION}' + Format a unit of measure, as in 12pt. Causes TeX to insert a thin + space before DIMENSION. No effect in Info. *Note `@dmn': dmn. + +`@dotaccent{C}' + Generate a dot accent over the character C, as in oo.. *Note + Inserting Accents::. + +`@dots{}' + Insert an ellipsis: `...'. *Note `@dots{}': dots. + +`@email{ADDRESS[, DISPLAYED-TEXT]}' + Indicate an electronic mail address. *Note `@email': email. + +`@emph{TEXT}' + Highlight TEXT; text is displayed in _italics_ in printed output, + and surrounded by asterisks in Info. *Note Emphasizing Text: + Emphasis. + +`@end ENVIRONMENT' + Ends ENVIRONMENT, as in `@end example'. *Note @-commands: + Formatting Commands. + +`@enddots{}' + Generate an end-of-sentence of ellipsis, like this .... *Note + `@dots{}': dots. + +`@enumerate [NUMBER-OR-LETTER]' + Begin a numbered list, using `@item' for each entry. Optionally, + start list with NUMBER-OR-LETTER. Pair with `@end enumerate'. + *Note `@enumerate': enumerate. + +`@equiv{}' + Indicate to the reader the exact equivalence of two forms with a + glyph: `=='. *Note Equivalence::. + +`@error{}' + Indicate to the reader with a glyph that the following text is an + error message: `error-->'. *Note Error Glyph::. + +`@evenfooting [LEFT] @| [CENTER] @| [RIGHT]' +`@evenheading [LEFT] @| [CENTER] @| [RIGHT]' + Specify page footings resp. headings for even-numbered (left-hand) + pages. Only allowed inside `@iftex'. *Note How to Make Your Own + Headings: Custom Headings. + +`@everyfooting [LEFT] @| [CENTER] @| [RIGHT]' +`@everyheading [LEFT] @| [CENTER] @| [RIGHT]' + Specify page footings resp. headings for every page. Not relevant + to Info. *Note How to Make Your Own Headings: Custom Headings. + +`@example' + Begin an example. Indent text, do not fill, and select + fixed-width font. Pair with `@end example'. *Note `@example': + example. + +`@exclamdown{}' + Produce an upside-down exclamation point. *Note Inserting + Accents::. + +`@exdent LINE-OF-TEXT' + Remove any indentation a line might have. *Note Undoing the + Indentation of a Line: exdent. + +`@expansion{}' + Indicate the result of a macro expansion to the reader with a + special glyph: `==>'. *Note ==> Indicating an Expansion: + expansion. + +`@file{FILENAME}' + Highlight the name of a file, buffer, node, or directory. *Note + `@file': file. + +`@finalout' + Prevent TeX from printing large black warning rectangles beside + over-wide lines. *Note Overfull hboxes::. + +`@findex ENTRY' + Add ENTRY to the index of functions. *Note Defining the Entries + of an Index: Index Entries. + +`@flushleft' +`@flushright' + Left justify every line but leave the right end ragged. Leave + font as is. Pair with `@end flushleft'. `@flushright' analogous. + *Note `@flushleft' and `@flushright': flushleft & flushright. + +`@footnote{TEXT-OF-FOOTNOTE}' + Enter a footnote. Footnote text is printed at the bottom of the + page by TeX; Info may format in either `End' node or `Separate' + node style. *Note Footnotes::. + +`@footnotestyle STYLE' + Specify an Info file's footnote style, either `end' for the end + node style or `separate' for the separate node style. *Note + Footnotes::. + +`@format' + Begin a kind of example. Like `@example' or `@display', but do + not narrow the margins and do not select the fixed-width font. + Pair with `@end format'. *Note `@example': example. + +`@ftable FORMATTING-COMMAND' + Begin a two-column table, using `@item' for each entry. + Automatically enter each of the items in the first column into the + index of functions. Pair with `@end ftable'. The same as + `@table', except for indexing. *Note `@ftable' and `@vtable': + ftable vtable. + +`@group' + Hold text together that must appear on one printed page. Pair with + `@end group'. Not relevant to Info. *Note `@group': group. + +`@H{C}' + Generate the long Hungarian umlaut accent over C, as in o''. + +`@heading TITLE' + Print an unnumbered section-like heading in the text, but not in + the table of contents of a printed manual. In Info, the title is + underlined with equal signs. *Note Section Commands: + unnumberedsec appendixsec heading. + +`@headings ON-OFF-SINGLE-DOUBLE' + Turn page headings on or off, and/or specify single-sided or + double-sided page headings for printing. *Note The `@headings' + Command: headings on off. + +`@html' + Enter HTML completely. Pair with `@end html'. *Note Raw + Formatter Commands::. + +`@hyphenation{HY-PHEN-A-TED WORDS}' + Explicitly define hyphenation points. *Note `@-' and + `@hyphenation': - and hyphenation. + +`@i{TEXT}' + Print TEXT in italic font. No effect in Info. *Note Fonts::. + +`@ifclear FLAG' + If FLAG is cleared, the Texinfo formatting commands format text + between `@ifclear FLAG' and the following `@end ifclear' command. + *Note `@set' `@clear' `@value': set clear value. + +`@ifhtml' +`@ifinfo' + Begin a stretch of text that will be ignored by TeX when it + typesets the printed manual. The text appears only in the HTML + resp. Info file. Pair with `@end ifhtml' resp. `@end ifinfo'. + *Note Conditionals::. + +`@ifnothtml' +`@ifnotinfo' +`@ifnottex' + Begin a stretch of text that will be ignored in one output format + but not the others. The text appears only in the format not + specified. Pair with `@end ifnothtml' resp. `@end ifnotinfo' resp. + `@end ifnotinfo'. *Note Conditionals::. + +`@ifset FLAG' + If FLAG is set, the Texinfo formatting commands format text + between `@ifset FLAG' and the following `@end ifset' command. + *Note `@set' `@clear' `@value': set clear value. + +`@iftex' + Begin a stretch of text that will not appear in the Info file, but + will be processed only by TeX. Pair with `@end iftex'. *Note + Conditionally Visible Text: Conditionals. + +`@ignore' + Begin a stretch of text that will not appear in either the Info + file or the printed output. Pair with `@end ignore'. *Note + Comments and Ignored Text: Comments. + +`@image{FILENAME, [WIDTH], [HEIGHT]}' + Include graphics image in external FILENAME scaled to the given + WIDTH and/or HEIGHT. *Note Images::. + +`@include FILENAME' + Incorporate the contents of the file FILENAME into the Info file + or printed document. *Note Include Files::. + +`@inforef{NODE-NAME, [ENTRY-NAME], INFO-FILE-NAME}' + Make a cross reference to an Info file for which there is no + printed manual. *Note Cross references using `@inforef': inforef. + +`\input MACRO-DEFINITIONS-FILE' + Use the specified macro definitions file. This command is used + only in the first line of a Texinfo file to cause TeX to make use + of the `texinfo' macro definitions file. The backslash in `\input' + is used instead of an `@' because TeX does not recognize `@' until + after it has read the definitions file. *Note The Texinfo File + Header: Header. + +`@item' + Indicate the beginning of a marked paragraph for `@itemize' and + `@enumerate'; indicate the beginning of the text of a first column + entry for `@table', `@ftable', and `@vtable'. *Note Lists and + Tables::. + +`@itemize MARK-GENERATING-CHARACTER-OR-COMMAND' + Produce a sequence of indented paragraphs, with a mark inside the + left margin at the beginning of each paragraph. Pair with `@end + itemize'. *Note `@itemize': itemize. + +`@itemx' + Like `@item' but do not generate extra vertical space above the + item text. *Note `@itemx': itemx. + +`@kbd{KEYBOARD-CHARACTERS}' + Indicate text that is characters of input to be typed by users. + *Note `@kbd': kbd. + +`@kbdinputstyle STYLE' + Specify when `@kbd' should use a font distinct from `@code'. + *Note `@kbd': kbd. + +`@key{KEY-NAME}' + Indicate a name for a key on a keyboard. *Note `@key': key. + +`@kindex ENTRY' + Add ENTRY to the index of keys. *Note Defining the Entries of an + Index: Index Entries. + +`@L{}' +`@l{}' + Generate the uppercase and lowercase Polish suppressed-L letters, + respectively: /L, /l. + +`@lisp' + Begin an example of Lisp code. Indent text, do not fill, and + select fixed-width font. Pair with `@end lisp'. *Note `@lisp': + Lisp Example. + +`@lowersections' + Change subsequent chapters to sections, sections to subsections, + and so on. *Note `@raisesections' and `@lowersections': + Raise/lower sections. + +`@macro MACRO-NAME {PARAMS}' + Define a new Texinfo command `@MACRO-NAME{PARAMS}'. Only + supported by `makeinfo' and `texi2dvi'. *Note Defining Macros::. + +`@majorheading TITLE' + Print a chapter-like heading in the text, but not in the table of + contents of a printed manual. Generate more vertical whitespace + before the heading than the `@chapheading' command. In Info, the + chapter heading line is underlined with asterisks. *Note + `@majorheading' and `@chapheading': majorheading & chapheading. + +`@math{MATHEMATICAL-EXPRESSION}' + Format a mathematical expression. *Note `@math' - Inserting + Mathematical Expressions: math. + +`@menu' + Mark the beginning of a menu of nodes in Info. No effect in a + printed manual. Pair with `@end menu'. *Note Menus::. + +`@minus{}' + Generate a minus sign, `-'. *Note `@minus': minus. + +`@multitable COLUMN-WIDTH-SPEC' + Begin a multi-column table. Pair with `@end multitable'. *Note + Multitable Column Widths::. + +`@need N' + Start a new page in a printed manual if fewer than N mils + (thousandths of an inch) remain on the current page. *Note + `@need': need. + +`@node NAME, NEXT, PREVIOUS, UP' + Define the beginning of a new node in Info, and serve as a locator + for references for TeX. *Note `@node': node. + +`@noindent' + Prevent text from being indented as if it were a new paragraph. + *Note `@noindent': noindent. + +`@O{}' +`@o{}' + Generate the uppercase and lowercase O-with-slash letters, + respectively: /O, /o. + +`@oddfooting [LEFT] @| [CENTER] @| [RIGHT]' +`@oddheading [LEFT] @| [CENTER] @| [RIGHT]' + Specify page footings resp. headings for odd-numbered (right-hand) + pages. Only allowed inside `@iftex'. *Note How to Make Your Own + Headings: Custom Headings. + +`@OE{}' +`@oe{}' + Generate the uppercase and lowercase OE ligatures, respectively: + OE, oe. *Note Inserting Accents::. + +`@page' + Start a new page in a printed manual. No effect in Info. *Note + `@page': page. + +`@paragraphindent INDENT' + Indent paragraphs by INDENT number of spaces; delete indentation + if the value of INDENT is 0; and do not change indentation if + INDENT is `asis'. *Note Paragraph Indenting: paragraphindent. + +`@pindex ENTRY' + Add ENTRY to the index of programs. *Note Defining the Entries of + an Index: Index Entries. + +`@point{}' + Indicate the position of point in a buffer to the reader with a + glyph: `-!-'. *Note Indicating Point in a Buffer: Point Glyph. + +`@pounds{}' + Generate the pounds sterling currency sign. *Note `@pounds{}': + pounds. + +`@print{}' + Indicate printed output to the reader with a glyph: `-|'. *Note + Print Glyph::. + +`@printindex INDEX-NAME' + Print an alphabetized two-column index in a printed manual or + generate an alphabetized menu of index entries for Info. *Note + Printing Indices & Menus::. + +`@pxref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' + Make a reference that starts with a lower case `see' in a printed + manual. Use within parentheses only. Do not follow command with a + punctuation mark--the Info formatting commands automatically insert + terminating punctuation as needed. Only the first argument is + mandatory. *Note `@pxref': pxref. + +`@questiondown{}' + Generate an upside-down question mark. *Note Inserting Accents::. + +`@quotation' + Narrow the margins to indicate text that is quoted from another + real or imaginary work. Write command on a line of its own. Pair + with `@end quotation'. *Note `@quotation': quotation. + +`@r{TEXT}' + Print TEXT in roman font. No effect in Info. *Note Fonts::. + +`@raisesections' + Change subsequent sections to chapters, subsections to sections, + and so on. *Note `@raisesections' and `@lowersections': + Raise/lower sections. + +`@ref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' + Make a reference. In a printed manual, the reference does not + start with a `See'. Follow command with a punctuation mark. Only + the first argument is mandatory. *Note `@ref': ref. + +`@refill' + In Info, refill and indent the paragraph after all the other + processing has been done. No effect on TeX, which always refills. + This command is no longer needed, since all formatters now + automatically refill. *Note Refilling Paragraphs::. + +`@result{}' + Indicate the result of an expression to the reader with a special + glyph: `=>'. *Note `@result': result. + +`@ringaccent{C}' + Generate a ring accent over the next character, as in o*. *Note + Inserting Accents::. + +`@samp{TEXT}' + Highlight TEXT that is a literal example of a sequence of + characters. Used for single characters, for statements, and often + for entire shell commands. *Note `@samp': samp. + +`@sc{TEXT}' + Set TEXT in a printed output in THE SMALL CAPS FONT and set text + in the Info file in uppercase letters. *Note Smallcaps::. + +`@section TITLE' + Begin a section within a chapter. In a printed manual, the section + title is numbered and appears in the table of contents. In Info, + the title is underlined with equal signs. *Note `@section': + section. + +`@set FLAG [STRING]' + Make FLAG active, causing the Texinfo formatting commands to + format text between subsequent pairs of `@ifset FLAG' and `@end + ifset' commands. Optionally, set value of FLAG to STRING. *Note + `@set' `@clear' `@value': set clear value. + +`@setchapternewpage ON-OFF-ODD' + Specify whether chapters start on new pages, and if so, whether on + odd-numbered (right-hand) new pages. *Note `@setchapternewpage': + setchapternewpage. + +`@setfilename INFO-FILE-NAME' + Provide a name to be used by the Info file. This command is + essential for TeX formatting as well, even though it produces no + output. *Note `@setfilename': setfilename. + +`@settitle TITLE' + Provide a title for page headers in a printed manual. *Note + `@settitle': settitle. + +`@shortcontents' + Print a short table of contents. Not relevant to Info, which uses + menus rather than tables of contents. A synonym for + `@summarycontents'. *Note Generating a Table of Contents: + Contents. + +`@shorttitlepage{TITLE}' + Generate a minimal title page. *Note `@titlepage': titlepage. + +`@smallbook' + Cause TeX to produce a printed manual in a 7 by 9.25 inch format + rather than the regular 8.5 by 11 inch format. *Note Printing + Small Books: smallbook. Also, see *Note `@smallexample' and + `@smalllisp': smallexample & smalllisp. + +`@smallexample' + Indent text to indicate an example. Do not fill, select + fixed-width font. In `@smallbook' format, print text in a smaller + font than with `@example'. Pair with `@end smallexample'. *Note + `@smallexample' and `@smalllisp': smallexample & smalllisp. + +`@smalllisp' + Begin an example of Lisp code. Indent text, do not fill, select + fixed-width font. In `@smallbook' format, print text in a smaller + font. Pair with `@end smalllisp'. *Note `@smallexample' and + `@smalllisp': smallexample & smalllisp. + +`@sp N' + Skip N blank lines. *Note `@sp': sp. + +`@ss{}' + Generate the German sharp-S es-zet letter, ss. *Note Inserting + Accents::. + +`@strong TEXT' + Emphasize TEXT by typesetting it in a *bold* font for the printed + manual and by surrounding it with asterisks for Info. *Note + Emphasizing Text: emph & strong. + +`@subheading TITLE' + Print an unnumbered subsection-like heading in the text, but not in + the table of contents of a printed manual. In Info, the title is + underlined with hyphens. *Note `@unnumberedsubsec' + `@appendixsubsec' `@subheading': unnumberedsubsec appendixsubsec + subheading. + +`@subsection TITLE' + Begin a subsection within a section. In a printed manual, the + subsection title is numbered and appears in the table of contents. + In Info, the title is underlined with hyphens. *Note + `@subsection': subsection. + +`@subsubheading TITLE' + Print an unnumbered subsubsection-like heading in the text, but + not in the table of contents of a printed manual. In Info, the + title is underlined with periods. *Note The `subsub' Commands: + subsubsection. + +`@subsubsection TITLE' + Begin a subsubsection within a subsection. In a printed manual, + the subsubsection title is numbered and appears in the table of + contents. In Info, the title is underlined with periods. *Note + The `subsub' Commands: subsubsection. + +`@subtitle TITLE' + In a printed manual, set a subtitle in a normal sized font flush to + the right-hand side of the page. Not relevant to Info, which does + not have title pages. *Note `@title' `@subtitle' and `@author' + Commands: title subtitle author. + +`@summarycontents' + Print a short table of contents. Not relevant to Info, which uses + menus rather than tables of contents. A synonym for + `@shortcontents'. *Note Generating a Table of Contents: Contents. + +`@syncodeindex FROM-INDEX INTO-INDEX' + Merge the index named in the first argument into the index named in + the second argument, printing the entries from the first index in + `@code' font. *Note Combining Indices::. + +`@synindex FROM-INDEX INTO-INDEX' + Merge the index named in the first argument into the index named in + the second argument. Do not change the font of FROM-INDEX + entries. *Note Combining Indices::. + +`@t{TEXT}' + Print TEXT in a fixed-width, typewriter-like font. No effect in + Info. *Note Fonts::. + +`@tab' + Separate columns in a multitable. *Note Multitable Rows::. + +`@table FORMATTING-COMMAND' + Begin a two-column table, using `@item' for each entry. Write + each first column entry on the same line as `@item'. First column + entries are printed in the font resulting from FORMATTING-COMMAND. + Pair with `@end table'. *Note Making a Two-column Table: + Two-column Tables. Also see *Note `@ftable' and `@vtable': ftable + vtable, and *Note `@itemx': itemx. + +`@TeX{}' + Insert the logo TeX. *Note Inserting TeX and (C): TeX and + copyright. + +`@tex' + Enter TeX completely. Pair with `@end tex'. *Note Raw Formatter + Commands::. + +`@thischapter' +`@thischaptername' +`@thisfile' +`@thispage' +`@thistitle' + Only allowed in a heading or footing. Stands for the number and + name of the current chapter (in the format `Chapter 1: Title'), + the chapter name only, the filename, the current page number, and + the title of the document, respectively. *Note How to Make Your + Own Headings: Custom Headings. + +`@tieaccent{CC}' + Generate a tie-after accent over the next two characters CC, as in + `oo['. *Note Inserting Accents::. + +`@tindex ENTRY' + Add ENTRY to the index of data types. *Note Defining the Entries + of an Index: Index Entries. + +`@title TITLE' + In a printed manual, set a title flush to the left-hand side of the + page in a larger than normal font and underline it with a black + rule. Not relevant to Info, which does not have title pages. + *Note The `@title' `@subtitle' and `@author' Commands: title + subtitle author. + +`@titlefont{TEXT}' + In a printed manual, print TEXT in a larger than normal font. Not + relevant to Info, which does not have title pages. *Note The + `@titlefont' `@center' and `@sp' Commands: titlefont center sp. + +`@titlepage' + Indicate to Texinfo the beginning of the title page. Write + command on a line of its own. Pair with `@end titlepage'. + Nothing between `@titlepage' and `@end titlepage' appears in Info. + *Note `@titlepage': titlepage. + +`@today{}' + Insert the current date, in `1 Jan 1900' style. *Note How to Make + Your Own Headings: Custom Headings. + +`@top TITLE' + In a Texinfo file to be formatted with `makeinfo', identify the + topmost `@node' line in the file, which must be written on the line + immediately preceding the `@top' command. Used for `makeinfo''s + node pointer insertion feature. The title is underlined with + asterisks. Both the `@node' line and the `@top' line normally + should be enclosed by `@ifinfo' and `@end ifinfo'. In TeX and + `texinfo-format-buffer', the `@top' command is merely a synonym + for `@unnumbered'. *Note Creating Pointers with `makeinfo': + makeinfo Pointer Creation. + +`@u{C}' +`@ubaraccent{C}' +`@udotaccent{C}' + Generate a breve, underbar, or underdot accent, respectively, over + or under the character C, as in o(, o_, .o. *Note Inserting + Accents::. + +`@unnumbered TITLE' + In a printed manual, begin a chapter that appears without chapter + numbers of any kind. The title appears in the table of contents + of a printed manual. In Info, the title is underlined with + asterisks. *Note `@unnumbered' and `@appendix': unnumbered & + appendix. + +`@unnumberedsec TITLE' + In a printed manual, begin a section that appears without section + numbers of any kind. The title appears in the table of contents + of a printed manual. In Info, the title is underlined with equal + signs. *Note Section Commands: unnumberedsec appendixsec heading. + +`@unnumberedsubsec TITLE' + In a printed manual, begin an unnumbered subsection within a + chapter. The title appears in the table of contents of a printed + manual. In Info, the title is underlined with hyphens. *Note + `@unnumberedsubsec' `@appendixsubsec' `@subheading': + unnumberedsubsec appendixsubsec subheading. + +`@unnumberedsubsubsec TITLE' + In a printed manual, begin an unnumbered subsubsection within a + chapter. The title appears in the table of contents of a printed + manual. In Info, the title is underlined with periods. *Note The + `subsub' Commands: subsubsection. + +`@uref{URL[, DISPLAYED-TEXT}' + Define a cross reference to an external uniform resource locator + for the World Wide Web. *Note `@url': url. + +`@url{URL}' + Indicate text that is a uniform resource locator for the World Wide + Web. *Note `@url': url. + +`@v{C}' + Generate check accent over the character C, as in o<. *Note + Inserting Accents::. + +`@value{FLAG}' + Replace FLAG with the value to which it is set by `@set FLAG'. + *Note `@set' `@clear' `@value': set clear value. + +`@var{METASYNTACTIC-VARIABLE}' + Highlight a metasyntactic variable, which is something that stands + for another piece of text. *Note Indicating Metasyntactic + Variables: var. + +`@vindex ENTRY' + Add ENTRY to the index of variables. *Note Defining the Entries + of an Index: Index Entries. + +`@vskip AMOUNT' + In a printed manual, insert whitespace so as to push text on the + remainder of the page towards the bottom of the page. Used in + formatting the copyright page with the argument `0pt plus 1filll'. + (Note spelling of `filll'.) `@vskip' may be used only in + contexts ignored for Info. *Note The Copyright Page and Printed + Permissions: Copyright & Permissions. + +`@vtable FORMATTING-COMMAND' + Begin a two-column table, using `@item' for each entry. + Automatically enter each of the items in the first column into the + index of variables. Pair with `@end vtable'. The same as + `@table', except for indexing. *Note `@ftable' and `@vtable': + ftable vtable. + +`@w{TEXT}' + Prevent TEXT from being split across two lines. Do not end a + paragraph that uses `@w' with an `@refill' command. *Note `@w': w. + +`@xref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}' + Make a reference that starts with `See' in a printed manual. + Follow command with a punctuation mark. Only the first argument is + mandatory. *Note `@xref': xref. + diff --git a/info/xemacs-faq.info-3 b/info/xemacs-faq.info-3 index 5538f03..363dfef 100644 --- a/info/xemacs-faq.info-3 +++ b/info/xemacs-faq.info-3 @@ -190,7 +190,7 @@ Q3.0.5: How to check if a lisp function is defined? variables. Instead, use feature-tests, such as `featurep', `boundp', `fboundp', -or even simple behaviroal tests, eg.: +or even simple behavioral tests, eg.: (defvar foo-old-losing-code-p (condition-case nil (progn (losing-code t) nil) diff --git a/info/xemacs-faq.info-4 b/info/xemacs-faq.info-4 index 805e13f..769fb4c 100644 --- a/info/xemacs-faq.info-4 +++ b/info/xemacs-faq.info-4 @@ -544,14 +544,6 @@ KOBAYASHI Shuhei . * MIME extenders for mh-e, GNUS, RMAIL and VM. tm is available from following anonymous ftp sites: - * `ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime/' (Japan). - - * `ftp://ftp.nis.co.jp/pub/gnu/emacs-lisp/tm/' (Japan). - - * `ftp://ftp.nisiq.net/pub/gnu/emacs-lisp/tm/' (US). - - * `ftp://ftp.miranova.com/pub/gnus/jaist.ac.jp/' (US). - * `ftp://ftp.unicamp.br/pub/mail/mime/tm/' (Brasil). * `ftp://ftp.th-darmstadt.de/pub/editors/GNU-Emacs/lisp/mime/' @@ -651,7 +643,7 @@ time. EOS is being replaced with a new graphical development environment called Sun WorkShop, which is currently (07/96) in Alpha Test. For more details, check out - `http://www.sun.com/software/Products/Developer-products/programs.html'. + `http://www.sun.com/software/Products/Developer-products'.  File: xemacs-faq.info, Node: Q4.4.2, Next: Q4.5.1, Prev: Q4.4.1, Up: Subsystems @@ -968,13 +960,14 @@ Q4.7.5: Is there a MatLab mode? Can I "teach" emacs what words are MatLab commands, comments, etc. ? Ulrich Elsner writes: - One way to do this (and much more) is by using the matlab mode - (ftp://ftp.mathworks.com/pub/contrib/v5/tools/matlab.el). + One way to do this (and much more) is by using the matlab mode. + (If someone knows where this can be found, please contact the + XEmacs FAQ maintainer . Instructions on how to install this mode are included in this file.  -File: xemacs-faq.info, Node: Miscellaneous, Next: Current Events, Prev: Subsystems, Up: Top +File: xemacs-faq.info, Node: Miscellaneous, Next: MS Windows, Prev: Subsystems, Up: Top 5 The Miscellaneous Stuff ************************* @@ -1343,7 +1336,7 @@ Q5.0.15: Where do I get the latest CC Mode? Barry A. Warsaw writes: - This can be had from `http://www.python.org/ftp/emacs/'. + This can be had from `http://www.python.org/emacs/'.  File: xemacs-faq.info, Node: Q5.0.16, Next: Q5.0.17, Prev: Q5.0.15, Up: Miscellaneous @@ -1358,3 +1351,12 @@ enabled by default. To turn it off, put the following in your `.emacs': (setq auto-show-mode nil) (setq-default auto-show-mode nil) + +File: xemacs-faq.info, Node: Q5.0.17, Next: Q5.0.18, Prev: Q5.0.16, Up: Miscellaneous + +Q5.0.17: How can I get two instances of info? +--------------------------------------------- + + You can't. The `info' package does not provide for multiple info +buffers. + diff --git a/info/xemacs-faq.info-5 b/info/xemacs-faq.info-5 index e67a395..60053a1 100644 --- a/info/xemacs-faq.info-5 +++ b/info/xemacs-faq.info-5 @@ -7,15 +7,6 @@ START-INFO-DIR-ENTRY END-INFO-DIR-ENTRY  -File: xemacs-faq.info, Node: Q5.0.17, Next: Q5.0.18, Prev: Q5.0.16, Up: Miscellaneous - -Q5.0.17: How can I get two instances of info? ---------------------------------------------- - - You can't. The `info' package does not provide for multiple info -buffers. - - File: xemacs-faq.info, Node: Q5.0.18, Next: Q5.0.19, Prev: Q5.0.17, Up: Miscellaneous Q5.0.18: I upgraded to XEmacs 19.14 and gnuserv stopped working. @@ -751,8 +742,7 @@ method, one should NOT quote the face string using the sed script . It might also be helpful to use Stig's script (included in the compface distribution at XEmacs.org) to do the -conversion. For convenience xbm2xface is available for anonymous FTP at -`ftp://ftp.miranova.com/pub/xemacs/xbm2xface.pl'. +conversion. Contributors for this item: @@ -839,12 +829,386 @@ printing (the `Pretty Print Buffer' menu item) *requires* a window system environment. It cannot be used outside of X11.  -File: xemacs-faq.info, Node: Current Events, Prev: Miscellaneous, Up: Top +File: xemacs-faq.info, Node: MS Windows, Next: Current Events, Prev: Miscellaneous, Up: Top + +6 XEmacs on MS Windows +********************** + + This is part 6 of the XEmacs Frequently Asked Questions list, +written by Hrvoje Niksic and others. This section is devoted to the MS +Windows port of XEmacs. + +* Menu: + + +General Info +* Q6.0.1:: What is the status of the XEmacs port to Windows? +* Q6.0.2:: What flavors of MS Windows are supported? +* Q6.0.3:: Where are the XEmacs on MS Windows binaries? +* Q6.0.4:: Does XEmacs on MS Windows require an X server to run? + +Building XEmacs on MS Windows +* Q6.1.1:: I decided to run with X. Where do I get an X server? +* Q6.1.2:: What compiler do I need to compile XEmacs? +* Q6.1.3:: How do I compile for the native port? +* Q6.1.4:: How do I compile for the X port? +* Q6.1.5:: How do I compile for Cygnus' Cygwin? +* Q6.1.6:: What do I need for Cygwin? + +Customization and User Interface +* Q6.2.1:: How will the port cope with differences in the Windows user interface? +* Q6.2.2:: How do I change fonts in XEmacs on MS Windows? +* Q6.2.3:: Where do I put my `.emacs' file? + +Miscellaneous +* Q6.3.1:: Will XEmacs rename all the win32-* symbols to w32-*? +* Q6.3.2:: What are the differences between the various MS Windows emacsen? +* Q6.3.3:: What is the porting team doing at the moment? + + +File: xemacs-faq.info, Node: Q6.0.1, Next: Q6.0.2, Prev: MS Windows, Up: MS Windows + +6.0: General Info +================= + +Q6.0.1: What is the status of the XEmacs port to Windows? +--------------------------------------------------------- + + Is XEmacs really getting ported to MS Windows? What is the status +of the port? + + Yes, a group of volunteers actively works on making XEmacs code base +cleanly compile and run on MS Windows operating systems. The mailing +list at is dedicated to that effort (please use +the -request address to subscribe). + + At this time, XEmacs on MS Windows is usable, but lacks some of the +features of XEmacs on UNIX and UNIX-like systems. Notably, +internationalization does not work. + + +File: xemacs-faq.info, Node: Q6.0.2, Next: Q6.0.3, Prev: Q6.0.1, Up: MS Windows + +Q6.0.2: What flavors of MS Windows are supported? The list name implies NT only. +--------------------------------------------------------------------------------- + + The list name is misleading, as XEmacs will support both Windows 95, +Windows 98 and Windows NT. The MS Windows-specific code is based on +Microsoft Win32 API, and will not work on MS Windows 3.x or on MS-DOS. + + +File: xemacs-faq.info, Node: Q6.0.3, Next: Q6.0.4, Prev: Q6.0.2, Up: MS Windows + +Q6.0.3: Are binary kits available? +---------------------------------- + + Binary kits are available at +`ftp://ftp.xemacs.org/pub/xemacs/binary-kits/win32/' for the "plain" MS +Windows version. + + +File: xemacs-faq.info, Node: Q6.0.4, Next: Q6.1.1, Prev: Q6.0.3, Up: MS Windows + +Q6.0.4: Does XEmacs on MS Windows require an X server to run? +------------------------------------------------------------- + + Short answer: No. + + Long answer: XEmacs can be built in several ways in the MS Windows +environment, some of them requiring an X server and some not. + + One is what we call the "X" port - it requires X libraries to build +and an X server to run. Internally it uses the Xt event loop and makes +use of X toolkits. Its look is quite un-Windowsy, but it works +reliably and supports all of the graphical features of Unix XEmacs. + + The other is what we call the "native" port. It uses the Win32 API +and does not require X libraries to build, nor does it require an X to +run. In fact, it has no connection with X whatsoever. At this time, +the native port obsoletes the X port, providing almost all of its +features, including support for menus, scrollbars, toolbars, embedded +images and background pixmaps, frame pointers, etc. Most of the future +work will be based on the native port. + + There is also a third special case, the Cygwin port. It takes +advantage of Cygnus emulation library under Win32, which enables it to +reuse much of the Unix XEmacs code base, such as processes and network +support, or internal select() mechanisms. + + Cygwin port supports all display types - TTY, X & MS gui, and can be +built with support for all three. If you build with ms gui support +then the Cygwin version uses the majority of the msw code, which is +mostly related to display. If you want to build with X support you +need X libraries. If you want to build with tty support you need +ncurses. MS gui requires no additional libraries. + + Some of the advantages of the Cygwin version are that it: + + * integrates well with Cygwin environment for existing Cygwin users; + + * uses configure so building with different features is very easy; + + * has process support in X & tty. + + + The disadvantage is that it requires several Unix utilities and the +whole Cygwin environment, whereas the native port requires only a +suitable MS Windows compiler. Also, it follows the Unix filesystem and +process model very closely (some will undoubtedly view this as an +advantage). + + +File: xemacs-faq.info, Node: Q6.1.1, Next: Q6.1.2, Prev: Q6.0.4, Up: MS Windows + +6.1: Building XEmacs on MS Windows +================================== + +Q6.1.1: I decided to run with X. Where do I get an X server? +------------------------------------------------------------- + + Pointers to X servers can be found at +`http://dao.gsfc.nasa.gov/software/grads/win32/X11R6.3/'; + + look for "Where to get an X server". Also note that, although the +above page talks about Cygnus gnu-win32 (Cygwin), the information on X +servers is Cygwin-independent. You don't have to be running/using +Cygwin to use these X servers, and you don't have to compile XEmacs +under Cygwin to use XEmacs with these X servers. An "X port" XEmacs +compiled under Visual C++ will work with these X servers (as will +XEmacs running on a Unix box, redirected to the server running on your +PC). + + +File: xemacs-faq.info, Node: Q6.1.2, Next: Q6.1.3, Prev: Q6.1.1, Up: MS Windows + +Q6.1.2: What compiler do I need to compile XEmacs? +-------------------------------------------------- + + You need Visual C++ 4.2 or 5.0, with the exception of the Cygwin +port, which uses Gcc. + + +File: xemacs-faq.info, Node: Q6.1.3, Next: Q6.1.4, Prev: Q6.1.2, Up: MS Windows + +Q6.1.3: How do I compile for the native port? +--------------------------------------------- + + Please read the file `nt/README' in the XEmacs distribution, which +contains the full description. + + +File: xemacs-faq.info, Node: Q6.1.4, Next: Q6.1.5, Prev: Q6.1.3, Up: MS Windows + +Q6.1.4: How do I compile for the X port? +---------------------------------------- + + Again, it is described in `nt/README' in some detail. Basically, you +need to get X11 libraries from ftp.x.org, and compile them. If the +precompiled versions are available somewhere, I don't know of it. + + +File: xemacs-faq.info, Node: Q6.1.5, Next: Q6.1.6, Prev: Q6.1.4, Up: MS Windows + +Q6.1.5: How do I compile for Cygnus' Cygwin? +-------------------------------------------- + + Similar as on Unix; use the usual `configure' and `make' process. +Some problems to watch out for: + + * make sure HOME is set. This controls where you `.emacs' file comes + from; + + * CYGWIN32 needs to be set to tty for process support work. e.g. + CYGWIN32=tty; + + * picking up some other grep or other unix like tools can kill + configure; + + * static heap too small, adjust src/sheap-adjust.h to a more positive + number; + + * The Cygwin version doesn't understand `//machine/path' type paths + so you will need to manually mount a directory of this form under + a unix style directory for a build to work on the directory. + + + +File: xemacs-faq.info, Node: Q6.1.6, Next: Q6.2.1, Prev: Q6.1.5, Up: MS Windows + +Q6.1.6: What do I need for Cygwin? +---------------------------------- + + You can find the Cygwin tools and compiler at: + + `http://sourceware.cygnus.com/cygwin/' + + You will need version b19 or later. + + You will also need the X libraries. There are libraries at +`http://dao.gsfc.nasa.gov/software/grads/win32/X11R6.3/', but these are +not b19 compatible. You can get b19 X11R6.3 binaries, as well as +pre-built ncurses and graphic libraries, from: + + `ftp://ftp.parallax.co.uk/pub/andyp/'. + + +File: xemacs-faq.info, Node: Q6.2.1, Next: Q6.2.2, Prev: Q6.1.6, Up: MS Windows + +6.2: Customization and User Interface +===================================== + +Q6.2.1: How will the port cope with differences in the Windows user interface? +------------------------------------------------------------------------------ + + XEmacs (and Emacs in general) UI is pretty different from what is +expected of a typical MS Windows program. How will the MS Windows port +cope with it? + + Fortunately, Emacs is also one of the most configurable editor beasts +in the world. The MS Windows "look and feel" (mark via shift-arrow, +self-inserting deletes region, etc.) can be easily configured via +various packages distributed with XEmacs. The `pending-delete' package +is an example of such a utility. + + In future versions, some of these packages might be turned on by +default in the MS Windows environment. + + +File: xemacs-faq.info, Node: Q6.2.2, Next: Q6.2.3, Prev: Q6.2.1, Up: MS Windows + +Q6.2.2: How do I change fonts in XEmacs on MS Windows? +------------------------------------------------------ + + You can change font manually, but not from the menubar, yet. For +example: + + (set-face-font 'default "Lucida Console:Regular:10") + (set-face-font 'modeline "MS Sans Serif:Regular:10") + + +File: xemacs-faq.info, Node: Q6.2.3, Next: Q6.3.1, Prev: Q6.2.2, Up: MS Windows + +Q6.2.3: Where do I put my `.emacs' file? +---------------------------------------- + + If the HOME environment variable is set, `.emacs' will be looked for +there. Else the directory defaults to `c:\'. + + +File: xemacs-faq.info, Node: Q6.3.1, Next: Q6.3.2, Prev: Q6.2.3, Up: MS Windows + +6.3: Miscellaneous +================== + +Q6.3.1: Will XEmacs rename all the win32-* symbols to w32-*? +------------------------------------------------------------ + + In his flavor of Emacs 20, Richard Stallman has renamed all the +win32-* symbols to w32-*. Will XEmacs do the same? + + We consider such a move counter-productive, thus we will not use the +`w32' prefix. However, we do recognize that Win32 name is little more +than a marketing buzzword (will it be Win64 in the next release?), so +we decided not to use it. Using `windows-' would be wrong because the +term is too generic, which is why we settled on a compromise +`mswindows' term. + + Thus all the XEmacs variables and functions directly related to Win32 +are prefixed `mswindows-'. The user-variables shared with NT Emacs +will be provided as compatibility aliases. + + Architectural note: We believe that there should be a very small +number of window-systems-specific variables, and will try to provide +generic interfaces whenever possible. + + +File: xemacs-faq.info, Node: Q6.3.2, Next: Q6.3.3, Prev: Q6.3.1, Up: MS Windows + +Q6.3.2: What are the differences between the various MS Windows emacsen? +------------------------------------------------------------------------ + + XEmacs, Win-Emacs, DOS Emacs, NT Emacs, this is all very confusing. +Could you briefly explain the differences between them? + + Here is a recount of various Emacs versions running on MS Windows: + + * Win-Emacs + + - Win-Emacs is a port of Lucid Emacs 19.6 to MS Windows using X + compatibility libraries. Win-Emacs has been written by Ben + Wing. The MS Windows code has not made it back to Lucid + Emacs, which left Win-Emacs pretty much dead for our + purposes. Win-Emacs used to be available at Pearlsoft, but + not anymore, since Pearlsoft went out of business. + + * GNU Emacs for DOS + + - GNU Emacs features support for MS-DOS and DJGPP (D.J. + Delorie's DOS port of Gcc). Such an Emacs is heavily + underfeatured, because it does not supports long file names, + lacks proper subprocesses support, and is far too big + compared to typical DOS editors. + + * GNU Emacs compiled with Win32 + + - Starting with version 19.30, it has been possible to compile + GNU Emacs under MS Windows using the DJGPP compiler and X + libraries. The result is is very similar to GNU Emacs + compiled under MS DOS, only it supports longer file names, + etc. This "port" is similar to the "X" flavor of XEmacs on + MS Windows. + + * NT Emacs + + - NT Emacs is a version of GNU Emacs modified to compile and + run under MS MS Windows 95 and NT using the native Win32 API. + As such, it is close in spirit to the XEmacs "native" port. + + - NT Emacs has been written by Geoff Voelker, and more + information can be found at + `http://www.cs.washington.edu/homes/voelker/ntemacs.html'. + + + * XEmacs + + - Beginning with XEmacs 19.12, XEmacs' architecture has been + redesigned in such a way to allow clean support of multiple + window systems. At this time the TTY support was added, + making X and TTY the first two "window systems" XEmacs + supported. The 19.12 design is the basis for the current + native MS Windows code. + + - Some time during 1997, David Hobley (soon joined by Marc + Paquette) imported some of the NT-specific portions of GNU + Emacs, making XEmacs with X support compile under Windows NT, + and creating the "X" port. + + - Several months later, Jonathan Harris sent out initial + patches to use the Win32 API, thus creating the native port. + Since then, various people have contributed, including Kirill + M. Katsnelson (contributed support for menubars, subprocesses + and network, as well as loads of other code), Andy Piper + (ported XEmacs to Cygwin environment, contributed Windows + unexec, Windows-specific glyphs and toolbars code, and more), + Jeff Sparkes (contributed scrollbars support) and many others. + + + + +File: xemacs-faq.info, Node: Q6.3.3, Prev: Q6.3.2, Up: MS Windows + +Q6.3.3: What is the porting team doing at the moment? +----------------------------------------------------- + + The porting team is continuing work on the MS Windows-specific code. + + +File: xemacs-faq.info, Node: Current Events, Prev: MS Windows, Up: Top -6 What the Future Holds +7 What the Future Holds *********************** - This is part 6 of the XEmacs Frequently Asked Questions list. This + This is part 7 of the XEmacs Frequently Asked Questions list. This section will change monthly, and contains any interesting items that have transpired over the previous month. If you are reading this from the XEmacs distribution, please see the version on the Web or archived @@ -852,18 +1216,18 @@ at the various FAQ FTP sites, as this file is surely out of date. * Menu: -* Q6.0.1:: What is new in 20.2? -* Q6.0.2:: What is new in 20.3? -* Q6.0.3:: What is new in 20.4? -* Q6.0.4:: Procedural changes in XEmacs development. +* Q7.0.1:: What is new in 20.2? +* Q7.0.2:: What is new in 20.3? +* Q7.0.3:: What is new in 20.4? +* Q7.0.4:: Procedural changes in XEmacs development.  -File: xemacs-faq.info, Node: Q6.0.1, Next: Q6.0.2, Prev: Current Events, Up: Current Events +File: xemacs-faq.info, Node: Q7.0.1, Next: Q7.0.2, Prev: Current Events, Up: Current Events -6.0: Changes +7.0: Changes ============ -Q6.0.1: What is new in 20.2? +Q7.0.1: What is new in 20.2? ---------------------------- The biggest changes in 20.2 include integration of EFS (the next @@ -876,9 +1240,9 @@ new system for customizing XEmacs options, invoked via `M-x customize'. longer considered unstable.  -File: xemacs-faq.info, Node: Q6.0.2, Next: Q6.0.3, Prev: Q6.0.1, Up: Current Events +File: xemacs-faq.info, Node: Q7.0.2, Next: Q7.0.3, Prev: Q7.0.1, Up: Current Events -Q6.0.2: What is new in 20.3? +Q7.0.2: What is new in 20.3? ---------------------------- XEmacs 20.3 was released in November 1997. It contains many bugfixes, @@ -899,17 +1263,17 @@ the default) is definitely faster than XEmacs 19.16. for all further development.  -File: xemacs-faq.info, Node: Q6.0.3, Next: Q6.0.4, Prev: Q6.0.2, Up: Current Events +File: xemacs-faq.info, Node: Q7.0.3, Next: Q7.0.4, Prev: Q7.0.2, Up: Current Events -Q6.0.3: What's new in XEmacs 20.4? +Q7.0.3: What's new in XEmacs 20.4? ---------------------------------- XEmacs 20.4 is a bugfix release with no user-visible changes.  -File: xemacs-faq.info, Node: Q6.0.4, Prev: Q6.0.3, Up: Current Events +File: xemacs-faq.info, Node: Q7.0.4, Prev: Q7.0.3, Up: Current Events -Q6.0.4: Procedural changes in XEmacs development. +Q7.0.4: Procedural changes in XEmacs development. ------------------------------------------------- 1. Discussion about the development of XEmacs occurs on the diff --git a/info/xemacs.info-19 b/info/xemacs.info-19 index 5ad3c61..cd04dc6 100644 --- a/info/xemacs.info-19 +++ b/info/xemacs.info-19 @@ -533,8 +533,8 @@ Key (Character) Index * C->: Setting Mark. * C-@ (Calendar mode): Mark and Region. * C-\: Select Input Method. -* C-] <1>: Recursive Edit. -* C-]: Quitting. +* C-] <1>: Quitting. +* C-]: Recursive Edit. * C-_: Undo. * C-a: Basic. * C-a (Calendar mode): Move to Beginning or End. @@ -622,8 +622,8 @@ Key (Character) Index * C-h C-c: Help. * C-h C-d: Help. * C-h C-w: Help. -* C-h f <1>: Help. -* C-h f: Documentation. +* C-h f <1>: Documentation. +* C-h f: Help. * C-h h: Mule Intro. * C-h I: Select Input Method. * C-h i: Help. @@ -635,20 +635,20 @@ Key (Character) Index * C-h s: Syntax Change. * C-h t <1>: Help. * C-h t: Basic. -* C-h v <1>: Help. -* C-h v <2>: Examining. -* C-h v: Documentation. +* C-h v <1>: Examining. +* C-h v <2>: Documentation. +* C-h v: Help. * C-h w: Help. * C-HOME: Basic. * C-k: Killing. -* C-l <1>: Basic. -* C-l: Scrolling. +* C-l <1>: Scrolling. +* C-l: Basic. * C-l (query-replace): Query Replace. * C-LEFT: Basic. -* C-M-@ <1>: Marking Objects. -* C-M-@: Lists. -* C-M-\ <1>: Indentation Commands. -* C-M-\: Multi-line Indent. +* C-M-@ <1>: Lists. +* C-M-@: Marking Objects. +* C-M-\ <1>: Multi-line Indent. +* C-M-\: Indentation Commands. * C-M-a: Defuns. * C-M-a (Fortran mode): Fortran Motion. * C-M-b: Lists. @@ -657,18 +657,18 @@ Key (Character) Index * C-M-e: Defuns. * C-M-e (Fortran mode): Fortran Motion. * C-M-f: Lists. -* C-M-h <1>: Marking Objects. -* C-M-h: Defuns. +* C-M-h <1>: Defuns. +* C-M-h: Marking Objects. * C-M-h (Fortran mode): Fortran Motion. -* C-M-k <1>: Killing. -* C-M-k: Lists. +* C-M-k <1>: Lists. +* C-M-k: Killing. * C-M-n: Lists. * C-M-o: Indentation Commands. * C-M-p: Lists. * C-M-q: Multi-line Indent. * C-M-q (Fortran mode): ForIndent Commands. -* C-M-t <1>: Transpose. -* C-M-t: Lists. +* C-M-t <1>: Lists. +* C-M-t: Transpose. * C-M-u: Lists. * C-M-v <1>: Other Window. * C-M-v: Minibuffer Edit. @@ -745,8 +745,8 @@ Key (Character) Index * C-x C-l: Case. * C-x C-o <1>: Killing. * C-x C-o: Blank Lines. -* C-x C-p <1>: Marking Objects. -* C-x C-p: Pages. +* C-x C-p <1>: Pages. +* C-x C-p: Marking Objects. * C-x C-q: Misc Buffer. * C-x C-q (version control): Editing with VC. * C-x C-s: Saving. @@ -802,26 +802,26 @@ Key (Character) Index * C-z: Exiting. * control key: Intro to Keystrokes. * d (Calendar mode): Diary Commands. -* DEL <1>: Basic. -* DEL <2>: Killing. +* DEL <1>: Program Modes. +* DEL <2>: Major Modes. * DEL <3>: Kill Errors. -* DEL <4>: Program Modes. -* DEL: Major Modes. +* DEL <4>: Killing. +* DEL: Basic. * DEL (isearch-mode): Incremental Search. * DEL (query-replace): Query Replace. * DOWN: Basic. * END: Basic. -* ESC <1>: Key Sequences. -* ESC: Meta Key. +* ESC <1>: Meta Key. +* ESC: Key Sequences. * ESC (query-replace): Query Replace. * g CHAR (Calendar mode): From Other Calendar. * g d (Calendar mode): Specified Dates. * g m l (Calendar mode): Mayan Calendar. * h (Calendar mode): Holidays. * HOME: Basic. -* hyper key <1>: Intro to Keystrokes. +* hyper key <1>: Super and Hyper Keys. * hyper key <2>: Representing Keystrokes. -* hyper key: Super and Hyper Keys. +* hyper key: Intro to Keystrokes. * i a (Calendar mode): Special Diary Entries. * i b (Calendar mode): Special Diary Entries. * i c (Calendar mode): Special Diary Entries. @@ -831,11 +831,11 @@ Key (Character) Index * i y (Calendar mode): Adding to Diary. * LEFT: Basic. * LFD <1>: Basic Indent. -* LFD <2>: String Key Sequences. -* LFD: Major Modes. +* LFD <2>: Major Modes. +* LFD: String Key Sequences. * LFD (TeX mode): TeX Editing. -* M (Calendar mode): Lunar Phases. * m (Calendar mode): Diary Commands. +* M (Calendar mode): Lunar Phases. * M-!: Single Shell. * M-$: Spelling. * M-%: Query Replace. @@ -864,8 +864,8 @@ Key (Character) Index * M-\ <1>: Indentation Commands. * M-\: Killing. * M-]: Paragraphs. -* M-^ <1>: Killing. -* M-^: Indentation Commands. +* M-^ <1>: Indentation Commands. +* M-^: Killing. * M-a: Sentences. * M-a (Calendar mode): Move to Beginning or End. * M-b: Words. @@ -873,9 +873,9 @@ Key (Character) Index * M-C-s: Regexp Search. * M-d <1>: Words. * M-d: Killing. -* M-DEL <1>: Killing. +* M-DEL <1>: Words. * M-DEL <2>: Kill Errors. -* M-DEL: Words. +* M-DEL: Killing. * M-e: Sentences. * M-e (Calendar mode): Move to Beginning or End. * M-ESC: Lisp Eval. @@ -884,8 +884,8 @@ Key (Character) Index * M-h <1>: Paragraphs. * M-h: Marking Objects. * M-i: Tab Stops. -* M-k <1>: Killing. -* M-k: Sentences. +* M-k <1>: Sentences. +* M-k: Killing. * M-l: Case. * M-LFD: Comments. * M-LFD (Fortran mode): ForIndent Commands. @@ -894,23 +894,23 @@ Key (Character) Index * M-n: Repetition. * M-n (isearch-mode): Incremental Search. * M-n (Shell mode): Shell Mode. -* M-p <1>: Repetition. -* M-p: Nroff Mode. +* M-p <1>: Nroff Mode. +* M-p: Repetition. * M-p (isearch-mode): Incremental Search. * M-p (Shell mode): Shell Mode. * M-q: Fill Commands. * M-r: Basic. * M-s: Fill Commands. * M-SPC: Killing. -* M-t <1>: Transpose. -* M-t: Words. +* M-t <1>: Words. +* M-t: Transpose. * M-TAB <1>: Tabs in Picture. * M-TAB: Lisp Completion. * M-TAB (customization buffer): Changing an Option. * M-TAB (isearch-mode): Incremental Search. * M-u: Case. -* M-v <1>: Basic. -* M-v: Scrolling. +* M-v <1>: Scrolling. +* M-v: Basic. * M-v (Calendar mode): Scroll Calendar. * M-w: Kill Ring. * M-x: M-x. @@ -926,10 +926,10 @@ Key (Character) Index * o (Calendar mode): Specified Dates. * p (Calendar mode): To Other Calendar. * p d (Calendar mode): General Calendar. -* PGDN: Basic. * pgdn: Scrolling. -* PGUP: Basic. +* PGDN: Basic. * pgup: Scrolling. +* PGUP: Basic. * prior: Scrolling. * q (Calendar mode): General Calendar. * RET: Basic. @@ -943,16 +943,16 @@ Key (Character) Index * SPC: Completion. * SPC (Calendar mode): General Calendar. * SPC (query-replace): Query Replace. -* super key <1>: Intro to Keystrokes. -* super key <2>: Super and Hyper Keys. -* super key: Representing Keystrokes. +* super key <1>: Super and Hyper Keys. +* super key <2>: Representing Keystrokes. +* super key: Intro to Keystrokes. * t (Calendar mode): LaTeX Calendar. -* TAB <1>: String Key Sequences. -* TAB <2>: Major Modes. -* TAB <3>: Basic Indent. -* TAB <4>: Text Mode. +* TAB <1>: Basic Indent. +* TAB <2>: Text Mode. +* TAB <3>: Indentation. +* TAB <4>: Major Modes. * TAB <5>: Completion. -* TAB: Indentation. +* TAB: String Key Sequences. * TAB (customization buffer): Changing an Option. * TAB (Shell mode): Shell Mode. * u (Calendar mode) <1>: Diary Commands. diff --git a/info/xemacs.info-20 b/info/xemacs.info-20 index 0522386..b1879d6 100644 --- a/info/xemacs.info-20 +++ b/info/xemacs.info-20 @@ -37,11 +37,11 @@ Command and Function Index * Menu: -* abbrev-mode <1>: Abbrevs. -* abbrev-mode: Minor Modes. +* abbrev-mode <1>: Minor Modes. +* abbrev-mode: Abbrevs. * abbrev-prefix-mark: Expanding Abbrevs. -* abort-recursive-edit <1>: Recursive Edit. -* abort-recursive-edit: Quitting. +* abort-recursive-edit <1>: Quitting. +* abort-recursive-edit: Recursive Edit. * add-change-log-entry: Change Log. * add-global-abbrev: Defining Abbrevs. * add-menu: Menu Customization. @@ -61,11 +61,11 @@ Command and Function Index * back-to-indentation: Indentation Commands. * backward-char: Basic. * backward-delete-char-untabify: Program Modes. -* backward-kill-sentence <1>: Kill Errors. -* backward-kill-sentence <2>: Sentences. +* backward-kill-sentence <1>: Sentences. +* backward-kill-sentence <2>: Kill Errors. * backward-kill-sentence: Killing. -* backward-kill-word <1>: Kill Errors. -* backward-kill-word <2>: Words. +* backward-kill-word <1>: Words. +* backward-kill-word <2>: Kill Errors. * backward-kill-word: Killing. * backward-list: Lists. * backward-page: Pages. @@ -143,8 +143,8 @@ Command and Function Index * calendar-unmark: Holidays. * call-last-kbd-macro: Basic Kbd Macro. * cancel-debug-on-entry: Lisp Debug. -* capitalize-word <1>: Fixing Case. -* capitalize-word: Case. +* capitalize-word <1>: Case. +* capitalize-word: Fixing Case. * center-line: Fill Commands. * clear-rectangle: Rectangles. * comint-delchar-or-maybe-eof: Shell Mode. @@ -188,9 +188,9 @@ Command and Function Index * define-abbrevs: Saving Abbrevs. * define-key <1>: Programmatic Rebinding. * define-key: Interactive Rebinding. -* delete-backward-char <1>: Basic. +* delete-backward-char <1>: Kill Errors. * delete-backward-char <2>: Killing. -* delete-backward-char: Kill Errors. +* delete-backward-char: Basic. * delete-blank-lines <1>: Killing. * delete-blank-lines: Blank Lines. * delete-char <1>: Basic Picture. @@ -211,8 +211,8 @@ Command and Function Index * describe-coding-system: Coding Systems. * describe-copying: Help. * describe-distribution: Help. -* describe-function <1>: Help. -* describe-function: Documentation. +* describe-function <1>: Documentation. +* describe-function: Help. * describe-input-method: Select Input Method. * describe-key: Help. * describe-key-briefly: Help. @@ -220,16 +220,16 @@ Command and Function Index * describe-mode: Help. * describe-no-warranty: Help. * describe-syntax: Syntax Change. -* describe-variable <1>: Documentation. -* describe-variable <2>: Examining. +* describe-variable <1>: Examining. +* describe-variable <2>: Documentation. * describe-variable: Help. * diary: Diary Commands. -* diary-anniversary <1>: Special Diary Entries. -* diary-anniversary: Sexp Diary Entries. +* diary-anniversary <1>: Sexp Diary Entries. +* diary-anniversary: Special Diary Entries. * diary-astro-day-number: Sexp Diary Entries. * diary-block: Special Diary Entries. -* diary-cyclic <1>: Special Diary Entries. -* diary-cyclic: Sexp Diary Entries. +* diary-cyclic <1>: Sexp Diary Entries. +* diary-cyclic: Special Diary Entries. * diary-day-of-year: Sexp Diary Entries. * diary-float: Special Diary Entries. * diary-french-date: Sexp Diary Entries. @@ -303,8 +303,8 @@ Command and Function Index * fill-region-as-paragraph: Fill Commands. * find-alternate-file: Visiting. * find-file: Visiting. -* find-file-other-frame <1>: XEmacs under X. -* find-file-other-frame: Visiting. +* find-file-other-frame <1>: Visiting. +* find-file-other-frame: XEmacs under X. * find-file-other-window <1>: Pop Up Window. * find-file-other-window: Visiting. * find-tag: Find Tag. @@ -329,8 +329,8 @@ Command and Function Index * forward-sexp: Lists. * forward-text-line: Nroff Mode. * forward-word: Words. -* global-set-key <1>: Interactive Rebinding. -* global-set-key: Programmatic Rebinding. +* global-set-key <1>: Programmatic Rebinding. +* global-set-key: Interactive Rebinding. * goto-char: Basic. * goto-line: Basic. * hanoi: Amusements. @@ -402,8 +402,8 @@ Command and Function Index * kill-output-from-shell: Shell Mode. * kill-rectangle: Rectangles. * kill-region: Killing. -* kill-sentence <1>: Killing. -* kill-sentence: Sentences. +* kill-sentence <1>: Sentences. +* kill-sentence: Killing. * kill-sexp <1>: Lists. * kill-sexp: Killing. * kill-some-buffers: Kill Buffer. @@ -433,8 +433,8 @@ Command and Function Index * load: Loading. * load-default-sounds: Audible Bell. * load-file: Loading. -* load-library <1>: Startup Paths. -* load-library: Loading. +* load-library <1>: Loading. +* load-library: Startup Paths. * load-sound-file: Audible Bell. * local-set-key: Interactive Rebinding. * local-unset-key: Interactive Rebinding. @@ -445,8 +445,8 @@ Command and Function Index * mail-cc: Mail Mode. * mail-fill-yanked-message: Mail Mode. * mail-interactive-insert-alias: Mail Headers. -* mail-other-window <1>: Pop Up Window. -* mail-other-window: Sending Mail. +* mail-other-window <1>: Sending Mail. +* mail-other-window: Pop Up Window. * mail-send: Mail Mode. * mail-send-and-exit: Mail Mode. * mail-signature: Mail Mode. @@ -481,8 +481,8 @@ Command and Function Index * mark-page: Marking Objects. * mark-paragraph <1>: Paragraphs. * mark-paragraph: Marking Objects. -* mark-sexp <1>: Marking Objects. -* mark-sexp: Lists. +* mark-sexp <1>: Lists. +* mark-sexp: Marking Objects. * mark-whole-buffer: Marking Objects. * mark-word <1>: Words. * mark-word: Marking Objects. @@ -555,8 +555,8 @@ Command and Function Index * picture-tab-search: Tabs in Picture. * picture-yank-rectangle: Rectangles in Picture. * picture-yank-rectangle-from-register: Rectangles in Picture. -* plain-tex-mode: TeX Mode. * plain-TeX-mode: TeX Mode. +* plain-tex-mode: TeX Mode. * play-sound: Audible Bell. * point-to-register: RegPos. * prefer-coding-system: Recognize Coding. @@ -600,8 +600,8 @@ Command and Function Index * scroll-calendar-right-three-months: Scroll Calendar. * scroll-down: Scrolling. * scroll-left: Horizontal Scrolling. -* scroll-other-window <1>: Other Window. -* scroll-other-window: General Calendar. +* scroll-other-window <1>: General Calendar. +* scroll-other-window: Other Window. * scroll-right: Horizontal Scrolling. * scroll-up: Scrolling. * search-backward: Non-Incremental Search. @@ -663,13 +663,13 @@ Command and Function Index * sunrise-sunset: Sunrise/Sunset. * suspend-emacs: Exiting. * switch-to-buffer: Select Buffer. -* switch-to-buffer-other-frame <1>: XEmacs under X. -* switch-to-buffer-other-frame: Select Buffer. -* switch-to-buffer-other-window <1>: Select Buffer. -* switch-to-buffer-other-window: Pop Up Window. +* switch-to-buffer-other-frame <1>: Select Buffer. +* switch-to-buffer-other-frame: XEmacs under X. +* switch-to-buffer-other-window <1>: Pop Up Window. +* switch-to-buffer-other-window: Select Buffer. * switch-to-other-buffer: Select Buffer. -* tab-to-tab-stop <1>: Tab Stops. -* tab-to-tab-stop: Text Mode. +* tab-to-tab-stop <1>: Text Mode. +* tab-to-tab-stop: Tab Stops. * tabify: Just Spaces. * tags-apropos: List Tags. * tags-loop-continue: Tags Search. @@ -683,8 +683,8 @@ Command and Function Index * tex-insert-braces: TeX Editing. * tex-insert-quote: TeX Editing. * tex-kill-job: TeX Print. -* TeX-mode: TeX Mode. * tex-mode: TeX Mode. +* TeX-mode: TeX Mode. * tex-print: TeX Print. * tex-recenter-output-buffer: TeX Print. * tex-region: TeX Print. @@ -693,15 +693,15 @@ Command and Function Index * text-mode: Text Mode. * toggle-input-method: Select Input Method. * toggle-read-only: Misc Buffer. -* top-level <1>: Recursive Edit. -* top-level: Quitting. -* transpose-chars <1>: Basic. -* transpose-chars: Transpose. +* top-level <1>: Quitting. +* top-level: Recursive Edit. +* transpose-chars <1>: Transpose. +* transpose-chars: Basic. * transpose-lines: Transpose. * transpose-sexps <1>: Lists. * transpose-sexps: Transpose. -* transpose-words <1>: Transpose. -* transpose-words: Words. +* transpose-words <1>: Words. +* transpose-words: Transpose. * undo: Undo. * unexpand-abbrev: Expanding Abbrevs. * universal-argument: Arguments. @@ -709,8 +709,8 @@ Command and Function Index * untabify: Just Spaces. * up-list: TeX Editing. * upcase-region: Case. -* upcase-word <1>: Fixing Case. -* upcase-word: Case. +* upcase-word <1>: Case. +* upcase-word: Fixing Case. * validate-tex-buffer: TeX Editing. * vc-cancel-version: Editing with VC. * vc-create-snapshot: Making Snapshots. diff --git a/info/xemacs.info-21 b/info/xemacs.info-21 index ba0998f..f16774b 100644 --- a/info/xemacs.info-21 +++ b/info/xemacs.info-21 @@ -97,8 +97,8 @@ Variable Index * calendar-time-zone: Sunrise/Sunset. * calendar-today-marker: Calendar Customizing. * calendar-week-start-day: Move to Beginning or End. -* case-fold-search <1>: Search Case. -* case-fold-search: Replacement and Case. +* case-fold-search <1>: Replacement and Case. +* case-fold-search: Search Case. * case-replace: Replacement and Case. * christian-holidays: Holiday Customizing. * coding: Recognize Coding. @@ -178,8 +178,8 @@ Variable Index * fortran-if-indent: ForIndent Vars. * fortran-line-number-indent: ForIndent Num. * fortran-minimum-statement-indent: ForIndent Vars. -* frame-icon-title-format <1>: XEmacs under X. -* frame-icon-title-format: Command Switches. +* frame-icon-title-format <1>: Command Switches. +* frame-icon-title-format: XEmacs under X. * frame-title-format <1>: Command Switches. * frame-title-format: XEmacs under X. * general-holidays: Holiday Customizing. @@ -195,8 +195,8 @@ Variable Index * input-method-highlight-flag: Input Methods. * input-method-verbose-flag: Input Methods. * input-ring-size: Interactive Shell. -* insert-default-directory <1>: Minibuffer File. -* insert-default-directory: File Names. +* insert-default-directory <1>: File Names. +* insert-default-directory: Minibuffer File. * isearch-mode-map: Keymaps. * islamic-holidays: Holiday Customizing. * kept-new-versions: Backup Deletion. @@ -267,8 +267,8 @@ Variable Index * scroll-step: Scrolling. * search-slow-speed: Incremental Search. * search-slow-window-lines: Incremental Search. -* selective-display-ellipses <1>: Display Vars. -* selective-display-ellipses: Outline Visibility. +* selective-display-ellipses <1>: Outline Visibility. +* selective-display-ellipses: Display Vars. * sentence-end: Sentences. * shell-cd-regexp: Interactive Shell. * shell-file-name: Single Shell. @@ -337,8 +337,8 @@ Concept Index * adding menu items: Menu Customization. * adding menus: Menu Customization. * againformation: Dissociated Press. -* Apps menu <1>: Pull-down Menus. -* Apps menu: Apps Menu. +* Apps menu <1>: Apps Menu. +* Apps menu: Pull-down Menus. * apropos: Help. * architecture-specific directories: Startup Paths. * arguments (from shell): Command Switches. @@ -347,9 +347,9 @@ Concept Index * astronomical day numbers: Calendar Systems. * audible bell, changing: Audible Bell. * Auto Delete Selection menu item: Options Menu. -* Auto Fill mode <1>: Comments. -* Auto Fill mode <2>: Auto Fill. -* Auto Fill mode: Minor Modes. +* Auto Fill mode <1>: Minor Modes. +* Auto Fill mode <2>: Comments. +* Auto Fill mode: Auto Fill. * Auto-Save mode: Auto Save. * autoload: Loading. * backup file: Backup. @@ -378,8 +378,8 @@ Concept Index * calendar and LaTeX: LaTeX Calendar. * calendar, first day of week: Move to Beginning or End. * candle lighting times: Sexp Diary Entries. -* case conversion <1>: Fixing Case. -* case conversion: Case. +* case conversion <1>: Case. +* case conversion: Fixing Case. * Case Sensitive Search menu item: Options Menu. * centering: Fill Commands. * change log: Change Log. @@ -393,8 +393,8 @@ Concept Index * Clear menu item: Edit Menu. * clipboard selections: X Clipboard Selection. * coding systems: Coding Systems. -* command <1>: Commands. -* command: Key Bindings. +* command <1>: Key Bindings. +* command: Commands. * command history: Repetition. * command line arguments: Command Switches. * command name: Key Bindings. @@ -409,19 +409,19 @@ Concept Index * Coptic calendar: Calendar Systems. * Copy menu item: Edit Menu. * copying files: Misc File Ops. -* copying text <1>: Yanking. -* copying text: Accumulating Text. +* copying text <1>: Accumulating Text. +* copying text: Yanking. * core distribution: Using Packages. * crashes: Auto Save. * creating directories: File Names. * creating files: Visiting. * current buffer: Buffers. * current stack frame: Lisp Debug. -* cursor <1>: Point. -* cursor: Basic. +* cursor <1>: Basic. +* cursor: Point. * customization <1>: Customization. -* customization <2>: Commands. -* customization: Lisp Indent. +* customization <2>: Lisp Indent. +* customization: Commands. * customization buffer: Easy Customization. * customization groups: Customization Groups. * customizing faces: Face Customization. @@ -455,11 +455,11 @@ Concept Index * dribble file: Bugs. * early package hierarchies: Startup Paths. * echo area: Echo Area. -* Edit menu <1>: Pull-down Menus. -* Edit menu: Edit Menu. +* Edit menu <1>: Edit Menu. +* Edit menu: Pull-down Menus. * editable fields (customization buffer): Customization Groups. -* editing level, recursive <1>: Recursive Edit. -* editing level, recursive: Quitting. +* editing level, recursive <1>: Quitting. +* editing level, recursive: Recursive Edit. * EDT: Emulation. * Eliza: Total Frustration. * Emacs initialization file: Init File. @@ -481,12 +481,12 @@ Concept Index * expression: Lists. * file dates: Interlocking. * file directory: ListDir. -* File menu <1>: Pull-down Menus. -* File menu: File Menu. +* File menu <1>: File Menu. +* File menu: Pull-down Menus. * file names: File Names. * file protection: Interlocking. -* files <1>: Files. -* files <2>: Visiting. +* files <1>: Visiting. +* files <2>: Files. * files: Basic. * fill prefix: Fill Prefix. * filling: Filling. @@ -519,9 +519,9 @@ Concept Index * holidays: Holidays. * horizontal scrolling: Horizontal Scrolling. * ignoriginal: Dissociated Press. -* indentation <1>: Grinding. -* indentation <2>: Indentation. -* indentation: Comments. +* indentation <1>: Comments. +* indentation <2>: Grinding. +* indentation: Indentation. * inferior process: Compilation. * init file: Init File. * input methods: Input Methods. @@ -542,8 +542,8 @@ Concept Index * key rebinding, this session: Rebinding. * keyboard macros: Keyboard Macros. * keycode: Super and Hyper Keys. -* keymap <1>: Commands. -* keymap: Keymaps. +* keymap <1>: Keymaps. +* keymap: Commands. * keystroke: Intro to Keystrokes. * keysym: Intro to Keystrokes. * keysyms: Super and Hyper Keys. @@ -586,19 +586,19 @@ Concept Index * Mayan tzolkin calendar: Mayan Calendar. * menus <1>: Change Window. * menus: Pull-down Menus. -* message <1>: Sending Mail. -* message: Reading Mail. +* message <1>: Reading Mail. +* message: Sending Mail. * Meta: Words. -* minibuffer <1>: M-x. -* minibuffer <2>: Keymaps. +* minibuffer <1>: Keymaps. +* minibuffer <2>: M-x. * minibuffer: Minibuffer. * minor modes: Minor Modes. * mistakes, correcting <1>: Fixit. * mistakes, correcting: Undo. * mocklisp: Mocklisp. * mode hook: Program Modes. -* mode line <1>: Mode Line. -* mode line: Minor Modes. +* mode line <1>: Minor Modes. +* mode line: Mode Line. * mode, Term: Term Mode. * modified (buffer): Visiting. * modifier key: Intro to Keystrokes. @@ -621,10 +621,10 @@ Concept Index * omer count: Sexp Diary Entries. * Open File, New Frame... menu item: File Menu. * Open File... menu item: File Menu. -* option <1>: Variables. -* option: Examining. -* Options menu <1>: Pull-down Menus. -* Options menu: Options Menu. +* option <1>: Examining. +* option: Variables. +* Options menu <1>: Options Menu. +* Options menu: Pull-down Menus. * other editors: Emulation. * outlines: Outline Mode. * outragedy: Dissociated Press. @@ -669,8 +669,8 @@ Concept Index * read-only buffer: Misc Buffer. * rebinding keys, permanently: Init File. * rebinding keys, this session: Rebinding. -* rectangle <1>: RegRect. -* rectangle: Rectangles in Picture. +* rectangle <1>: Rectangles in Picture. +* rectangle: RegRect. * rectangles: Rectangles. * recursive editing level <1>: Quitting. * recursive editing level: Recursive Edit. @@ -742,11 +742,11 @@ Concept Index * TeX: TeX Mode. * text: Text. * Text mode: Text Mode. -* Tools menu <1>: Pull-down Menus. -* Tools menu: Tools Menu. +* Tools menu <1>: Tools Menu. +* Tools menu: Pull-down Menus. * top level: Mode Line. -* transposition <1>: Words. -* transposition <2>: Lists. +* transposition <1>: Lists. +* transposition <2>: Words. * transposition: Transpose. * truncation: Continuation Lines. * typos: Fixit. @@ -771,12 +771,12 @@ Concept Index * Windows menu: Change Window. * word search: Word Search. * words <1>: Case. -* words <2>: Fixing Case. -* words: Words. +* words <2>: Words. +* words: Fixing Case. * work file: Concepts of VC. * X resources: X Resources. -* yahrzeits <1>: From Other Calendar. -* yahrzeits: Sexp Diary Entries. +* yahrzeits <1>: Sexp Diary Entries. +* yahrzeits: From Other Calendar. * yanking: Yanking.