1146515Sru$Id: README,v 1.16 2004/12/13 13:36:32 karl Exp $ 2146515SruThis is the README file for the GNU Texinfo distribution. Texinfo is 3146515Sruthe preferred documentation format for GNU software. 493139Sru 5114472Sru Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 6146515Sru 2001, 2002, 2003, 2004 Free Software Foundation, Inc. 793139Sru 8114472Sru Copying and distribution of this file, with or without modification, 9114472Sru are permitted in any medium without royalty provided the copyright 10114472Sru notice and this notice are preserved. 1193139Sru 12114472SruSee ./INSTALL* for installation instructions. 1321495Sjmacd 14114472SruPrimary distribution point: ftp://ftp.gnu.org/gnu/texinfo/ 15114472Sru (list of mirrors at: http://www.gnu.org/prep/ftp.html) 16114472Sru 17114472SruHome page: http://www.gnu.org/software/texinfo/ 18114472Sru (list of mirrors at: http://www.gnu.org/server/list-mirrors.html) 19114472Sru This page includes links to other Texinfo-related programs. 20114472Sru 21114472SruMailing lists and archives: 2256160Sru- bug-texinfo@gnu.org for bug reports or enhancement suggestions, 23114472Sru archive: http://mail.gnu.org/pipermail/bug-texinfo 24114472Sru- help-texinfo@gnu.org for authoring questions and general discussion, 25114472Sru archive: http://mail.gnu.org/pipermail/help-texinfo 2693139Sru- texinfo-pretest@texinfo.org for pretests of new releases, 27114472Sru archive: http://texinfo.org/ftp/texinfo-pretest-archive 28114472SruThere are no corresponding newsgroups. 2921495Sjmacd 30114472SruBug reports: 31114472Sru please include enough information for the maintainers to reproduce the 32114472Sru problem. Generally speaking, that means: 3393139Sru- the contents of any input files necessary to reproduce the bug (crucial!). 3493139Sru- a description of the problem and any samples of the erroneous output. 3556160Sru- the version number of Texinfo and the program(s) involved (use --version). 3656160Sru- hardware, operating system, and compiler versions (uname -a). 37114472Sru- unusual options you gave to configure, if any (see config.status). 3856160Sru- anything else that you think would be helpful. 3921495Sjmacd 4056160SruPatches are most welcome; if possible, please make them with diff -c and 4156160Sruinclude ChangeLog entries. 4256160Sru 4356160SruWhen sending email, please do not encode or split the messages in any 4493139Sruway if at all possible; it's easier to deal with one large message than 45114472Srumany small ones. GNU shar (http://www.gnu.org/software/sharutils/) is a 46114472Sruconvenient way of packaging multiple and/or binary files for email. 4756160Sru 48114472SruSee README.dev for information on the Texinfo development environment -- 49114472Sruany interested parties are welcome. If you're a programmer and wish to 50114472Srucontribute, this should get you started. And if you're not a 51114472Sruprogrammer, you can still make significant contributions by writing test 52114472Srucases, checking the documentation against the implementation, etc. 5356160Sru 5456160SruThis distribution includes the following files, among others: 5521495Sjmacd README This file. 56114472Sru README.dev Texinfo developer information. 5756160Sru 58114472Sru INSTALL Texinfo-specific installation notes. 5956160Sru NEWS Summary of new features by release. 6042660Smarkm INTRODUCTION Brief introduction to the system, and 6142660Smarkm how to create readable files from the 6242660Smarkm Texinfo source files in this distribution. 6321495Sjmacd 64114472SruTexinfo documentation files (in ./doc): 6556160Sru texinfo.txi Describes the Texinfo language and many 6656160Sru of the associated tools. It tells how 6756160Sru to use Texinfo to write documentation, 6856160Sru how to use Texinfo mode in GNU Emacs, 6956160Sru TeX, makeinfo, and the Emacs Lisp 7056160Sru Texinfo formatting commands. 7121495Sjmacd 7221495Sjmacd info.texi This manual tells you how to use 73114472Sru Info. This document also comes as part of 7421495Sjmacd GNU Emacs. If you do not have Emacs, 7521495Sjmacd you can format this Texinfo source 7621495Sjmacd file with makeinfo or TeX and then 7721495Sjmacd read the resulting Info file with the 7821495Sjmacd standalone Info reader that is part of 7921495Sjmacd this distribution. 8021495Sjmacd 8121495Sjmacd info-stnd.texi This manual tells you how to use 8221495Sjmacd the standalone GNU Info reader that is 8342660Smarkm included in this distribution as C 8442660Smarkm source (./info). 8521495Sjmacd 8621495SjmacdPrinting related files: 8742660Smarkm doc/texinfo.tex This TeX definitions file tells 8821495Sjmacd the TeX program how to typeset a 8921495Sjmacd Texinfo file into a DVI file ready for 9021495Sjmacd printing. 9121495Sjmacd 9242660Smarkm util/texindex.c This file contains the source for 9321495Sjmacd the `texindex' program that generates 9421495Sjmacd sorted indices used by TeX when 9521495Sjmacd typesetting a file for printing. 9621495Sjmacd 9742660Smarkm util/texi2dvi This is a shell script for 9821495Sjmacd producing an indexed DVI file using 9956160Sru TeX and texindex. 10021495Sjmacd 101114472SruSource files for standalone C programs: 102114472Sru ./lib 103114472Sru ./makeinfo 104114472Sru ./info 10521495Sjmacd 10642660SmarkmInstallation files: 107114472Sru Makefile.am What Automake uses to make a Makefile.in. 108114472Sru Makefile.in What `configure' uses to make a Makefile, 109114472Sru created by Automake. 110114472Sru configure.ac What Autoconf uses to create `configure'. 111114472Sru configure Configuration script for local conditions, 112114472Sru created by Autoconf. 113