[libgxps] docs: Add man pages for tools
- From: Carlos Garcia Campos <carlosgc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgxps] docs: Add man pages for tools
- Date: Sat, 19 Nov 2011 17:40:12 +0000 (UTC)
commit 1a305fd8fd4fb7b00eddf3f03e975a6720c8dcee
Author: Carlos Garcia Campos <carlosgc gnome org>
Date: Sat Nov 19 18:37:54 2011 +0100
docs: Add man pages for tools
Makefile.am | 1 +
configure.ac | 9 ++
docs/Makefile.am | 6 +-
docs/tools/Makefile.am | 28 +++++
docs/tools/xpstojpeg.xml | 187 ++++++++++++++++++++++++++++++
docs/tools/xpstopdf.xml | 236 ++++++++++++++++++++++++++++++++++++++
docs/tools/xpstopng.xml | 196 +++++++++++++++++++++++++++++++
docs/tools/xpstops.xml | 285 ++++++++++++++++++++++++++++++++++++++++++++++
docs/tools/xpstosvg.xml | 236 ++++++++++++++++++++++++++++++++++++++
9 files changed, 1183 insertions(+), 1 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 6c0d1aa..fe792ca 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,6 +17,7 @@ DISTCLEANFILES = \
DISTCHECK_CONFIGURE_FLAGS = \
--enable-gtk-doc \
+ --enable-man \
--disable-maintainer-mode \
--enable-introspection
diff --git a/configure.ac b/configure.ac
index c8102be..2a23a45 100644
--- a/configure.ac
+++ b/configure.ac
@@ -213,6 +213,14 @@ AC_SUBST(CAIRO_SVG_LIBS)
dnl gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
+AC_ARG_ENABLE(man,
+ [AC_HELP_STRING([--enable-man],
+ [generate tools man pages [default=no]])],
+ enable_man=yes, enable_man=no)
+
+AC_PATH_PROG([XSLTPROC], [xsltproc])
+AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)
+
dnl GObject instrospection
GOBJECT_INTROSPECTION_CHECK([0.10.1])
@@ -240,6 +248,7 @@ test/Makefile
docs/Makefile
docs/reference/Makefile
docs/reference/version.xml
+docs/tools/Makefile
])
AC_OUTPUT
diff --git a/docs/Makefile.am b/docs/Makefile.am
index b69bfe0..35e48b1 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1 +1,5 @@
-SUBDIRS = reference
\ No newline at end of file
+SUBDIRS = reference
+
+if ENABLE_MAN
+SUBDIRS += tools
+endif
\ No newline at end of file
diff --git a/docs/tools/Makefile.am b/docs/tools/Makefile.am
new file mode 100644
index 0000000..2f2148d
--- /dev/null
+++ b/docs/tools/Makefile.am
@@ -0,0 +1,28 @@
+man_MANS =
+
+if HAVE_LIBPNG
+man_MANS += xpstopng.1
+endif
+
+if HAVE_LIBJPEG
+man_MANS += xpstojpeg.1
+endif
+
+if HAVE_CAIRO_PDF
+man_MANS += xpstopdf.1
+endif
+
+if HAVE_CAIRO_PS
+man_MANS += xpstops.1
+endif
+
+if HAVE_CAIRO_SVG
+man_MANS += xpstosvg.1
+endif
+
+.xml.1:
+ $(AM_V_GEN)@XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+
+MAINTAINERCLEANFILES = $(man_MANS)
+EXTRA_DIST = $(man_MANS)
\ No newline at end of file
diff --git a/docs/tools/xpstojpeg.xml b/docs/tools/xpstojpeg.xml
new file mode 100644
index 0000000..d73dc7a
--- /dev/null
+++ b/docs/tools/xpstojpeg.xml
@@ -0,0 +1,187 @@
+<refentry id="xpstojpeg" lang="en">
+
+ <refmeta>
+ <refentrytitle>xpstojpeg</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">XPS Tools</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>xpstojpeg</refname>
+ <refpurpose>XPS to JPEG converter</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>xpstojpeg</command>
+ <arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
+ <arg choice="plain">FILE</arg>
+ <arg choice="opt"><replaceable>OUTPUT FILE</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>xpstojpeg</command> converts XPS documents to JPEG format.
+ <command>xpstojpeg</command> reads the XPS file, <replaceable>FILE</replaceable>,
+ and writes a JPEG file per page with the page number and file type appended to
+ <replaceable>OUTPUT FILE</replaceable>. If <replaceable>OUTPUT FILE</replaceable>
+ is not specified "page" will be used.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-?</option>, <option>--help</option></term>
+ <listitem>
+ <para>
+ Show help options.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d</option> <replaceable>DOCUMENT</replaceable>, <option>--document</option>=<replaceable>DOCUMENT</replaceable></term>
+ <listitem>
+ <para>
+ The document inside the XPS file to convert. By default, the
+ first document of the XPS file is used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>PAGE</replaceable>, <option>--first</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The first page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-l</option> <replaceable>PAGE</replaceable>, <option>--last</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The last page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option>, <option>--odd</option></term>
+ <listitem>
+ <para>
+ Convert only odd pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-e</option>, <option>--even</option></term>
+ <listitem>
+ <para>
+ Convert only even pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option> <replaceable>RESOLUTION</replaceable>, <option>--resolution</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal and vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--rx</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ry</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-x</option> <replaceable>X</replaceable>, <option>--crop-x</option>=<replaceable>X</replaceable></term>
+ <listitem>
+ <para>
+ The x-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-y</option> <replaceable>Y</replaceable>, <option>--crop-y</option>=<replaceable>Y</replaceable></term>
+ <listitem>
+ <para>
+ The y-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-w</option> <replaceable>WIDTH</replaceable>, <option>--crop-width</option>=<replaceable>WIDTH</replaceable></term>
+ <listitem>
+ <para>
+ The width of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-h</option> <replaceable>HEIGHT</replaceable>, <option>--crop-height</option>=<replaceable>HEIGHT</replaceable></term>
+ <listitem>
+ <para>
+ The height of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Bugs</title>
+ <para>
+ Please send bug reports to
+ <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps";>https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps</ulink>.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>xpstopng</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstopdf</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstops</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstosvg</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
diff --git a/docs/tools/xpstopdf.xml b/docs/tools/xpstopdf.xml
new file mode 100644
index 0000000..f61b133
--- /dev/null
+++ b/docs/tools/xpstopdf.xml
@@ -0,0 +1,236 @@
+<refentry id="xpstopdf" lang="en">
+
+ <refmeta>
+ <refentrytitle>xpstopdf</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">XPS Tools</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>xpstopdf</refname>
+ <refpurpose>XPS to PDF converter</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>xpstopdf</command>
+ <arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
+ <arg choice="plain">FILE</arg>
+ <arg choice="opt"><replaceable>OUTPUT FILE</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>xpstopdf</command> converts XPS documents to PDF format.
+ <command>xpstopdf</command> reads the XPS file, <replaceable>FILE</replaceable>,
+ and writes a PDF file, <replaceable>OUTPUT FILE</replaceable>. If
+ <replaceable>OUTPUT FILE</replaceable> is not specified the output
+ filename will be derived from the <replaceable>OUTPUT FILE</replaceable>
+ filename.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-?</option>, <option>--help</option></term>
+ <listitem>
+ <para>
+ Show help options.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d</option> <replaceable>DOCUMENT</replaceable>, <option>--document</option>=<replaceable>DOCUMENT</replaceable></term>
+ <listitem>
+ <para>
+ The document inside the XPS file to convert. By default, the
+ first document of the XPS file is used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>PAGE</replaceable>, <option>--first</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The first page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-l</option> <replaceable>PAGE</replaceable>, <option>--last</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The last page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option>, <option>--odd</option></term>
+ <listitem>
+ <para>
+ Convert only odd pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-e</option>, <option>--even</option></term>
+ <listitem>
+ <para>
+ Convert only even pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option> <replaceable>RESOLUTION</replaceable>, <option>--resolution</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal and vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--rx</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ry</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-x</option> <replaceable>X</replaceable>, <option>--crop-x</option>=<replaceable>X</replaceable></term>
+ <listitem>
+ <para>
+ The x-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-y</option> <replaceable>Y</replaceable>, <option>--crop-y</option>=<replaceable>Y</replaceable></term>
+ <listitem>
+ <para>
+ The y-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-w</option> <replaceable>WIDTH</replaceable>, <option>--crop-width</option>=<replaceable>WIDTH</replaceable></term>
+ <listitem>
+ <para>
+ The width of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-h</option> <replaceable>HEIGHT</replaceable>, <option>--crop-height</option>=<replaceable>HEIGHT</replaceable></term>
+ <listitem>
+ <para>
+ The height of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--paper-width</option>=<replaceable>WIDTH</replaceable></term>
+ <listitem>
+ <para>
+ The paper width.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--paper-height</option>=<replaceable>HEIGHT</replaceable></term>
+ <listitem>
+ <para>
+ The paper height.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--expand</option></term>
+ <listitem>
+ <para>
+ Expand pages smaller than the paper to fill the paper.
+ By default, pages are not scaled.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--no-shrink</option></term>
+ <listitem>
+ <para>
+ Don't scale pages which are larger than the paper.
+ By default, pages larger than the paper are shrunk to fit.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--no-center</option></term>
+ <listitem>
+ <para>
+ Don't center on the paper pages smaller than the paper (after any scaling).
+ By default, pages smaller than the paper are aligned to the lower-left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Bugs</title>
+ <para>
+ Please send bug reports to
+ <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps";>https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps</ulink>.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>xpstojpeg</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstopng</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstops</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstosvg</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
diff --git a/docs/tools/xpstopng.xml b/docs/tools/xpstopng.xml
new file mode 100644
index 0000000..298edfa
--- /dev/null
+++ b/docs/tools/xpstopng.xml
@@ -0,0 +1,196 @@
+<refentry id="xpstopng" lang="en">
+
+ <refmeta>
+ <refentrytitle>xpstopng</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">XPS Tools</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>xpstopng</refname>
+ <refpurpose>XPS to PNG converter</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>xpstopng</command>
+ <arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
+ <arg choice="plain">FILE</arg>
+ <arg choice="opt"><replaceable>OUTPUT FILE</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>xpstopng</command> converts XPS documents to PNG format.
+ <command>xpstopng</command> reads the XPS file, <replaceable>FILE</replaceable>,
+ and writes a PNG file per page with the page number and file type appended to
+ <replaceable>OUTPUT FILE</replaceable>. If <replaceable>OUTPUT FILE</replaceable>
+ is not specified "page" will be used.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-?</option>, <option>--help</option></term>
+ <listitem>
+ <para>
+ Show help options.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d</option> <replaceable>DOCUMENT</replaceable>, <option>--document</option>=<replaceable>DOCUMENT</replaceable></term>
+ <listitem>
+ <para>
+ The document inside the XPS file to convert. By default, the
+ first document of the XPS file is used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>PAGE</replaceable>, <option>--first</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The first page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-l</option> <replaceable>PAGE</replaceable>, <option>--last</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The last page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option>, <option>--odd</option></term>
+ <listitem>
+ <para>
+ Convert only odd pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-e</option>, <option>--even</option></term>
+ <listitem>
+ <para>
+ Convert only even pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option> <replaceable>RESOLUTION</replaceable>, <option>--resolution</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal and vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--rx</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ry</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-x</option> <replaceable>X</replaceable>, <option>--crop-x</option>=<replaceable>X</replaceable></term>
+ <listitem>
+ <para>
+ The x-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-y</option> <replaceable>Y</replaceable>, <option>--crop-y</option>=<replaceable>Y</replaceable></term>
+ <listitem>
+ <para>
+ The y-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-w</option> <replaceable>WIDTH</replaceable>, <option>--crop-width</option>=<replaceable>WIDTH</replaceable></term>
+ <listitem>
+ <para>
+ The width of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-h</option> <replaceable>HEIGHT</replaceable>, <option>--crop-height</option>=<replaceable>HEIGHT</replaceable></term>
+ <listitem>
+ <para>
+ The height of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-t</option>, <option>--transparent-bg</option></term>
+ <listitem>
+ <para>
+ Use a transparent background for pages instead of white.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Bugs</title>
+ <para>
+ Please send bug reports to
+ <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps";>https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps</ulink>.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>xpstojpeg</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstopdf</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstops</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstosvg</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
diff --git a/docs/tools/xpstops.xml b/docs/tools/xpstops.xml
new file mode 100644
index 0000000..5c66755
--- /dev/null
+++ b/docs/tools/xpstops.xml
@@ -0,0 +1,285 @@
+<refentry id="xpstops" lang="en">
+
+ <refmeta>
+ <refentrytitle>xpstops</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">XPS Tools</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>xpstops</refname>
+ <refpurpose>XPS to PostScript converter</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>xpstops</command>
+ <arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
+ <arg choice="plain">FILE</arg>
+ <arg choice="opt"><replaceable>OUTPUT FILE</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>xpstops</command> converts XPS documents to PostScript format.
+ <command>xpstops</command> reads the XPS file, <replaceable>FILE</replaceable>,
+ and writes a PostScript file, <replaceable>OUTPUT FILE</replaceable>. If
+ <replaceable>OUTPUT FILE</replaceable> is not specified the output
+ filename will be derived from the <replaceable>OUTPUT FILE</replaceable>
+ filename.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-?</option>, <option>--help</option></term>
+ <listitem>
+ <para>
+ Show help options.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d</option> <replaceable>DOCUMENT</replaceable>, <option>--document</option>=<replaceable>DOCUMENT</replaceable></term>
+ <listitem>
+ <para>
+ The document inside the XPS file to convert. By default, the
+ first document of the XPS file is used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>PAGE</replaceable>, <option>--first</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The first page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-l</option> <replaceable>PAGE</replaceable>, <option>--last</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The last page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option>, <option>--odd</option></term>
+ <listitem>
+ <para>
+ Convert only odd pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-e</option>, <option>--even</option></term>
+ <listitem>
+ <para>
+ Convert only even pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option> <replaceable>RESOLUTION</replaceable>, <option>--resolution</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal and vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--rx</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ry</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-x</option> <replaceable>X</replaceable>, <option>--crop-x</option>=<replaceable>X</replaceable></term>
+ <listitem>
+ <para>
+ The x-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-y</option> <replaceable>Y</replaceable>, <option>--crop-y</option>=<replaceable>Y</replaceable></term>
+ <listitem>
+ <para>
+ The y-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-w</option> <replaceable>WIDTH</replaceable>, <option>--crop-width</option>=<replaceable>WIDTH</replaceable></term>
+ <listitem>
+ <para>
+ The width of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-h</option> <replaceable>HEIGHT</replaceable>, <option>--crop-height</option>=<replaceable>HEIGHT</replaceable></term>
+ <listitem>
+ <para>
+ The height of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--level2</option></term>
+ <listitem>
+ <para>
+ Generate Level 2 PostScript. Level 2 supports color images and image compression.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--level3</option></term>
+ <listitem>
+ <para>
+ Generate Level 3 PostScript. This enables all Level 2 features plus shading patterns
+ and masked images. This is the default setting.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--eps</option></term>
+ <listitem>
+ <para>
+ Generate an Encapsulated PostScript (EPS) file.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--paper</option>=<replaceable>PAPER</replaceable></term>
+ <listitem>
+ <para>
+ Set the paper size to one of "A0", "A1", "A2", "A3", "A4", "A5",
+ "B4", "B5", "Letter", "Tabloid", "Ledger", "Legal", "Statement",
+ "Executive", "Folio", "Quarto", "10x14".
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--duplex</option></term>
+ <listitem>
+ <para>
+ Adds the %%IncludeFeature: *Duplex DuplexNoTumble DSC comment to the PostScript file.
+ This tells the print manager to enable duplexing.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--paper-width</option>=<replaceable>WIDTH</replaceable></term>
+ <listitem>
+ <para>
+ The paper width.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--paper-height</option>=<replaceable>HEIGHT</replaceable></term>
+ <listitem>
+ <para>
+ The paper height.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--expand</option></term>
+ <listitem>
+ <para>
+ Expand pages smaller than the paper to fill the paper.
+ By default, pages are not scaled.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--no-shrink</option></term>
+ <listitem>
+ <para>
+ Don't scale pages which are larger than the paper.
+ By default, pages larger than the paper are shrunk to fit.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--no-center</option></term>
+ <listitem>
+ <para>
+ Don't center on the paper pages smaller than the paper (after any scaling).
+ By default, pages smaller than the paper are aligned to the lower-left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Bugs</title>
+ <para>
+ Please send bug reports to
+ <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps";>https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps</ulink>.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>xpstojpeg</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstopng</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstopdf</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstosvg</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
diff --git a/docs/tools/xpstosvg.xml b/docs/tools/xpstosvg.xml
new file mode 100644
index 0000000..0fc1640
--- /dev/null
+++ b/docs/tools/xpstosvg.xml
@@ -0,0 +1,236 @@
+<refentry id="xpstosvg" lang="en">
+
+ <refmeta>
+ <refentrytitle>xpstosvg</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">XPS Tools</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>xpstosvg</refname>
+ <refpurpose>XPS to SVG converter</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>xpstosvg</command>
+ <arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
+ <arg choice="plain">FILE</arg>
+ <arg choice="opt"><replaceable>OUTPUT FILE</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>xpstosvg</command> converts XPS documents to SVG format.
+ <command>xpstosvg</command> reads the XPS file, <replaceable>FILE</replaceable>,
+ and writes a SVG file, <replaceable>OUTPUT FILE</replaceable>. If
+ <replaceable>OUTPUT FILE</replaceable> is not specified the output
+ filename will be derived from the <replaceable>OUTPUT FILE</replaceable>
+ filename.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-?</option>, <option>--help</option></term>
+ <listitem>
+ <para>
+ Show help options.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d</option> <replaceable>DOCUMENT</replaceable>, <option>--document</option>=<replaceable>DOCUMENT</replaceable></term>
+ <listitem>
+ <para>
+ The document inside the XPS file to convert. By default, the
+ first document of the XPS file is used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>PAGE</replaceable>, <option>--first</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The first page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-l</option> <replaceable>PAGE</replaceable>, <option>--last</option>=<replaceable>PAGE</replaceable></term>
+ <listitem>
+ <para>
+ The last page to convert.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option>, <option>--odd</option></term>
+ <listitem>
+ <para>
+ Convert only odd pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-e</option>, <option>--even</option></term>
+ <listitem>
+ <para>
+ Convert only even pages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option> <replaceable>RESOLUTION</replaceable>, <option>--resolution</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal and vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--rx</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Horizontal resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ry</option>=<replaceable>RESOLUTION</replaceable></term>
+ <listitem>
+ <para>
+ Vertical resolution in PPI (Pixels Per Inch). The default is 150 PPI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-x</option> <replaceable>X</replaceable>, <option>--crop-x</option>=<replaceable>X</replaceable></term>
+ <listitem>
+ <para>
+ The x-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-y</option> <replaceable>Y</replaceable>, <option>--crop-y</option>=<replaceable>Y</replaceable></term>
+ <listitem>
+ <para>
+ The y-coordinate of the crop area top left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-w</option> <replaceable>WIDTH</replaceable>, <option>--crop-width</option>=<replaceable>WIDTH</replaceable></term>
+ <listitem>
+ <para>
+ The width of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-h</option> <replaceable>HEIGHT</replaceable>, <option>--crop-height</option>=<replaceable>HEIGHT</replaceable></term>
+ <listitem>
+ <para>
+ The height of crop area.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--paper-width</option>=<replaceable>WIDTH</replaceable></term>
+ <listitem>
+ <para>
+ The paper width.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--paper-height</option>=<replaceable>HEIGHT</replaceable></term>
+ <listitem>
+ <para>
+ The paper height.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--expand</option></term>
+ <listitem>
+ <para>
+ Expand pages smaller than the paper to fill the paper.
+ By default, pages are not scaled.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--no-shrink</option></term>
+ <listitem>
+ <para>
+ Don't scale pages which are larger than the paper.
+ By default, pages larger than the paper are shrunk to fit.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--no-center</option></term>
+ <listitem>
+ <para>
+ Don't center on the paper pages smaller than the paper (after any scaling).
+ By default, pages smaller than the paper are aligned to the lower-left corner.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Bugs</title>
+ <para>
+ Please send bug reports to
+ <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps";>https://bugzilla.gnome.org/enter_bug.cgi?product=libgxps</ulink>.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>See also</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>xpstojpeg</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstopng</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstopdf</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+
+ <citerefentry>
+ <refentrytitle>xpstops</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
