Commit e40a4cd2 authored by Jeff Licquia's avatar Jeff Licquia Committed by Fabian Wolff

Import Debian changes 2.3-2

doclifter (2.3-2) unstable; urgency=low

  * New maintainer.  Closes: #470885.
  * Include proper copyright notice in debian/copyright.
  * Update Standards-Version.
  * Include Homepage and Vcs-* headers.
  * Re-generate man pages.  Closes: #418643.
  * Fix other lintian warnings.
  * Recommend: plotutils (based on notes in the man page).
parent cab1eb05
doclifter (2.3-2) unstable; urgency=low
* New maintainer. Closes: #470885.
* Include proper copyright notice in debian/copyright.
* Update Standards-Version.
* Include Homepage and Vcs-* headers.
* Re-generate man pages. Closes: #418643.
* Fix other lintian warnings.
* Recommend: plotutils (based on notes in the man page).
-- Jeff Licquia <licquia@debian.org> Tue, 27 May 2008 23:02:42 -0400
doclifter (2.3-1) unstable; urgency=low
* New upstream release (closes: #405632)
......
Source: doclifter
Section: devel
Priority: optional
Maintainer: Ross Burton <ross@debian.org>
Build-Depends: debhelper (>= 4.0.0)
Standards-Version: 3.7.2
Maintainer: Jeff Licquia <licquia@debian.org>
Homepage: http://www.catb.org/~esr/doclifter/
Vcs-Bzr: http://bzr.licquia.org/doclifter/debian/
Vcs-Browser: http://bzr.licquia.org/loggerhead/doclifter/debian/
Build-Depends: debhelper (>= 5)
Standards-Version: 3.7.3
Package: doclifter
Architecture: all
Depends: python (>=2.2)
Recommends: plotutils
Description: Convert troff to DocBook
Lifting documents from presentation level to semantic level is hard,
and a really good job requires human polishing. This tool aims to do
......
......@@ -5,22 +5,10 @@ It was downloaded from http://www.catb.org/~esr/doclifter/
Upstream Author: Eric S. Raymond
Copyright:
Copyright (from the doclifter script):
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
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this package; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
02110-1301, USA.
By Eric S. Raymond, copyright 2002, 2006.
Released as open source the Gnu General Public License.
On Debian GNU/Linux systems, the complete text of the GNU General
Public License can be found in `/usr/share/common-licenses/GPL'.
#!/usr/bin/make -f
#export DH_VERBOSE=1
export DH_COMPAT=4
build: build-stamp
build-stamp:
......
This diff is collapsed.
.\" ** You probably do not want to edit this file directly **
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
.TH "MANLIFTER" "1" "12/25/2006" "" ""
.\" Title: manlifter
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: 05/27/2008
.\" Manual:
.\" Source:
.\"
.TH "MANLIFTER" "1" "05/27/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
manlifter \- mass\-conversion script and test harness for doclifter
manlifter \- mass-conversion script and test harness for doclifter
.SH "SYNOPSIS"
.HP 10
\fBmanlifter\fR [\-d\ \fIoption\fR] [\-e] [\-f\ \fIlistfile\fR] [\-h] [\-I\ \fImandir\fR] [\-o\ \fIoutdir\fR] [\-p\ \fIpatch\-directory\fR] [\-q] [\-v] [\-s\ \fIsection\fR] \fIname\fR...
......@@ -19,118 +22,137 @@ manlifter \- mass\-conversion script and test harness for doclifter
\fBmanlifter\fR
is a script that sequences
\fBdoclifter\fR(1)
to convert an entire manual\-page tree to XML\-Docbook, optionally also generating HTML from the XML. Another use is as a torture\-test tool for doclifter; it logs errors to standard output and collects timings.
to convert an entire manual\-page tree to XML\-Docbook, optionally also generating HTML from the XML\&. Another use is as a torture\-test tool for doclifter; it logs errors to standard output and collects timings\&.
.PP
Called without any file arguments, manlifter tries to convert all man pages installed on the system, placing the resulting xml files under
\fIxmlman\fR
in the current directory. Each successfully translated page foo.N is copied to manN/foo.xml beneath the output directory, regardless of what source directory it came from.
in the current directory\&. Each successfully translated page foo\&.N is copied to manN/foo\&.xml beneath the output directory, regardless of what source directory it came from\&.
.PP
For each source file examined, if the destination file exists and is newer than the source, the conversion is skipped; thus, incremental runs of
\fBmanlifter\fR
do the least work needed to keep the target XML tree up to date. Likewise, in \-h mode derived HTML files are only made when necessary.
do the least work needed to keep the target XML tree up to date\&. Likewise, in \-h mode derived HTML files are only made when necessary\&.
.PP
Stub pages that are just
.so
redirections are translated to corresponding symlinks of XML files (and, with \-h, HTML files).
\fB\&.so\fR
redirections are translated to corresponding symlinks of XML files (and, with \-h, HTML files)\&.
.PP
\fBmanlifter\fR
may also be called with a single file argument, which is interpreted as the stem name of a potential manual page.
may also be called with a single file argument, which is interpreted as the stem name of a potential manual page\&.
\fBmanlifter\fR
then searches all selected manual sections for a matching page and attempts to convert it. In this case, a copy of the man page and the converted version are dropped immediately beheath the output directory, with the names foobar.man and foobar.man.xml, respectively. This mode is normally only of interest only to
then searches all selected manual sections for a matching page and attempts to convert it\&. In this case, a copy of the man page and the converted version are dropped immediately beheath the output directory, with the names foobar\&.man and foobar\&.man\&.xml, respectively\&. This mode is normally only of interest only to
\fBdoclifter\fR
developers for debugging that program.
developers for debugging that program\&.
.PP
In either of the above cases,
\fBmanlifter\fR
will uncompress the file if it has a
\fI.gz\fR,
\fI.bz2\fR
\fI\&.gz\fR,
\fI\&.bz2\fR
or
\fI.Z\fR
suffix on the name.
\fI\&.Z\fR
suffix on the name\&.
.PP
Options are as follows:
.TP
.PP
\-d
Pass the string argument to each doclifter call as options. Each space\-separated token in the string becomes a separate argument in the call.
.TP
.RS 4
Pass the string argument to each doclifter call as options\&. Each space\-separated token in the string becomes a separate argument in the call\&.
.RE
.PP
\-e
.RS 4
Run in log\-filter mode (mainly of interest to
\fBdoclifter\fR
developers). In this mode,
developers)\&. In this mode,
\fBmanlifter\fR
reads a test log from standard input and filters it in a a way dependent on the \-f and \-q options. If neither of these is given, messages from successful runs are stripped out and only errors passed through to standard output.
.TP
reads a test log from standard input and filters it in a a way dependent on the \-f and \-q options\&. If neither of these is given, messages from successful runs are stripped out and only errors passed through to standard output\&.
.RE
.PP
\-f
Normally, run doclifter on the files named by each line in the argument file. In error\-filter mode the argument is instead interpreted as a filtering regular expression.
.TP
.RS 4
Normally, run doclifter on the files named by each line in the argument file\&. In error\-filter mode the argument is instead interpreted as a filtering regular expression\&.
.RE
.PP
\-h
Also generate HTML translations into the output directory. DocBook citerefentry markup is transformed to hyperlinks in the directory, and a contents listing is generated to
\fIindex.html\fR.
.TP
.RS 4
Also generate HTML translations into the output directory\&. DocBook citerefentry markup is transformed to hyperlinks in the directory, and a contents listing is generated to
\fIindex\&.html\fR\&.
.RE
.PP
\-I
Specify the root of the manual\-page tree. By default this is
\fI/usr/share/man\fR.
.TP
.RS 4
Specify the root of the manual\-page tree\&. By default this is
\fI/usr/share/man\fR\&.
.RE
.PP
\-o
Set the output directory into which XML\-DocBook translations will be dropped. By default this is
.RS 4
Set the output directory into which XML\-DocBook translations will be dropped\&. By default this is
\fIxmlman\fR
under the current directory in batch mode, or the current directory otherwise.
.TP
under the current directory in batch mode, or the current directory otherwise\&.
.RE
.PP
\-p
.RS 4
Interpret the argument as the name of a patch directory (the default name is
\fIprepatch\fR
under the current directory). Each file named
\fIfoo.N.patch\fR
is interpreted as a patch to be applied to the manual page foo(N) before doclifter translates it.
.TP
under the current directory)\&. Each file named
\fIfoo\&.N\&.patch\fR
is interpreted as a patch to be applied to the manual page foo(N) before doclifter translates it\&.
.RE
.PP
\-q
Normally, pass the \-q (quiet) option to each doclifter call. In error\-filter mode, return a list of files on which translation failed.
.TP
.RS 4
Normally, pass the \-q (quiet) option to each doclifter call\&. In error\-filter mode, return a list of files on which translation failed\&.
.RE
.PP
\-v
Pass the \-v (verbose) option to each doclifter call. This option can be repeated to increase the verbosity level.
.TP
.RS 4
Pass the \-v (verbose) option to each doclifter call\&. This option can be repeated to increase the verbosity level\&.
.RE
.PP
\-s
Specify a section to scan. Use this with an argument; it should not be necessary when doing a conversion of the entire tree.
.TP
.RS 4
Specify a section to scan\&. Use this with an argument; it should not be necessary when doing a conversion of the entire tree\&.
.RE
.PP
\-S
.RS 4
Compile error statistics from a
\fBmanlifter\fR
logfile presented on standard input. This option will be of interest mainly to
logfile presented on standard input\&. This option will be of interest mainly to
\fBdoclifter\fR
developers.
developers\&.
.RE
.PP
\fBmanlifter\fR
emits a logfile to standard output. The file begins with a timestamp line and a blank line, and ends with a line giving run time and various interesting statistics. Between these are stanzas, separated by blank lines, one for each file on which
emits a logfile to standard output\&. The file begins with a timestamp line and a blank line, and ends with a line giving run time and various interesting statistics\&. Between these are stanzas, separated by blank lines, one for each file on which
\fBdoclifter\fR
was run.
was run\&.
.PP
The first line of each stanza beguns with "! ", followed by the pathname of the source manual pager, followed by "=" and the return status of doclifter run on that file. Following that is a space and
\fBdoclifter\fR's runtime in seconds.
The first line of each stanza beguns with "! ", followed by the pathname of the source manual pager, followed by "=" and the return status of doclifter run on that file\&. Following that is a space and
\fBdoclifter\fR\'s runtime in seconds\&.
.PP
This initial line may be followed by information messages and the error output of the doclifter run.
This initial line may be followed by information messages and the error output of the doclifter run\&.
.PP
\fBmanlifter\fR
must find a copy of
\fBdoclifter\fR
in either the current directory or one of the command directories in your
\fBPATH\fR
in order to run.
in order to run\&.
.SH "BUGS"
.PP
HTML generation is painfully slow. Unfortunately, there is little we can do to remedy this, because XSLT engines are painfully slow.
HTML generation is painfully slow\&. Unfortunately, there is little we can do to remedy this, because XSLT engines are painfully slow\&.
.SH "SEE ALSO"
.PP
\fBdoclifter\fR(1),
\fBxmlto\fR(1)
.SH "AUTHOR"
.PP
Eric S. Raymond
<esr@thyrsus.com>
Eric S\&. Raymond
<esr@thyrsus\&.com>
.PP
There is a project web page at
[1]\&\fIhttp://www.catb.org/~esr/doclifter/\fR.
.SH "REFERENCES"
.TP 3
1.\ http://www.catb.org/~esr/doclifter/
\%http://www.catb.org/~esr/doclifter/
\fIhttp://www\&.catb\&.org/~esr/doclifter/\fR\&.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment