"Fossies" - the Fresh Open Source Software Archive

Member "texinfo-6.5/README" (23 Jun 2017, 5897 Bytes) of package /linux/misc/texinfo-6.5.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 6.4_vs_6.5.

    1 $Id: README 7842 2017-06-23 06:47:27Z gavin $
    2 This is the README file for the GNU Texinfo distribution.  Texinfo is
    3 the preferred documentation format for GNU software.
    4 
    5   Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
    6   2002, 2003, 2004, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
    7   Free Software Foundation, Inc.
    8 
    9   Copying and distribution of this file, with or without modification,
   10   are permitted in any medium without royalty provided the copyright
   11   notice and this notice are preserved.
   12 
   13 Home page: http://www.gnu.org/software/texinfo/
   14   Including links to Texinfo-related programs not part of this package.
   15 
   16 Primary distribution point: http://ftp.gnu.org/gnu/texinfo/
   17   automatic mirror redirection: http://ftpmirror.gnu.org/texinfo/
   18                    mirror list: http://www.gnu.org/prep/ftp.html
   19 
   20 Texinfo is a documentation system that uses a single source to produce
   21 many forms of output:
   22 - a PDF or DVI document (via the TeX typesetting system) with the normal
   23   features of a book, including sectioning, cross references, indices, etc.
   24 - an Info file with analogous features to make documentation browsing easy.
   25 - a plain text (ASCII) file.
   26 - an HTML output file suitable for use with a web browser.
   27 - a Docbook file.
   28 - a XML file transliterating the source with a Texinfo DTD.
   29 
   30 See ./INSTALL* for installation instructions.
   31 
   32 To get started with Texinfo, best is to read the Texinfo manual;
   33 it is online at http://www.gnu.org/software/texinfo/manual/texinfo.
   34 If you don't have Internet access, you can read the manual locally:
   35 - first, build the distribution.
   36 - then, for HTML, run: make -C doc html
   37   and you can start reading at doc/texinfo.html/index.html.
   38 - for PDF, if you have a working TeX, run: make -C doc pdf
   39 - for Info, you can read a tutorial on reading Info files:
   40  ./info/ginfo doc/info
   41   and/or read the Texinfo manual:
   42  ./info/ginfo doc/texinfo
   43 
   44 Texinfo mailing lists and archives:
   45 - http://lists.gnu.org/mailman/listinfo/bug-texinfo
   46   for bug reports, enhancement suggestions, technical discussion.
   47 - http://lists.gnu.org/mailman/listinfo/help-texinfo
   48   for authoring questions and general discussion.
   49 There are no corresponding newsgroups.
   50 
   51 Bug reports:
   52 Please include enough information for the maintainers to reproduce the
   53 problem.  Generally speaking, that means:
   54 - the contents of all input files needed to reproduce the bug (crucial!).
   55 - a statement of the problem and any samples of the erroneous output.
   56 - the version number of Texinfo and the program(s) involved (use --version).
   57 - hardware and operating system information (uname -a).
   58 - unusual options you gave to configure, if any (try ./config.status --help).
   59 - anything else that you think could be helpful.
   60 
   61 Patches are most welcome; if possible, please make them with diff -c and
   62 include ChangeLog entries.
   63 
   64 See README-hacking for information on the Texinfo development
   65 environment -- any interested parties are welcome.  If you're a
   66 programmer and wish to contribute, this should get you started.  If
   67 you're not a programmer, you can still make significant contributions by
   68 writing test cases, checking the documentation against the
   69 implementation, etc.
   70 
   71 This distribution includes the following files, among others:
   72     README                 This file.
   73     README-hacking         Texinfo developer information.
   74 
   75     INSTALL                Texinfo-specific installation notes.
   76     NEWS                   Summary of new features by release.
   77 
   78 Texinfo documentation files (in ./doc):
   79     texinfo.texi           Describes the Texinfo language and many
   80                            of the associated tools.  It tells how to use
   81                            Texinfo to write documentation, how to use
   82                            Texinfo mode in GNU Emacs, TeX,
   83                            texi2any/makeinfo, and much else.
   84 
   85     info.texi              Describes how to read manuals in Info.
   86                            This document also comes as part of GNU Emacs.
   87 
   88     info-stnd.texi         How to use the standalone GNU Info reader that is
   89                            included in this distribution (./info).
   90 
   91 Printing-related files:
   92     doc/texinfo.tex        This implements Texinfo in TeX, to typeset a
   93                            Texinfo file into a DVI or PDF file.
   94 
   95     util/texi2dvi          This is a shell script for producing an
   96                            indexed DVI file using TeX and texindex.
   97     
   98     util/texi2pdf          Generate PDF (wrapper for texi2dvi).
   99 
  100 Source directories: 
  101   djgpp/                   Support for compiling under DJGPP.
  102   gnulib/                  Support files from Gnulib.
  103   info/                    Standalone Info reader.
  104   install-info/            Maintain the Info dir file.
  105   tp/                      Texinfo Parser in Perl, includes texi2any/makeinfo.
  106   texindex/                The `texindex' program that generates
  107                            sorted indices used by TeX when
  108                            typesetting a file for printing.
  109 
  110 Translation support:
  111   po/                      Strings of the programs.
  112   po_document/             Strings in generated Texinfo documents.
  113 
  114 Installation support:
  115   Makefile.am              Read by Automake to create a Makefile.in.
  116   Makefile.in              Read by configure to make a Makefile,
  117                              created by Automake.
  118   configure.ac             Read by Autoconf to create `configure'.
  119   configure                Configuration script for local conditions,
  120                              created by Autoconf.
  121   build-aux/               Common files.
  122 
  123 The util/ directory contains a few other scripts, e.g., examples of
  124 using makeinfo in various ways.  See util/README.
  125 
  126 Finally, the contrib/ directory contains additional files from users
  127 provided for your reading and/or hacking pleasure.  They aren't part of
  128 Texinfo proper or maintained by the Texinfo developers.