home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 6 / FreshFish_September1994.bin / gnu / info / texi.info-6 (.txt) < prev    next >
GNU Info File  |  1994-09-02  |  50KB  |  1,016 lines
  1. This is Info file texi.info, produced by Makeinfo-1.55 from the input
  2. file texi.texi.
  3.    This file documents Texinfo, a documentation system that uses a
  4. single source file to produce both on-line information and a printed
  5. manual.
  6.    Copyright (C) 1988, 1990, 1991, 1992, 1993 Free Software Foundation,
  7.    This is the second edition of the Texinfo documentation,
  8. and is consistent with version 2 of `texinfo.tex'.
  9.    Permission is granted to make and distribute verbatim copies of this
  10. manual provided the copyright notice and this permission notice are
  11. preserved on all copies.
  12.    Permission is granted to copy and distribute modified versions of
  13. this manual under the conditions for verbatim copying, provided that
  14. the entire resulting derived work is distributed under the terms of a
  15. permission notice identical to this one.
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that this permission notice may be stated in a
  19. translation approved by the Free Software Foundation.
  20. File: texi.info,  Node: Inserting An Atsign,  Next: Inserting Braces,  Up: Braces Atsigns Periods
  21. Inserting `@' with @@
  22. ---------------------
  23.    `@@' stands for a single `@' in either printed or Info output.
  24.    Do not put braces after an `@@' command.
  25. File: texi.info,  Node: Inserting Braces,  Next: Controlling Spacing,  Prev: Inserting An Atsign,  Up: Braces Atsigns Periods
  26. Inserting `{' and `}'with @{ and @}
  27. -----------------------------------
  28.    `@{' stands for a single `{' in either printed or Info output.
  29.    `@}' stands for a single `}' in either printed or Info output.
  30.    Do not put braces after either an `@{' or an `@}' command.
  31. File: texi.info,  Node: Controlling Spacing,  Prev: Inserting Braces,  Up: Braces Atsigns Periods
  32. Spacing After Colons and Periods
  33. --------------------------------
  34.    Use the `@:' command after a period, question mark, exclamation
  35. mark, or colon that should not be followed by extra space.  For
  36. example, use `@:' after periods that end abbreviations which are not at
  37. the ends of sentences.  `@:' has no effect on the Info file output.
  38.    For example,
  39.      The s.o.p.@: has three parts ...
  40.      The s.o.p. has three parts ...
  41. produces
  42.      The s.o.p. has three parts ...
  43.      The s.o.p. has three parts ...
  44. `@:' has no effect on the Info output.  (`s.o.p' is an acronym for
  45. "Standard Operating Procedure".)
  46.    Use `@.' instead of a period at the end of a sentence that ends with
  47. a single capital letter.  Otherwise, TeX will think the letter is an
  48. abbreviation and will not insert the correct end-of-sentence spacing.
  49. Here is an example:
  50.      Give it to M.I.B. and to M.E.W@.  Also, give it to R.J.C@.
  51.      Give it to M.I.B. and to M.E.W.  Also, give it to R.J.C.
  52. produces
  53.      Give it to M.I.B. and to M.E.W.  Also, give it to R.J.C.
  54.      Give it to M.I.B. and to M.E.W.  Also, give it to R.J.C.
  55.    In the Info file output, `@.' is equivalent to a simple `.'.
  56.    The meanings of `@:' and `@.' in Texinfo are designed to work well
  57. with the Emacs sentence motion commands.  This made it necessary for
  58. them to be incompatible with some other formatting systems that use
  59. @-commands.
  60.    Do not put braces after either an `@:' or an `@.' command.
  61. File: texi.info,  Node: dmn,  Next: Dots Bullets,  Prev: Braces Atsigns Periods,  Up: Insertions
  62. `@dmn'{DIMENSION}: Format a Dimension
  63. =====================================
  64.    At times, you may want to write `12pt' or `8.5in' with little or no
  65. space between the number and the abbreviation for the dimension.  You
  66. can use the `@dmn' command to do this.  On seeing the command, TeX
  67. inserts just enough space for proper typesetting; the Info formatting
  68. commands insert no space at all, since the Info file does not require
  69.    To use the `@dmn' command, write the number and then follow it
  70. immediately, with no intervening space, by `@dmn', and then by the
  71. dimension within braces.
  72. For example,
  73.      A4 paper is 8.27@dmn{in} wide.
  74. produces
  75.      A4 paper is 8.27in wide.
  76.    Not everyone uses this style.  Instead of writing `8.27@dmn{in}' in
  77. the Texinfo file, you may write `8.27 in.' or `8.27 inches'.  (In these
  78. cases, the formatters may insert a line break between the number and the
  79. dimension.  Also, if you write a period after an abbreviation within a
  80. sentence, you should write `@:' after the period to prevent TeX from
  81. inserting extra whitespace.  *Note Spacing After Colons and Periods:
  82. Controlling Spacing.)
  83. File: texi.info,  Node: Dots Bullets,  Next: TeX and copyright,  Prev: dmn,  Up: Insertions
  84. Inserting Ellipsis, Dots, and Bullets
  85. =====================================
  86.    An "ellipsis" (a line of dots) is not typeset as a string of
  87. periods, so a special command is used for ellipsis in Texinfo.  The
  88. `@bullet' command is special, too.  Each of these commands is followed
  89. by a pair of braces, `{}', without any whitespace between the name of
  90. the command and the braces.  (You need to use braces with these
  91. commands because you can use them next to other text; without the
  92. braces, the formatters would be confused.  *Note @-Command Syntax:
  93. Command Syntax, for further information.)
  94. * Menu:
  95. * dots::                        How to insert dots ...
  96. * bullet::                      How to insert a bullet.
  97. File: texi.info,  Node: dots,  Next: bullet,  Up: Dots Bullets
  98. `@dots'{}
  99. ---------
  100.    Use the `@dots{}' command to generate an ellipsis, which is three
  101. dots in a row, appropriately spaced, like this: `...'.  Do not simply
  102. write three periods in the input file; that would work for the Info
  103. file output, but would produce the wrong amount of space between the
  104. periods in the printed manual.
  105. File: texi.info,  Node: bullet,  Prev: dots,  Up: Dots Bullets
  106. `@bullet'{}
  107. -----------
  108.    Use the `@bullet{}' command to generate a large round dot, or the
  109. closest possible thing to one.  In Info, an asterisk is used.
  110.    Here is a bullet: *
  111.    When you use `@bullet' in `@itemize', you do not need to type the
  112. braces, because `@itemize' supplies them.  *Note itemize::.
  113. File: texi.info,  Node: TeX and copyright,  Next: minus,  Prev: Dots Bullets,  Up: Insertions
  114. Inserting TeX and the Copyright Symbol
  115. ======================================
  116.    The logo `TeX' is typeset in a special fashion and it needs an
  117. @-command.  The copyright symbol, `(C)', is also special.  Each of
  118. these commands is followed by a pair of braces, `{}', without any
  119. whitespace between the name of the command and the braces.
  120. * Menu:
  121. * tex::                         How to insert the TeX logo.
  122. * copyright symbol::            How to use `@copyright'{}.
  123. File: texi.info,  Node: tex,  Next: copyright symbol,  Up: TeX and copyright
  124. `@TeX'{}
  125. --------
  126.    Use the `@TeX{}' command to generate `TeX'.  In a printed manual,
  127. this is a special logo that is different from three ordinary letters.
  128. In Info, it just looks like `TeX'.  The `@TeX{}' command is unique
  129. among Texinfo commands in that the T and the X are in upper case.
  130. File: texi.info,  Node: copyright symbol,  Prev: tex,  Up: TeX and copyright
  131. `@copyright'{}
  132. --------------
  133.    Use the `@copyright{}' command to generate `(C)'.  In a printed
  134. manual, this is a `c' inside a circle, and in Info, this is `(C)'.
  135. File: texi.info,  Node: minus,  Prev: TeX and copyright,  Up: Insertions
  136. `@minus'{}: Inserting a Minus Sign
  137. ==================================
  138.    Use the `@minus{}' command to generate a minus sign.  In a
  139. fixed-width font, this is a single hyphen, but in a proportional font,
  140. the symbol is the customary length for a minus sign--a little longer
  141. than a hyphen.
  142.    You can compare the two forms:
  143.      `-' is a minus sign generated with `@minus{}',
  144.      
  145.      `-' is a hyphen generated with the character `-'.
  146. In the fixed-width font used by Info, `@minus{}' is the same as a
  147. hyphen.
  148.    You should not use `@minus{}' inside `@code' or `@example' because
  149. the width distinction is not made in the fixed-width font they use.
  150.    When you use `@minus' to specify the mark beginning each entry in an
  151. itemized list, you do not need to type the braces (*note itemize::.).
  152. File: texi.info,  Node: Glyphs,  Next: Breaks,  Prev: Insertions,  Up: Top
  153. Glyphs for Examples
  154. *******************
  155.    In Tex