[Python-modules-commits] r13348 - in packages/pdfminer/trunk/debian/manpages (dumppdf.1.xml)

[jwilk at users.alioth.debian.org]

    Date: Tuesday, June 8, 2010 @ 22:37:00
  Author: jwilk
Revision: 13348

Add manpage for dumppdf.

Added:
  packages/pdfminer/trunk/debian/manpages/dumppdf.1.xml

Added: packages/pdfminer/trunk/debian/manpages/dumppdf.1.xml
===================================================================
--- packages/pdfminer/trunk/debian/manpages/dumppdf.1.xml	                        (rev 0)
+++ packages/pdfminer/trunk/debian/manpages/dumppdf.1.xml	2010-06-08 22:37:00 UTC (rev 13348)
@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd">
+<refentry>
+  <refentryinfo>
+    <title>PDFMiner Manual</title>
+    <productname>dumppdf</productname>
+    <authorgroup>
+      <author>
+        <firstname>Jakub</firstname>
+        <surname>Wilk</surname>
+        <contrib>Wrote this manual page for the Debian system.</contrib>
+        <address><email>jwilk at debian.org</email></address>
+      </author>
+      <author>
+        <firstname>Yusuke</firstname>
+        <surname>Shinyama</surname>
+        <contrib>Author of PDFMiner and its original HTML documentation.</contrib>
+        <address><email>yusuke at cs.nyu.edu</email></address>
+      </author>
+    </authorgroup>
+  </refentryinfo>
+  <refmeta>
+    <refentrytitle>dumppdf</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+  <refnamediv>
+    <refname>dumppdf</refname>
+    <refpurpose>dumps internal contents of a PDF files</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>dumppdf</command>
+      <arg choice='opt' rep='repeat'><replaceable>option</replaceable></arg>
+      <arg choice='plain' rep='repeat'><replaceable>file</replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+  <refsection>
+    <title>Description</title>
+    <para>
+      <command>dumppdf</command> dumps the internal contents of a PDF file in pseudo-XML format.
+      This program is primarily for debugging purposes, but it's also possible to extract some
+      meaningful contents 
+    </para>
+  </refsection>
+  <refsection>
+    <title>Options</title>
+    <variablelist>
+      <varlistentry>
+        <term><option>-a</option></term>
+        <listitem>
+          <para>
+            Dump all the objects. By default only the document trailer is printed.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-i <replaceable>objno[,objno,…]</replaceable></option></term>
+        <listitem>
+          <para>
+            Specifies PDF object IDs to display. Comma-separated IDs, or multiple
+            <option>-i</option> options are accepted.  
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-p <replaceable>pageno</replaceable><replaceable>[,pageno,…]</replaceable></option></term>
+        <listitem>
+          <para>
+            Specifies the comma-separated list of the page numbers to be extracted. Page numbers are
+            starting from one. By default, it extracts texts from all the pages.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-r</option></term>
+        <term><option>-b</option></term>
+        <term><option>-t</option></term>
+        <listitem>
+          <para>
+            Specifies the output format of stream contents. Because the contents of stream objects
+            can be very large, they are omitted when none of the options above is specified.
+          </para>
+          <para>
+            With <option>-r</option> option, the “raw” stream contents are dumped without
+            decompression. With <option>-b</option> option, the decompressed
+            contents are dumped as a binary blob. With <option>-t</option> option, the decompressed
+            contents are dumped in a text format, similar to <function>repr()</function> manner.
+            When <option>-r</option> or <option>-b</option> option is given, no stream header is
+            displayed for the ease of saving it to a file.  
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-T</option></term>
+        <listitem>
+          <para>Show the table of contents.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-P <replaceable>password</replaceable></option></term>
+        <listitem>
+          <para>Provides the user password to access PDF contents.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-d</option></term>
+        <listitem>
+          <para>Increase the debug level.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsection>
+  <refsection>
+    <title>Examples</title>
+    <para>
+      Dump all the headers and contents, except stream objects:
+      <screen><prompt>$</prompt> <command>dumppdf</command> -a test.pdf</screen>
+    </para>
+    <para>
+      Dump the table of contents:
+      <screen><prompt>$</prompt> <command>dumppdf</command> -T test.pdf</screen>
+    </para>
+    <para>
+      Extract a JPEG image:
+      <screen><prompt>$</prompt> <command>dumppdf</command> -r -i6 test.pdf > image.jpeg</screen>
+    </para>
+  </refsection>
+  <refsection>
+    <title>See also</title>
+    <para>
+      <citerefentry><refentrytitle>pdf2txt</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    </para>
+  </refsection>
+</refentry>
+
+<!-- vim:set ts=2 sw=2 et:-->


Property changes on: packages/pdfminer/trunk/debian/manpages/dumppdf.1.xml
___________________________________________________________________
Added: svn:mime-type
   + text/xml