1 This is Info file ../info/texinfo.info, produced by Makeinfo version
2 1.68 from the input file texinfo.texi.
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.
164 An `@' followed by a space, tab, or newline produces a normal,
165 stretchable, interword space. *Note Multiple Spaces::.
168 Generate an exclamation point that really does end a sentence
169 (usually after an end-of-sentence capital letter). *Note Ending a
174 Generate an umlaut or acute accent, respectively, over the next
175 character, as in "o and 'o. *Note Inserting Accents::.
178 Force a line break. Do not end a paragraph that uses `@*' with an
179 `@refill' command. *Note Line Breaks::.
182 Generate a cedilla accent under C, as in c,. *Note Inserting
186 Insert a discretionary hyphenation point. *Note - and
190 Produce a period that really does end a sentence (usually after an
191 end-of-sentence capital letter). *Note Ending a Sentence::.
194 Indicate to TeX that an immediately preceding period, question
195 mark, exclamation mark, or colon does not end a sentence. Prevent
196 TeX from inserting extra whitespace as it does at the end of a
197 sentence. The command has no effect on the Info file output.
198 *Note Not Ending a Sentence::.
201 Generate a macro (bar) accent over the next character, as in =o.
202 *Note Inserting Accents::.
205 Generate a question mark that really does end a sentence (usually
206 after an end-of-sentence capital letter). *Note Ending a
210 Stands for an at sign, `@'. *Note Inserting @ and braces: Braces
215 Generate a circumflex (hat) or grave accent, respectively, over
216 the next character, as in ^o. *Note Inserting Accents::.
219 Stands for a left brace, `{'. *Note Inserting @ and braces:
223 Stands for a right-hand brace, `}'.
224 *Note Inserting @ and braces: Braces Atsigns.
227 Generate a tilde accent over the next character, as in ~N. *Note
232 Generate the uppercase and lowercase Scandinavian A-ring letters,
233 respectively: AA, aa. *Note Inserting Accents::.
237 Generate the uppercase and lowercase AE ligatures, respectively:
238 AE, ae. *Note Inserting Accents::.
241 Change page dimensions for the A4 paper size. Only allowed inside
242 `@iftex' ... `@end iftex'. *Note A4 Paper::.
245 Begin an appendix. The title appears in the table of contents of
246 a printed manual. In Info, the title is underlined with
247 asterisks. *Note The `@unnumbered' and `@appendix' Commands:
248 unnumbered & appendix.
251 `@appendixsection TITLE'
252 Begin an appendix section within an appendix. The section title
253 appears in the table of contents of a printed manual. In Info,
254 the title is underlined with equal signs. `@appendixsection' is a
255 longer spelling of the `@appendixsec' command. *Note Section
256 Commands: unnumberedsec appendixsec heading.
258 `@appendixsubsec TITLE'
259 Begin an appendix subsection within an appendix. The title appears
260 in the table of contents of a printed manual. In Info, the title
261 is underlined with hyphens. *Note Subsection Commands:
262 unnumberedsubsec appendixsubsec subheading.
264 `@appendixsubsubsec TITLE'
265 Begin an appendix subsubsection within an appendix subsection. The
266 title appears in the table of contents of a printed manual. In
267 Info, the title is underlined with periods. *Note The `subsub'
268 Commands: subsubsection.
271 Used following `@table', `@ftable', and `@vtable' to print the
272 table's first column without highlighting ("as is"). *Note Making
273 a Two-column Table: Two-column Tables.
276 Typeset AUTHOR flushleft and underline it. *Note The `@title' and
277 `@author' Commands: title subtitle author.
280 Print TEXT in bold font. No effect in Info. *Note Fonts::.
283 Generate a large round dot, or the closest possible thing to one.
284 *Note `@bullet': bullet.
287 Stop formatting a file. The formatters do not see the contents of
288 a file following an `@bye' command. *Note Ending a File::.
291 Begin a comment in Texinfo. The rest of the line does not appear
292 in either the Info file or the printed manual. A synonym for
293 `@comment'. *Note Comments: Comments.
296 Highlight an example or quotation by drawing a box with rounded
297 corners around it. Pair with `@end cartouche'. No effect in
298 Info. *Note Drawing Cartouches Around Examples: cartouche.)
300 `@center LINE-OF-TEXT'
301 Center the line of text following the command. *Note `@center':
304 `@centerchap LINE-OF-TEXT'
305 Like `@chapter', but centers the chapter title. *Note `@chapter':
309 Print a chapter-like heading in the text, but not in the table of
310 contents of a printed manual. In Info, the title is underlined
311 with asterisks. *Note `@majorheading' and `@chapheading':
312 majorheading & chapheading.
315 Begin a chapter. The chapter title appears in the table of
316 contents of a printed manual. In Info, the title is underlined
317 with asterisks. *Note `@chapter': chapter.
320 Add ENTRY to the index of concepts. *Note Defining the Entries of
321 an Index: Index Entries.
324 Highlight the name of a book or other reference that lacks a
325 companion Info file. *Note `@cite': cite.
328 Unset FLAG, preventing the Texinfo formatting commands from
329 formatting text between subsequent pairs of `@ifset FLAG' and
330 `@end ifset' commands, and preventing `@value{FLAG}' from
331 expanding to the value to which FLAG is set. *Note `@set'
332 `@clear' `@value': set clear value.
335 Highlight text that is an expression, a syntactically complete
336 token of a program, or a program name. *Note `@code': code.
339 Begin a comment in Texinfo. The rest of the line does not appear
340 in either the Info file or the printed manual. A synonym for `@c'.
341 *Note Comments: Comments.
344 Print a complete table of contents. Has no effect in Info, which
345 uses menus instead. *Note Generating a Table of Contents:
349 Generate a copyright symbol. *Note `@copyright': copyright symbol.
351 `@defcodeindex INDEX-NAME'
352 Define a new index and its indexing command. Print entries in an
353 `@code' font. *Note Defining New Indices: New Indices.
355 `@defcv CATEGORY CLASS NAME'
356 `@defcvx CATEGORY CLASS NAME'
357 Format a description for a variable associated with a class in
358 object-oriented programming. Takes three arguments: the category
359 of thing being defined, the class to which it belongs, and its
360 name. *Note Definition Commands::, and *Note Def Cmds in Detail:
363 `@deffn CATEGORY NAME ARGUMENTS...'
364 `@deffnx CATEGORY NAME ARGUMENTS...'
365 Format a description for a function, interactive command, or
366 similar entity that may take arguments. `@deffn' takes as
367 arguments the category of entity being described, the name of this
368 particular entity, and its arguments, if any. *Note Definition
371 `@defindex INDEX-NAME'
372 Define a new index and its indexing command. Print entries in a
373 roman font. *Note Defining New Indices: New Indices.
375 `@definfoenclose NEW-COMMAND, BEFORE, AFTER,'
376 Create new @-command for Info that marks text by enclosing it in
377 strings that precede and follow the text. Write definition inside
378 of `@ifinfo' ... `@end ifinfo'. *Note Customized Highlighting::.
380 `@defivar CLASS INSTANCE-VARIABLE-NAME'
381 `@defivarx CLASS INSTANCE-VARIABLE-NAME'
382 This command formats a description for an instance variable in
383 object-oriented programming. The command is equivalent to `@defcv
384 {Instance Variable} ...'. *Note Definition Commands::, and *Note
385 Def Cmds in Detail: deffnx.
387 `@defmac MACRO-NAME ARGUMENTS...'
388 `@defmacx MACRO-NAME ARGUMENTS...'
389 Format a description for a macro. The command is equivalent to
390 `@deffn Macro ...'. *Note Definition Commands::, and *Note Def
391 Cmds in Detail: deffnx.
393 `@defmethod CLASS METHOD-NAME ARGUMENTS...'
394 `@defmethodx CLASS METHOD-NAME ARGUMENTS...'
395 Format a description for a method in object-oriented programming.
396 The command is equivalent to `@defop Method ...'. Takes as
397 arguments the name of the class of the method, the name of the
398 method, and its arguments, if any. *Note Definition Commands::,
399 and *Note Def Cmds in Detail: deffnx.
401 `@defop CATEGORY CLASS NAME ARGUMENTS...'
402 `@defopx CATEGORY CLASS NAME ARGUMENTS...'
403 Format a description for an operation in object-oriented
404 programming. `@defop' takes as arguments the overall name of the
405 category of operation, the name of the class of the operation, the
406 name of the operation, and its arguments, if any. *Note
407 Definition Commands::, and *Note Def Cmds in Detail: deffnx.
409 `@defopt OPTION-NAME'
410 `@defoptx OPTION-NAME'
411 Format a description for a user option. The command is equivalent
412 to `@defvr {User Option} ...'. *Note Definition Commands::, and
413 *Note Def Cmds in Detail: deffnx.
415 `@defspec SPECIAL-FORM-NAME ARGUMENTS...'
416 `@defspecx SPECIAL-FORM-NAME ARGUMENTS...'
417 Format a description for a special form. The command is
418 equivalent to `@deffn {Special Form} ...'. *Note Definition
419 Commands::, and *Note Def Cmds in Detail: deffnx.
421 `@deftp CATEGORY NAME-OF-TYPE ATTRIBUTES...'
422 `@deftpx CATEGORY NAME-OF-TYPE ATTRIBUTES...'
423 Format a description for a data type. `@deftp' takes as arguments
424 the category, the name of the type (which is a word like `int' or
425 `float'), and then the names of attributes of objects of that type.
426 *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx.
428 `@deftypefn CLASSIFICATION DATA-TYPE NAME ARGUMENTS...'
429 `@deftypefnx CLASSIFICATION DATA-TYPE NAME ARGUMENTS...'
430 Format a description for a function or similar entity that may take
431 arguments and that is typed. `@deftypefn' takes as arguments the
432 classification of entity being described, the type, the name of the
433 entity, and its arguments, if any. *Note Definition Commands::,
434 and *Note Def Cmds in Detail: deffnx.
436 `@deftypefun DATA-TYPE FUNCTION-NAME ARGUMENTS...'
437 `@deftypefunx DATA-TYPE FUNCTION-NAME ARGUMENTS...'
438 Format a description for a function in a typed language. The
439 command is equivalent to `@deftypefn Function ...'. *Note
440 Definition Commands::, and *Note Def Cmds in Detail: deffnx.
442 `@deftypemethod CLASS DATA-TYPE METHOD-NAME ARGUMENTS...'
443 `@deftypemethodx CLASS DATA-TYPE METHOD-NAME ARGUMENTS...'
444 Format a description for a typed method in object-oriented
445 programming. Takes as arguments the name of the class of the
446 method, the return type of the method, the name of the method, and
447 its arguments, if any. *Note Definition Commands::, and *Note Def
448 Cmds in Detail: deffnx.
450 `@deftypevr CLASSIFICATION DATA-TYPE NAME'
451 `@deftypevrx CLASSIFICATION DATA-TYPE NAME'
452 Format a description for something like a variable in a typed
453 language--an entity that records a value. Takes as arguments the
454 classification of entity being described, the type, and the name
455 of the entity. *Note Definition Commands::, and *Note Def Cmds in
458 `@deftypevar DATA-TYPE VARIABLE-NAME'
459 `@deftypevarx DATA-TYPE VARIABLE-NAME'
460 Format a description for a variable in a typed language. The
461 command is equivalent to `@deftypevr Variable ...'. *Note
462 Definition Commands::, and *Note Def Cmds in Detail: deffnx.
464 `@defun FUNCTION-NAME ARGUMENTS...'
465 `@defunx FUNCTION-NAME ARGUMENTS...'
466 Format a description for functions. The command is equivalent to
467 `@deffn Function ...'. *Note Definition Commands::, and *Note Def
468 Cmds in Detail: deffnx.
470 `@defvar VARIABLE-NAME'
471 `@defvarx VARIABLE-NAME'
472 Format a description for variables. The command is equivalent to
473 `@defvr Variable ...'. *Note Definition Commands::, and *Note Def
474 Cmds in Detail: deffnx.
476 `@defvr CATEGORY NAME'
477 `@defvrx CATEGORY NAME'
478 Format a description for any kind of variable. `@defvr' takes as
479 arguments the category of the entity and the name of the entity.
480 *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx.
483 Avoid `makeinfo' confusion stemming from the detailed node listing
484 in a master menu. *Note Master Menu Parts::.
487 Highlight the introductory or defining use of a term. *Note
490 `@dircategory DIRPART'
491 Specify a part of the Info directory menu where this file's entry
492 should go. *Note Installing Dir Entries::.
495 Begin the Info directory menu entry for this file. *Note
496 Installing Dir Entries::.
499 Begin a kind of example. Indent text, do not fill, do not select a
500 new font. Pair with `@end display'. *Note `@display': display.
503 Format a unit of measure, as in 12pt. Causes TeX to insert a thin
504 space before DIMENSION. No effect in Info. *Note `@dmn': dmn.
507 Generate a dot accent over the character C, as in .oo. *Note
511 Insert an ellipsis: `...'. *Note `@dots{}': dots.
513 `@email{ADDRESS[, DISPLAYED-TEXT]}'
514 Indicate an electronic mail address. *Note `@email': email.
517 Highlight TEXT; text is displayed in *italics* in printed output,
518 and surrounded by asterisks in Info. *Note Emphasizing Text:
522 Ends ENVIRONMENT, as in `@end example'. *Note @-commands:
526 Generate an end-of-sentence of ellipsis, like this .... *Note
529 `@enumerate [NUMBER-OR-LETTER]'
530 Begin a numbered list, using `@item' for each entry. Optionally,
531 start list with NUMBER-OR-LETTER. Pair with `@end enumerate'.
532 *Note `@enumerate': enumerate.
535 Indicate to the reader the exact equivalence of two forms with a
536 glyph: `=='. *Note Equivalence::.
539 Indicate to the reader with a glyph that the following text is an
540 error message: `error-->'. *Note Error Glyph::.
542 `@evenfooting [LEFT] @| [CENTER] @| [RIGHT]'
543 `@evenheading [LEFT] @| [CENTER] @| [RIGHT]'
544 Specify page footings resp. headings for even-numbered (left-hand)
545 pages. Only allowed inside `@iftex'. *Note How to Make Your Own
546 Headings: Custom Headings.
548 `@everyfooting [LEFT] @| [CENTER] @| [RIGHT]'
549 `@everyheading [LEFT] @| [CENTER] @| [RIGHT]'
550 Specify page footings resp. headings for every page. Not relevant
551 to Info. *Note How to Make Your Own Headings: Custom Headings.
554 Begin an example. Indent text, do not fill, and select
555 fixed-width font. Pair with `@end example'. *Note `@example':
559 Produce an upside-down exclamation point. *Note Inserting
562 `@exdent LINE-OF-TEXT'
563 Remove any indentation a line might have. *Note Undoing the
564 Indentation of a Line: exdent.
567 Indicate the result of a macro expansion to the reader with a
568 special glyph: `==>'. *Note ==> Indicating an Expansion:
572 Highlight the name of a file, buffer, node, or directory. *Note
576 Prevent TeX from printing large black warning rectangles beside
577 over-wide lines. *Note Overfull hboxes::.
580 Add ENTRY to the index of functions. *Note Defining the Entries
581 of an Index: Index Entries.
585 Left justify every line but leave the right end ragged. Leave
586 font as is. Pair with `@end flushleft'. `@flushright' analogous.
587 *Note `@flushleft' and `@flushright': flushleft & flushright.
589 `@footnote{TEXT-OF-FOOTNOTE}'
590 Enter a footnote. Footnote text is printed at the bottom of the
591 page by TeX; Info may format in either `End' node or `Separate'
592 node style. *Note Footnotes::.
594 `@footnotestyle STYLE'
595 Specify an Info file's footnote style, either `end' for the end
596 node style or `separate' for the separate node style. *Note
600 Begin a kind of example. Like `@example' or `@display', but do
601 not narrow the margins and do not select the fixed-width font.
602 Pair with `@end format'. *Note `@example': example.
604 `@ftable FORMATTING-COMMAND'
605 Begin a two-column table, using `@item' for each entry.
606 Automatically enter each of the items in the first column into the
607 index of functions. Pair with `@end ftable'. The same as
608 `@table', except for indexing. *Note `@ftable' and `@vtable':
612 Hold text together that must appear on one printed page. Pair with
613 `@end group'. Not relevant to Info. *Note `@group': group.
616 Generate the long Hungarian umlaut accent over C, as in ''o.
619 Print an unnumbered section-like heading in the text, but not in
620 the table of contents of a printed manual. In Info, the title is
621 underlined with equal signs. *Note Section Commands:
622 unnumberedsec appendixsec heading.
624 `@headings ON-OFF-SINGLE-DOUBLE'
625 Turn page headings on or off, and/or specify single-sided or
626 double-sided page headings for printing. *Note The `@headings'
627 Command: headings on off.
630 Enter HTML completely. Pair with `@end html'. *Note Raw
631 Formatter Commands::.
633 `@hyphenation{HY-PHEN-A-TED WORDS}'
634 Explicitly define hyphenation points. *Note `@-' and
635 `@hyphenation': - and hyphenation.
638 Print TEXT in italic font. No effect in Info. *Note Fonts::.
641 If FLAG is cleared, the Texinfo formatting commands format text
642 between `@ifclear FLAG' and the following `@end ifclear' command.
643 *Note `@set' `@clear' `@value': set clear value.
647 Begin a stretch of text that will be ignored by TeX when it
648 typesets the printed manual. The text appears only in the HTML
649 resp. Info file. Pair with `@end ifhtml' resp. `@end ifinfo'.
650 *Note Conditionals::.
655 Begin a stretch of text that will be ignored in one output format
656 but not the others. The text appears only in the format not
657 specified. Pair with `@end ifnothtml' resp. `@end ifnotinfo' resp.
658 `@end ifnotinfo'. *Note Conditionals::.
661 If FLAG is set, the Texinfo formatting commands format text
662 between `@ifset FLAG' and the following `@end ifset' command.
663 *Note `@set' `@clear' `@value': set clear value.
666 Begin a stretch of text that will not appear in the Info file, but
667 will be processed only by TeX. Pair with `@end iftex'. *Note
668 Conditionally Visible Text: Conditionals.
671 Begin a stretch of text that will not appear in either the Info
672 file or the printed output. Pair with `@end ignore'. *Note
673 Comments and Ignored Text: Comments.
675 `@image{FILENAME, [WIDTH], [HEIGHT]}'
676 Include graphics image in external FILENAME scaled to the given
677 WIDTH and/or HEIGHT. *Note Images::.
680 Incorporate the contents of the file FILENAME into the Info file
681 or printed document. *Note Include Files::.
683 `@inforef{NODE-NAME, [ENTRY-NAME], INFO-FILE-NAME}'
684 Make a cross reference to an Info file for which there is no
685 printed manual. *Note Cross references using `@inforef': inforef.
687 `\input MACRO-DEFINITIONS-FILE'
688 Use the specified macro definitions file. This command is used
689 only in the first line of a Texinfo file to cause TeX to make use
690 of the `texinfo' macro definitions file. The backslash in `\input'
691 is used instead of an `@' because TeX does not recognize `@' until
692 after it has read the definitions file. *Note The Texinfo File
696 Indicate the beginning of a marked paragraph for `@itemize' and
697 `@enumerate'; indicate the beginning of the text of a first column
698 entry for `@table', `@ftable', and `@vtable'. *Note Lists and
701 `@itemize MARK-GENERATING-CHARACTER-OR-COMMAND'
702 Produce a sequence of indented paragraphs, with a mark inside the
703 left margin at the beginning of each paragraph. Pair with `@end
704 itemize'. *Note `@itemize': itemize.
707 Like `@item' but do not generate extra vertical space above the
708 item text. *Note `@itemx': itemx.
710 `@kbd{KEYBOARD-CHARACTERS}'
711 Indicate text that is characters of input to be typed by users.
714 `@kbdinputstyle STYLE'
715 Specify when `@kbd' should use a font distinct from `@code'.
719 Indicate a name for a key on a keyboard. *Note `@key': key.
722 Add ENTRY to the index of keys. *Note Defining the Entries of an
723 Index: Index Entries.
727 Generate the uppercase and lowercase Polish suppressed-L letters,
728 respectively: L/, l/.
731 Begin an example of Lisp code. Indent text, do not fill, and
732 select fixed-width font. Pair with `@end lisp'. *Note `@lisp':
736 Change subsequent chapters to sections, sections to subsections,
737 and so on. *Note `@raisesections' and `@lowersections':
738 Raise/lower sections.
740 `@macro MACRO-NAME {PARAMS}'
741 Define a new Texinfo command `@MACRO-NAME{PARAMS}'. Only
742 supported by `makeinfo' and `texi2dvi'. *Note Defining Macros::.
744 `@majorheading TITLE'
745 Print a chapter-like heading in the text, but not in the table of
746 contents of a printed manual. Generate more vertical whitespace
747 before the heading than the `@chapheading' command. In Info, the
748 chapter heading line is underlined with asterisks. *Note
749 `@majorheading' and `@chapheading': majorheading & chapheading.
751 `@math{MATHEMATICAL-EXPRESSION}'
752 Format a mathematical expression. *Note `@math' - Inserting
753 Mathematical Expressions: math.
756 Mark the beginning of a menu of nodes in Info. No effect in a
757 printed manual. Pair with `@end menu'. *Note Menus::.
760 Generate a minus sign, `-'. *Note `@minus': minus.
762 `@multitable COLUMN-WIDTH-SPEC'
763 Begin a multi-column table. Pair with `@end multitable'. *Note
764 Multitable Column Widths::.
767 Start a new page in a printed manual if fewer than N mils
768 (thousandths of an inch) remain on the current page. *Note
771 `@node NAME, NEXT, PREVIOUS, UP'
772 Define the beginning of a new node in Info, and serve as a locator
773 for references for TeX. *Note `@node': node.
776 Prevent text from being indented as if it were a new paragraph.
777 *Note `@noindent': noindent.
781 Generate the uppercase and lowercase O-with-slash letters,
782 respectively: O/, o/.
784 `@oddfooting [LEFT] @| [CENTER] @| [RIGHT]'
785 `@oddheading [LEFT] @| [CENTER] @| [RIGHT]'
786 Specify page footings resp. headings for odd-numbered (right-hand)
787 pages. Only allowed inside `@iftex'. *Note How to Make Your Own
788 Headings: Custom Headings.
792 Generate the uppercase and lowercase OE ligatures, respectively:
793 OE, oe. *Note Inserting Accents::.
796 Start a new page in a printed manual. No effect in Info. *Note
799 `@paragraphindent INDENT'
800 Indent paragraphs by INDENT number of spaces; delete indentation
801 if the value of INDENT is 0; and do not change indentation if
802 INDENT is `asis'. *Note Paragraph Indenting: paragraphindent.
805 Add ENTRY to the index of programs. *Note Defining the Entries of
806 an Index: Index Entries.
809 Indicate the position of point in a buffer to the reader with a
810 glyph: `-!-'. *Note Indicating Point in a Buffer: Point Glyph.
813 Generate the pounds sterling currency sign. *Note `@pounds{}':
817 Indicate printed output to the reader with a glyph: `-|'. *Note
820 `@printindex INDEX-NAME'
821 Print an alphabetized two-column index in a printed manual or
822 generate an alphabetized menu of index entries for Info. *Note
823 Printing Indices & Menus::.
825 `@pxref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
826 Make a reference that starts with a lower case `see' in a printed
827 manual. Use within parentheses only. Do not follow command with a
828 punctuation mark--the Info formatting commands automatically insert
829 terminating punctuation as needed. Only the first argument is
830 mandatory. *Note `@pxref': pxref.
833 Generate an upside-down question mark. *Note Inserting Accents::.
836 Narrow the margins to indicate text that is quoted from another
837 real or imaginary work. Write command on a line of its own. Pair
838 with `@end quotation'. *Note `@quotation': quotation.
841 Print TEXT in roman font. No effect in Info. *Note Fonts::.
844 Change subsequent sections to chapters, subsections to sections,
845 and so on. *Note `@raisesections' and `@lowersections':
846 Raise/lower sections.
848 `@ref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
849 Make a reference. In a printed manual, the reference does not
850 start with a `See'. Follow command with a punctuation mark. Only
851 the first argument is mandatory. *Note `@ref': ref.
854 In Info, refill and indent the paragraph after all the other
855 processing has been done. No effect on TeX, which always refills.
856 This command is no longer needed, since all formatters now
857 automatically refill. *Note Refilling Paragraphs::.
860 Indicate the result of an expression to the reader with a special
861 glyph: `=>'. *Note `@result': result.
864 Generate a ring accent over the next character, as in *o. *Note
868 Highlight TEXT that is a literal example of a sequence of
869 characters. Used for single characters, for statements, and often
870 for entire shell commands. *Note `@samp': samp.
873 Set TEXT in a printed output in THE SMALL CAPS FONT and set text
874 in the Info file in uppercase letters. *Note Smallcaps::.
877 Begin a section within a chapter. In a printed manual, the section
878 title is numbered and appears in the table of contents. In Info,
879 the title is underlined with equal signs. *Note `@section':
883 Make FLAG active, causing the Texinfo formatting commands to
884 format text between subsequent pairs of `@ifset FLAG' and `@end
885 ifset' commands. Optionally, set value of FLAG to STRING. *Note
886 `@set' `@clear' `@value': set clear value.
888 `@setchapternewpage ON-OFF-ODD'
889 Specify whether chapters start on new pages, and if so, whether on
890 odd-numbered (right-hand) new pages. *Note `@setchapternewpage':
893 `@setfilename INFO-FILE-NAME'
894 Provide a name to be used by the Info file. This command is
895 essential for TeX formatting as well, even though it produces no
896 output. *Note `@setfilename': setfilename.
899 Provide a title for page headers in a printed manual. *Note
900 `@settitle': settitle.
903 Print a short table of contents. Not relevant to Info, which uses
904 menus rather than tables of contents. A synonym for
905 `@summarycontents'. *Note Generating a Table of Contents:
908 `@shorttitlepage{TITLE}'
909 Generate a minimal title page. *Note `@titlepage': titlepage.
912 Cause TeX to produce a printed manual in a 7 by 9.25 inch format
913 rather than the regular 8.5 by 11 inch format. *Note Printing
914 Small Books: smallbook. Also, see *Note `@smallexample' and
915 `@smalllisp': smallexample & smalllisp.
918 Indent text to indicate an example. Do not fill, select
919 fixed-width font. In `@smallbook' format, print text in a smaller
920 font than with `@example'. Pair with `@end smallexample'. *Note
921 `@smallexample' and `@smalllisp': smallexample & smalllisp.
924 Begin an example of Lisp code. Indent text, do not fill, select
925 fixed-width font. In `@smallbook' format, print text in a smaller
926 font. Pair with `@end smalllisp'. *Note `@smallexample' and
927 `@smalllisp': smallexample & smalllisp.
930 Skip N blank lines. *Note `@sp': sp.
933 Generate the German sharp-S es-zet letter, ss. *Note Inserting
937 Emphasize TEXT by typesetting it in a *bold* font for the printed
938 manual and by surrounding it with asterisks for Info. *Note
939 Emphasizing Text: emph & strong.
942 Print an unnumbered subsection-like heading in the text, but not in
943 the table of contents of a printed manual. In Info, the title is
944 underlined with hyphens. *Note `@unnumberedsubsec'
945 `@appendixsubsec' `@subheading': unnumberedsubsec appendixsubsec
949 Begin a subsection within a section. In a printed manual, the
950 subsection title is numbered and appears in the table of contents.
951 In Info, the title is underlined with hyphens. *Note
952 `@subsection': subsection.
954 `@subsubheading TITLE'
955 Print an unnumbered subsubsection-like heading in the text, but
956 not in the table of contents of a printed manual. In Info, the
957 title is underlined with periods. *Note The `subsub' Commands:
960 `@subsubsection TITLE'
961 Begin a subsubsection within a subsection. In a printed manual,
962 the subsubsection title is numbered and appears in the table of
963 contents. In Info, the title is underlined with periods. *Note
964 The `subsub' Commands: subsubsection.
967 In a printed manual, set a subtitle in a normal sized font flush to
968 the right-hand side of the page. Not relevant to Info, which does
969 not have title pages. *Note `@title' `@subtitle' and `@author'
970 Commands: title subtitle author.
973 Print a short table of contents. Not relevant to Info, which uses
974 menus rather than tables of contents. A synonym for
975 `@shortcontents'. *Note Generating a Table of Contents: Contents.
977 `@syncodeindex FROM-INDEX INTO-INDEX'
978 Merge the index named in the first argument into the index named in
979 the second argument, printing the entries from the first index in
980 `@code' font. *Note Combining Indices::.
982 `@synindex FROM-INDEX INTO-INDEX'
983 Merge the index named in the first argument into the index named in
984 the second argument. Do not change the font of FROM-INDEX
985 entries. *Note Combining Indices::.
988 Print TEXT in a fixed-width, typewriter-like font. No effect in
992 Separate columns in a multitable. *Note Multitable Rows::.
994 `@table FORMATTING-COMMAND'
995 Begin a two-column table, using `@item' for each entry. Write
996 each first column entry on the same line as `@item'. First column
997 entries are printed in the font resulting from FORMATTING-COMMAND.
998 Pair with `@end table'. *Note Making a Two-column Table:
999 Two-column Tables. Also see *Note `@ftable' and `@vtable': ftable
1000 vtable, and *Note `@itemx': itemx.
1003 Insert the logo TeX. *Note Inserting TeX and (C): TeX and
1007 Enter TeX completely. Pair with `@end tex'. *Note Raw Formatter
1015 Only allowed in a heading or footing. Stands for the number and
1016 name of the current chapter (in the format `Chapter 1: Title'),
1017 the chapter name only, the filename, the current page number, and
1018 the title of the document, respectively. *Note How to Make Your
1019 Own Headings: Custom Headings.
1022 Generate a tie-after accent over the next two characters CC, as in
1023 `[oo'. *Note Inserting Accents::.
1026 Add ENTRY to the index of data types. *Note Defining the Entries
1027 of an Index: Index Entries.
1030 In a printed manual, set a title flush to the left-hand side of the
1031 page in a larger than normal font and underline it with a black
1032 rule. Not relevant to Info, which does not have title pages.
1033 *Note The `@title' `@subtitle' and `@author' Commands: title
1037 In a printed manual, print TEXT in a larger than normal font. Not
1038 relevant to Info, which does not have title pages. *Note The
1039 `@titlefont' `@center' and `@sp' Commands: titlefont center sp.
1042 Indicate to Texinfo the beginning of the title page. Write
1043 command on a line of its own. Pair with `@end titlepage'.
1044 Nothing between `@titlepage' and `@end titlepage' appears in Info.
1045 *Note `@titlepage': titlepage.
1048 Insert the current date, in `1 Jan 1900' style. *Note How to Make
1049 Your Own Headings: Custom Headings.
1052 In a Texinfo file to be formatted with `makeinfo', identify the
1053 topmost `@node' line in the file, which must be written on the line
1054 immediately preceding the `@top' command. Used for `makeinfo''s
1055 node pointer insertion feature. The title is underlined with
1056 asterisks. Both the `@node' line and the `@top' line normally
1057 should be enclosed by `@ifinfo' and `@end ifinfo'. In TeX and
1058 `texinfo-format-buffer', the `@top' command is merely a synonym
1059 for `@unnumbered'. *Note Creating Pointers with `makeinfo':
1060 makeinfo Pointer Creation.
1065 Generate a breve, underbar, or underdot accent, respectively, over
1066 or under the character C, as in (o, o_, o-.. *Note Inserting
1070 In a printed manual, begin a chapter that appears without chapter
1071 numbers of any kind. The title appears in the table of contents
1072 of a printed manual. In Info, the title is underlined with
1073 asterisks. *Note `@unnumbered' and `@appendix': unnumbered &
1076 `@unnumberedsec TITLE'
1077 In a printed manual, begin a section that appears without section
1078 numbers of any kind. The title appears in the table of contents
1079 of a printed manual. In Info, the title is underlined with equal
1080 signs. *Note Section Commands: unnumberedsec appendixsec heading.
1082 `@unnumberedsubsec TITLE'
1083 In a printed manual, begin an unnumbered subsection within a
1084 chapter. The title appears in the table of contents of a printed
1085 manual. In Info, the title is underlined with hyphens. *Note
1086 `@unnumberedsubsec' `@appendixsubsec' `@subheading':
1087 unnumberedsubsec appendixsubsec subheading.
1089 `@unnumberedsubsubsec TITLE'
1090 In a printed manual, begin an unnumbered subsubsection within a
1091 chapter. The title appears in the table of contents of a printed
1092 manual. In Info, the title is underlined with periods. *Note The
1093 `subsub' Commands: subsubsection.
1095 `@uref{URL[, DISPLAYED-TEXT}'
1096 Define a cross reference to an external uniform resource locator
1097 for the World Wide Web. *Note `@url': url.
1100 Indicate text that is a uniform resource locator for the World Wide
1101 Web. *Note `@url': url.
1104 Generate check accent over the character C, as in <o. *Note
1105 Inserting Accents::.
1108 Replace FLAG with the value to which it is set by `@set FLAG'.
1109 *Note `@set' `@clear' `@value': set clear value.
1111 `@var{METASYNTACTIC-VARIABLE}'
1112 Highlight a metasyntactic variable, which is something that stands
1113 for another piece of text. *Note Indicating Metasyntactic
1117 Add ENTRY to the index of variables. *Note Defining the Entries
1118 of an Index: Index Entries.
1121 In a printed manual, insert whitespace so as to push text on the
1122 remainder of the page towards the bottom of the page. Used in
1123 formatting the copyright page with the argument `0pt plus 1filll'.
1124 (Note spelling of `filll'.) `@vskip' may be used only in
1125 contexts ignored for Info. *Note The Copyright Page and Printed
1126 Permissions: Copyright & Permissions.
1128 `@vtable FORMATTING-COMMAND'
1129 Begin a two-column table, using `@item' for each entry.
1130 Automatically enter each of the items in the first column into the
1131 index of variables. Pair with `@end vtable'. The same as
1132 `@table', except for indexing. *Note `@ftable' and `@vtable':
1136 Prevent TEXT from being split across two lines. Do not end a
1137 paragraph that uses `@w' with an `@refill' command. *Note `@w': w.
1139 `@xref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
1140 Make a reference that starts with `See' in a printed manual.
1141 Follow command with a punctuation mark. Only the first argument is
1142 mandatory. *Note `@xref': xref.
projects / chise / xemacs-chise.git.1 / blob