1279377Simp$Id: README,v 1.16 2004/12/13 13:36:32 karl Exp $ 2279377SimpThis is the README file for the GNU Texinfo distribution. Texinfo is 3279377Simpthe preferred documentation format for GNU software. 4279377Simp 5279377Simp Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 6279377Simp 2001, 2002, 2003, 2004 Free Software Foundation, Inc. 7279377Simp 8279377Simp Copying and distribution of this file, with or without modification, 9279377Simp are permitted in any medium without royalty provided the copyright 10279377Simp notice and this notice are preserved. 11279377Simp 12279377SimpSee ./INSTALL* for installation instructions. 13279377Simp 14279377SimpPrimary distribution point: ftp://ftp.gnu.org/gnu/texinfo/ 15279377Simp (list of mirrors at: http://www.gnu.org/prep/ftp.html) 16279377Simp 17279377SimpHome page: http://www.gnu.org/software/texinfo/ 18279377Simp (list of mirrors at: http://www.gnu.org/server/list-mirrors.html) 19279377Simp This page includes links to other Texinfo-related programs. 20279377Simp 21279377SimpMailing lists and archives: 22279377Simp- bug-texinfo@gnu.org for bug reports or enhancement suggestions, 23279377Simp archive: http://mail.gnu.org/pipermail/bug-texinfo 24279377Simp- help-texinfo@gnu.org for authoring questions and general discussion, 25279377Simp archive: http://mail.gnu.org/pipermail/help-texinfo 26279377Simp- texinfo-pretest@texinfo.org for pretests of new releases, 27279377Simp archive: http://texinfo.org/ftp/texinfo-pretest-archive 28279377SimpThere are no corresponding newsgroups. 29279377Simp 30279377SimpBug reports: 31279377Simp please include enough information for the maintainers to reproduce the 32279377Simp problem. Generally speaking, that means: 33279377Simp- the contents of any input files necessary to reproduce the bug (crucial!). 34279377Simp- a description of the problem and any samples of the erroneous output. 35279377Simp- the version number of Texinfo and the program(s) involved (use --version). 36279377Simp- hardware, operating system, and compiler versions (uname -a). 37279377Simp- unusual options you gave to configure, if any (see config.status). 38279377Simp- anything else that you think would be helpful. 39279377Simp 40279377SimpPatches are most welcome; if possible, please make them with diff -c and 41279377Simpinclude ChangeLog entries. 42279377Simp 43279377SimpWhen sending email, please do not encode or split the messages in any 44279377Simpway if at all possible; it's easier to deal with one large message than 45279377Simpmany small ones. GNU shar (http://www.gnu.org/software/sharutils/) is a 46279377Simpconvenient way of packaging multiple and/or binary files for email. 47279377Simp 48279377SimpSee README.dev for information on the Texinfo development environment -- 49279377Simpany interested parties are welcome. If you're a programmer and wish to 50279377Simpcontribute, this should get you started. And if you're not a 51279377Simpprogrammer, you can still make significant contributions by writing test 52279377Simpcases, checking the documentation against the implementation, etc. 53279377Simp 54279377SimpThis distribution includes the following files, among others: 55279377Simp README This file. 56279377Simp README.dev Texinfo developer information. 57279377Simp 58279377Simp INSTALL Texinfo-specific installation notes. 59279377Simp NEWS Summary of new features by release. 60279377Simp INTRODUCTION Brief introduction to the system, and 61279377Simp how to create readable files from the 62279377Simp Texinfo source files in this distribution. 63279377Simp 64279377SimpTexinfo documentation files (in ./doc): 65279377Simp texinfo.txi Describes the Texinfo language and many 66279377Simp of the associated tools. It tells how 67279377Simp to use Texinfo to write documentation, 68279377Simp how to use Texinfo mode in GNU Emacs, 69279377Simp TeX, makeinfo, and the Emacs Lisp 70279377Simp Texinfo formatting commands. 71279377Simp 72279377Simp info.texi This manual tells you how to use 73279377Simp Info. This document also comes as part of 74279377Simp GNU Emacs. If you do not have Emacs, 75279377Simp you can format this Texinfo source 76279377Simp file with makeinfo or TeX and then 77279377Simp read the resulting Info file with the 78279377Simp standalone Info reader that is part of 79279377Simp this distribution. 80279377Simp 81279377Simp info-stnd.texi This manual tells you how to use 82279377Simp the standalone GNU Info reader that is 83279377Simp included in this distribution as C 84279377Simp source (./info). 85279377Simp 86279377SimpPrinting related files: 87279377Simp doc/texinfo.tex This TeX definitions file tells 88279377Simp the TeX program how to typeset a 89279377Simp Texinfo file into a DVI file ready for 90279377Simp printing. 91 92 util/texindex.c This file contains the source for 93 the `texindex' program that generates 94 sorted indices used by TeX when 95 typesetting a file for printing. 96 97 util/texi2dvi This is a shell script for 98 producing an indexed DVI file using 99 TeX and texindex. 100 101Source files for standalone C programs: 102 ./lib 103 ./makeinfo 104 ./info 105 106Installation files: 107 Makefile.am What Automake uses to make a Makefile.in. 108 Makefile.in What `configure' uses to make a Makefile, 109 created by Automake. 110 configure.ac What Autoconf uses to create `configure'. 111 configure Configuration script for local conditions, 112 created by Autoconf. 113