INTRODUCTION revision 114472
10Sstevel@tonic-gate$Id: INTRODUCTION,v 1.2 2002/09/11 16:32:09 karl Exp $ 20Sstevel@tonic-gateGetting started with Texinfo. 30Sstevel@tonic-gate 40Sstevel@tonic-gate Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001 54570Sraf Free Software Foundation, Inc. 64570Sraf 70Sstevel@tonic-gate Copying and distribution of this file, with or without modification, 80Sstevel@tonic-gate are permitted in any medium without royalty provided the copyright 90Sstevel@tonic-gate notice and this notice are preserved. 100Sstevel@tonic-gate 110Sstevel@tonic-gate 120Sstevel@tonic-gate 130Sstevel@tonic-gateGetting Started with Texinfo 140Sstevel@tonic-gate============================ 150Sstevel@tonic-gate 160Sstevel@tonic-gate"Texinfo" is a documentation system that uses a single source file to 170Sstevel@tonic-gateproduce both on-line information and printed output. Using Texinfo, 180Sstevel@tonic-gateyou can create a printed document with the normal features of a book, 190Sstevel@tonic-gateincluding chapters, sections, cross references, and indices. From the 200Sstevel@tonic-gatesame Texinfo source file, you can create a menu-driven, on-line Info 214570Sraffile with nodes, menus, cross references, and indices. 224570Sraf 2311798SRoger.Faulkner@Sun.COMThe name of the Texinfo source documentation file is `texinfo.txi'. 244570SrafYou can produce both on-line information and printed output from this 254570Srafsource file. The documentation describes Texinfo in detail, including 264570Srafhow to write Texinfo files, how to format them for both hard copy and 270Sstevel@tonic-gateInfo, and how to install Info files. 280Sstevel@tonic-gate 290Sstevel@tonic-gateTo get started, you need to create either a printed manual or an 300Sstevel@tonic-gateon-line Info file from the `texinfo.txi' file. You do not need to 310Sstevel@tonic-gatecreate both, although you will probably want both eventually. 320Sstevel@tonic-gate 330Sstevel@tonic-gateTo learn how to use Info, read the info documentation. You can do this in 340Sstevel@tonic-gateone of two ways: using the standalone `info' program, or using Info mode in 350Sstevel@tonic-gateGNU Emacs. 360Sstevel@tonic-gate 370Sstevel@tonic-gate * If you want to use the `info' program, run 380Sstevel@tonic-gate 390Sstevel@tonic-gate info -f info-stnd 400Sstevel@tonic-gate 410Sstevel@tonic-gate * If you want to use Emacs, start up emacs and type `C-h i' [M-x info]. 420Sstevel@tonic-gate Follow the instructions to learn how to use Info. 430Sstevel@tonic-gate 440Sstevel@tonic-gateAfter learning how to use Info, you can read the Texinfo documentation. 450Sstevel@tonic-gateUsing the standalone `info', type the following at the shell prompt: 460Sstevel@tonic-gate 470Sstevel@tonic-gate info -f texinfo 480Sstevel@tonic-gate 490Sstevel@tonic-gateTo use read this manual in Emacs, you first need to edit the Info-directory 500Sstevel@tonic-gatemenu (the file `dir' in the system info directory) to contain the 510Sstevel@tonic-gateappropriate node. To learn how to do this, see node: Add in the Info 520Sstevel@tonic-gatedocumentation. 530Sstevel@tonic-gate 540Sstevel@tonic-gateThe Texinfo documentation describes Texinfo in detail; among other things, 550Sstevel@tonic-gateit tells how to install Info files in the usual manner. (See node: Install 560Sstevel@tonic-gatean Info File.) 570Sstevel@tonic-gate 580Sstevel@tonic-gateThe `info-stnd.info' file describes the standalone Info reader in detail. To 590Sstevel@tonic-gateread this file, type 600Sstevel@tonic-gate 610Sstevel@tonic-gate $ info -f info-stnd 620Sstevel@tonic-gate 630Sstevel@tonic-gate 640Sstevel@tonic-gateTo create a printed manual 650Sstevel@tonic-gate========================== 660Sstevel@tonic-gate 670Sstevel@tonic-gateYou need: 680Sstevel@tonic-gate 699264SRoger.Faulkner@Sun.COM * The `tex' program, which typesets the manual using TeX. 7010887SRoger.Faulkner@Sun.COM * The `texinfo.tex' definition file that tells TeX how to typeset 7110887SRoger.Faulkner@Sun.COM a Texinfo file. 720Sstevel@tonic-gate * The `texindex' program, which sorts the unsorted index files 730Sstevel@tonic-gate created by TeX. 740Sstevel@tonic-gate * A printing program such as `lp' or `lpr', 750Sstevel@tonic-gate * A printer. 760Sstevel@tonic-gate 770Sstevel@tonic-gateThis Texinfo distribution package contains `texinfo.tex', the C source 780Sstevel@tonic-gatefor `texindex', and the handy shell script `texi2dvi'. The `tex' 790Sstevel@tonic-gateprogram is not part of this distribution, but is available separately. 800Sstevel@tonic-gate(See `How to Obtain TeX' in the Texinfo documentation.) 810Sstevel@tonic-gate 820Sstevel@tonic-gate * Install `tex'. (`texindex' is installed automagically by 830Sstevel@tonic-gate `make install' in this distribution.) 840Sstevel@tonic-gate 850Sstevel@tonic-gate * Move the `texinfo.tex' file to an appropriate directory; the current 860Sstevel@tonic-gate directory will do. (`/usr/local/lib/tex/inputs' might be a good place. 870Sstevel@tonic-gate See ``Preparing to Use TeX'' in the Texinfo manual, for more 880Sstevel@tonic-gate information.) 890Sstevel@tonic-gate 900Sstevel@tonic-gateAfter following those instructions, type the following to make the .dvi 910Sstevel@tonic-gatefiles: 920Sstevel@tonic-gate 930Sstevel@tonic-gate $ (cd doc; make dvi) 940Sstevel@tonic-gate 950Sstevel@tonic-gateYou can then print the resulting .dvi files with the `lpr' or `lp' 960Sstevel@tonic-gatecommands, or maybe `dvips'. 970Sstevel@tonic-gate 980Sstevel@tonic-gateFor example, the command to print the texinfo.dvi file might be: 990Sstevel@tonic-gate 1000Sstevel@tonic-gate $ lpr -d texinfo.dvi 1010Sstevel@tonic-gate 1020Sstevel@tonic-gateThe name of the printing command depends on the system; `lpr -d' is 1030Sstevel@tonic-gatecommon, and is illustrated here. You may use a different name for the 1040Sstevel@tonic-gateprinting command. 1050Sstevel@tonic-gate 1060Sstevel@tonic-gatePlease report bugs to bug-texinfo@gnu.org. 1070Sstevel@tonic-gate 1080Sstevel@tonic-gateHappy formatting. 1090Sstevel@tonic-gate