Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cgwalters/texinfo-git-mirror

Mirror of texinfo CVS into git
https://github.com/cgwalters/texinfo-git-mirror

Last synced: 1 day ago
JSON representation

Mirror of texinfo CVS into git

Awesome Lists containing this project

README 

        
$Id: README,v 1.20 2011/10/16 23:14:08 karl Exp $

This is the README file for the GNU Texinfo distribution.  Texinfo is

the preferred documentation format for GNU software.



  Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,

  2002, 2003, 2004, 2009, 2010, 2011

  Free Software Foundation, Inc.



  Copying and distribution of this file, with or without modification,

  are permitted in any medium without royalty provided the copyright

  notice and this notice are preserved.



See ./INSTALL* for installation instructions.



Primary distribution point: ftp://ftp.gnu.org/gnu/texinfo/

  automatic mirror redirection: http://ftpmirror.gnu.org/texinfo/

                   mirror list: http://www.gnu.org/prep/ftp.html



Home page: http://www.gnu.org/software/texinfo/

  This page includes links to other Texinfo-related programs.



Mailing lists and archives:

- http://lists.gnu.org/mailman/listinfo/bug-texinfo

  for bug reports, enhancement suggestions, technical discussion.

- http://lists.gnu.org/mailman/listinfo/help-texinfo

  for authoring questions and general discussion.

There are no corresponding newsgroups.



Bug reports:

 Please include enough information for the maintainers to reproduce the

 problem.  Generally speaking, that means:

- the contents of all input files necessary to reproduce the bug (crucial!).

- a statement of the problem and any samples of the erroneous output.

- the version number of Texinfo and the program(s) involved (use --version).

- hardware and operating system information (uname -a).

- unusual options you gave to configure, if any (see config.status).

- anything else that you think could be helpful.



Patches are most welcome; if possible, please make them with diff -c and

include ChangeLog entries.



See README.dev for information on the Texinfo development environment --

any interested parties are welcome.  If you're a programmer and wish to

contribute, this should get you started.  If you're not a programmer,

you can still make significant contributions by writing test cases,

checking the documentation against the implementation, etc.



This distribution includes the following files, among others:

    README                 This file.

    README.dev             Texinfo developer information.



    INSTALL                Texinfo-specific installation notes.

    NEWS                   Summary of new features by release.

    INTRODUCTION           Brief introduction to the system, and

                           how to create readable files from the

                           Texinfo source files in this distribution.



Texinfo documentation files (in ./doc):

    texinfo.txi            Describes the Texinfo language and many

                           of the associated tools.  It tells how to use

                           Texinfo to write documentation, how to use

                           Texinfo mode in GNU Emacs, TeX, makeinfo, and

                           the Emacs Lisp Texinfo formatting commands.



    info.texi              This manual tells you how to read manuals

                           in Info.  This document also comes as part of

                           GNU Emacs.  If you do not have Emacs, you can

                           format this Texinfo source file with makeinfo

                           or TeX and then read the resulting Info file

                           with the standalone Info reader that is part

                           of this distribution.



    info-stnd.texi         This manual tells you how to use

                           the standalone GNU Info reader that is

                           included in this distribution as C

                           source (./info).



Printing-related files:

    doc/texinfo.tex        This implements Texinfo in TeX, to typeset a

                           Texinfo file into a DVI or PDF file.



    util/texindex.c        This file contains the source for

                           the `texindex' program that generates

                           sorted indices used by TeX when

                           typesetting a file for printing.



    util/texi2dvi          This is a shell script for producing an

                           indexed DVI file using TeX and texindex.

    

    util/texi2pdf          Generate PDF, otherwise like texi2dvi.



Source directories: 

  djgpp/                   Support for compiling under DJGPP.

  gnulib/                  Support files from Gnulib.

  info/                    Standalone Info reader.

  install-info/            Maintain the Info dir file.

  lib/                     Support files.

  tp/                      Texinfo Parser, includes makeinfo and texi2any.



Translation support:

  po                       Strings of the programs.

  po_document              Strings in generated Texinfo documents.



Installation support:

  Makefile.am              Read by Automake to create a Makefile.in.

  Makefile.in              Read by configure to make a Makefile,

                             created by Automake.

  configure.ac		   Read by Autoconf to create `configure'.

  configure                Configuration script for local conditions,

                             created by Autoconf.

  build-aux/               Common files.