blob: c80dde72d9d1392fcc27832f2d95ba569ca21e15 [file] [log] [blame]
.\" Copyright 2011 Glyph & Cog, LLC
.TH pdfdetach 1 "15 August 2011"
pdfdetach \- Portable Document Format (PDF) document embedded file
extractor (version 3.03)
.B pdfdetach
.RI [ PDF-file ]
.B Pdfdetach
lists or extracts embedded files (attachments) from a Portable
Document Format (PDF) file.
Pdfdetach reads a configuration file at startup. It first tries to
find the user's private config file, ~/.xpdfrc. If that doesn't
exist, it looks for a system-wide config file, typically
/usr/local/etc/xpdfrc (but this location can be changed when pdfinfo
is built). See the
.BR xpdfrc (5)
man page for details.
Some of the following options can be set with configuration file
commands. These are listed in square brackets with the description of
the corresponding command line option.
.B \-list
List all of the embedded files in the PDF file. File names are
converted to the text encoding specified by the "\-enc" switch.
.BI \-save " number"
Save the specified embedded file. By default, this uses the file name
associated with the embedded file (as printed by the "\-list" switch);
the file name can be changed with the "\-o" switch.
.BI \-saveall
Save all of the embedded files. This uses the file names associated
with the embedded files (as printed by the "\-list" switch). By
default, the files are saved in the current directory; this can be
changed with the "\-o" switch.
.BI \-o " path"
Set the file name used when saving an embedded file with the "\-save"
switch, or the directory used by "\-saveall".
.BI \-enc " encoding-name"
Sets the encoding to use for text output (embedded file names). The
.I encoding\-name
must be defined with the unicodeMap command (see
.BR xpdfrc (5)).
This defaults to "Latin1" (which is a built-in encoding).
.RB "[config file: " textEncoding ]
.BI \-opw " password"
Specify the owner password for the PDF file. Providing this will
bypass all security restrictions.
.BI \-upw " password"
Specify the user password for the PDF file.
.BI \-cfg " config-file"
.I config-file
in place of ~/.xpdfrc or the system-wide config file.
.B \-v
Print copyright and version information.
.B \-h
Print usage information.
.RB ( \-help
.B \-\-help
are equivalent.)
The Xpdf tools use the following exit codes:
No error.
Error opening a PDF file.
Error opening an output file.
Error related to PDF permissions.
Other error.
The pdfinfo software and documentation are copyright 1996-2011 Glyph &
Cog, LLC.
.BR pdfimages (1),
.BR pdffonts (1),
.BR pdfinfo (1),
.BR pdftocairo (1),
.BR pdftohtml (1),
.BR pdftoppm (1),
.BR pdftops (1),
.BR pdftotext (1)