[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog NEWS README-hacking doc/Makef...
|
From: |
karl |
|
Subject: |
texinfo ChangeLog NEWS README-hacking doc/Makef... |
|
Date: |
Mon, 04 Feb 2013 01:35:15 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: karl <karl> 13/02/04 01:35:13
Modified files:
. : ChangeLog NEWS README-hacking
doc : Makefile.am texinfo.txi
man : pod2texi.1
util : dir-example gendocs.sh
contrib : README
Pod-Simple-Texinfo: .cvsignore pod2texi.pl
Added files:
contrib/perldoc-all: .cvsignore GNUmakefile README
gendocs_template perldoc-all.texi
Log message:
pod2texi documentation, with perldoc-all as an example
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1538&r2=1.1539
http://cvs.savannah.gnu.org/viewcvs/texinfo/NEWS?cvsroot=texinfo&r1=1.227&r2=1.228
http://cvs.savannah.gnu.org/viewcvs/texinfo/README-hacking?cvsroot=texinfo&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/Makefile.am?cvsroot=texinfo&r1=1.54&r2=1.55
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.536&r2=1.537
http://cvs.savannah.gnu.org/viewcvs/texinfo/man/pod2texi.1?cvsroot=texinfo&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/texinfo/util/dir-example?cvsroot=texinfo&r1=1.100&r2=1.101
http://cvs.savannah.gnu.org/viewcvs/texinfo/util/gendocs.sh?cvsroot=texinfo&r1=1.44&r2=1.45
http://cvs.savannah.gnu.org/viewcvs/texinfo/contrib/README?cvsroot=texinfo&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/texinfo/contrib/perldoc-all/.cvsignore?cvsroot=texinfo&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/texinfo/contrib/perldoc-all/GNUmakefile?cvsroot=texinfo&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/texinfo/contrib/perldoc-all/README?cvsroot=texinfo&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/texinfo/contrib/perldoc-all/gendocs_template?cvsroot=texinfo&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/texinfo/contrib/perldoc-all/perldoc-all.texi?cvsroot=texinfo&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/texinfo/Pod-Simple-Texinfo/.cvsignore?cvsroot=texinfo&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/texinfo/Pod-Simple-Texinfo/pod2texi.pl?cvsroot=texinfo&r1=1.24&r2=1.25
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1538
retrieving revision 1.1539
diff -u -b -r1.1538 -r1.1539
--- ChangeLog 3 Feb 2013 23:53:48 -0000 1.1538
+++ ChangeLog 4 Feb 2013 01:34:46 -0000 1.1539
@@ -1,5 +1,18 @@
2013-02-03 Karl Berry <address@hidden>
+ * contrib/perldoc-all: example making Texinfo from Perl's *.pod.
+ * util/dir-example (Perl): add it.
+ * util/gendocs.sh: add --source, --common, --split --no-ascii.
+ Prettify output.
+ * doc/Makefile.am (gendocs): use the version from our
+ source hierarchy, since it's maintained here.
+
+ * Pod-Simple-Texinfo/pod2texi.pl (preamble): null if making
+ @include files. More doc.
+ * doc/texinfo.txi (Invoking pod2texi): new node.
+
+2013-02-03 Karl Berry <address@hidden>
+
* tp/Makefile.am: doc fix.
* tp/maintain/regenerate_docstr.sh: do not depend on directories
with their unpredictable timestamps.
Index: NEWS
===================================================================
RCS file: /sources/texinfo/texinfo/NEWS,v
retrieving revision 1.227
retrieving revision 1.228
diff -u -b -r1.227 -r1.228
--- NEWS 3 Feb 2013 23:44:58 -0000 1.227
+++ NEWS 4 Feb 2013 01:34:46 -0000 1.228
@@ -1,4 +1,4 @@
-$Id: NEWS,v 1.227 2013/02/03 23:44:58 karl Exp $
+$Id: NEWS,v 1.228 2013/02/04 01:34:46 karl Exp $
This NEWS file records noteworthy changes, very tersely.
See the manual for detailed information.
@@ -57,22 +57,24 @@
names for the same program; there are no differences in behavior based
on the program name.
- The new implementation is in Perl (based on the texi2html program, but
- with a vast array of subsequent changes). It requires Perl 5.7.3
- (released in March 2002) and the standard Encode module.
+ The new implementation is in Perl, requiring Perl 5.7.3 (released in
+ March 2002) and its standard Encode module.
The Perl texi2any/makeinfo both replaces and is intended to be (for
all practical purposes) upward-compatible with the C makeinfo. It has
many new features not in the C makeinfo. For example, cross-manual
- references are now fully supported, and extensive customization of the
- HTML output is possible. See the `Generic Translator texi2any'
- chapter in the manual (among other places) for more about this
- reimplementation.
+ references are now fully supported, and allows for extensive
+ customization of the HTML output. See the `Generic Translator
+ texi2any' chapter in the manual (among other places) for more about
+ this reimplementation.
The new program is, unfortunately, noticeably slower at present than
the C program was. We hope all the many improvements make the new
version worthwhile for users nevertheless.
+* pod2texi is a new (Perl) program that uses the capabilities of
+ texi2any to translate Perl pod documentation to Texinfo.
+
* texinfo.tex:
. urls (given to @uref and @url) are broken by default at special
characters; behavior controllable with @urefbreakstyle.
@@ -94,13 +96,11 @@
. INFOPATH is determined from PATH by default, or if an element "PATH"
is specified.
. New command Info-virtual-index, bound to I by default, following Emacs.
- . Info keywords not included in searches.
- . There is a lower limit on the length of search patterns. The default
- value is 1. It can be changed by setting the variable min-search-length,
- either by `M-x set-variable', or using infokey.
+ . Info keywords not found by searches.
+ . A lower limit on the length of search patterns, default 1,
+ specified by the variable min-search-length.
+ . Use ASCII versions of images, if supplied by the document.
. xz compression supported.
- . Fix bug #37686: use the text attribute to represent "image" tags on
- output.
* install-info:
. xz compression supported.
@@ -112,8 +112,8 @@
* Distribution:
. new file htmlxref.cnf is installed to support cross-manual
- references; official updates between full package releases available at
- http://ftpmirror.gnu.org/texinfo/htmlxref.cnf.
+ references; official updates between full package releases available
+ at http://ftpmirror.gnu.org/texinfo/htmlxref.cnf.
. language support for no removed/renamed to nb, per Norwegian translators.
. new translations: id it,
and document translations: eo pl.
Index: README-hacking
===================================================================
RCS file: /sources/texinfo/texinfo/README-hacking,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- README-hacking 28 Jan 2013 18:36:40 -0000 1.3
+++ README-hacking 4 Feb 2013 01:34:47 -0000 1.4
@@ -1,4 +1,4 @@
-$Id: README-hacking,v 1.3 2013/01/28 18:36:40 karl Exp $
+$Id: README-hacking,v 1.4 2013/02/04 01:34:47 karl Exp $
This file describes the development environment for Texinfo.
Copyright 2002, 2003, 2005, 2006, 2007, 2008, 2010, 2011, 2012, 2013
@@ -100,6 +100,7 @@
update version in configure.ac, ChangeLog; NEWS with date if official.
gnulib-tool --add-import
util/srclist-txi
+pod2man Pod-Simple-Texinfo/pod2texi.pl >man/pod2texi.1 # until we fix deps
make
make po-check # update po/POTFILES.in as needed
make -C po update-po # but don't commit yet, dist updates po_document
@@ -131,7 +132,9 @@
cvs add $ver/texinfo.dtd
cvs com -m$ver $ver
-update texinfo.html and commit as needed.
+update home page (texinfo.html) and commit as needed.
+update manual, including:
+ pod2html Pod-Simple-Texinfo/pod2texi.pl >pod2texi.html
... tag source tree:
cvs tag -b texinfo_`echo $ver | tr . _`
Index: doc/Makefile.am
===================================================================
RCS file: /sources/texinfo/texinfo/doc/Makefile.am,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- doc/Makefile.am 19 Jan 2013 15:54:04 -0000 1.54
+++ doc/Makefile.am 4 Feb 2013 01:34:47 -0000 1.55
@@ -1,4 +1,4 @@
-# $Id: Makefile.am,v 1.54 2013/01/19 15:54:04 karl Exp $
+# $Id: Makefile.am,v 1.55 2013/02/04 01:34:47 karl Exp $
# Makefile.am for texinfo/doc.
#
# Copyright 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012,
@@ -76,9 +76,11 @@
# using the gendocs.sh script; see
# http://www.gnu.org/prep/maintain/html_node/Invoking-gendocs_002esh.html
#
-gnulib = $(HOME)/gnu/src/gnulib
-gendocs = $(gnulib)/build-aux/gendocs.sh
-gendocs_templates = $(gnulib)/doc
+# Since gendocs.sh is maintained here in Texinfo, use it from
+# the development sources; ordinarily it's invoked from a gnulib checkout.
+#
+gendocs = $(abs_top_srcdir)/util/gendocs.sh
+gendocs_templates = $(abs_top_srcdir)/util
gendocs_envvars = GENDOCS_TEMPLATE_DIR=$(gendocs_templates)
gendocs_email = address@hidden
gendocs_invoke = env $(gendocs_envvars) $(gendocs) --email $(gendocs_email)
@@ -98,6 +100,7 @@
wwwdoc-build:
rm -rf $(doctemp) && mkdir $(doctemp)
cd $(doctemp) \
+ && pod2html $(abs_top_srcdir)/Pod-Simple-Texinfo/pod2texi.pl
>pod2texi.html \
&& ln -s ../*.texi ../*.txi . \
&& $(gendocs_invoke) -o $(manual1) $(manual1) $(manual1_title) \
&& $(gendocs_invoke) -o $(manual2) $(manual2) $(manual2_title) \
@@ -108,6 +111,7 @@
# http://www.gnu.org/software/texinfo/manual/
wwwdoc-install:
cp -arf $(doctemp)/$(manual1) $(doctemp)/$(manual2) \
- $(doctemp)/$(manual3) $(www_target)
+ $(doctemp)/$(manual3) $(doctemp)/pod2texi.html \
+ $(www_target)
ls -ltu $(www_target)/*/html_node | tail # cvs rm -f obsolete files
# followed by cvs add of new files and cvs commit.
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.536
retrieving revision 1.537
diff -u -b -r1.536 -r1.537
--- doc/texinfo.txi 30 Jan 2013 01:35:41 -0000 1.536
+++ doc/texinfo.txi 4 Feb 2013 01:34:48 -0000 1.537
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.536 2013/01/30 01:35:41 karl Exp $
address@hidden $Id: texinfo.txi,v 1.537 2013/02/04 01:34:48 karl Exp $
@c Ordinarily, Texinfo files have the extension .texi. But texinfo.texi
@c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
@@ -61,11 +61,12 @@
@direntry
* Texinfo: (texinfo). The GNU documentation format.
* install-info: (texinfo)Invoking install-info. Update info/dir entries.
+* makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source.
+* pod2texi: (pod2texi)Invoking pod2texi. Translate Perl POD to Texinfo.
* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents.
* texi2pdf: (texinfo)PDF Output. PDF output for Texinfo.
* pdftexi2dvi: (texinfo)PDF Output. PDF output for Texinfo.
* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files.
-* makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source.
@end direntry
@c Before release, run C-u C-c C-u C-a (texinfo-all-menus-update with a
@@ -600,6 +601,7 @@
* Pointer Validation:: How to check that pointers point somewhere.
* Customization Variables:: Configuring @command{texi2any}.
* Internationalization of Document Strings:: Translating program-inserted text.
+* Invoking @t{pod2texi}:: Translating Perl pod to Texinfo.
* @t{texi2html}:: An ancestor of @command{texi2any}.
Customization Variables
@@ -16742,12 +16744,13 @@
* Pointer Validation:: How to check that pointers point somewhere.
* Customization Variables:: Configuring @command{texi2any}.
* Internationalization of Document Strings:: Translating program-inserted text.
+* Invoking @t{pod2texi}:: Translating Perl pod to Texinfo.
* @t{texi2html}:: An ancestor of @command{texi2any}.
@end menu
@node Reference Implementation
address@hidden @command{texi2any}: A Reference Implementation
address@hidden @command{texi2any}: A Texinfo Reference Implementation
@cindex @command{texi2any}, as reference implementation
@cindex Reference implementation
@@ -18364,6 +18367,28 @@
appropriately in many languages.
address@hidden Invoking @t{pod2texi}
address@hidden Invoking @t{pod2texi}:
+
address@hidden pod2texi
address@hidden Invoking @code{pod2texi}
address@hidden POD, converting to Texinfo
address@hidden Perl POD, converting to Texinfo
+
+The @code{pod2texi} program translates Perl pod documentation file(s)
+to Texinfo. There are two basic modes of operation: generating a
+standalone manual from each input pod, or generating Texinfo subfiles
+suitable for use @code{@@include}.
+turn within a hand-written top-level file.
+
+Although ordinarily this documentation in the Texinfo manual would be
+the best place to look, in this case we have documented all the
+options and examples in the @code{pod2texi} program itself, since it
+may be useful outside of the rest of Texinfo. Thus, please see the
+output of @code{pod2texi --help}, the version on the web at
address@hidden://www.gnu.org/software/texinfo/manual/pod2texi.html}, etc.
+
+
@node @t{texi2html}
@section @code{texi2html}: Ancestor of @code{texi2any}
@@ -18377,9 +18402,9 @@
contributed to @command{texi2html} over the years.
The present @command{texi2any} uses little of the actual code of
address@hidden, and has quite a different general approach to the
-implementation (parsing the Texinfo document into a tree), but still,
-there is a family resemblance.
address@hidden, and has quite a different basic approach to the
+implementation (namely, parsing the Texinfo document into a tree), but
+still, there is a family resemblance.
By design, @command{texi2any} supports nearly all the features of
@command{texi2html} in some way. However, we did not attempt to
@@ -22076,7 +22101,7 @@
as:
@example
-$Id: texinfo.txi,v 1.536 2013/01/30 01:35:41 karl Exp $
+$Id: texinfo.txi,v 1.537 2013/02/04 01:34:48 karl Exp $
@end example
(This is potentially useful in all sources that use version control,
Index: man/pod2texi.1
===================================================================
RCS file: /sources/texinfo/texinfo/man/pod2texi.1,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- man/pod2texi.1 27 Jan 2013 17:34:30 -0000 1.1
+++ man/pod2texi.1 4 Feb 2013 01:34:58 -0000 1.2
@@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "POD2TEXI 1"
-.TH POD2TEXI 1 "2013-01-27" "perl v5.16.2" "User Contributed Perl
Documentation"
+.TH POD2TEXI 1 "2013-02-03" "perl v5.16.2" "User Contributed Perl
Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -134,28 +134,37 @@
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
-\& pod2texi [OPTION]... POD\-FILE...
+\& pod2texi [OPTION]... POD...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-Translate Pod to Texinfo. If the \f(CW\*(C`\-\-base\-level\*(C'\fR is higher
than 0, a
-main manual including all the files is done otherwise all manuals are
-standalone (the default).
+Translate Pod file(s) to Texinfo. There are two basic modes of
+operation. First, by default, each pod is translated to a standalone
+Texinfo manual.
+.PP
+Second, if \f(CW\*(C`\-\-base\-level\*(C'\fR is set higher than 0, each pod is
translated
+to a file suitable for \f(address@hidden, and one more file with all the
+\&\f(address@hidden is generated, which is intended to be \f(address@hidden in
turn
+within a hand-written top-level file.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-base\-level\fR=\fINUM|NAME\fR" 4
.IX Item "--base-level=NUM|NAME"
-Sets the level of the head1 commands. It may be an integer or a Texinfo
-sectioning command. If it is a Texinfo sectioning command the corresponding
-level is used. If the resulting level is 1, this corresponds to
-\&\f(address@hidden/@unnumbered level. If set to 0, the head1 commands level
is
-still 1, but the output manual is considered to be a standalone manual.
+Sets the level of the \f(CW\*(C`head1\*(C'\fR commands. It may be an integer
or a
+Texinfo sectioning command (without the \f(CW\*(address@hidden(C'\fR): 1
corresponds to the
+\&\f(address@hidden/\f(address@hidden level, 2 to the \f(address@hidden level,
and so on.
+The default is 0, meaning that \f(CW\*(C`head1\*(C'\fR commands are still
output as
+chapters, but the output is arranged as a standalone manual.
.Sp
If the level is not 0, the pod file is rendered as a fragment of a
-Texinfo manual. In that case, each pod file has an additional sectioning
-command one level above the head1 commands level added for the whole
-file. Therefore if you want to have each pod file as a chapter, you should
-use \f(CW\*(C`section\*(C'\fR as the base level.
+Texinfo manual suitable for \f(address@hidden In this case, each pod file
+has an additional sectioning command covering the entire file, one level
+above the \f(CW\*(C`\-\-base\-level\*(C'\fR value. Therefore, to make each
pod file a
+chapter in a large manual, you should use \f(CW\*(C`section\*(C'\fR as the
base level.
+.Sp
+For an example of making Texinfo out of the Perl documentation itself,
+see \f(CW\*(C`contrib/perldoc\-all\*(C'\fR in the Texinfo source distribution,
with
+output available at <http://www.gnu.org/software/perl/manual>.
.IP "\fB\-\-debug\fR=\fI\s-1NUM\s0\fR" 4
.IX Item "--debug=NUM"
Set debugging level to \fI\s-1NUM\s0\fR.
@@ -165,23 +174,26 @@
.IP "\fB\-\-output\fR=\fI\s-1NAME\s0\fR" 4
.IX Item "--output=NAME"
Name for the first manual, or the main manual if there is a main manual.
-Default is output on standard out.
+Default is to write to standard output.
.IP "\fB\-\-no\-section\-nodes\fR" 4
.IX Item "--no-section-nodes"
Use anchors for sections instead of nodes.
.IP "\fB\-\-no\-fill\-section\-gaps\fR" 4
.IX Item "--no-fill-section-gaps"
-Do not fill sectioning gaps with empty \f(address@hidden
+Do not fill sectioning gaps with empty \f(address@hidden files.
+Ordinarily, it's good to keep the sectioning hierarchy intact.
.IP "\fB\-\-preamble\fR=\fI\s-1STR\s0\fR" 4
.IX Item "--preamble=STR"
-Insert \fI\s-1STR\s0\fR as top boilerplate before includes. The default is
fairly
-minimal, and sets \f(address@hidden to \f(CW\*(C`utf\-8\*(C'\fR. For example,
you can
-set this to the empty string and then write your own top-level
-boilerplate which uses \f(address@hidden to incorporate the generated one.
+Insert \fI\s-1STR\s0\fR as top boilerplate before includes. For standalone
+documents (\f(CW\*(C`\-\-base\-level\*(C'\fR is 0), the default is a minimal
beginning for
+a Texinfo document, and sets \f(address@hidden to \f(CW\*(C`utf\-8\*(C'\fR.
For
+included documents (\f(CW\*(C`\-\-base\-level\*(C'\fR is nonzero), it is the
empty string,
+under the assumption that you will want your own top-level material,
+and to \f(address@hidden the generated files.
.IP "\fB\-\-subdir\fR=\fI\s-1NAME\s0\fR" 4
.IX Item "--subdir=NAME"
-If there is a main manual with include files, each corresponding to
-an input pod file, then include files are put in the directory
\fI\s-1NAME\s0\fR.
+If there is a main manual with include files (each corresponding to
+an input pod file), then those include files are put in directory
\fI\s-1NAME\s0\fR.
.IP "\fB\-\-unnumbered\-sections\fR" 4
.IX Item "--unnumbered-sections"
Use unnumbered sectioning commands (@unnumbered...) instead of the default
@@ -194,10 +206,10 @@
Display version information and exit.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-Pod::Simple::Texinfo. The Texinfo manual. perlpod.
+Pod::Simple::Texinfo. perlpod. The Texinfo manual.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
-Copyright (C) 2012 Free Software Foundation, Inc.
+Copyright (C) 2013 Free Software Foundation, Inc.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
Index: util/dir-example
===================================================================
RCS file: /sources/texinfo/texinfo/util/dir-example,v
retrieving revision 1.100
retrieving revision 1.101
diff -u -b -r1.100 -r1.101
--- util/dir-example 2 Jan 2013 01:00:35 -0000 1.100
+++ util/dir-example 4 Feb 2013 01:34:59 -0000 1.101
@@ -9,7 +9,7 @@
If you have dir entries for Texinfo manuals you'd like to be added here,
please send them to address@hidden
-$Id: dir-example,v 1.100 2013/01/02 01:00:35 karl Exp $
+$Id: dir-example,v 1.101 2013/02/04 01:34:59 karl Exp $
File: dir, Node: Top, This is the top of the INFO tree.
@@ -45,6 +45,7 @@
* Gawk: (gawk). A text scanning and processing language.
* grep: (grep). Print lines matching a pattern.
* M4: (m4). A powerful macro processor.
+* Perl: (perldoc-all). Practical Extraction and Report Language.
* sed: (sed). Stream EDitor.
* Wdiff: (wdiff). Word difference finder and related tools.
Index: util/gendocs.sh
===================================================================
RCS file: /sources/texinfo/texinfo/util/gendocs.sh,v
retrieving revision 1.44
retrieving revision 1.45
diff -u -b -r1.44 -r1.45
--- util/gendocs.sh 27 Oct 2012 18:36:50 -0000 1.44
+++ util/gendocs.sh 4 Feb 2013 01:35:10 -0000 1.45
@@ -2,9 +2,9 @@
# gendocs.sh -- generate a GNU manual in many formats. This script is
# mentioned in maintain.texi. See the help message below for usage details.
-scriptversion=2012-10-27.11
+scriptversion=2013-02-03.15
-# Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
+# Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
# Free Software Foundation, Inc.
#
# This program is free software: you can redistribute it and/or modify
@@ -56,7 +56,7 @@
version="gendocs.sh $scriptversion
-Copyright 2012 Free Software Foundation, Inc.
+Copyright 2013 Free Software Foundation, Inc.
There is NO warranty. You may redistribute this software
under the terms of the GNU General Public License.
For more information about these matters, see the files named COPYING."
@@ -69,14 +69,21 @@
http://www.gnu.org/prep/maintain_toc.html
Options:
+ --email ADR use ADR as contact in generated web pages; always give this.
+
-s SRCFILE read Texinfo from SRCFILE, instead of PACKAGE.{texinfo|texi|txi}
-o OUTDIR write files into OUTDIR, instead of manual/.
-I DIR append DIR to the Texinfo search path.
- --email ADR use ADR as contact in generated web pages.
+ --common ARG pass ARG in all invocations.
+ --html ARG pass ARG to makeinfo or texi2html for HTML targets.
+ --info ARG pass ARG to makeinfo for Info, instead of --no-split.
+ --no-ascii skip generating the plain text output.
+ --source ARG include ARG in tar archive of sources.
+ --split HOW make split HTML by node, section, chapter; default node.
+
+ --texi2html use texi2html to make HTML target, with all split versions.
--docbook convert through DocBook too (xml, txt, html, pdf).
- --html ARG pass indicated ARG to makeinfo or texi2html for HTML targets.
- --info ARG pass indicated ARG to makeinfo for Info, instead of --no-split.
- --texi2html use texi2html to generate HTML targets.
+
--help display this help and exit successfully.
--version display version information and exit successfully.
@@ -92,8 +99,8 @@
use -o OUTDIR to override). Move all the new files into your web CVS
tree, as explained in the Web Pages node of maintain.texi.
-Please do use the --email ADDRESS option to specify your bug-reporting
-address in the generated HTML pages.
+Please use the --email ADDRESS option so your own bug-reporting
+address will be used in the generated HTML pages.
MANUAL-TITLE is included as part of the HTML <title> of the overall
manual/index.html file. It should include the name of the package being
@@ -117,7 +124,7 @@
and PERL to control the programs that get executed, and
GENDOCS_TEMPLATE_DIR to control where the gendocs_template file is
looked for. With --docbook, the environment variables DOCBOOK2HTML,
-DOCBOOK2PDF, and DOCBOOK2TXT are also respected.
+DOCBOOK2PDF, and DOCBOOK2TXT are also consulted.
By default, makeinfo and texi2dvi are run in the default (English)
locale, since that's the language of most Texinfo manuals. If you
@@ -130,25 +137,34 @@
MANUAL_TITLE=
PACKAGE=
address@hidden # please override with --email
-commonarg= # Options passed to all the tools (-I dir).
+commonarg= # passed to all makeinfo/texi2html invcations.
+dirargs= # passed to all tools (-I dir).
dirs= # -I's directories.
htmlarg=
infoarg=--no-split
+generate_ascii=true
outdir=manual
+source_extra=
+split=node
srcfile=
while test $# -gt 0; do
case $1 in
- --email) shift; EMAIL=$1;;
- --help) echo "$usage"; exit 0;;
- --version) echo "$version"; exit 0;;
-s) shift; srcfile=$1;;
-o) shift; outdir=$1;;
- -I) shift; commonarg="$commonarg -I '$1'"; dirs="$dirs $1";;
+ -I) shift; dirargs="$dirargs -I '$1'"; dirs="$dirs $1";;
+ --common) shift; commonarg=$1;;
--docbook) docbook=yes;;
+ --email) shift; EMAIL=$1;;
--html) shift; htmlarg=$1;;
--info) shift; infoarg=$1;;
+ --no-ascii) generate_ascii=false;;
+ --source) shift; source_extra=$1;;
+ --split) shift; split=$1;;
--texi2html) use_texi2html=1;;
+
+ --help) echo "$usage"; exit 0;;
+ --version) echo "$version"; exit 0;;
-*)
echo "$0: Unknown option \`$1'." >&2
echo "$0: Try \`--help' for more information." >&2
@@ -166,6 +182,9 @@
shift
done
+# makeinfo uses the dirargs, but texi2dvi doesn't.
+commonarg=" $dirargs $commonarg"
+
# For most of the following, the base name is just $PACKAGE
base=$PACKAGE
@@ -247,46 +266,52 @@
*) abs_outdir=$srcdir/$outdir;;
esac
-echo "Generating output formats for $srcfile"
+echo "Making output for $srcfile"
+echo " in `pwd`"
+mkdir -p "$outdir/"
cmd="$SETLANG $MAKEINFO -o $PACKAGE.info $commonarg $infoarg \"$srcfile\""
-echo "Generating info file(s)... ($cmd)"
+echo "Generating info... ($cmd)"
eval "$cmd"
-mkdir -p "$outdir/"
tar czf "$outdir/$PACKAGE.info.tar.gz" $PACKAGE.info*
+ls -l "$outdir/$PACKAGE.info.tar.gz"
info_tgz_size=`calcsize "$outdir/$PACKAGE.info.tar.gz"`
# do not mv the info files, there's no point in having them available
# separately on the web.
-cmd="$SETLANG $TEXI2DVI $commonarg \"$srcfile\""
-echo "Generating dvi ... ($cmd)"
+cmd="$SETLANG $TEXI2DVI $dirargs \"$srcfile\""
+printf "\nGenerating dvi... ($cmd)\n"
eval "$cmd"
-
# compress/finish dvi:
gzip -f -9 $PACKAGE.dvi
dvi_gz_size=`calcsize $PACKAGE.dvi.gz`
mv $PACKAGE.dvi.gz "$outdir/"
+ls -l "$outdir/$PACKAGE.dvi.gz"
-cmd="$SETLANG $TEXI2DVI --pdf $commonarg \"$srcfile\""
-echo "Generating pdf ... ($cmd)"
+cmd="$SETLANG $TEXI2DVI --pdf $dirargs \"$srcfile\""
+printf "\nGenerating pdf... ($cmd)\n"
eval "$cmd"
pdf_size=`calcsize $PACKAGE.pdf`
mv $PACKAGE.pdf "$outdir/"
+ls -l "$outdir/$PACKAGE.pdf"
-opt="-o $PACKAGE.txt --no-split --no-headers $commonarg"
-cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
-echo "Generating ASCII... ($cmd)"
-eval "$cmd"
-ascii_size=`calcsize $PACKAGE.txt`
-gzip -f -9 -c $PACKAGE.txt >"$outdir/$PACKAGE.txt.gz"
-ascii_gz_size=`calcsize "$outdir/$PACKAGE.txt.gz"`
-mv $PACKAGE.txt "$outdir/"
+if $generate_ascii; then
+ opt="-o $PACKAGE.txt --no-split --no-headers $commonarg"
+ cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
+ printf "\nGenerating ascii... ($cmd)\n"
+ eval "$cmd"
+ ascii_size=`calcsize $PACKAGE.txt`
+ gzip -f -9 -c $PACKAGE.txt >"$outdir/$PACKAGE.txt.gz"
+ ascii_gz_size=`calcsize "$outdir/$PACKAGE.txt.gz"`
+ mv $PACKAGE.txt "$outdir/"
+ ls -l "$outdir/$PACKAGE.txt" "$outdir/$PACKAGE.txt.gz"
+fi
html_split()
{
- opt="--split=$1 $commonarg $htmlarg --node-files"
+ opt="--split=$1 --node-files $commonarg $htmlarg"
cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html $opt \"$srcfile\""
- echo "Generating html by $1... ($cmd)"
+ printf "\nGenerating html by $1... ($cmd)\n"
eval "$cmd"
split_html_dir=$PACKAGE.html
(
@@ -304,7 +329,7 @@
if test -z "$use_texi2html"; then
opt="--no-split --html -o $PACKAGE.html $commonarg $htmlarg"
cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
- echo "Generating monolithic html... ($cmd)"
+ printf "\nGenerating monolithic html... ($cmd)\n"
rm -rf $PACKAGE.html # in case a directory is left over
eval "$cmd"
html_mono_size=`calcsize $PACKAGE.html`
@@ -312,24 +337,29 @@
html_mono_gz_size=`calcsize "$outdir/$PACKAGE.html.gz"`
copy_images "$outdir/" $PACKAGE.html
mv $PACKAGE.html "$outdir/"
+ ls -l "$outdir/$PACKAGE.html" "$outdir/$PACKAGE.html.gz"
- opt="--html -o $PACKAGE.html $commonarg $htmlarg"
+ opt="--html -o $PACKAGE.html --split=$split $commonarg $htmlarg"
cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
- echo "Generating html by node... ($cmd)"
+ printf "\nGenerating html by $split... ($cmd)\n"
eval "$cmd"
split_html_dir=$PACKAGE.html
copy_images $split_html_dir/ $split_html_dir/*.html
(
cd $split_html_dir || exit 1
- tar -czf "$abs_outdir/$PACKAGE.html_node.tar.gz" -- *
+ tar -czf "$abs_outdir/$PACKAGE.html_$split.tar.gz" -- *
)
- html_node_tgz_size=`calcsize "$outdir/$PACKAGE.html_node.tar.gz"`
- rm -rf "$outdir/html_node/"
- mv $split_html_dir "$outdir/html_node/"
-else
+ eval \
+ html_${split}_tgz_size=`calcsize "$outdir/$PACKAGE.html_$split.tar.gz"`
+ rm -rf "$outdir/html_$split/"
+ mv $split_html_dir "$outdir/html_$split/"
+ du -s "$outdir/html_$split/"
+ ls -l "$outdir/$PACKAGE.html_$split.tar.gz"
+
+else # use texi2html:
opt="--output $PACKAGE.html $commonarg $htmlarg"
cmd="$SETLANG $TEXI2HTML $opt \"$srcfile\""
- echo "Generating monolithic html... ($cmd)"
+ printf "\nGenerating monolithic html with texi2html... ($cmd)\n"
rm -rf $PACKAGE.html # in case a directory is left over
eval "$cmd"
html_mono_size=`calcsize $PACKAGE.html`
@@ -342,19 +372,20 @@
html_split section
fi
-echo Making .tar.gz for sources...
+printf "\nMaking .tar.gz for sources...\n"
d=`dirname $srcfile`
(
cd "$d"
- srcfiles=`ls *.texinfo *.texi *.txi *.eps 2>/dev/null` || true
- tar cvzfh "$abs_outdir/$PACKAGE.texi.tar.gz" $srcfiles
+ srcfiles=`ls -d *.texinfo *.texi *.txi *.eps $source_extra 2>/dev/null` ||
true
+ tar czfh "$abs_outdir/$PACKAGE.texi.tar.gz" $srcfiles
+ ls -l "$abs_outdir/$PACKAGE.texi.tar.gz"
)
texi_tgz_size=`calcsize "$outdir/$PACKAGE.texi.tar.gz"`
if test -n "$docbook"; then
opt="-o - --docbook $commonarg"
cmd="$SETLANG $MAKEINFO $opt \"$srcfile\" >${srcdir}/$PACKAGE-db.xml"
- echo "Generating docbook XML... ($cmd)"
+ printf "\nGenerating docbook XML... ($cmd)\n"
eval "$cmd"
docbook_xml_size=`calcsize $PACKAGE-db.xml`
gzip -f -9 -c $PACKAGE-db.xml >"$outdir/$PACKAGE-db.xml.gz"
@@ -364,7 +395,7 @@
split_html_db_dir=html_node_db
opt="$commonarg -o $split_html_db_dir"
cmd="$DOCBOOK2HTML $opt \"${outdir}/$PACKAGE-db.xml\""
- echo "Generating docbook HTML... ($cmd)"
+ printf "\nGenerating docbook HTML... ($cmd)\n"
eval "$cmd"
(
cd ${split_html_db_dir} || exit 1
@@ -377,23 +408,24 @@
rmdir ${split_html_db_dir}
cmd="$DOCBOOK2TXT \"${outdir}/$PACKAGE-db.xml\""
- echo "Generating docbook ASCII... ($cmd)"
+ printf "\nGenerating docbook ASCII... ($cmd)\n"
eval "$cmd"
docbook_ascii_size=`calcsize $PACKAGE-db.txt`
mv $PACKAGE-db.txt "$outdir/"
cmd="$DOCBOOK2PDF \"${outdir}/$PACKAGE-db.xml\""
- echo "Generating docbook PDF... ($cmd)"
+ printf "\nGenerating docbook PDF... ($cmd)\n"
eval "$cmd"
docbook_pdf_size=`calcsize $PACKAGE-db.pdf`
mv $PACKAGE-db.pdf "$outdir/"
fi
-echo "Writing index file..."
+printf "\nMaking index file...\n"
if test -z "$use_texi2html"; then
CONDS="/%%IF *HTML_SECTION%%/,/%%ENDIF *HTML_SECTION%%/d;\
/%%IF *HTML_CHAPTER%%/,/%%ENDIF *HTML_CHAPTER%%/d"
else
+ # should take account of --split here.
CONDS="/%%ENDIF.*%%/d;/%%IF *HTML_SECTION%%/d;/%%IF *HTML_CHAPTER%%/d"
fi
Index: contrib/README
===================================================================
RCS file: /sources/texinfo/texinfo/contrib/README,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- contrib/README 2 Jan 2013 01:00:12 -0000 1.1
+++ contrib/README 4 Feb 2013 01:35:10 -0000 1.2
@@ -1,4 +1,4 @@
-$Id: README,v 1.1 2013/01/02 01:00:12 karl Exp $
+$Id: README,v 1.2 2013/02/04 01:35:10 karl Exp $
texinfo/contrib/README
Copyright 2013 Free Software Foundation, Inc.
@@ -24,3 +24,7 @@
Adapting one of these to actually be installable would doubtless be much
simpler (which is not to say simple) than finalizing texifont/, though
of course much less featureful.
+
+The perldoc-all subdirectory is about making Texinfo out of the standard
+Perl *.pod files. The results are at
+http://www.gnu.org/software/perl/manual.
Index: Pod-Simple-Texinfo/.cvsignore
===================================================================
RCS file: /sources/texinfo/texinfo/Pod-Simple-Texinfo/.cvsignore,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- Pod-Simple-Texinfo/.cvsignore 19 Nov 2012 23:54:08 -0000 1.3
+++ Pod-Simple-Texinfo/.cvsignore 4 Feb 2013 01:35:13 -0000 1.4
@@ -1,4 +1,5 @@
*.log
+*.tmp
*.trs
Makefile.in
Makefile
Index: Pod-Simple-Texinfo/pod2texi.pl
===================================================================
RCS file: /sources/texinfo/texinfo/Pod-Simple-Texinfo/pod2texi.pl,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -b -r1.24 -r1.25
--- Pod-Simple-Texinfo/pod2texi.pl 26 Jan 2013 13:35:39 -0000 1.24
+++ Pod-Simple-Texinfo/pod2texi.pl 4 Feb 2013 01:35:13 -0000 1.25
@@ -1,7 +1,6 @@
#! /usr/bin/env perl
-
+# $Id: pod2texi.pl,v 1.25 2013/02/04 01:35:13 karl Exp $
# pod2texi -- convert Pod to Texinfo.
-#
# Copyright 2012, 2013 Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or modify
@@ -108,25 +107,34 @@
sub pod2texi_help()
{
- return __("Usage: pod2texi [OPTION]... POD-FILE...
+ return __("Usage: pod2texi [OPTION]... POD...
-Translate Pod to Texinfo. If --base-level is higher than 0,
-a main manual including all the files is done; otherwise, all
-manuals are standalone (the default).
+Translate Perl pod documentation file(s) to Texinfo. There are two
+basic modes of operation. First, by default, each pod is translated to
+a standalone Texinfo manual.
+
+Second, if C<--base-level> is set higher than 0, each pod is translated
+to a file suitable for C<address@hidden>, and one more file with all the
+C<address@hidden>s is generated, intended to be C<address@hidden>d in turn
within
+a hand-written top-level file.
Options:
- --base-level=NUM|NAME level of the head1 commands.
- --debug=NUM set debugging level
+ --base-level=NUM|NAME level of the head1 commands; default 0.
+ --debug=NUM set debugging level.
--help display this help and exit.
--no-fill-section-gaps do not fill sectioning gaps.
--no-section-nodes use anchors for sections instead of nodes.
- --output=NAME output to <NAME> for the first or the main manual
- instead of standard out.
+ --output=NAME output to NAME for the first or main manual
+ instead of standard output.
--preamble=STR insert STR as beginning boilerplate.
- --subdir=NAME put files included in the main manual in <NAME>.
+ --subdir=NAME put files included in the main manual in NAME.
--top top for the main manual.
--unnumbered-sections use unumbered sections.
- --version display version information and exit.\n");
+ --version display version information and exit.
+
+Email bug reports to address@hidden,
+general questions and discussion to address@hidden
+Texinfo home page: http://www.gnu.org/software/texinfo/\n";);
}
my $base_level = 0;
@@ -436,13 +444,12 @@
$outfile_name .= '.info';
if (! defined ($preamble)) {
- $preamble = '\input texinfo
+ $preamble = ($base_level > 0) ? ""
+ : '\input texinfo
@setfilename ' . Pod::Simple::Texinfo::_protect_text ($outfile_name) . "
address@hidden utf-8
-
address@hidden $top
address@hidden
address@hidden
address@hidden
@@ -483,13 +490,18 @@
=head1 SYNOPSIS
- pod2texi [OPTION]... POD-FILE...
+ pod2texi [OPTION]... POD...
=head1 DESCRIPTION
-Translate Pod to Texinfo. If the C<--base-level> is higher than 0, a
-main manual including all the files is done otherwise all manuals are
-standalone (the default).
+Translate Pod file(s) to Texinfo. There are two basic modes of
+operation. First, by default, each pod is translated to a standalone
+Texinfo manual.
+
+Second, if C<--base-level> is set higher than 0, each pod is translated
+to a file suitable for C<@include>, and one more file with all the
+C<@include>s is generated, intended to be C<@include>d in turn within a
+hand-written top-level file.
=head1 OPTIONS
@@ -497,17 +509,21 @@
=item B<--base-level>=I<NUM|NAME>
-Sets the level of the head1 commands. It may be an integer or a Texinfo
-sectioning command. If it is a Texinfo sectioning command the corresponding
-level is used. If the resulting level is 1, this corresponds to
address@hidden/@unnumbered level. If set to 0, the head1 commands level is
-still 1, but the output manual is considered to be a standalone manual.
+Sets the level of the C<head1> commands. It may be an integer or a
+Texinfo sectioning command (without the C<@>): 1 corresponds to the
+C<@chapter>/C<@unnumbered> level, 2 to the C<@section> level, and so on.
+The default is 0, meaning that C<head1> commands are still output as
+chapters, but the output is arranged as a standalone manual.
If the level is not 0, the pod file is rendered as a fragment of a
-Texinfo manual. In that case, each pod file has an additional sectioning
-command one level above the head1 commands level added for the whole
-file. Therefore if you want to have each pod file as a chapter, you should
-use C<section> as the base level.
+Texinfo manual suitable for C<@include>. In this case, each pod file
+has an additional sectioning command covering the entire file, one level
+above the C<--base-level> value. Therefore, to make each pod file a
+chapter in a large manual, you should use C<section> as the base level.
+
+For an example of making Texinfo out of the Perl documentation itself,
+see C<contrib/perldoc-all> in the Texinfo source distribution, with
+output available at L<http://www.gnu.org/software/perl/manual>.
=item B<--debug>=I<NUM>
@@ -520,7 +536,7 @@
=item B<--output>=I<NAME>
Name for the first manual, or the main manual if there is a main manual.
-Default is output on standard out.
+Default is to write to standard output.
=item B<--no-section-nodes>
@@ -528,19 +544,22 @@
=item B<--no-fill-section-gaps>
-Do not fill sectioning gaps with empty C<@unnumbered>.
+Do not fill sectioning gaps with empty C<@unnumbered> files.
+Ordinarily, it's good to keep the sectioning hierarchy intact.
=item B<--preamble>=I<STR>
-Insert I<STR> as top boilerplate before includes. The default is fairly
-minimal, and sets @documentencoding to C<utf-8>. For example, you can
-set this to the empty string and then write your own top-level
-boilerplate which uses @include to incorporate the generated one.
+Insert I<STR> as top boilerplate before includes. For standalone
+documents (C<--base-level> is 0), the default is a minimal beginning for
+a Texinfo document, and sets C<@documentencoding> to C<utf-8>. For
+included documents (C<--base-level> is nonzero), it is the empty string,
+under the assumption that you will want your own top-level material,
+and to C<@include> the generated files.
=item B<--subdir>=I<NAME>
-If there is a main manual with include files, each corresponding to
-an input pod file, then include files are put in the directory I<NAME>.
+If there is a main manual with include files (each corresponding to
+an input pod file), then those include files are put in directory I<NAME>.
=item B<--unnumbered-sections>
@@ -559,11 +578,12 @@
=head1 SEE ALSO
-L<Pod::Simple::Texinfo>. The Texinfo manual. L<perlpod>.
+L<Pod::Simple::Texinfo>. L<perlpod>. The Texinfo manual.
+Texinfo home page: L<http://www.gnu.org/software/texinfo/>
=head1 COPYRIGHT
-Copyright (C) 2012 Free Software Foundation, Inc.
+Copyright (C) 2013 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -574,6 +594,6 @@
=head1 AUTHOR
-Patrice Dumas E<lt>address@hidden<gt>.
+Patrice Dumas E<lt>address@hidden<gt>.
=cut
Index: contrib/perldoc-all/.cvsignore
===================================================================
RCS file: contrib/perldoc-all/.cvsignore
diff -N contrib/perldoc-all/.cvsignore
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ contrib/perldoc-all/.cvsignore 4 Feb 2013 01:35:11 -0000 1.1
@@ -0,0 +1,9 @@
+perl-5.*
+perldoc-all
+perldoc-all-incl.texi
+perldoc-all.html
+perldoc-all.info
+manual
+*.aux
+perldoc-all.??
+perldoc-all.???
Index: contrib/perldoc-all/GNUmakefile
===================================================================
RCS file: contrib/perldoc-all/GNUmakefile
diff -N contrib/perldoc-all/GNUmakefile
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ contrib/perldoc-all/GNUmakefile 4 Feb 2013 01:35:11 -0000 1.1
@@ -0,0 +1,46 @@
+# $Id: GNUmakefile,v 1.1 2013/02/04 01:35:11 karl Exp $
+# Sample Makefile to build Texinfo from the Perl POD documentation,
+# using pod2texi.
+#
+# Copyright 2013 Free Software Foundation, Inc.
+#
+# This file is free software; as a special exception the author gives
+# unlimited permission to copy and/or distribute it, with or without
+# modifications, as long as this notice is preserved.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+perl_pod_subdir = $(shell pwd)/perl-[0-9]*.*/pod
+texi_pod_doc = perldoc-all
+texi_pod_doc_incl = $(texi_pod_doc)-incl.texi
+texi_pod_subdir = $(texi_pod_doc)
+
+texinfo_srcdir = $(shell cd ../../ && pwd)
+pod2texi = perl $(texinfo_srcdir)/Pod-Simple-Texinfo/pod2texi.pl
+pod2texi_args = --base-level=section
+
+# Unfortunately have to use --no-validate since not all the names and
+# L<references> match up. Split HTML by chapter is the natural thing here.
+gendocs_args = --email address@hidden
+gendocs_args = --common "--no-warn --no-validate"
+gendocs_args += --split chapter
+gendocs_args += --no-ascii
+gendocs_args += --source $(texi_pod_subdir)
+gendocs_title = "Perl documentation in Texinfo"
+
+all: $(texi_pod_doc_incl)
+ rm -rf manual
+ gendocs.sh $(gendocs_args) $(texi_pod_doc) $(gendocs_title)
+
+$(texi_pod_doc_incl): $(perl_pod_subdir)/*.pod
+ rm -rf $(texi_pod_subdir)
+# we omit the numerous delta pods, which are uninteresting when searching
+# (and take tons of time and space).
+ cd $(perl_pod_subdir) \
+ && $(pod2texi) -o $@ --subdir=$(texi_pod_subdir) $(pod2texi_args) \
+ `ls *.pod | fgrep -v delta` \
+ && mv $(texi_pod_subdir) $@ ../..
+
+force:
Index: contrib/perldoc-all/README
===================================================================
RCS file: contrib/perldoc-all/README
diff -N contrib/perldoc-all/README
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ contrib/perldoc-all/README 4 Feb 2013 01:35:11 -0000 1.1
@@ -0,0 +1,17 @@
+$Id: README,v 1.1 2013/02/04 01:35:11 karl Exp $
+texinfo/contrib/perldoc-all/README
+
+ Copyright 2013 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.
+
+This stuff is about making Texinfo out of the standard Perl *.pod files.
+The results are at http://www.gnu.org/software/perl/manual.
+
+The idea is to download the perl distribution here, as in,
+ wget http://www.cpan.org/src/5.0/perl-5.16.2.tar.gz
+and run (GNU) make. Aside from the result hopefully being useful in
+itself, it also serves as a nontrivial example of using pod2texi.
+
Index: contrib/perldoc-all/gendocs_template
===================================================================
RCS file: contrib/perldoc-all/gendocs_template
diff -N contrib/perldoc-all/gendocs_template
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ contrib/perldoc-all/gendocs_template 4 Feb 2013 01:35:12 -0000
1.1
@@ -0,0 +1,79 @@
+<!--#include virtual="/server/header.html" -->
+<title>%%TITLE%% - GNU Project - Free Software Foundation (FSF)</title>
+<!--#include virtual="/server/banner.html" -->
+<h2>%%TITLE%%</h2>
+
+<address>Free Software Foundation</address>
+<address>last updated %%DATE%%</address>
+
+<p>This translation of the <a href="http://perldoc.perl.org/";>Perl
+documentation</a> from POD to Texinfo is not official, and not endorsed
+by the Perl developers (indeed, they haven't seen it). It was created
+by the GNU Texinfo developers because they found it useful to have the
+core Perl documentation available in Info other formats, and thought
+they would share the results. Suggestions welcome.</p>
+
+<p>This output is created entirely by the Texinfo tools; see the <a
+href="http://cvs.savannah.gnu.org/viewvc/texinfo/contrib/perldoc-all/?root=texinfo";>contrib/perldoc-all</a>
+directory in the Texinfo sources for the procedure used.</p>
+
+<p>This documentation (%%PACKAGE%%) is available in the following formats:</p>
+
+<ul>
+<li><a href="%%PACKAGE%%.html">HTML
+ (%%HTML_MONO_SIZE%%K bytes)</a> - entirely on one web page.</li>
+<li><a href="html_chapter/index.html">HTML</a> - with one web page per
+ chapter.</li>
+<li><a href="%%PACKAGE%%.html.gz">HTML compressed
+ (%%HTML_MONO_GZ_SIZE%%K gzipped characters)</a> - entirely on
+ one web page.</li>
+<li><a href="%%PACKAGE%%.html_node.tar.gz">HTML compressed
+ (%%HTML_NODE_TGZ_SIZE%%K gzipped tar file)</a> -
+ with one web page per node.</li>
+<li><a href="%%PACKAGE%%.html_chapter.tar.gz">HTML compressed
+ (%%HTML_CHAPTER_TGZ_SIZE%%K gzipped tar file)</a> -
+ with one web page per chapter.</li>
+<li><a href="%%PACKAGE%%.info.tar.gz">Info document
+ (%%INFO_TGZ_SIZE%%K bytes gzipped tar file)</a>.</li>
+<li><a href="%%PACKAGE%%.dvi.gz">TeX dvi file
+ (%%DVI_GZ_SIZE%%K bytes gzipped)</a>.</li>
+<li><a href="%%PACKAGE%%.pdf">PDF file
+ (%%PDF_SIZE%%K bytes)</a>.</li>
+<li><a href="%%PACKAGE%%.texi.tar.gz">Texinfo source
+ (%%TEXI_TGZ_SIZE%%K bytes gzipped tar file).</a></li>
+</ul>
+
+<p>You can <a href="http://shop.fsf.org/";>buy printed copies of
+some manuals</a> (among other items) from the Free Software Foundation;
+this helps support FSF activities.</p>
+
+<p>(This page generated by the <a href="%%SCRIPTURL%%">%%SCRIPTNAME%%
+script</a>.)</p>
+
+<!-- If needed, change the copyright block at the bottom. In general,
+ all pages on the GNU web server should have the section about
+ verbatim copying. Please do NOT remove this without talking
+ with the webmasters first.
+ Please make sure the copyright date is consistent with the document
+ and that it is like this: "2001, 2002", not this: "2001-2002". -->
+</div><!-- for id="content", starts in the include above -->
+<!--#include virtual="/server/footer.html" -->
+<div id="footer">
+
+<p>Please send general FSF & GNU inquiries to
+<a href="mailto:address@hidden";><address@hidden></a>.
+There are also <a href="/contact/">other ways to contact</a>
+the FSF.<br />
+Please send broken links and other corrections or suggestions to
+<a href="mailto:%%EMAIL%%";><%%EMAIL%%></a>.</p>
+
+<p>Copyright © 2013 Free Software Foundation, Inc.</p>
+
+<p>Verbatim copying and distribution of this entire article are
+permitted worldwide, without royalty, in any medium, provided this
+notice, and the copyright notice, are preserved.</p>
+
+</div>
+</div>
+</body>
+</html>
Index: contrib/perldoc-all/perldoc-all.texi
===================================================================
RCS file: contrib/perldoc-all/perldoc-all.texi
diff -N contrib/perldoc-all/perldoc-all.texi
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ contrib/perldoc-all/perldoc-all.texi 4 Feb 2013 01:35:12 -0000
1.1
@@ -0,0 +1,28 @@
+\input texinfo
address@hidden This top-level file is so trivial, it has to be public domain.
address@hidden perldoc-all.info
address@hidden Perl pod documentation
+
address@hidden
address@hidden
+
address@hidden
address@hidden Top
address@hidden Perl pod documentation
+
+This translation of the Perl documentation
+(@url{http://perldoc.perl.org}) from POD to Texinfo is not official,
+and not endorsed by the Perl developers (indeed, they haven't seen
+it). It was created by the GNU Texinfo developers because they found
+it useful to have the Perl documentation available in Info and other
+formats, and thought they would share the results. Suggestions welcome.
+
+This is created entirely by the Texinfo tools; see the
address@hidden://cvs.savannah.gnu.org/viewvc/texinfo/contrib/perldoc-all/?root=texinfo,
address@hidden/perldoc-all}} directory in the Texinfo sources for the
+procedure used.
address@hidden ifnottex
+
address@hidden perldoc-all-incl.texi
+
address@hidden
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- texinfo ChangeLog NEWS README-hacking doc/Makef...,
karl <=