Mercurial > hg > xemacs-beta
comparison man/texinfo.texi @ 290:c9fe270a4101 r21-0b43
Import from CVS: tag r21-0b43
author | cvs |
---|---|
date | Mon, 13 Aug 2007 10:36:47 +0200 |
parents | bfd6434d15b3 |
children | 4b85ae5eabfb |
comparison
equal
deleted
inserted
replaced
289:6e6992ccc4b6 | 290:c9fe270a4101 |
---|---|
1 \input texinfo.tex @c -*-texinfo-*- | 1 \input texinfo.tex @c -*-texinfo-*- |
2 @c $Id: texinfo.texi,v 1.5 1997/08/10 04:40:35 steve Exp $ | 2 @c $Id: texinfo.texi,v 1.6 1998/06/13 04:28:16 steve Exp $ |
3 @c %**start of header | 3 @c %**start of header |
4 | 4 |
5 @c All text is ignored before the setfilename. | 5 @c All text is ignored before the setfilename. |
6 @setfilename texinfo | 6 @setfilename texinfo |
7 @settitle Texinfo @value{edition} | 7 @settitle Texinfo @value{edition} |
8 | 8 |
9 @set edition 2.24 | 9 @c Edition number is now the same as the Texinfo distribution version number. |
10 @set update-month July 1997 | 10 @set edition 3.12 |
11 @set update-date 25 @value{update-month} | 11 @set update-month February 1998 |
12 @set update-date 27 @value{update-month} | |
12 | 13 |
13 @c Define a new index for options. | 14 @c Define a new index for options. |
14 @defcodeindex op | 15 @defcodeindex op |
15 @c Put everything except function (command, in this case) names in one | 16 @c Put everything except function (command, in this case) names in one |
16 @c index (arbitrarily chosen to be the concept index). | 17 @c index (arbitrarily chosen to be the concept index). |
42 @c smallbook | 43 @c smallbook |
43 @c set smallbook | 44 @c set smallbook |
44 @c @@clear smallbook | 45 @c @@clear smallbook |
45 | 46 |
46 @c Currently undocumented command, 5 December 1993: | 47 @c Currently undocumented command, 5 December 1993: |
47 @c | |
48 @c nwnode (Same as node, but no warnings; for `makeinfo'.) | 48 @c nwnode (Same as node, but no warnings; for `makeinfo'.) |
49 | 49 |
50 @ifinfo | 50 @ifinfo |
51 This file documents Texinfo, a documentation system that can produce | 51 This file documents Texinfo, a documentation system that can produce |
52 both on-line information and a printed manual from a single source file. | 52 both on-line information and a printed manual from a single source file. |
53 | 53 |
54 Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97 Free Software Foundation, Inc. | 54 Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98 |
55 | 55 Free Software Foundation, Inc. |
56 This is the second edition of the Texinfo documentation,@* | 56 |
57 and is consistent with version 2 of @file{texinfo.tex}. | 57 This edition is for Texinfo version @value{edition}. |
58 | 58 |
59 Permission is granted to make and distribute verbatim copies of | 59 Permission is granted to make and distribute verbatim copies of |
60 this manual provided the copyright notice and this permission notice | 60 this manual provided the copyright notice and this permission notice |
61 are preserved on all copies. | 61 are preserved on all copies. |
62 | 62 |
84 | 84 |
85 @titlepage | 85 @titlepage |
86 @c use the new format for titles | 86 @c use the new format for titles |
87 @title Texinfo | 87 @title Texinfo |
88 @subtitle The GNU Documentation Format | 88 @subtitle The GNU Documentation Format |
89 @subtitle Edition @value{edition}, for Texinfo Version Three | 89 @subtitle for Texinfo version @value{edition} |
90 @subtitle @value{update-month} | 90 @subtitle @value{update-month} |
91 | 91 |
92 @author Robert J.@: Chassell | 92 @author Robert J.@: Chassell |
93 @author Richard M.@: Stallman | 93 @author Richard M.@: Stallman |
94 | 94 |
95 @c Include the Distribution inside the titlepage so | 95 @c Include the Distribution inside the titlepage so |
96 @c that headings are turned off. | 96 @c that headings are turned off. |
97 | 97 |
98 @page | 98 @page |
99 @vskip 0pt plus 1filll | 99 @vskip 0pt plus 1filll |
100 Copyright @copyright{} 1988, 90, 91, 92, 93, 95, 96, 97 | 100 Copyright @copyright{} 1988, 90, 91, 92, 93, 95, 96, 97, 98 |
101 Free Software Foundation, Inc. | 101 Free Software Foundation, Inc. |
102 | |
103 @sp 2 | |
104 This is the second edition of the Texinfo documentation,@* | |
105 and is consistent with version 2 of @file{texinfo.tex}. | |
106 @sp 2 | |
107 | 102 |
108 Published by the Free Software Foundation @* | 103 Published by the Free Software Foundation @* |
109 59 Temple Place Suite 330 @* | 104 59 Temple Place Suite 330 @* |
110 Boston, MA 02111-1307 @* | 105 Boston, MA 02111-1307 @* |
111 USA @* | 106 USA @* |
112 Printed copies are available for $15 each.@* | 107 ISBN 1-882114-65-5 |
113 ISBN 1-882114-64-7 | |
114 @c ISBN 1-882114-63-9 is for edition 2.20 of 28 February 1995 | 108 @c ISBN 1-882114-63-9 is for edition 2.20 of 28 February 1995 |
115 @c ISBN 1-882114-64-7 is for edition 2.23 of 1 October 1996. | 109 @c ISBN 1-882114-64-7 is for edition 2.24 of November 1996. |
116 | 110 |
117 Permission is granted to make and distribute verbatim copies of | 111 Permission is granted to make and distribute verbatim copies of |
118 this manual provided the copyright notice and this permission notice | 112 this manual provided the copyright notice and this permission notice |
119 are preserved on all copies. | 113 are preserved on all copies. |
120 | 114 |
141 The first part of this master menu lists the major nodes in this Info | 135 The first part of this master menu lists the major nodes in this Info |
142 document, including the @@-command and concept indices. The rest of | 136 document, including the @@-command and concept indices. The rest of |
143 the menu lists all the lower level nodes in the document.@refill | 137 the menu lists all the lower level nodes in the document.@refill |
144 | 138 |
145 This is Edition @value{edition} of the Texinfo documentation, | 139 This is Edition @value{edition} of the Texinfo documentation, |
146 @w{@value{update-date},} for Texinfo Version Three. | 140 @w{@value{update-date}}. |
147 @end ifinfo | 141 @end ifinfo |
148 | 142 |
149 @c Here is a spare copy of the chapter menu entry descriptions, | 143 @c Here is a spare copy of the chapter menu entry descriptions, |
150 @c in case they are accidently deleted | 144 @c in case they are accidently deleted |
151 @ignore | 145 @ignore |
1468 Please send suggestions and corrections to: | 1462 Please send suggestions and corrections to: |
1469 | 1463 |
1470 @example | 1464 @example |
1471 @group | 1465 @group |
1472 @r{Internet address:} | 1466 @r{Internet address:} |
1473 bug-texinfo@@prep.ai.mit.edu | 1467 bug-texinfo@@gnu.org |
1474 @end group | 1468 @end group |
1475 @end example | 1469 @end example |
1476 | 1470 |
1477 @noindent | 1471 @noindent |
1478 Please include the manual's edition number and update date in your messages. | 1472 Please include the manual's edition number and update date in your messages. |
2203 you first create a file for printing (called a DVI file), and then | 2197 you first create a file for printing (called a DVI file), and then |
2204 print the file. Optionally, you may also create indices. To do this, | 2198 print the file. Optionally, you may also create indices. To do this, |
2205 you must run the @code{texindex} command after first running the | 2199 you must run the @code{texindex} command after first running the |
2206 @code{tex} typesetting command; and then you must run the @code{tex} | 2200 @code{tex} typesetting command; and then you must run the @code{tex} |
2207 command again. Or else run the @code{texi2dvi} command which | 2201 command again. Or else run the @code{texi2dvi} command which |
2208 automatically creates indices as needed.@refill | 2202 automatically creates indices as needed (@pxref{Format with texi2dvi}). |
2209 | 2203 |
2210 Often, when you are writing a document, you want to typeset and print | 2204 Often, when you are writing a document, you want to typeset and print |
2211 only part of a file to see what it will look like. You can use the | 2205 only part of a file to see what it will look like. You can use the |
2212 @code{texinfo-tex-region} and related commands for this purpose. Use | 2206 @code{texinfo-tex-region} and related commands for this purpose. Use |
2213 the @code{texinfo-tex-buffer} command to format all of a | 2207 the @code{texinfo-tex-buffer} command to format all of a |
6807 the text to display if any. In HTML output, @code{@@email} produces a | 6801 the text to display if any. In HTML output, @code{@@email} produces a |
6808 @samp{mailto} link that usually brings up a mail composition window. | 6802 @samp{mailto} link that usually brings up a mail composition window. |
6809 For example: | 6803 For example: |
6810 | 6804 |
6811 @example | 6805 @example |
6812 Send bug reports to @@email@{bug-texinfo@@@@prep.ai.mit.edu@}. | 6806 Send bug reports to @@email@{bug-texinfo@@@@gnu.org@}. |
6813 Send suggestions to the @@email@{bug-texinfo@@@@prep.ai.mit.edu, same place@}. | 6807 Send suggestions to the @@email@{bug-texinfo@@@@gnu.org, same place@}. |
6814 @end example | 6808 @end example |
6815 @noindent produces | 6809 @noindent produces |
6816 @example | 6810 @example |
6817 Send bug reports to @email{bug-texinfo@@prep.ai.mit.edu}. | 6811 Send bug reports to @email{bug-texinfo@@gnu.org}. |
6818 Send suggestions to the @email{bug-texinfo@@prep.ai.mit.edu, same place}. | 6812 Send suggestions to the @email{bug-texinfo@@gnu.org, same place}. |
6819 @end example | 6813 @end example |
6820 | 6814 |
6821 | 6815 |
6822 @node Emphasis, , Indicating, Marking Text | 6816 @node Emphasis, , Indicating, Marking Text |
6823 @comment node-name, next, previous, up | 6817 @comment node-name, next, previous, up |
10675 @end example | 10669 @end example |
10676 | 10670 |
10677 @code{@@deftypefun} creates an entry in the index of functions for | 10671 @code{@@deftypefun} creates an entry in the index of functions for |
10678 @var{name}.@refill | 10672 @var{name}.@refill |
10679 | 10673 |
10680 @item @@deftypemethod @var{class} @var{data-type} @var{method-name} @var{arguments}@dots{} | |
10681 @findex deftypefun | |
10682 The @code{@@deftypemethod} command is the definition command for methods | |
10683 in object-oriented typed languages, such as C++ and Java. It is similar | |
10684 to the @code{@@deftypefn} with the addition of the @var{class} parameter | |
10685 to specify the class containing the method. | |
10686 | |
10687 @end table | 10674 @end table |
10688 | 10675 |
10689 | 10676 |
10690 @node Typed Variables, Abstract Objects, Typed Functions, Def Cmds in Detail | 10677 @node Typed Variables, Abstract Objects, Typed Functions, Def Cmds in Detail |
10691 @subsection Variables in Typed Languages | 10678 @subsection Variables in Typed Languages |
12069 you do not, on the next run, the @code{tex} formatting command will use | 12056 you do not, on the next run, the @code{tex} formatting command will use |
12070 whatever sorted index files happen to exist from the previous use of | 12057 whatever sorted index files happen to exist from the previous use of |
12071 @code{texindex}. This is usually ok while you are | 12058 @code{texindex}. This is usually ok while you are |
12072 debugging.@refill | 12059 debugging.@refill |
12073 | 12060 |
12061 | |
12074 @node Format with texi2dvi, Print with lpr, Format with tex/texindex, Format/Print Hardcopy | 12062 @node Format with texi2dvi, Print with lpr, Format with tex/texindex, Format/Print Hardcopy |
12075 @comment node-name, next, previous, up | 12063 @comment node-name, next, previous, up |
12076 @section Format using @code{texi2dvi} | 12064 @section Format using @code{texi2dvi} |
12077 @pindex texi2dvi @r{(shell script)} | 12065 @pindex texi2dvi @r{(shell script)} |
12078 | 12066 |
12079 The @code{texi2dvi} command is a shell script that automatically runs | 12067 The @code{texi2dvi} command automatically runs both @code{tex} and |
12080 both @code{tex} and @code{texindex} as many times as necessary to | 12068 @code{texindex} as many times as necessary to produce a DVI file with |
12081 produce a DVI file with up-to-date, sorted indices. It simplifies the | 12069 up-to-date, sorted indices. It simplifies the |
12082 @code{tex}---@code{texindex}---@code{tex} sequence described in the | 12070 @code{tex}---@code{texindex}---@code{tex} sequence described in the |
12083 previous section. | 12071 previous section. |
12084 | 12072 |
12085 @need 1000 | 12073 The syntax for @code{texi2dvi} is like this (where @samp{prompt$} is your |
12086 The syntax for @code{texi2dvi} is like this (where @samp{prompt$} is the | |
12087 shell prompt):@refill | 12074 shell prompt):@refill |
12088 | 12075 |
12089 @example | 12076 @example |
12090 prompt$ @kbd{texi2dvi @var{filename}@dots{}} | 12077 prompt$ @kbd{texi2dvi @var{filename}@dots{}} |
12091 @end example | 12078 @end example |
12079 | |
12080 For a list of options, run @samp{texi2dvi --help}. | |
12081 | |
12092 | 12082 |
12093 @node Print with lpr, Within Emacs, Format with texi2dvi, Format/Print Hardcopy | 12083 @node Print with lpr, Within Emacs, Format with texi2dvi, Format/Print Hardcopy |
12094 @comment node-name, next, previous, up | 12084 @comment node-name, next, previous, up |
12095 @section Shell Print Using @code{lpr -d} | 12085 @section Shell Print Using @code{lpr -d} |
12096 @pindex lpr @r{(DVI print command)} | 12086 @pindex lpr @r{(DVI print command)} |
15211 Software Foundation permission notice reads as follows:@refill | 15201 Software Foundation permission notice reads as follows:@refill |
15212 | 15202 |
15213 @example | 15203 @example |
15214 This file documents @dots{} | 15204 This file documents @dots{} |
15215 | 15205 |
15216 Copyright 1997 Free Software Foundation, Inc. | 15206 Copyright 1998 Free Software Foundation, Inc. |
15217 | 15207 |
15218 Permission is granted to make and distribute verbatim | 15208 Permission is granted to make and distribute verbatim |
15219 copies of this manual provided the copyright notice and | 15209 copies of this manual provided the copyright notice and |
15220 this permission notice are preserved on all copies. | 15210 this permission notice are preserved on all copies. |
15221 | 15211 |
15471 @end group | 15461 @end group |
15472 | 15462 |
15473 @group | 15463 @group |
15474 @@page | 15464 @@page |
15475 @@vskip 0pt plus 1filll | 15465 @@vskip 0pt plus 1filll |
15476 Copyright @@copyright@{@} 1997 Free Software Foundation, Inc. | 15466 Copyright @@copyright@{@} 1998 Free Software Foundation, Inc. |
15477 @@end titlepage | 15467 @@end titlepage |
15478 @end group | 15468 @end group |
15479 | 15469 |
15480 @group | 15470 @group |
15481 @@ifinfo | 15471 @@ifinfo |
16684 @appendix How to Obtain @TeX{} | 16674 @appendix How to Obtain @TeX{} |
16685 @cindex Obtaining @TeX{} | 16675 @cindex Obtaining @TeX{} |
16686 @cindex @TeX{}, how to obtain | 16676 @cindex @TeX{}, how to obtain |
16687 | 16677 |
16688 @c !!! Here is information about obtaining TeX. Update it whenever. | 16678 @c !!! Here is information about obtaining TeX. Update it whenever. |
16689 @c !!! Also consider updating TeX.README on prep. | 16679 @c !!! Also consider updating TeX.README on ftp.gnu.org. |
16690 @c Updated by RJC on 1 March 1995, conversation with MacKay. | 16680 @c Updated by RJC on 1 March 1995, conversation with MacKay. |
16691 @c Updated by kb@cs.umb.edu on 29 July 1996. | 16681 @c Updated by kb@cs.umb.edu on 29 July 1996. |
16692 @c Updated by kb@cs.umb.edu on 25 April 1997. | 16682 @c Updated by kb@cs.umb.edu on 25 April 1997. |
16683 @c Updated by kb@cs.umb.edu on 27 February 1998. | |
16693 @TeX{} is freely redistributable. You can obtain @TeX{} for Unix | 16684 @TeX{} is freely redistributable. You can obtain @TeX{} for Unix |
16694 systems via anonymous ftp or on physical media. The core material | 16685 systems via anonymous ftp or on physical media. The core material |
16695 consists of the Web2c @TeX{} distribution (@uref{http://www.tug.org/web2c}). | 16686 consists of the Web2c @TeX{} distribution (@uref{http://tug.org/web2c}). |
16696 | 16687 |
16697 Instructions for retrieval by anonymous ftp and information on other | 16688 Instructions for retrieval by anonymous ftp and information on other |
16698 available distributions: | 16689 available distributions: |
16699 @example | 16690 @example |
16700 @uref{ftp://ftp.tug.org/tex/unixtex.ftp} | 16691 @uref{ftp://tug.org/tex/unixtex.ftp} |
16701 @uref{http://www.tug.org/unixtex.ftp} | 16692 @uref{http://tug.org/unixtex.ftp} |
16702 @end example | 16693 @end example |
16703 | 16694 |
16704 The Free Software Foundation provides a core distribution on its Source | 16695 The Free Software Foundation provides a core distribution on its Source |
16705 Code CD-ROM suitable for printing Texinfo manuals; the University of | 16696 Code CD-ROM suitable for printing Texinfo manuals; the University of |
16706 Washington maintains and supports a tape distribution; the @TeX{} Users | 16697 Washington maintains and supports a tape distribution; the @TeX{} Users |
16716 @group | 16707 @group |
16717 Free Software Foundation, Inc. | 16708 Free Software Foundation, Inc. |
16718 59 Temple Place Suite 330 | 16709 59 Temple Place Suite 330 |
16719 Boston, MA @ @ 02111-1307 | 16710 Boston, MA @ @ 02111-1307 |
16720 USA | 16711 USA |
16721 Telephone: @w{@t{+}1--617--542--5942} | 16712 Telephone: @w{+1-617-542-5942} |
16722 Fax: (including Japan) @w{@t{+}1--617--542--2652} | 16713 Fax: (including Japan) @w{+1-617-542-2652} |
16723 Free Dial Fax (in Japan): | 16714 Free Dial Fax (in Japan): |
16724 @w{ } @w{ } @w{ } 0031--13--2473 (KDD) | 16715 @w{ } @w{ } @w{ } 0031-13-2473 (KDD) |
16725 @w{ } @w{ } @w{ } 0066--3382--0158 (IDC) | 16716 @w{ } @w{ } @w{ } 0066-3382-0158 (IDC) |
16726 Electronic mail: @code{gnu@@prep.ai.mit.edu} | 16717 Electronic mail: @code{gnu@@gnu.org} |
16727 @end group | 16718 @end group |
16728 @end display | 16719 @end display |
16729 @end iftex | 16720 @end iftex |
16730 @ifinfo | 16721 @ifinfo |
16731 @display | 16722 @display |
16733 Free Software Foundation, Inc. | 16724 Free Software Foundation, Inc. |
16734 59 Temple Place Suite 330 | 16725 59 Temple Place Suite 330 |
16735 Boston, MA @w{ } 02111-1307 | 16726 Boston, MA @w{ } 02111-1307 |
16736 USA | 16727 USA |
16737 | 16728 |
16738 Telephone: @w{@t{+}1-617-542-5942} | 16729 Telephone: @w{+1-617-542-5942} |
16739 Fax: (including Japan) @w{@t{+}1-617-542-2652} | 16730 Fax: (including Japan) @w{+1-617-542-2652} |
16740 Free Dial Fax (in Japan): | 16731 Free Dial Fax (in Japan): |
16741 @w{ } @w{ } @w{ } 0031-13-2473 (KDD) | 16732 @w{ } @w{ } @w{ } 0031-13-2473 (KDD) |
16742 @w{ } @w{ } @w{ } 0066-3382-0158 (IDC) | 16733 @w{ } @w{ } @w{ } 0066-3382-0158 (IDC) |
16743 Electronic mail: @code{gnu@@prep.ai.mit.edu} | 16734 Electronic mail: @code{gnu@@gnu.org} |
16744 @end group | 16735 @end group |
16745 @end display | 16736 @end display |
16746 @end ifinfo | 16737 @end ifinfo |
16747 | 16738 |
16748 @item | 16739 @item |
16749 To order a complete distribution on CD-ROM, please see | 16740 To order a complete distribution on CD-ROM, please see |
16750 @uref{http://www.tug.org/tex-live.html}. (This distribution is also | 16741 @uref{http://tug.org/tex-live.html}. (This distribution is also |
16751 available by FTP; see the URL's above.) | 16742 available by FTP; see the URL's above.) |
16752 | 16743 |
16753 @item | 16744 @item |
16754 To order a full distribution from the University of Washington on either | 16745 To order a full distribution from the University of Washington on either |
16755 a 1/4@dmn{in} 4-track QIC-24 cartridge or a 4@dmn{mm} DAT cartridge, | 16746 a 1/4@dmn{in} 4-track QIC-24 cartridge or a 4@dmn{mm} DAT cartridge, |
16760 Pierre A. MacKay | 16751 Pierre A. MacKay |
16761 Denny Hall, Mail Stop DH-10 | 16752 Denny Hall, Mail Stop DH-10 |
16762 University of Washington | 16753 University of Washington |
16763 Seattle, WA @w{ } 98195 | 16754 Seattle, WA @w{ } 98195 |
16764 USA | 16755 USA |
16765 Telephone: @t{+}1--206--543--2268 | 16756 Telephone: +1-206-543-2268 |
16766 Electronic mail: @code{mackay@@cs.washington.edu} | 16757 Electronic mail: @code{mackay@@cs.washington.edu} |
16767 @end group | 16758 @end group |
16768 @end display | 16759 @end display |
16769 | 16760 |
16770 @noindent Please make checks payable to the University of Washington. | 16761 @noindent Please make checks payable to the University of Washington. |
16773 air parcel post, or $30.00 for shipment via courier. | 16764 air parcel post, or $30.00 for shipment via courier. |
16774 | 16765 |
16775 @end itemize | 16766 @end itemize |
16776 | 16767 |
16777 Many other @TeX{} distributions are available; see | 16768 Many other @TeX{} distributions are available; see |
16778 @uref{http://www.tug.org/}. | 16769 @uref{http://tug.org/}. |
16779 | 16770 |
16780 | 16771 |
16781 @c These are no longer ``new'', and the explanations | 16772 @c These are no longer ``new'', and the explanations |
16782 @c are all given elsewhere anyway, I think. --karl, 25apr97. | 16773 @c are all given elsewhere anyway, I think. --karl, 25apr97. |
16783 @ignore (the entire appendix) | 16774 @ignore (the entire appendix) |