source: main/trunk/greenstone2/bin/linux/xpdf-tools/doc/pdfdetach.1@ 32205

Last change on this file since 32205 was 32205, checked in by ak19, 6 years ago

First set of commits to do with implementing the new 'paged_html' output option of PDFPlugin that uses using xpdftools' new pdftohtml. So far tested only on Linux (64 bit), but things work there so I'm optimistically committing the changes since they work. 2. Committing the pre-built Linux binaries of XPDFtools for both 32 and 64 bit built by the XPDF group. 2. To use the correct bitness variant of xpdftools, setup.bash now exports the BITNESS env var, consulted by gsConvert.pl. 3. All the perl code changes to do with using xpdf tools' pdftohtml to generate paged_html and feed it in the desired form into GS(3): gsConvert.pl, PDFPlugin.pm and its parent ConvertBinaryPFile.pm have been modified to make it all work. xpdftools' pdftohtml generates a folder containing an html file and a screenshot for each page in a PDF (as well as an index.html linking to each page's html). However, we want a single html file that contains each individual 'page' html's content in a div, and need to do some further HTML style, attribute and structure modifications to massage the xpdftool output to what we want for GS. In order to parse and manipulate the HTML 'DOM' to do this, we're using the Mojo::DOM package that Dr Bainbridge found and which he's compiled up. Mojo::DOM is therefore also committed in this revision. Some further changes and some display fixes are required, but need to check with the others about that.
File size: 2.8 KB
Line 
1.\" Copyright 2013-2017 Glyph & Cog, LLC
2.TH pdfdetach 1 "10 Aug 2017"
3.SH NAME
4pdfdetach \- Portable Document Format (PDF) document embedded file
5extractor (version 4.00)
6.SH SYNOPSIS
7.B pdfdetach
8[options]
9.RI [ PDF-file ]
10.SH DESCRIPTION
11.B Pdfdetach
12lists or extracts embedded files (attachments) from a Portable
13Document Format (PDF) file.
14.SH CONFIGURATION FILE
15Pdfdetach reads a configuration file at startup. It first tries to
16find the user's private config file, ~/.xpdfrc. If that doesn't
17exist, it looks for a system-wide config file, typically
18/usr/local/etc/xpdfrc (but this location can be changed when pdfinfo
19is built). See the
20.BR xpdfrc (5)
21man page for details.
22.SH OPTIONS
23Some of the following options can be set with configuration file
24commands. These are listed in square brackets with the description of
25the corresponding command line option.
26.TP
27.B \-list
28List all of the embedded files in the PDF file. File names are
29converted to the text encoding specified by the "\-enc" switch.
30.TP
31.BI \-save " number"
32Save the specified embedded file. By default, this uses the file name
33associated with the embedded file (as printed by the "\-list" switch);
34the file name can be changed with the "\-o" switch.
35.TP
36.BI \-saveall
37Save all of the embedded files. This uses the file names associated
38with the embedded files (as printed by the "\-list" switch). By
39default, the files are saved in the current directory; this can be
40changed with the "\-o" switch.
41.TP
42.BI \-o " path"
43Set the file name used when saving an embedded file with the "\-save"
44switch, or the directory used by "\-saveall".
45.TP
46.BI \-enc " encoding-name"
47Sets the encoding to use for text output (embedded file names). The
48.I encoding\-name
49must be defined with the unicodeMap command (see
50.BR xpdfrc (5)).
51This defaults to "Latin1" (which is a built-in encoding).
52.RB "[config file: " textEncoding ]
53.TP
54.BI \-opw " password"
55Specify the owner password for the PDF file. Providing this will
56bypass all security restrictions.
57.TP
58.BI \-upw " password"
59Specify the user password for the PDF file.
60.TP
61.BI \-cfg " config-file"
62Read
63.I config-file
64in place of ~/.xpdfrc or the system-wide config file.
65.TP
66.B \-v
67Print copyright and version information.
68.TP
69.B \-h
70Print usage information.
71.RB ( \-help
72and
73.B \-\-help
74are equivalent.)
75.SH EXIT CODES
76The Xpdf tools use the following exit codes:
77.TP
780
79No error.
80.TP
811
82Error opening a PDF file.
83.TP
842
85Error opening an output file.
86.TP
873
88Error related to PDF permissions.
89.TP
9099
91Other error.
92.SH AUTHOR
93The pdfinfo software and documentation are copyright 1996-2017 Glyph &
94Cog, LLC.
95.SH "SEE ALSO"
96.BR xpdf (1),
97.BR pdftops (1),
98.BR pdftotext (1),
99.BR pdftohtml (1),
100.BR pdfinfo (1),
101.BR pdffonts (1),
102.BR pdftoppm (1),
103.BR pdftopng (1),
104.BR pdfimages (1),
105.BR xpdfrc (5)
106.br
107.B http://www.xpdfreader.com/
Note: See TracBrowser for help on using the repository browser.