[pkg-java] r15642 - trunk/fop/debian

Thu Jan 5 08:49:40 UTC 2012

Author: malat-guest
Date: 2012-01-05 08:49:40 +0000 (Thu, 05 Jan 2012)
New Revision: 15642

Added:
   trunk/fop/debian/fop.1
   trunk/fop/debian/fop.1.in
Modified:
   trunk/fop/debian/changelog
   trunk/fop/debian/rules
Log:
Fix catalog bug

Modified: trunk/fop/debian/changelog
===================================================================

--- trunk/fop/debian/changelog	2012-01-05 08:32:47 UTC (rev 15641)
+++ trunk/fop/debian/changelog	2012-01-05 08:49:40 UTC (rev 15642)
@@ -1,6 +1,7 @@
 fop (1:1.0.dfsg2-6) UNRELEASED; urgency=low
 
   * Support conf.d like configuration files. Closes: #630198
+  * Fix fop man page (outdated). Closes: #654592, #512443
 
  -- Mathieu Malaterre <mathieu.malaterre at gmail.com>  Thu, 05 Jan 2012 09:32:15 +0100
 

Added: trunk/fop/debian/fop.1
===================================================================
--- trunk/fop/debian/fop.1	                        (rev 0)
+++ trunk/fop/debian/fop.1	2012-01-05 08:49:40 UTC (rev 15642)
@@ -0,0 +1,217 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
+.TH FOP "1" "January 2012" "fop Version 1.0" "User Commands"
+.SH NAME
+
+fop \- Command line wrapper for the java version of fop.
+.SH DESCRIPTION
+Apache FOP (Formatting Objects Processor) is a print formatter driven by XSL
+formatting objects (XSL-FO) and an output independent formatter. It is a Java
+application that reads a formatting object (FO) tree and renders the resulting
+pages to a specified output. Output formats currently supported include PDF,
+PS, PCL, AFP, XML (area tree representation), Print, AWT and PNG, and to a
+lesser extent, RTF and TXT. The primary output target is PDF.
+.PP
+.SH SYNOPSIS
+
+fop [options] [\-fo|\-xml] infile [\-xsl file] [\-awt|\-pdf|\-mif|\-rtf|\-tiff|\-png|\-pcl|\-ps|\-txt|\-at [mime]|\-print] <outfile>
+.IP
+.SH OPTIONS
+.TP
+\fB\-version\fR
+print FOP version and exit
+.TP
+\fB\-d\fR
+debug mode
+.TP
+\fB\-x\fR
+dump configuration settings
+.TP
+\fB\-q\fR
+quiet mode
+.TP
+\fB\-c\fR cfg.xml
+use additional configuration file cfg.xml
+.TP
+\fB\-l\fR lang
+the language to use for user information
+.TP
+\fB\-r\fR
+relaxed/less strict validation (where available)
+.TP
+\fB\-dpi\fR xxx
+target resolution in dots per inch (dpi) where xxx is a number
+.TP
+\fB\-s\fR
+for area tree XML, down to block areas only
+.TP
+\fB\-v\fR
+run in verbose mode (currently simply print FOP version and continue)
+.TP
+\fB\-o\fR [password]
+PDF file will be encrypted with option owner password
+.TP
+\fB\-u\fR [password]
+PDF file will be encrypted with option user password
+.TP
+\fB\-noprint\fR
+PDF file will be encrypted without printing permission
+.TP
+\fB\-nocopy\fR
+PDF file will be encrypted without copy content permission
+.TP
+\fB\-noedit\fR
+PDF file will be encrypted without edit content permission
+.TP
+\fB\-noannotations\fR
+PDF file will be encrypted without edit annotation permission
+.TP
+\fB\-a\fR
+enables accessibility features (Tagged PDF etc., default off)
+.TP
+\fB\-pdfprofile\fR prof
+PDF file will be generated with the specified profile
+(Examples for prof: PDF/A\-1b or PDF/X\-3:2003)
+.TP
+\fB\-conserve\fR
+Enable memory\-conservation policy (trades memory\-consumption for disk I/O)
+(Note: currently only influences whether the area tree is serialized.)
+.IP
+.SH INPUT
+.TP
+infile
+xsl:fo input file (the same as the next)
+(use '\-' for infile to pipe input from stdin)
+.TP
+\fB\-fo\fR
+infile       xsl:fo input file
+.TP
+\fB\-xml\fR infile
+xml input file, must be used together with \fB\-xsl\fR
+.TP
+\fB\-atin\fR infile
+area tree input file
+.TP
+\fB\-ifin\fR infile
+intermediate format input file
+.TP
+\fB\-imagein\fR infile
+image input file (piping through stdin not supported)
+.TP
+\fB\-xsl\fR stylesheet
+xslt stylesheet
+.TP
+\fB\-param\fR name value <value> to use for parameter <name> in xslt stylesheet
+(repeat '\-param name value' for each parameter)
+.TP
+\fB\-catalog\fR
+use catalog resolver for input XML and XSLT files
+.IP
+.SH OUTPUT
+.TP
+outfile
+input will be rendered as PDF into outfile
+(use '\-' for outfile to pipe output to stdout)
+.TP
+\fB\-pdf\fR outfile
+input will be rendered as PDF (outfile req'd)
+.TP
+\fB\-pdfa1b\fR outfile
+input will be rendered as PDF/A\-1b compliant PDF
+(outfile req'd, same as "\-pdf outfile \fB\-pdfprofile\fR PDF/A\-1b")
+.TP
+\fB\-awt\fR
+input will be displayed on screen
+.TP
+\fB\-rtf\fR outfile
+input will be rendered as RTF (outfile req'd)
+.TP
+\fB\-pcl\fR outfile
+input will be rendered as PCL (outfile req'd)
+.TP
+\fB\-ps\fR outfile
+input will be rendered as PostScript (outfile req'd)
+.TP
+\fB\-afp\fR outfile
+input will be rendered as AFP (outfile req'd)
+.TP
+\fB\-tiff\fR outfile
+input will be rendered as TIFF (outfile req'd)
+.TP
+\fB\-png\fR outfile
+input will be rendered as PNG (outfile req'd)
+.TP
+\fB\-txt\fR outfile
+input will be rendered as plain text (outfile req'd)
+.TP
+\fB\-at\fR [mime] out
+representation of area tree as XML (outfile req'd)
+specify optional mime output to allow the AT to be converted
+to final format later
+.TP
+\fB\-if\fR [mime] out
+representation of document in intermediate format XML (outfile req'd)
+specify optional mime output to allow the IF to be converted
+to final format later
+.TP
+\fB\-print\fR
+input file will be rendered and sent to the printer
+see options with "\-print help"
+.TP
+\fB\-out\fR mime outfile input will be rendered using the given MIME type
+(outfile req'd) Example: "\-out application/pdf D:\eout.pdf"
+(Tip: "\-out list" prints the list of supported MIME types)
+.TP
+\fB\-svg\fR outfile
+input will be rendered as an SVG slides file (outfile req'd)
+Experimental feature \- requires additional fop\-sandbox.jar.
+.TP
+\fB\-foout\fR outfile
+input will only be XSL transformed. The intermediate
+XSL\-FO file is saved and no rendering is performed.
+(Only available if you use \fB\-xml\fR and \fB\-xsl\fR parameters)
+.IP
+.SH EXAMPLES
+.IP
+
+fop foo.fo foo.pdf
+
+fop \fB\-fo\fR foo.fo \fB\-pdf\fR foo.pdf (does the same as the previous line)
+
+fop \fB\-xml\fR foo.xml \fB\-xsl\fR foo.xsl \fB\-pdf\fR foo.pdf
+
+fop \fB\-xml\fR foo.xml \fB\-xsl\fR foo.xsl \fB\-foout\fR foo.fo
+
+fop \fB\-xml\fR \- \fB\-xsl\fR foo.xsl \fB\-pdf\fR \-
+
+fop foo.fo \fB\-mif\fR foo.mif
+
+fop foo.fo \fB\-rtf\fR foo.rtf
+
+fop foo.fo \fB\-print\fR
+
+fop foo.fo \fB\-awt\fR
+.SH HYPENATION
+
+fop can make use of external hyphenation rules that can be supplied in
+the form of a hyphenation jar. You can find such a one at
+http://offo.sourceforge.net/.
+
+To actually use that, set the FOP_HYPHENATION_PATH environment variable
+to the full path of this file, or use configuration files, see below.
+.SH "CONFIGURATION FILES"
+
+fop reads two configuration files on startup: /etc/fop.conf and
+$HOME/.foprc. These are plain shell script files where you can define
+for instance the FOP_HYPHENATION_PATH variable.
+.SH "JAVA-WRAPPERS NOTE"
+This program is a shell script wrapper based on java-wrappers(7). You
+therefore benefit from several features; please see the java-wrappers(7)
+manual page for more information about them.
+.SH AUTHOR
+Wrapper author: Ola Lundqvist <opal at debian.org>
+
+This manual page was written by Mathieu Malaterre <mathieu.malaterre at gmail.com>,
+for the Debian project (and may be used by others).
+.SH "SEE ALSO"
+.BR fop-ttfreader(1),
+.BR java-wrappers(7).

Added: trunk/fop/debian/fop.1.in
===================================================================
--- trunk/fop/debian/fop.1.in	                        (rev 0)
+++ trunk/fop/debian/fop.1.in	2012-01-05 08:49:40 UTC (rev 15642)
@@ -0,0 +1,40 @@
+[NAME]
+fop \- Command line wrapper for the java version of fop.
+
+[DESCRIPTION]
+Apache FOP (Formatting Objects Processor) is a print formatter driven by XSL
+formatting objects (XSL-FO) and an output independent formatter. It is a Java
+application that reads a formatting object (FO) tree and renders the resulting
+pages to a specified output. Output formats currently supported include PDF,
+PS, PCL, AFP, XML (area tree representation), Print, AWT and PNG, and to a
+lesser extent, RTF and TXT. The primary output target is PDF.
+
+[HYPENATION]
+fop can make use of external hyphenation rules that can be supplied in
+the form of a hyphenation jar. You can find such a one at
+http://offo.sourceforge.net/.
+
+To actually use that, set the FOP_HYPHENATION_PATH environment variable
+to the full path of this file, or use configuration files, see below.
+
+[CONFIGURATION FILES]
+fop reads two configuration files on startup: /etc/fop.conf and
+$HOME/.foprc. These are plain shell script files where you can define
+for instance the FOP_HYPHENATION_PATH variable.
+Another way to extend is conf.d/ files. Simply add a configuration file
+into /etc/fop.conf.d/my.conf.
+
+[JAVA-WRAPPERS NOTE]
+This program is a shell script wrapper based on java-wrappers(7). You
+therefore benefit from several features; please see the java-wrappers(7)
+manual page for more information about them.
+
+[AUTHOR]
+Wrapper author: Ola Lundqvist <opal at debian.org>
+
+This manual page was written by Mathieu Malaterre <mathieu.malaterre at gmail.com>,
+for the Debian project (and may be used by others).
+
+[SEE ALSO]
+.BR fop-ttfreader(1),
+.BR java-wrappers(7).

Modified: trunk/fop/debian/rules
===================================================================
--- trunk/fop/debian/rules	2012-01-05 08:32:47 UTC (rev 15641)
+++ trunk/fop/debian/rules	2012-01-05 08:49:40 UTC (rev 15642)
@@ -25,10 +25,7 @@
 
 	cp -a debian/fop.sh debian/fop/usr/bin/fop
 	cp -a debian/fop-ttfreader.sh debian/fop/usr/bin/fop-ttfreader
-	pod2man --section=1 \
-		--release="Fop " \
-		--date="`date`" \
-		debian/fop.pod > build/fop.1
+	cp -a	debian/fop.1 build/fop.1
 
 	pod2man --section=1 \
 		--release="Fop-TTFReader " \
@@ -47,5 +44,14 @@
 	rm -f lib/build/qdox.jar
 	mh_clean
 
+debian/fop.1: debian/fop.1.in
+	help2man --no-info --version-option=-version --no-discard-stderr --include=debian/fop.1.in --output=debian/fop.1 fop
+	sed -i -e 's/^USAGE$$/.SH SYNOPSIS/' debian/fop.1
+	sed -i -e 's/^\[OPTIONS\]$$/.SH OPTIONS/' debian/fop.1
+	sed -i -e 's/^\[INPUT\]$$/.SH INPUT/' debian/fop.1
+	sed -i -e 's/^\[OUTPUT\]$$/.SH OUTPUT/' debian/fop.1
+	sed -i -e 's/^\[Examples\]$$/.SH EXAMPLES/' debian/fop.1
+	sed -i -e 's/^fop .*$$/\n&/' debian/fop.1
+
 get-orig-source:
 	uscan --force-download --rename


