| 1 | .\" Copyright 2013-2017 Glyph & Cog, LLC
|
|---|
| 2 | .TH pdfdetach 1 "10 Aug 2017"
|
|---|
| 3 | .SH NAME
|
|---|
| 4 | pdfdetach \- Portable Document Format (PDF) document embedded file
|
|---|
| 5 | extractor (version 4.00)
|
|---|
| 6 | .SH SYNOPSIS
|
|---|
| 7 | .B pdfdetach
|
|---|
| 8 | [options]
|
|---|
| 9 | .RI [ PDF-file ]
|
|---|
| 10 | .SH DESCRIPTION
|
|---|
| 11 | .B Pdfdetach
|
|---|
| 12 | lists or extracts embedded files (attachments) from a Portable
|
|---|
| 13 | Document Format (PDF) file.
|
|---|
| 14 | .SH CONFIGURATION FILE
|
|---|
| 15 | Pdfdetach reads a configuration file at startup. It first tries to
|
|---|
| 16 | find the user's private config file, ~/.xpdfrc. If that doesn't
|
|---|
| 17 | exist, it looks for a system-wide config file, typically
|
|---|
| 18 | /usr/local/etc/xpdfrc (but this location can be changed when pdfinfo
|
|---|
| 19 | is built). See the
|
|---|
| 20 | .BR xpdfrc (5)
|
|---|
| 21 | man page for details.
|
|---|
| 22 | .SH OPTIONS
|
|---|
| 23 | Some of the following options can be set with configuration file
|
|---|
| 24 | commands. These are listed in square brackets with the description of
|
|---|
| 25 | the corresponding command line option.
|
|---|
| 26 | .TP
|
|---|
| 27 | .B \-list
|
|---|
| 28 | List all of the embedded files in the PDF file. File names are
|
|---|
| 29 | converted to the text encoding specified by the "\-enc" switch.
|
|---|
| 30 | .TP
|
|---|
| 31 | .BI \-save " number"
|
|---|
| 32 | Save the specified embedded file. By default, this uses the file name
|
|---|
| 33 | associated with the embedded file (as printed by the "\-list" switch);
|
|---|
| 34 | the file name can be changed with the "\-o" switch.
|
|---|
| 35 | .TP
|
|---|
| 36 | .BI \-saveall
|
|---|
| 37 | Save all of the embedded files. This uses the file names associated
|
|---|
| 38 | with the embedded files (as printed by the "\-list" switch). By
|
|---|
| 39 | default, the files are saved in the current directory; this can be
|
|---|
| 40 | changed with the "\-o" switch.
|
|---|
| 41 | .TP
|
|---|
| 42 | .BI \-o " path"
|
|---|
| 43 | Set the file name used when saving an embedded file with the "\-save"
|
|---|
| 44 | switch, or the directory used by "\-saveall".
|
|---|
| 45 | .TP
|
|---|
| 46 | .BI \-enc " encoding-name"
|
|---|
| 47 | Sets the encoding to use for text output (embedded file names). The
|
|---|
| 48 | .I encoding\-name
|
|---|
| 49 | must be defined with the unicodeMap command (see
|
|---|
| 50 | .BR xpdfrc (5)).
|
|---|
| 51 | This defaults to "Latin1" (which is a built-in encoding).
|
|---|
| 52 | .RB "[config file: " textEncoding ]
|
|---|
| 53 | .TP
|
|---|
| 54 | .BI \-opw " password"
|
|---|
| 55 | Specify the owner password for the PDF file. Providing this will
|
|---|
| 56 | bypass all security restrictions.
|
|---|
| 57 | .TP
|
|---|
| 58 | .BI \-upw " password"
|
|---|
| 59 | Specify the user password for the PDF file.
|
|---|
| 60 | .TP
|
|---|
| 61 | .BI \-cfg " config-file"
|
|---|
| 62 | Read
|
|---|
| 63 | .I config-file
|
|---|
| 64 | in place of ~/.xpdfrc or the system-wide config file.
|
|---|
| 65 | .TP
|
|---|
| 66 | .B \-v
|
|---|
| 67 | Print copyright and version information.
|
|---|
| 68 | .TP
|
|---|
| 69 | .B \-h
|
|---|
| 70 | Print usage information.
|
|---|
| 71 | .RB ( \-help
|
|---|
| 72 | and
|
|---|
| 73 | .B \-\-help
|
|---|
| 74 | are equivalent.)
|
|---|
| 75 | .SH EXIT CODES
|
|---|
| 76 | The Xpdf tools use the following exit codes:
|
|---|
| 77 | .TP
|
|---|
| 78 | 0
|
|---|
| 79 | No error.
|
|---|
| 80 | .TP
|
|---|
| 81 | 1
|
|---|
| 82 | Error opening a PDF file.
|
|---|
| 83 | .TP
|
|---|
| 84 | 2
|
|---|
| 85 | Error opening an output file.
|
|---|
| 86 | .TP
|
|---|
| 87 | 3
|
|---|
| 88 | Error related to PDF permissions.
|
|---|
| 89 | .TP
|
|---|
| 90 | 99
|
|---|
| 91 | Other error.
|
|---|
| 92 | .SH AUTHOR
|
|---|
| 93 | The pdfinfo software and documentation are copyright 1996-2017 Glyph &
|
|---|
| 94 | Cog, 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/
|
|---|
