1 This is ../info/texinfo.info, produced by makeinfo version 3.12s from
4 INFO-DIR-SECTION Texinfo documentation system
6 * Texinfo: (texinfo). The GNU documentation format.
7 * install-info: (texinfo)Invoking install-info. Updating info/dir entries.
8 * texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation.
9 * texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files.
10 * makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source.
13 This file documents Texinfo, a documentation system that can produce
14 both on-line information and a printed manual from a single source file.
16 Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 Free Software
19 This edition is for Texinfo version 3.12.
21 Permission is granted to make and distribute verbatim copies of this
22 manual provided the copyright notice and this permission notice are
23 preserved on all copies.
25 Permission is granted to copy and distribute modified versions of this
26 manual under the conditions for verbatim copying, provided that the
27 entire resulting derived work is distributed under the terms of a
28 permission notice identical to this one.
30 Permission is granted to copy and distribute translations of this
31 manual into another language, under the above conditions for modified
32 versions, except that this permission notice may be stated in a
33 translation approved by the Free Software Foundation.
36 File: texinfo.info, Node: Installing Dir Entries, Next: Invoking install-info, Prev: Other Info Directories, Up: Install an Info File
38 Installing Info Directory Files
39 ===============================
41 When you install an Info file onto your system, you can use the
42 program `install-info' to update the Info directory file `dir'.
43 Normally the makefile for the package runs `install-info', just after
44 copying the Info file into its proper installed location.
46 In order for the Info file to work with `install-info', you should
47 use the commands `@dircategory' and `@direntry' in the Texinfo source
48 file. Use `@direntry' to specify the menu entry to add to the Info
49 directory file, and use `@dircategory' to specify which part of the
50 Info directory to put it in. Here is how these commands are used in
53 @dircategory Texinfo documentation system
55 * Texinfo: (texinfo). The GNU documentation format.
56 * install-info: (texinfo)Invoking install-info. ...
60 Here's what this produces in the Info file:
62 INFO-DIR-SECTION Texinfo documentation system
64 * Texinfo: (texinfo). The GNU documentation format.
65 * install-info: (texinfo)Invoking install-info. ...
69 The `install-info' program sees these lines in the Info file, and that
70 is how it knows what to do.
72 Always use the `@direntry' and `@dircategory' commands near the
73 beginning of the Texinfo input, before the first `@node' command. If
74 you use them later on in the input, `install-info' will not notice them.
76 If you use `@dircategory' more than once in the Texinfo source, each
77 usage specifies one category; the new menu entry is added to the Info
78 directory file in each of the categories you specify. If you use
79 `@direntry' more than once, each usage specifies one menu entry; each
80 of these menu entries is added to the directory in each of the
84 File: texinfo.info, Node: Invoking install-info, Prev: Installing Dir Entries, Up: Install an Info File
89 `install-info' inserts menu entries from an Info file into the
90 top-level `dir' file in the Info system (see the previous sections for
91 an explanation of how the `dir' file works). It's most often run as
92 part of software installation, or when constructing a dir file for all
93 manuals on a system. Synopsis:
95 install-info [OPTION]... [INFO-FILE [DIR-FILE]]
97 If INFO-FILE or DIR-FILE are not specified, the various options
98 (described below) that define them must be. There are no compile-time
99 defaults, and standard input is never used. `install-info' can read
100 only one info file and write only one dir file per invocation.
102 If DIR-FILE (however specified) does not exist, `install-info'
103 creates it if possible (with no entries).
108 Delete the entries in INFO-FILE from DIR-FILE. The file name in
109 the entry in DIR-FILE must be INFO-FILE (except for an optional
110 `.info' in either one). Don't insert any new entries.
113 Specify file name of the Info directory file. This is equivalent
114 to using the DIR-FILE argument.
117 Insert TEXT as an Info directory entry; TEXT should have the form
118 of an Info menu item line plus zero or more extra lines starting
119 with whitespace. If you specify more than one entry, they are all
120 added. If you don't specify any entries, they are determined from
121 information in the Info file itself.
124 Display a usage message listing basic usage and all available
125 options, then exit successfully.
128 Specify Info file to install in the directory. This is equivalent
129 to using the INFO-FILE argument.
132 Equivalent to `--dir-file=DIR/dir'.
135 Same as `--entry=TEXT'. An Info directory entry is actually a
145 Put this file's entries in section SEC of the directory. If you
146 specify more than one section, all the entries are added in each
147 of the sections. If you don't specify any sections, they are
148 determined from information in the Info file itself.
151 Display version information and exit successfully.
154 File: texinfo.info, Node: Command List, Next: Tips, Prev: Install an Info File, Up: Top
159 Here is an alphabetical list of the @-commands in Texinfo. Square
160 brackets, [ ], indicate optional arguments; an ellipsis, `...',
161 indicates repeated text.
165 An `@' followed by a space, tab, or newline produces a normal,
166 stretchable, interword space. *Note Multiple Spaces::.
169 Generate an exclamation point that really does end a sentence
170 (usually after an end-of-sentence capital letter). *Note Ending a
175 Generate an umlaut or acute accent, respectively, over the next
176 character, as in o" and o'. *Note Inserting Accents::.
179 Force a line break. Do not end a paragraph that uses `@*' with an
180 `@refill' command. *Note Line Breaks::.
183 Generate a cedilla accent under C, as in c,. *Note Inserting
187 Insert a discretionary hyphenation point. *Note - and
191 Produce a period that really does end a sentence (usually after an
192 end-of-sentence capital letter). *Note Ending a Sentence::.
195 Indicate to TeX that an immediately preceding period, question
196 mark, exclamation mark, or colon does not end a sentence. Prevent
197 TeX from inserting extra whitespace as it does at the end of a
198 sentence. The command has no effect on the Info file output.
199 *Note Not Ending a Sentence::.
202 Generate a macro (bar) accent over the next character, as in o=.
203 *Note Inserting Accents::.
206 Generate a question mark that really does end a sentence (usually
207 after an end-of-sentence capital letter). *Note Ending a
211 Stands for an at sign, `@'. *Note Inserting @ and braces: Braces
216 Generate a circumflex (hat) or grave accent, respectively, over
217 the next character, as in o^. *Note Inserting Accents::.
220 Stands for a left brace, `{'. *Note Inserting @ and braces:
224 Stands for a right-hand brace, `}'.
225 *Note Inserting @ and braces: Braces Atsigns.
228 Generate a tilde accent over the next character, as in N~. *Note
233 Generate the uppercase and lowercase Scandinavian A-ring letters,
234 respectively: AA, aa. *Note Inserting Accents::.
238 Generate the uppercase and lowercase AE ligatures, respectively:
239 AE, ae. *Note Inserting Accents::.
242 Change page dimensions for the A4 paper size. Only allowed inside
243 `@iftex' ... `@end iftex'. *Note A4 Paper::.
246 Begin an appendix. The title appears in the table of contents of
247 a printed manual. In Info, the title is underlined with
248 asterisks. *Note The `@unnumbered' and `@appendix' Commands:
249 unnumbered & appendix.
252 `@appendixsection TITLE'
253 Begin an appendix section within an appendix. The section title
254 appears in the table of contents of a printed manual. In Info,
255 the title is underlined with equal signs. `@appendixsection' is a
256 longer spelling of the `@appendixsec' command. *Note Section
257 Commands: unnumberedsec appendixsec heading.
259 `@appendixsubsec TITLE'
260 Begin an appendix subsection within an appendix. The title appears
261 in the table of contents of a printed manual. In Info, the title
262 is underlined with hyphens. *Note Subsection Commands:
263 unnumberedsubsec appendixsubsec subheading.
265 `@appendixsubsubsec TITLE'
266 Begin an appendix subsubsection within an appendix subsection. The
267 title appears in the table of contents of a printed manual. In
268 Info, the title is underlined with periods. *Note The `subsub'
269 Commands: subsubsection.
272 Used following `@table', `@ftable', and `@vtable' to print the
273 table's first column without highlighting ("as is"). *Note Making
274 a Two-column Table: Two-column Tables.
277 Typeset AUTHOR flushleft and underline it. *Note The `@title' and
278 `@author' Commands: title subtitle author.
281 Print TEXT in bold font. No effect in Info. *Note Fonts::.
284 Generate a large round dot, or the closest possible thing to one.
285 *Note `@bullet': bullet.
288 Stop formatting a file. The formatters do not see the contents of
289 a file following an `@bye' command. *Note Ending a File::.
292 Begin a comment in Texinfo. The rest of the line does not appear
293 in either the Info file or the printed manual. A synonym for
294 `@comment'. *Note Comments: Comments.
297 Highlight an example or quotation by drawing a box with rounded
298 corners around it. Pair with `@end cartouche'. No effect in
299 Info. *Note Drawing Cartouches Around Examples: cartouche.)
301 `@center LINE-OF-TEXT'
302 Center the line of text following the command. *Note `@center':
305 `@centerchap LINE-OF-TEXT'
306 Like `@chapter', but centers the chapter title. *Note `@chapter':
310 Print a chapter-like heading in the text, but not in the table of
311 contents of a printed manual. In Info, the title is underlined
312 with asterisks. *Note `@majorheading' and `@chapheading':
313 majorheading & chapheading.
316 Begin a chapter. The chapter title appears in the table of
317 contents of a printed manual. In Info, the title is underlined
318 with asterisks. *Note `@chapter': chapter.
321 Add ENTRY to the index of concepts. *Note Defining the Entries of
322 an Index: Index Entries.
325 Highlight the name of a book or other reference that lacks a
326 companion Info file. *Note `@cite': cite.
329 Unset FLAG, preventing the Texinfo formatting commands from
330 formatting text between subsequent pairs of `@ifset FLAG' and
331 `@end ifset' commands, and preventing `@value{FLAG}' from
332 expanding to the value to which FLAG is set. *Note `@set'
333 `@clear' `@value': set clear value.
336 Highlight text that is an expression, a syntactically complete
337 token of a program, or a program name. *Note `@code': code.
340 Begin a comment in Texinfo. The rest of the line does not appear
341 in either the Info file or the printed manual. A synonym for `@c'.
342 *Note Comments: Comments.
345 Print a complete table of contents. Has no effect in Info, which
346 uses menus instead. *Note Generating a Table of Contents:
350 Generate a copyright symbol. *Note `@copyright': copyright symbol.
352 `@defcodeindex INDEX-NAME'
353 Define a new index and its indexing command. Print entries in an
354 `@code' font. *Note Defining New Indices: New Indices.
356 `@defcv CATEGORY CLASS NAME'
357 `@defcvx CATEGORY CLASS NAME'
358 Format a description for a variable associated with a class in
359 object-oriented programming. Takes three arguments: the category
360 of thing being defined, the class to which it belongs, and its
361 name. *Note Definition Commands::, and *Note Def Cmds in Detail:
364 `@deffn CATEGORY NAME ARGUMENTS...'
365 `@deffnx CATEGORY NAME ARGUMENTS...'
366 Format a description for a function, interactive command, or
367 similar entity that may take arguments. `@deffn' takes as
368 arguments the category of entity being described, the name of this
369 particular entity, and its arguments, if any. *Note Definition
372 `@defindex INDEX-NAME'
373 Define a new index and its indexing command. Print entries in a
374 roman font. *Note Defining New Indices: New Indices.
376 `@definfoenclose NEW-COMMAND, BEFORE, AFTER,'
377 Create new @-command for Info that marks text by enclosing it in
378 strings that precede and follow the text. Write definition inside
379 of `@ifinfo' ... `@end ifinfo'. *Note Customized Highlighting::.
381 `@defivar CLASS INSTANCE-VARIABLE-NAME'
382 `@defivarx CLASS INSTANCE-VARIABLE-NAME'
383 This command formats a description for an instance variable in
384 object-oriented programming. The command is equivalent to `@defcv
385 {Instance Variable} ...'. *Note Definition Commands::, and *Note
386 Def Cmds in Detail: deffnx.
388 `@defmac MACRO-NAME ARGUMENTS...'
389 `@defmacx MACRO-NAME ARGUMENTS...'
390 Format a description for a macro. The command is equivalent to
391 `@deffn Macro ...'. *Note Definition Commands::, and *Note Def
392 Cmds in Detail: deffnx.
394 `@defmethod CLASS METHOD-NAME ARGUMENTS...'
395 `@defmethodx CLASS METHOD-NAME ARGUMENTS...'
396 Format a description for a method in object-oriented programming.
397 The command is equivalent to `@defop Method ...'. Takes as
398 arguments the name of the class of the method, the name of the
399 method, and its arguments, if any. *Note Definition Commands::,
400 and *Note Def Cmds in Detail: deffnx.
402 `@defop CATEGORY CLASS NAME ARGUMENTS...'
403 `@defopx CATEGORY CLASS NAME ARGUMENTS...'
404 Format a description for an operation in object-oriented
405 programming. `@defop' takes as arguments the overall name of the
406 category of operation, the name of the class of the operation, the
407 name of the operation, and its arguments, if any. *Note
408 Definition Commands::, and *Note Def Cmds in Detail: deffnx.
410 `@defopt OPTION-NAME'
411 `@defoptx OPTION-NAME'
412 Format a description for a user option. The command is equivalent
413 to `@defvr {User Option} ...'. *Note Definition Commands::, and
414 *Note Def Cmds in Detail: deffnx.
416 `@defspec SPECIAL-FORM-NAME ARGUMENTS...'
417 `@defspecx SPECIAL-FORM-NAME ARGUMENTS...'
418 Format a description for a special form. The command is
419 equivalent to `@deffn {Special Form} ...'. *Note Definition
420 Commands::, and *Note Def Cmds in Detail: deffnx.
422 `@deftp CATEGORY NAME-OF-TYPE ATTRIBUTES...'
423 `@deftpx CATEGORY NAME-OF-TYPE ATTRIBUTES...'
424 Format a description for a data type. `@deftp' takes as arguments
425 the category, the name of the type (which is a word like `int' or
426 `float'), and then the names of attributes of objects of that type.
427 *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx.
429 `@deftypefn CLASSIFICATION DATA-TYPE NAME ARGUMENTS...'
430 `@deftypefnx CLASSIFICATION DATA-TYPE NAME ARGUMENTS...'
431 Format a description for a function or similar entity that may take
432 arguments and that is typed. `@deftypefn' takes as arguments the
433 classification of entity being described, the type, the name of the
434 entity, and its arguments, if any. *Note Definition Commands::,
435 and *Note Def Cmds in Detail: deffnx.
437 `@deftypefun DATA-TYPE FUNCTION-NAME ARGUMENTS...'
438 `@deftypefunx DATA-TYPE FUNCTION-NAME ARGUMENTS...'
439 Format a description for a function in a typed language. The
440 command is equivalent to `@deftypefn Function ...'. *Note
441 Definition Commands::, and *Note Def Cmds in Detail: deffnx.
443 `@deftypemethod CLASS DATA-TYPE METHOD-NAME ARGUMENTS...'
444 `@deftypemethodx CLASS DATA-TYPE METHOD-NAME ARGUMENTS...'
445 Format a description for a typed method in object-oriented
446 programming. Takes as arguments the name of the class of the
447 method, the return type of the method, the name of the method, and
448 its arguments, if any. *Note Definition Commands::, and *Note Def
449 Cmds in Detail: deffnx.
451 `@deftypevr CLASSIFICATION DATA-TYPE NAME'
452 `@deftypevrx CLASSIFICATION DATA-TYPE NAME'
453 Format a description for something like a variable in a typed
454 language--an entity that records a value. Takes as arguments the
455 classification of entity being described, the type, and the name
456 of the entity. *Note Definition Commands::, and *Note Def Cmds in
459 `@deftypevar DATA-TYPE VARIABLE-NAME'
460 `@deftypevarx DATA-TYPE VARIABLE-NAME'
461 Format a description for a variable in a typed language. The
462 command is equivalent to `@deftypevr Variable ...'. *Note
463 Definition Commands::, and *Note Def Cmds in Detail: deffnx.
465 `@defun FUNCTION-NAME ARGUMENTS...'
466 `@defunx FUNCTION-NAME ARGUMENTS...'
467 Format a description for functions. The command is equivalent to
468 `@deffn Function ...'. *Note Definition Commands::, and *Note Def
469 Cmds in Detail: deffnx.
471 `@defvar VARIABLE-NAME'
472 `@defvarx VARIABLE-NAME'
473 Format a description for variables. The command is equivalent to
474 `@defvr Variable ...'. *Note Definition Commands::, and *Note Def
475 Cmds in Detail: deffnx.
477 `@defvr CATEGORY NAME'
478 `@defvrx CATEGORY NAME'
479 Format a description for any kind of variable. `@defvr' takes as
480 arguments the category of the entity and the name of the entity.
481 *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx.
484 Avoid `makeinfo' confusion stemming from the detailed node listing
485 in a master menu. *Note Master Menu Parts::.
488 Highlight the introductory or defining use of a term. *Note
491 `@dircategory DIRPART'
492 Specify a part of the Info directory menu where this file's entry
493 should go. *Note Installing Dir Entries::.
496 Begin the Info directory menu entry for this file. *Note
497 Installing Dir Entries::.
500 Begin a kind of example. Indent text, do not fill, do not select a
501 new font. Pair with `@end display'. *Note `@display': display.
504 Format a unit of measure, as in 12pt. Causes TeX to insert a thin
505 space before DIMENSION. No effect in Info. *Note `@dmn': dmn.
508 Generate a dot accent over the character C, as in oo.. *Note
512 Insert an ellipsis: `...'. *Note `@dots{}': dots.
514 `@email{ADDRESS[, DISPLAYED-TEXT]}'
515 Indicate an electronic mail address. *Note `@email': email.
518 Highlight TEXT; text is displayed in _italics_ in printed output,
519 and surrounded by asterisks in Info. *Note Emphasizing Text:
523 Ends ENVIRONMENT, as in `@end example'. *Note @-commands:
527 Generate an end-of-sentence of ellipsis, like this .... *Note
530 `@enumerate [NUMBER-OR-LETTER]'
531 Begin a numbered list, using `@item' for each entry. Optionally,
532 start list with NUMBER-OR-LETTER. Pair with `@end enumerate'.
533 *Note `@enumerate': enumerate.
536 Indicate to the reader the exact equivalence of two forms with a
537 glyph: `=='. *Note Equivalence::.
540 Indicate to the reader with a glyph that the following text is an
541 error message: `error-->'. *Note Error Glyph::.
543 `@evenfooting [LEFT] @| [CENTER] @| [RIGHT]'
544 `@evenheading [LEFT] @| [CENTER] @| [RIGHT]'
545 Specify page footings resp. headings for even-numbered (left-hand)
546 pages. Only allowed inside `@iftex'. *Note How to Make Your Own
547 Headings: Custom Headings.
549 `@everyfooting [LEFT] @| [CENTER] @| [RIGHT]'
550 `@everyheading [LEFT] @| [CENTER] @| [RIGHT]'
551 Specify page footings resp. headings for every page. Not relevant
552 to Info. *Note How to Make Your Own Headings: Custom Headings.
555 Begin an example. Indent text, do not fill, and select
556 fixed-width font. Pair with `@end example'. *Note `@example':
560 Produce an upside-down exclamation point. *Note Inserting
563 `@exdent LINE-OF-TEXT'
564 Remove any indentation a line might have. *Note Undoing the
565 Indentation of a Line: exdent.
568 Indicate the result of a macro expansion to the reader with a
569 special glyph: `==>'. *Note ==> Indicating an Expansion:
573 Highlight the name of a file, buffer, node, or directory. *Note
577 Prevent TeX from printing large black warning rectangles beside
578 over-wide lines. *Note Overfull hboxes::.
581 Add ENTRY to the index of functions. *Note Defining the Entries
582 of an Index: Index Entries.
586 Left justify every line but leave the right end ragged. Leave
587 font as is. Pair with `@end flushleft'. `@flushright' analogous.
588 *Note `@flushleft' and `@flushright': flushleft & flushright.
590 `@footnote{TEXT-OF-FOOTNOTE}'
591 Enter a footnote. Footnote text is printed at the bottom of the
592 page by TeX; Info may format in either `End' node or `Separate'
593 node style. *Note Footnotes::.
595 `@footnotestyle STYLE'
596 Specify an Info file's footnote style, either `end' for the end
597 node style or `separate' for the separate node style. *Note
601 Begin a kind of example. Like `@example' or `@display', but do
602 not narrow the margins and do not select the fixed-width font.
603 Pair with `@end format'. *Note `@example': example.
605 `@ftable FORMATTING-COMMAND'
606 Begin a two-column table, using `@item' for each entry.
607 Automatically enter each of the items in the first column into the
608 index of functions. Pair with `@end ftable'. The same as
609 `@table', except for indexing. *Note `@ftable' and `@vtable':
613 Hold text together that must appear on one printed page. Pair with
614 `@end group'. Not relevant to Info. *Note `@group': group.
617 Generate the long Hungarian umlaut accent over C, as in o''.
620 Print an unnumbered section-like heading in the text, but not in
621 the table of contents of a printed manual. In Info, the title is
622 underlined with equal signs. *Note Section Commands:
623 unnumberedsec appendixsec heading.
625 `@headings ON-OFF-SINGLE-DOUBLE'
626 Turn page headings on or off, and/or specify single-sided or
627 double-sided page headings for printing. *Note The `@headings'
628 Command: headings on off.
631 Enter HTML completely. Pair with `@end html'. *Note Raw
632 Formatter Commands::.
634 `@hyphenation{HY-PHEN-A-TED WORDS}'
635 Explicitly define hyphenation points. *Note `@-' and
636 `@hyphenation': - and hyphenation.
639 Print TEXT in italic font. No effect in Info. *Note Fonts::.
642 If FLAG is cleared, the Texinfo formatting commands format text
643 between `@ifclear FLAG' and the following `@end ifclear' command.
644 *Note `@set' `@clear' `@value': set clear value.
648 Begin a stretch of text that will be ignored by TeX when it
649 typesets the printed manual. The text appears only in the HTML
650 resp. Info file. Pair with `@end ifhtml' resp. `@end ifinfo'.
651 *Note Conditionals::.
656 Begin a stretch of text that will be ignored in one output format
657 but not the others. The text appears only in the format not
658 specified. Pair with `@end ifnothtml' resp. `@end ifnotinfo' resp.
659 `@end ifnotinfo'. *Note Conditionals::.
662 If FLAG is set, the Texinfo formatting commands format text
663 between `@ifset FLAG' and the following `@end ifset' command.
664 *Note `@set' `@clear' `@value': set clear value.
667 Begin a stretch of text that will not appear in the Info file, but
668 will be processed only by TeX. Pair with `@end iftex'. *Note
669 Conditionally Visible Text: Conditionals.
672 Begin a stretch of text that will not appear in either the Info
673 file or the printed output. Pair with `@end ignore'. *Note
674 Comments and Ignored Text: Comments.
676 `@image{FILENAME, [WIDTH], [HEIGHT]}'
677 Include graphics image in external FILENAME scaled to the given
678 WIDTH and/or HEIGHT. *Note Images::.
681 Incorporate the contents of the file FILENAME into the Info file
682 or printed document. *Note Include Files::.
684 `@inforef{NODE-NAME, [ENTRY-NAME], INFO-FILE-NAME}'
685 Make a cross reference to an Info file for which there is no
686 printed manual. *Note Cross references using `@inforef': inforef.
688 `\input MACRO-DEFINITIONS-FILE'
689 Use the specified macro definitions file. This command is used
690 only in the first line of a Texinfo file to cause TeX to make use
691 of the `texinfo' macro definitions file. The backslash in `\input'
692 is used instead of an `@' because TeX does not recognize `@' until
693 after it has read the definitions file. *Note The Texinfo File
697 Indicate the beginning of a marked paragraph for `@itemize' and
698 `@enumerate'; indicate the beginning of the text of a first column
699 entry for `@table', `@ftable', and `@vtable'. *Note Lists and
702 `@itemize MARK-GENERATING-CHARACTER-OR-COMMAND'
703 Produce a sequence of indented paragraphs, with a mark inside the
704 left margin at the beginning of each paragraph. Pair with `@end
705 itemize'. *Note `@itemize': itemize.
708 Like `@item' but do not generate extra vertical space above the
709 item text. *Note `@itemx': itemx.
711 `@kbd{KEYBOARD-CHARACTERS}'
712 Indicate text that is characters of input to be typed by users.
715 `@kbdinputstyle STYLE'
716 Specify when `@kbd' should use a font distinct from `@code'.
720 Indicate a name for a key on a keyboard. *Note `@key': key.
723 Add ENTRY to the index of keys. *Note Defining the Entries of an
724 Index: Index Entries.
728 Generate the uppercase and lowercase Polish suppressed-L letters,
729 respectively: /L, /l.
732 Begin an example of Lisp code. Indent text, do not fill, and
733 select fixed-width font. Pair with `@end lisp'. *Note `@lisp':
737 Change subsequent chapters to sections, sections to subsections,
738 and so on. *Note `@raisesections' and `@lowersections':
739 Raise/lower sections.
741 `@macro MACRO-NAME {PARAMS}'
742 Define a new Texinfo command `@MACRO-NAME{PARAMS}'. Only
743 supported by `makeinfo' and `texi2dvi'. *Note Defining Macros::.
745 `@majorheading TITLE'
746 Print a chapter-like heading in the text, but not in the table of
747 contents of a printed manual. Generate more vertical whitespace
748 before the heading than the `@chapheading' command. In Info, the
749 chapter heading line is underlined with asterisks. *Note
750 `@majorheading' and `@chapheading': majorheading & chapheading.
752 `@math{MATHEMATICAL-EXPRESSION}'
753 Format a mathematical expression. *Note `@math' - Inserting
754 Mathematical Expressions: math.
757 Mark the beginning of a menu of nodes in Info. No effect in a
758 printed manual. Pair with `@end menu'. *Note Menus::.
761 Generate a minus sign, `-'. *Note `@minus': minus.
763 `@multitable COLUMN-WIDTH-SPEC'
764 Begin a multi-column table. Pair with `@end multitable'. *Note
765 Multitable Column Widths::.
768 Start a new page in a printed manual if fewer than N mils
769 (thousandths of an inch) remain on the current page. *Note
772 `@node NAME, NEXT, PREVIOUS, UP'
773 Define the beginning of a new node in Info, and serve as a locator
774 for references for TeX. *Note `@node': node.
777 Prevent text from being indented as if it were a new paragraph.
778 *Note `@noindent': noindent.
782 Generate the uppercase and lowercase O-with-slash letters,
783 respectively: /O, /o.
785 `@oddfooting [LEFT] @| [CENTER] @| [RIGHT]'
786 `@oddheading [LEFT] @| [CENTER] @| [RIGHT]'
787 Specify page footings resp. headings for odd-numbered (right-hand)
788 pages. Only allowed inside `@iftex'. *Note How to Make Your Own
789 Headings: Custom Headings.
793 Generate the uppercase and lowercase OE ligatures, respectively:
794 OE, oe. *Note Inserting Accents::.
797 Start a new page in a printed manual. No effect in Info. *Note
800 `@paragraphindent INDENT'
801 Indent paragraphs by INDENT number of spaces; delete indentation
802 if the value of INDENT is 0; and do not change indentation if
803 INDENT is `asis'. *Note Paragraph Indenting: paragraphindent.
806 Add ENTRY to the index of programs. *Note Defining the Entries of
807 an Index: Index Entries.
810 Indicate the position of point in a buffer to the reader with a
811 glyph: `-!-'. *Note Indicating Point in a Buffer: Point Glyph.
814 Generate the pounds sterling currency sign. *Note `@pounds{}':
818 Indicate printed output to the reader with a glyph: `-|'. *Note
821 `@printindex INDEX-NAME'
822 Print an alphabetized two-column index in a printed manual or
823 generate an alphabetized menu of index entries for Info. *Note
824 Printing Indices & Menus::.
826 `@pxref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
827 Make a reference that starts with a lower case `see' in a printed
828 manual. Use within parentheses only. Do not follow command with a
829 punctuation mark--the Info formatting commands automatically insert
830 terminating punctuation as needed. Only the first argument is
831 mandatory. *Note `@pxref': pxref.
834 Generate an upside-down question mark. *Note Inserting Accents::.
837 Narrow the margins to indicate text that is quoted from another
838 real or imaginary work. Write command on a line of its own. Pair
839 with `@end quotation'. *Note `@quotation': quotation.
842 Print TEXT in roman font. No effect in Info. *Note Fonts::.
845 Change subsequent sections to chapters, subsections to sections,
846 and so on. *Note `@raisesections' and `@lowersections':
847 Raise/lower sections.
849 `@ref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
850 Make a reference. In a printed manual, the reference does not
851 start with a `See'. Follow command with a punctuation mark. Only
852 the first argument is mandatory. *Note `@ref': ref.
855 In Info, refill and indent the paragraph after all the other
856 processing has been done. No effect on TeX, which always refills.
857 This command is no longer needed, since all formatters now
858 automatically refill. *Note Refilling Paragraphs::.
861 Indicate the result of an expression to the reader with a special
862 glyph: `=>'. *Note `@result': result.
865 Generate a ring accent over the next character, as in o*. *Note
869 Highlight TEXT that is a literal example of a sequence of
870 characters. Used for single characters, for statements, and often
871 for entire shell commands. *Note `@samp': samp.
874 Set TEXT in a printed output in THE SMALL CAPS FONT and set text
875 in the Info file in uppercase letters. *Note Smallcaps::.
878 Begin a section within a chapter. In a printed manual, the section
879 title is numbered and appears in the table of contents. In Info,
880 the title is underlined with equal signs. *Note `@section':
884 Make FLAG active, causing the Texinfo formatting commands to
885 format text between subsequent pairs of `@ifset FLAG' and `@end
886 ifset' commands. Optionally, set value of FLAG to STRING. *Note
887 `@set' `@clear' `@value': set clear value.
889 `@setchapternewpage ON-OFF-ODD'
890 Specify whether chapters start on new pages, and if so, whether on
891 odd-numbered (right-hand) new pages. *Note `@setchapternewpage':
894 `@setfilename INFO-FILE-NAME'
895 Provide a name to be used by the Info file. This command is
896 essential for TeX formatting as well, even though it produces no
897 output. *Note `@setfilename': setfilename.
900 Provide a title for page headers in a printed manual. *Note
901 `@settitle': settitle.
904 Print a short table of contents. Not relevant to Info, which uses
905 menus rather than tables of contents. A synonym for
906 `@summarycontents'. *Note Generating a Table of Contents:
909 `@shorttitlepage{TITLE}'
910 Generate a minimal title page. *Note `@titlepage': titlepage.
913 Cause TeX to produce a printed manual in a 7 by 9.25 inch format
914 rather than the regular 8.5 by 11 inch format. *Note Printing
915 Small Books: smallbook. Also, see *Note `@smallexample' and
916 `@smalllisp': smallexample & smalllisp.
919 Indent text to indicate an example. Do not fill, select
920 fixed-width font. In `@smallbook' format, print text in a smaller
921 font than with `@example'. Pair with `@end smallexample'. *Note
922 `@smallexample' and `@smalllisp': smallexample & smalllisp.
925 Begin an example of Lisp code. Indent text, do not fill, select
926 fixed-width font. In `@smallbook' format, print text in a smaller
927 font. Pair with `@end smalllisp'. *Note `@smallexample' and
928 `@smalllisp': smallexample & smalllisp.
931 Skip N blank lines. *Note `@sp': sp.
934 Generate the German sharp-S es-zet letter, ss. *Note Inserting
938 Emphasize TEXT by typesetting it in a *bold* font for the printed
939 manual and by surrounding it with asterisks for Info. *Note
940 Emphasizing Text: emph & strong.
943 Print an unnumbered subsection-like heading in the text, but not in
944 the table of contents of a printed manual. In Info, the title is
945 underlined with hyphens. *Note `@unnumberedsubsec'
946 `@appendixsubsec' `@subheading': unnumberedsubsec appendixsubsec
950 Begin a subsection within a section. In a printed manual, the
951 subsection title is numbered and appears in the table of contents.
952 In Info, the title is underlined with hyphens. *Note
953 `@subsection': subsection.
955 `@subsubheading TITLE'
956 Print an unnumbered subsubsection-like heading in the text, but
957 not in the table of contents of a printed manual. In Info, the
958 title is underlined with periods. *Note The `subsub' Commands:
961 `@subsubsection TITLE'
962 Begin a subsubsection within a subsection. In a printed manual,
963 the subsubsection title is numbered and appears in the table of
964 contents. In Info, the title is underlined with periods. *Note
965 The `subsub' Commands: subsubsection.
968 In a printed manual, set a subtitle in a normal sized font flush to
969 the right-hand side of the page. Not relevant to Info, which does
970 not have title pages. *Note `@title' `@subtitle' and `@author'
971 Commands: title subtitle author.
974 Print a short table of contents. Not relevant to Info, which uses
975 menus rather than tables of contents. A synonym for
976 `@shortcontents'. *Note Generating a Table of Contents: Contents.
978 `@syncodeindex FROM-INDEX INTO-INDEX'
979 Merge the index named in the first argument into the index named in
980 the second argument, printing the entries from the first index in
981 `@code' font. *Note Combining Indices::.
983 `@synindex FROM-INDEX INTO-INDEX'
984 Merge the index named in the first argument into the index named in
985 the second argument. Do not change the font of FROM-INDEX
986 entries. *Note Combining Indices::.
989 Print TEXT in a fixed-width, typewriter-like font. No effect in
993 Separate columns in a multitable. *Note Multitable Rows::.
995 `@table FORMATTING-COMMAND'
996 Begin a two-column table, using `@item' for each entry. Write
997 each first column entry on the same line as `@item'. First column
998 entries are printed in the font resulting from FORMATTING-COMMAND.
999 Pair with `@end table'. *Note Making a Two-column Table:
1000 Two-column Tables. Also see *Note `@ftable' and `@vtable': ftable
1001 vtable, and *Note `@itemx': itemx.
1004 Insert the logo TeX. *Note Inserting TeX and (C): TeX and
1008 Enter TeX completely. Pair with `@end tex'. *Note Raw Formatter
1016 Only allowed in a heading or footing. Stands for the number and
1017 name of the current chapter (in the format `Chapter 1: Title'),
1018 the chapter name only, the filename, the current page number, and
1019 the title of the document, respectively. *Note How to Make Your
1020 Own Headings: Custom Headings.
1023 Generate a tie-after accent over the next two characters CC, as in
1024 `oo['. *Note Inserting Accents::.
1027 Add ENTRY to the index of data types. *Note Defining the Entries
1028 of an Index: Index Entries.
1031 In a printed manual, set a title flush to the left-hand side of the
1032 page in a larger than normal font and underline it with a black
1033 rule. Not relevant to Info, which does not have title pages.
1034 *Note The `@title' `@subtitle' and `@author' Commands: title
1038 In a printed manual, print TEXT in a larger than normal font. Not
1039 relevant to Info, which does not have title pages. *Note The
1040 `@titlefont' `@center' and `@sp' Commands: titlefont center sp.
1043 Indicate to Texinfo the beginning of the title page. Write
1044 command on a line of its own. Pair with `@end titlepage'.
1045 Nothing between `@titlepage' and `@end titlepage' appears in Info.
1046 *Note `@titlepage': titlepage.
1049 Insert the current date, in `1 Jan 1900' style. *Note How to Make
1050 Your Own Headings: Custom Headings.
1053 In a Texinfo file to be formatted with `makeinfo', identify the
1054 topmost `@node' line in the file, which must be written on the line
1055 immediately preceding the `@top' command. Used for `makeinfo''s
1056 node pointer insertion feature. The title is underlined with
1057 asterisks. Both the `@node' line and the `@top' line normally
1058 should be enclosed by `@ifinfo' and `@end ifinfo'. In TeX and
1059 `texinfo-format-buffer', the `@top' command is merely a synonym
1060 for `@unnumbered'. *Note Creating Pointers with `makeinfo':
1061 makeinfo Pointer Creation.
1066 Generate a breve, underbar, or underdot accent, respectively, over
1067 or under the character C, as in o(, o_, .o. *Note Inserting
1071 In a printed manual, begin a chapter that appears without chapter
1072 numbers of any kind. The title appears in the table of contents
1073 of a printed manual. In Info, the title is underlined with
1074 asterisks. *Note `@unnumbered' and `@appendix': unnumbered &
1077 `@unnumberedsec TITLE'
1078 In a printed manual, begin a section that appears without section
1079 numbers of any kind. The title appears in the table of contents
1080 of a printed manual. In Info, the title is underlined with equal
1081 signs. *Note Section Commands: unnumberedsec appendixsec heading.
1083 `@unnumberedsubsec TITLE'
1084 In a printed manual, begin an unnumbered subsection within a
1085 chapter. The title appears in the table of contents of a printed
1086 manual. In Info, the title is underlined with hyphens. *Note
1087 `@unnumberedsubsec' `@appendixsubsec' `@subheading':
1088 unnumberedsubsec appendixsubsec subheading.
1090 `@unnumberedsubsubsec TITLE'
1091 In a printed manual, begin an unnumbered subsubsection within a
1092 chapter. The title appears in the table of contents of a printed
1093 manual. In Info, the title is underlined with periods. *Note The
1094 `subsub' Commands: subsubsection.
1096 `@uref{URL[, DISPLAYED-TEXT}'
1097 Define a cross reference to an external uniform resource locator
1098 for the World Wide Web. *Note `@url': url.
1101 Indicate text that is a uniform resource locator for the World Wide
1102 Web. *Note `@url': url.
1105 Generate check accent over the character C, as in o<. *Note
1106 Inserting Accents::.
1109 Replace FLAG with the value to which it is set by `@set FLAG'.
1110 *Note `@set' `@clear' `@value': set clear value.
1112 `@var{METASYNTACTIC-VARIABLE}'
1113 Highlight a metasyntactic variable, which is something that stands
1114 for another piece of text. *Note Indicating Metasyntactic
1118 Add ENTRY to the index of variables. *Note Defining the Entries
1119 of an Index: Index Entries.
1122 In a printed manual, insert whitespace so as to push text on the
1123 remainder of the page towards the bottom of the page. Used in
1124 formatting the copyright page with the argument `0pt plus 1filll'.
1125 (Note spelling of `filll'.) `@vskip' may be used only in
1126 contexts ignored for Info. *Note The Copyright Page and Printed
1127 Permissions: Copyright & Permissions.
1129 `@vtable FORMATTING-COMMAND'
1130 Begin a two-column table, using `@item' for each entry.
1131 Automatically enter each of the items in the first column into the
1132 index of variables. Pair with `@end vtable'. The same as
1133 `@table', except for indexing. *Note `@ftable' and `@vtable':
1137 Prevent TEXT from being split across two lines. Do not end a
1138 paragraph that uses `@w' with an `@refill' command. *Note `@w': w.
1140 `@xref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
1141 Make a reference that starts with `See' in a printed manual.
1142 Follow command with a punctuation mark. Only the first argument is
1143 mandatory. *Note `@xref': xref.
projects / chise / xemacs-chise.git- / blob