"Fossies" - the Fresh Open Source Software Archive

Member "texinfo-6.5/tp/README" (7 May 2015, 2418 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.

    1 $Id: README 6252 2015-05-06 17:37:57Z karl $
    2 texinfo/tp/README
    3 
    4   Copyright 2011, 2012, 2013, 2014, 2015 Free Software Foundation, Inc.
    5 
    6   Copying and distribution of this file, with or without modification,
    7   are permitted in any medium without royalty provided the copyright
    8   notice and this notice are preserved.
    9 
   10 Texinfo::Parser (hence the directory name tp) is a Perl module for
   11 parsing Texinfo code into a tree representing the Texinfo code
   12 structure.
   13 
   14 These other modules and libraries are required (all have been standard
   15 parts of Perl for years, at least since 5.7.3):
   16   Carp, Config, Data::Dumper, Encode, File::Basename, File::Spec
   17   Getopt::Long, Unicode::Normalize, Storable
   18 
   19 It also uses the less widely-available modules:
   20   Locale::Messages, Unicode::EastAsianWidth, Text::Unidecode
   21 For these, internal versions are included, and are installed and used as
   22 part of Texinfo (not disturbing the Perl installation at all).
   23 
   24 To run the tests you also need:
   25   Test::More, Data::Compare, Test::Deep
   26 On Debian-based distros, Test::More is part of perl-modules and thus 
   27 installed with perl, the packages corresponding to the other modules
   28 are named:
   29   libdata-compare-perl libtest-deep-perl
   30 
   31 The tests are in the subdirectories t/ and test/.  The tests in t/ test 
   32 the Perl modules used by the makeinfo command, and the tests in test/ 
   33 test the command itself.
   34 
   35 This module is part of GNU Texinfo.  A standalone Perl module may also be
   36 produced from within the the Texinfo tree, using 
   37   ./maintain/prepare_perl_standalone_module_archive.sh
   38 The resulting module, although standalone, should always be regenerated
   39 from the sources in Texinfo, to avoid divergence of sources.
   40 
   41 
   42 If you want to delve into making a new backend, the documentation in
   43 tp/Texinfo/Convert/Converter.pm is a good starting point, as it
   44 describes the existing backends and other places to look.  To do a good
   45 job, expect to spend a lot of time making it do the right thing with the
   46 existing tests.
   47 
   48 tp builds a complicated parse tree.  It can output a lot of debug
   49 information about the tree, and what it's doing generally.  For example,
   50 these commands output the tree (in different forms):
   51   makeinfo -c DUMP_TREE=1 -c TEXINFO_OUTPUT_FORMAT=parse document.texi
   52   makeinfo -c TEXINFO_OUTPUT_FORMAT=debugtree document.texi
   53 In addition (or instead) setting the DEBUG configuration variable will
   54 dump more information about what it's doing.