GNU Texinfo Reference Card @Contents Print a Complete Table of Contents
Total Page:16
File Type:pdf, Size:1020Kb
GNU Texinfo Reference Card @contents Print a complete table of contents. Has no effect in @subsubheading title Print an unnumbered subsubsection-like (for Texinfo version 4.13) Info, which uses menus instead. heading. http://www.gnu.org/software/texinfo/ @setcontentsaftertitlepage Put the table of contents after the `@end titlepage' even if the @contents is at the end. Menus Texinfo document skeleton @setshortcontentsaftertitlepage Place the short table @menu Mark the beginning of a menu of nodes in Info. No effect of contents after the `@end titlepage' command even if the in a printed manual. Pair with @end menu. Texinfo source files are plain text; standard extensions are @shortcontents command is at the end. @detailmenu Mark the (optional) detailed node listing in a master `.texinfo', `.texi', and `.txi'. A Texinfo file must begin with menu. lines like this: Nodes \input texinfo @node name, next, previous, up Begin a new node. The Cross references @setfilename info-file-name next, previous, and up pointers are usually omitted in a Within the Info system @settitle name-of-manual normally-structured document. @xref {node, [entry] , [node-title] , [info-file] , [manual] } Makes ::: the contents of the Texinfo document follow, ending with: @top title Mark the topmost @node in the file, which must be a reference that starts with `See' in a printed manual. Follow @bye defined on the line immediately preceding @top. The title is command with punctuation. Only the first argument is formatted as a chapter-level heading. The entire top node, mandatory. Texinfo @-commands including the @node and @top lines, are normally enclosed with @pxref {node, [entry] , [node-title] , [info-file] , [manual] } Like @ifnottex ... @end ifnottex. @xref, but starts with `see' instead of `See', and must be used Beginning a Texinfo document @anchor {name} Define name as the current location, for use as a inside parentheses. The commands in this section are given approximately in the cross-reference target. @ref {node, [entry] , [node-title] , [info-file] , [manual] } Like @xref, order in which they conventionally appear. @novalidate Suppress validation of node references and omit but produces only the bare reference without `See' or `see'; must @setfilename info-file-name Provide a name to be used for the creation of auxiliary files with TEX. Use before @setfilename. be followed by a punctuation mark. output files. This command is essential for TEX formatting as Chapter structuring @inforef {node, [entry-name] , info-file} Make a cross reference to well, even though it produces no output. Should be the first an Info file for which there is no printed manual. command in the input. @lowersections Change subsequent chapters to sections, sections to subsections, and so on. Outside of Info @settitle title Specify document title. @raisesections Change subsequent sections to chapters, @url {url, [displayed-text] , [replacement] } Make a hyperlink Internationalization subsections to sections, and so on. reference to a uniform resource locator. @uref is a synonym. enc Declare the input encoding to be enc; use @documentencoding Numbered, included in contents @cite {title} Indicate the name of a book or other reference that right after @setfilename. Default is US-ASCII; other possibilities: has no Info file; no hyperlink. UTF-8, ISO-8859-1, koi8-r, ::: @chapter title Begin a numbered chapter; title appears in the table of contents. @documentlanguage LL[_CC] Declare the current language as the Marking words and phrases title Like , with chapter title centered. two-character ISO-639 abbreviation LL, optionally followed by @centerchap @chapter Markup for regular text an underscore and a two-letter ISO 3166 two-letter country code Context-dependent, included in contents @emph {text} Emphasize text, by using italics where possible, and (CC). Default is en_US. @section title Begin a section within a chapter. Within @chapter enclosing in asterisks in Info. Info directory specifications and @appendix, the section is numbered; within @unnumbered, it is @strong {text} Emphasize text even more strongly, by using bold @dircategory category name Specify an Info directory section unnumbered. where possible; still enclosed in asterisks in Info. for this file’s entries. Can be repeated. We try to follow the @subsection title Begin a subsection within a section. Same @var {metasyntactic-variable} Indicate a meta variable (a name categories in the Free Software Directory. context-dependent numbering as @section. that stands for another piece of text). @direntry Begin the Info directory menu entries for this file. Pair @subsubsection title Begin a numbered subsubsection within a @dfn {term} Indicate the introductory or defining use of a with @end direntry. subsection. Same context-dependent numbering as @section. technical term. HTML document description Unnumbered, included in contents @acronym {acronym} Indicate an acronym written in all captial letters, such as `NASA'. @documentdescription Set the document description text for @unnumbered title Begin an unnumbered chapter. abbreviation Indicate a general abbreviation, such as HTML; default is just the title of the document. Pair with @end @unnumberedsec title Begin an unnumbered section. @abbr { } documentdescription. @unnumberedsubsec title Begin an unnumbered subsection. `Comput.' Title pages @unnumberedsubsubsec title Begin an unnumbered subsubsection. Markup for literal text @shorttitlepage title Generate a minimal title page, generally for Lettered and numbered, included in contents @code {sample-code} Indicate an expression, a syntactically complete token, or a program name. Unquoted in Info output. the first page of output in a long printed manual. @appendix title Begin an appendix. @file {filename} Indicate the name of a file, buffer, node, @center line-of-text Center line-of-text, usually for titles. @appendixsec title Begin an appendix section within an appendix; directory, etc. @titlefont {text} In a printed manual, print text in a larger than @appendixsection is a synonym. command-name Indicate a system command name, normal font. Ignored in Info. @appendixsubsec title Begin an appendix subsection; @command { } such as . @titlepage Begin the title page. Write the command on a line of @appendixsubsection is a synonym. ls its own, paired with @end titlepage. Ignored in Info. @appendixsubsubsec title Begin an appendix subsubsection; @env {environment-variable} Indicate an environment variable @title title Within @titlepage, display title appropriately. @appendixsubsubsection is a synonym. name, such as PATH. @subtitle subtitle Within @titlepage, display subtitle. @option {option-name} Indicate a command-line option, such as Unnumbered, not in contents, no new page -v and --help. @author author Within @titlepage, display author. @chapheading title Print an unnumbered chapter-like heading. @kbd {keyboard-characters} Indicate characters of input to be Tables of contents @majorheading title Like @chapheading, but generate additional typed by users. @shortcontents Print a short table of contents (chapter-level vertical whitespace before the heading. @key {key-name} Indicate the name of a key on a keyboard. entries only). Not relevant to Info. @heading title Print an unnumbered section-like heading. @email {address, [displayed-text] } Indicate an email address. @summarycontents Synonym for @shortcontents. @subheading title Print an unnumbered subsection-like heading. @indicateurl {url} Indicate a uniform resource locator, but Lists and tables @syncodeindex from-index to-index Merge the contents of without creating any hyperlink. @itemize mark-command Begin an unordered list, using @item for from-index into to-index, formatting the entries in from-index @samp {text} Indicate a sequence of literal characters, in general. each entry, which consist of indented paragraphs, with a mark with @code. Quoted in Info output. such as @bullet inside the left margin at the beginning of each @synindex from-index to-index Merge the contents of from-index @verb {delimchar literal-text delimchar} Output literal-text, item. Pair with @end itemize. into to-index; no special formatting. delimited by the single character delimchar, exactly as is, @enumerate [number-or-letter] Begin a numbered list, using @item @printindex index-name Generate an alphabetized index (using including any whitespace or Texinfo special characters. Example: for each entry. Optionally, start list with number-or-letter and two columns in a printed manual). @verb{|@ @}|}. count from there; by default, number consecutively from `1'. Pair Insertions within a paragraph Explicit font selection with @end enumerate. @table formatting-command Begin a two-column table Characters special to Texinfo @sc {text} Set text in a small caps font in printed output, and (description list), using for each entry. Write each first uppercase in Info. No other font command has any effect in Info. @item @@ Insert an at sign, `@'. column entry on the same line as @item. formatting-command is Insert a left brace, `f'. @r {text} Set text in the regular roman font. @{ applied to each first column entry. Pair with @end table. Insert a right brace, `g'. @i {text} Set text in an italic font. @} @ftable formatting-command Like @table, but automatically Insert a comma character; needed only when a literal @slanted {text} Set text in a slanted (oblique) font if possible. @comma {} enter each first column entry in the function index. comma would be an argument separator, as in @xref. @b {text} Set text in a bold font. @vtable formatting-command