diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/pdfdetach.1 | 106 | ||||
| -rw-r--r-- | doc/pdfdetach.cat | 92 | ||||
| -rw-r--r-- | doc/pdffonts.1 | 163 | ||||
| -rw-r--r-- | doc/pdffonts.cat | 118 | ||||
| -rw-r--r-- | doc/pdfimages.1 | 122 | ||||
| -rw-r--r-- | doc/pdfimages.cat | 102 | ||||
| -rw-r--r-- | doc/pdfinfo.1 | 167 | ||||
| -rw-r--r-- | doc/pdfinfo.cat | 117 | ||||
| -rw-r--r-- | doc/pdftohtml.1 | 158 | ||||
| -rw-r--r-- | doc/pdftohtml.cat | 144 | ||||
| -rw-r--r-- | doc/pdftopng.1 | 130 | ||||
| -rw-r--r-- | doc/pdftopng.cat | 107 | ||||
| -rw-r--r-- | doc/pdftoppm.1 | 130 | ||||
| -rw-r--r-- | doc/pdftoppm.cat | 106 | ||||
| -rw-r--r-- | doc/pdftops.1 | 257 | ||||
| -rw-r--r-- | doc/pdftops.cat | 218 | ||||
| -rw-r--r-- | doc/pdftotext.1 | 222 | ||||
| -rw-r--r-- | doc/pdftotext.cat | 184 | ||||
| -rw-r--r-- | doc/sample-xpdfrc | 86 | ||||
| -rw-r--r-- | doc/xpdf.1 | 965 | ||||
| -rw-r--r-- | doc/xpdf.cat | 871 | ||||
| -rw-r--r-- | doc/xpdfrc.5 | 854 | ||||
| -rw-r--r-- | doc/xpdfrc.cat | 786 |
23 files changed, 6205 insertions, 0 deletions
diff --git a/doc/pdfdetach.1 b/doc/pdfdetach.1 new file mode 100644 index 0000000..4d00f37 --- /dev/null +++ b/doc/pdfdetach.1 @@ -0,0 +1,106 @@ +.\" Copyright 2013-2022 Glyph & Cog, LLC +.TH pdfdetach 1 "18 Apr 2022" +.SH NAME +pdfdetach \- Portable Document Format (PDF) document embedded file +extractor (version 4.04) +.SH SYNOPSIS +.B pdfdetach +[options] +.RI [ PDF-file ] +.SH DESCRIPTION +.B Pdfdetach +lists or extracts embedded files (attachments) from a Portable +Document Format (PDF) file. +.SH CONFIGURATION 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 /etc/xpdfrc +(but this location can be changed when pdfinfo is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +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. +.TP +.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. +.TP +.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. +.TP +.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. +.TP +.BI \-o " path" +Set the file name used when saving an embedded file with the "\-save" +switch, or the directory used by "\-saveall". +.TP +.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 ] +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.BI \-cfg " config-file" +Read +.I config-file +in place of ~/.xpdfrc or the system-wide config file. +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdfinfo software and documentation are copyright 1996-2022 Glyph & +Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdfdetach.cat b/doc/pdfdetach.cat new file mode 100644 index 0000000..220bb75 --- /dev/null +++ b/doc/pdfdetach.cat @@ -0,0 +1,92 @@ +pdfdetach(1) General Commands Manual pdfdetach(1) + + + +NAME + pdfdetach - Portable Document Format (PDF) document embedded file + extractor (version 4.04) + +SYNOPSIS + pdfdetach [options] [PDF-file] + +DESCRIPTION + Pdfdetach lists or extracts embedded files (attachments) from a Porta- + ble Document Format (PDF) file. + +CONFIGURATION 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 /etc/xpdfrc (but this + location can be changed when pdfinfo is built). See the xpdfrc(5) man + page for details. + +OPTIONS + Some of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -list List all of the embedded files in the PDF file. File names are + converted to the text encoding specified by the "-enc" switch. + + -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. + + -saveall + Save all of the embedded files. This uses the file names asso- + ciated with the embedded files (as printed by the "-list" + switch). By default, the files are saved in the current direc- + tory; this can be changed with the "-o" switch. + + -o path + Set the file name used when saving an embedded file with the + "-save" switch, or the directory used by "-saveall". + + -enc encoding-name + Sets the encoding to use for text output (embedded file names). + The encoding-name must be defined with the unicodeMap command + (see xpdfrc(5)). This defaults to "Latin1" (which is a built-in + encoding). [config file: textEncoding] + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -cfg config-file + Read config-file in place of ~/.xpdfrc or the system-wide config + file. + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdfinfo software and documentation are copyright 1996-2022 Glyph & + Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftotext(1), pdftohtml(1), pdfinfo(1), pdf- + fonts(1), pdftoppm(1), pdftopng(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdfdetach(1) diff --git a/doc/pdffonts.1 b/doc/pdffonts.1 new file mode 100644 index 0000000..6ee0226 --- /dev/null +++ b/doc/pdffonts.1 @@ -0,0 +1,163 @@ +.\" Copyright 1999-2022 Glyph & Cog, LLC +.TH pdffonts 1 "18 Apr 2022" +.SH NAME +pdffonts \- Portable Document Format (PDF) font analyzer (version +4.04) +.SH SYNOPSIS +.B pdffonts +[options] +.RI [ PDF-file ] +.SH DESCRIPTION +.B Pdffonts +lists the fonts used in a Portable Document Format (PDF) file along +with various information for each font. +.PP +The following information is listed for each font: +.TP +.B name +the font name, exactly as given in the PDF file (potentially including +a subset prefix) +.TP +.B type +the font type -- see below for details +.TP +.B emb +"yes" if the font is embedded in the PDF file +.TP +.B sub +"yes" if the font is a subset +.TP +.B uni +"yes" if there is an explicit "ToUnicode" map in the PDF file (the +absence of a ToUnicode map doesn't necessarily mean that the text +can't be converted to Unicode) +.TP +.B prob +"X" if this font is likely to be problematic when converting text to +Unicode +.TP +.B object ID +the font dictionary object ID (number and generation) +.TP +.B location +the font location (see the +.B \-loc +and +.B \-locPS +options). +.PP +PDF files can contain the following types of fonts: +.PP +.RS +Type 1 +.RE +.RS +Type 1C -- aka Compact Font Format (CFF) +.RE +.RS +Type 1C (OT) -- OpenType with 8-bit CFF data +.RE +.RS +Type 3 +.RE +.RS +TrueType +.RE +.RS +TrueType (OT) -- OpenType with 8-bit TrueType data +.RE +.RS +CID Type 0 -- 16-bit font with no specified type +.RE +.RS +CID Type 0C -- 16-bit PostScript CFF font +.RE +.RS +CID Type 0C (OT) -- OpenType with CID CFF data +.RE +.RS +CID TrueType -- 16-bit TrueType font +.RE +.RS +CID TrueType (OT) -- OpenType with CID TrueType data +.RE +.SH CONFIGURATION FILE +Pdffonts 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 /etc/xpdfrc +(but this location can be changed when pdffonts is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +Many 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. +.TP +.BI \-f " number" +Specifies the first page to analyze. +.TP +.B \-loc +Shows additional information on the location of the font that will be +used when the PDF file is rasterized (with xpdf, pdftoppm, etc.). +.TP +.B \-locPS +Shows additional information on the location of the font that will be +used when the PDF file is converted to PostScript (with pdftops). +.TP +.BI \-l " number" +Specifies the last page to analyze. +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.BI \-cfg " config-file" +Read +.I config-file +in place of ~/.xpdfrc or the system-wide config file. +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdffonts software and documentation are copyright 1996-2022 Glyph +& Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdffonts.cat b/doc/pdffonts.cat new file mode 100644 index 0000000..77fef55 --- /dev/null +++ b/doc/pdffonts.cat @@ -0,0 +1,118 @@ +pdffonts(1) General Commands Manual pdffonts(1) + + + +NAME + pdffonts - Portable Document Format (PDF) font analyzer (version 4.04) + +SYNOPSIS + pdffonts [options] [PDF-file] + +DESCRIPTION + Pdffonts lists the fonts used in a Portable Document Format (PDF) file + along with various information for each font. + + The following information is listed for each font: + + name the font name, exactly as given in the PDF file (potentially + including a subset prefix) + + type the font type -- see below for details + + emb "yes" if the font is embedded in the PDF file + + sub "yes" if the font is a subset + + uni "yes" if there is an explicit "ToUnicode" map in the PDF file + (the absence of a ToUnicode map doesn't necessarily mean that + the text can't be converted to Unicode) + + prob "X" if this font is likely to be problematic when converting + text to Unicode + + object ID + the font dictionary object ID (number and generation) + + location + the font location (see the -loc and -locPS options). + + PDF files can contain the following types of fonts: + + Type 1 + Type 1C -- aka Compact Font Format (CFF) + Type 1C (OT) -- OpenType with 8-bit CFF data + Type 3 + TrueType + TrueType (OT) -- OpenType with 8-bit TrueType data + CID Type 0 -- 16-bit font with no specified type + CID Type 0C -- 16-bit PostScript CFF font + CID Type 0C (OT) -- OpenType with CID CFF data + CID TrueType -- 16-bit TrueType font + CID TrueType (OT) -- OpenType with CID TrueType data + +CONFIGURATION FILE + Pdffonts 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 /etc/xpdfrc (but this + location can be changed when pdffonts is built). See the xpdfrc(5) man + page for details. + +OPTIONS + Many of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -f number + Specifies the first page to analyze. + + -loc Shows additional information on the location of the font that + will be used when the PDF file is rasterized (with xpdf, + pdftoppm, etc.). + + -locPS Shows additional information on the location of the font that + will be used when the PDF file is converted to PostScript (with + pdftops). + + -l number + Specifies the last page to analyze. + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -cfg config-file + Read config-file in place of ~/.xpdfrc or the system-wide config + file. + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdffonts software and documentation are copyright 1996-2022 Glyph & + Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftotext(1), pdftohtml(1), pdfinfo(1), pdfde- + tach(1), pdftoppm(1), pdftopng(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdffonts(1) diff --git a/doc/pdfimages.1 b/doc/pdfimages.1 new file mode 100644 index 0000000..06a9c1f --- /dev/null +++ b/doc/pdfimages.1 @@ -0,0 +1,122 @@ +.\" Copyright 1998-2022 Glyph & Cog, LLC +.TH pdfimages 1 "18 Apr 2022" +.SH NAME +pdfimages \- Portable Document Format (PDF) image extractor +(version 4.04) +.SH SYNOPSIS +.B pdfimages +[options] +.I PDF-file image-root +.SH DESCRIPTION +.B Pdfimages +saves images from a Portable Document Format (PDF) file as Portable +Pixmap (PPM), Portable Graymap (PGM), Portable Bitmap (PBM), or JPEG +files. +.PP +Pdfimages reads the PDF file, scans one or more pages, +.IR PDF-file , +and writes one PPM, PGM, PBM, or JPEG file for each image, +.IR image-root - nnnn . xxx , +where +.I nnnn +is the image number and +.I xxx +is the image type (.ppm, .pgm, .pbm, .jpg). +.PP +NB: pdfimages extracts the raw image data from the PDF file, without +performing any additional transforms. Any rotation, clipping, +color inversion, etc. done by the PDF content stream is ignored. +.SH CONFIGURATION FILE +Pdfimages 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 /etc/xpdfrc +(but this location can be changed when pdfimages is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +Many 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. +.TP +.BI \-f " number" +Specifies the first page to scan. +.TP +.BI \-l " number" +Specifies the last page to scan. +.TP +.B \-j +Normally, all images are written as PBM (for monochrome images), PGM +(for grayscale images), or PPM (for color images) files. With this +option, images in DCT format are saved as JPEG files. All non-DCT +images are saved in PBM/PGM/PPM format as usual. (Inline images are +always saved in PBM/PGM/PPM format.) +.TP +.B \-raw +Write all images in PDF-native formats. Most of the formats are not +standard image formats, so this option is primarily useful as input to +a tool that generates PDF files. (Inline images are always saved in +PBM/PGM/PPM format.) +.TP +.B \-list +Write a one-line summary to stdout for each image. The summary +provides the image file name, the page number, the image width and +height, the horizontal and vertical resolution (DPI) as drawn, the +color space type, and the number of bits per component (BPC). +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.B \-verbose +Print a status message (to stdout) before processing each page. +.RB "[config file: " printStatusInfo ] +.TP +.B \-q +Don't print any messages or errors. +.RB "[config file: " errQuiet ] +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdfimages software and documentation are copyright 1998-2022 Glyph +& Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdfimages.cat b/doc/pdfimages.cat new file mode 100644 index 0000000..7361a3b --- /dev/null +++ b/doc/pdfimages.cat @@ -0,0 +1,102 @@ +pdfimages(1) General Commands Manual pdfimages(1) + + + +NAME + pdfimages - Portable Document Format (PDF) image extractor (version + 4.04) + +SYNOPSIS + pdfimages [options] PDF-file image-root + +DESCRIPTION + Pdfimages saves images from a Portable Document Format (PDF) file as + Portable Pixmap (PPM), Portable Graymap (PGM), Portable Bitmap (PBM), + or JPEG files. + + Pdfimages reads the PDF file, scans one or more pages, PDF-file, and + writes one PPM, PGM, PBM, or JPEG file for each image, image-root- + nnnn.xxx, where nnnn is the image number and xxx is the image type + (.ppm, .pgm, .pbm, .jpg). + + NB: pdfimages extracts the raw image data from the PDF file, without + performing any additional transforms. Any rotation, clipping, color + inversion, etc. done by the PDF content stream is ignored. + +CONFIGURATION FILE + Pdfimages 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 /etc/xpdfrc (but this + location can be changed when pdfimages is built). See the xpdfrc(5) + man page for details. + +OPTIONS + Many of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -f number + Specifies the first page to scan. + + -l number + Specifies the last page to scan. + + -j Normally, all images are written as PBM (for monochrome images), + PGM (for grayscale images), or PPM (for color images) files. + With this option, images in DCT format are saved as JPEG files. + All non-DCT images are saved in PBM/PGM/PPM format as usual. + (Inline images are always saved in PBM/PGM/PPM format.) + + -raw Write all images in PDF-native formats. Most of the formats are + not standard image formats, so this option is primarily useful + as input to a tool that generates PDF files. (Inline images are + always saved in PBM/PGM/PPM format.) + + -list Write a one-line summary to stdout for each image. The summary + provides the image file name, the page number, the image width + and height, the horizontal and vertical resolution (DPI) as + drawn, the color space type, and the number of bits per compo- + nent (BPC). + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -verbose + Print a status message (to stdout) before processing each page. + [config file: printStatusInfo] + + -q Don't print any messages or errors. [config file: errQuiet] + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdfimages software and documentation are copyright 1998-2022 Glyph + & Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftotext(1), pdftohtml(1), pdfinfo(1), pdf- + fonts(1), pdfdetach(1), pdftoppm(1), pdftopng(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdfimages(1) diff --git a/doc/pdfinfo.1 b/doc/pdfinfo.1 new file mode 100644 index 0000000..66f3e70 --- /dev/null +++ b/doc/pdfinfo.1 @@ -0,0 +1,167 @@ +.\" Copyright 1999-2022 Glyph & Cog, LLC +.TH pdfinfo 1 "18 Apr 2022" +.SH NAME +pdfinfo \- Portable Document Format (PDF) document information +extractor (version 4.04) +.SH SYNOPSIS +.B pdfinfo +[options] +.RI [ PDF-file ] +.SH DESCRIPTION +.B Pdfinfo +prints the contents of the \'Info' dictionary (plus some other useful +information) from a Portable Document Format (PDF) file. +.PP +The \'Info' dictionary contains the following values: +.PP +.RS +title +.RE +.RS +subject +.RE +.RS +keywords +.RE +.RS +author +.RE +.RS +creator +.RE +.RS +producer +.RE +.RS +creation date +.RE +.RS +modification date +.RE +.PP +In addition, the following information is printed: +.PP +.RS +tagged (yes/no) +.RE +.RS +form (AcroForm / static XFA / dynamic XFA / none) +.RE +.RS +page count +.RE +.RS +encrypted flag (yes/no) +.RE +.RS +print and copy permissions (if encrypted) +.RE +.RS +page size and rotation +.RE +.RS +file size +.RE +.RS +linearized (yes/no) +.RE +.RS +PDF version +.RE +.RS +metadata (only if requested) +.RE +.SH CONFIGURATION FILE +Pdfinfo 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 /etc/xpdfrc (but this +location can be changed when pdfinfo is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +Many 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. +.TP +.BI \-f " number" +Specifies the first page to examine. If multiple pages are requested +using the "\-f" and "\-l" options, the size of each requested page +(and, optionally, the bounding boxes for each requested page) are +printed. Otherwise, only page one is examined. +.TP +.BI \-l " number" +Specifies the last page to examine. +.TP +.B \-box +Prints the page box bounding boxes: MediaBox, CropBox, BleedBox, +TrimBox, and ArtBox. +.TP +.B \-meta +Prints document-level metadata. (This is the "Metadata" stream from +the PDF file's Catalog object.) +.TP +.B \-rawdates +Prints the raw (undecoded) date strings, directly from the PDF file. +.TP +.BI \-enc " encoding-name" +Sets the encoding to use for text output. 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 ] +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.BI \-cfg " config-file" +Read +.I config-file +in place of ~/.xpdfrc or the system-wide config file. +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdfinfo software and documentation are copyright 1996-2022 Glyph & +Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdfinfo.cat b/doc/pdfinfo.cat new file mode 100644 index 0000000..05dbc38 --- /dev/null +++ b/doc/pdfinfo.cat @@ -0,0 +1,117 @@ +pdfinfo(1) General Commands Manual pdfinfo(1) + + + +NAME + pdfinfo - Portable Document Format (PDF) document information extractor + (version 4.04) + +SYNOPSIS + pdfinfo [options] [PDF-file] + +DESCRIPTION + Pdfinfo prints the contents of the 'Info' dictionary (plus some other + useful information) from a Portable Document Format (PDF) file. + + The 'Info' dictionary contains the following values: + + title + subject + keywords + author + creator + producer + creation date + modification date + + In addition, the following information is printed: + + tagged (yes/no) + form (AcroForm / static XFA / dynamic XFA / none) + page count + encrypted flag (yes/no) + print and copy permissions (if encrypted) + page size and rotation + file size + linearized (yes/no) + PDF version + metadata (only if requested) + +CONFIGURATION FILE + Pdfinfo 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 /etc/xpdfrc (but this + location can be changed when pdfinfo is built). See the xpdfrc(5) man + page for details. + +OPTIONS + Many of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -f number + Specifies the first page to examine. If multiple pages are + requested using the "-f" and "-l" options, the size of each + requested page (and, optionally, the bounding boxes for each + requested page) are printed. Otherwise, only page one is exam- + ined. + + -l number + Specifies the last page to examine. + + -box Prints the page box bounding boxes: MediaBox, CropBox, BleedBox, + TrimBox, and ArtBox. + + -meta Prints document-level metadata. (This is the "Metadata" stream + from the PDF file's Catalog object.) + + -rawdates + Prints the raw (undecoded) date strings, directly from the PDF + file. + + -enc encoding-name + Sets the encoding to use for text output. The encoding-name + must be defined with the unicodeMap command (see xpdfrc(5)). + This defaults to "Latin1" (which is a built-in encoding). [con- + fig file: textEncoding] + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -cfg config-file + Read config-file in place of ~/.xpdfrc or the system-wide config + file. + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdfinfo software and documentation are copyright 1996-2022 Glyph & + Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftotext(1), pdftohtml(1), pdffonts(1), pdfde- + tach(1), pdftoppm(1), pdftopng(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdfinfo(1) diff --git a/doc/pdftohtml.1 b/doc/pdftohtml.1 new file mode 100644 index 0000000..5129f0d --- /dev/null +++ b/doc/pdftohtml.1 @@ -0,0 +1,158 @@ +.\" Copyright 1997-2022 Glyph & Cog, LLC +.TH pdftohtml 1 "18 Apr 2022" +.SH NAME +pdftohtml \- Portable Document Format (PDF) to HTML converter +(version 4.04) +.SH SYNOPSIS +.B pdftohtml +[options] +.I PDF-file +.I HTML-dir +.SH DESCRIPTION +.B Pdftohtml +converts Portable Document Format (PDF) files to HTML. +.PP +Pdftohtml reads the PDF file, +.IR PDF-file , +and places an HTML file for each page, along with auxiliary images +in the directory, +.IR HTML-dir . +The HTML directory will be created; if it already exists, pdftohtml +will report an error. +.SH CONFIGURATION FILE +Pdftohtml 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 /etc/xpdfrc +(but this location can be changed when pdftohtml is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +Many 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. +.TP +.BI \-f " number" +Specifies the first page to convert. +.TP +.BI \-l " number" +Specifies the last page to convert. +.TP +.BI \-z " number" +Specifies the initial zoom level. The default is 1.0, which means +72dpi, i.e., 1 point in the PDF file will be 1 pixel in the HTML. +Using \'-z 1.5', for example, will make the initial view 50% larger. +.TP +.BI \-r " number" +Specifies the resolution, in DPI, for background images. This +controls the pixel size of the background image files. The initial +zoom level is controlled by the \'-z' option. Specifying a larger +\'-r' value will allow the viewer to zoom in farther without upscaling +artifacts in the background. +.TP +.BI \-vstretch " number" +Specifies a vertical stretch factor. Setting this to a value greater +than 1.0 will stretch each page vertically, spreading out the lines. +This also stretches the background image to match. +.TP +.B \-embedbackground +Embeds the background image as base64-encoded data directly in the +HTML file, rather than storing it as a separate file. +.TP +.B \-nofonts +Disable extraction of embedded fonts. By default, pdftohtml extracts +TrueType and OpenType fonts. Disabling extraction can work around +problems with buggy fonts. +.TP +.B \-embedfonts +Embeds any extracted fonts as base64-encoded data directly in the HTML +file, rather than storing them as separate files. +.TP +.B \-skipinvisible +Don't draw invisible text. By default, invisible text (commonly used +in OCR'ed PDF files) is drawn as transparent (alpha=0) HTML text. +This option tells pdftohtml to discard invisible text entirely. +.TP +.B \-allinvisible +Treat all text as invisible. By default, regular (non-invisible) text +is not drawn in the background image, and is instead drawn with HTML +on top of the image. This option tells pdftohtml to include the +regular text in the background image, and then draw it as transparent +(alpha=0) HTML text. +.TP +.B \-formfields +Convert AcroForm text and checkbox fields to HTML input elements. +This also removes text (e.g., underscore characters) and erases +background image content (e.g., lines or boxes) in the field areas. +.TP +.B \-table +Use table mode when performing the underlying text extraction. This +will generally produce better output when the PDF content is a +full-page table. NB: This does not generate HTML tables; it just +changes the way text is split up. +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.B \-verbose +Print a status message (to stdout) before processing each page. +.RB "[config file: " printStatusInfo ] +.TP +.B \-q +Don't print any messages or errors. +.RB "[config file: " errQuiet ] +.TP +.BI \-cfg " config-file" +Read +.I config-file +in place of ~/.xpdfrc or the system-wide config file. +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH BUGS +Some PDF files contain fonts whose encodings have been mangled beyond +recognition. There is no way (short of OCR) to extract text from +these files. +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdftohtml software and documentation are copyright 1996-2022 Glyph +& Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftotext (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdftohtml.cat b/doc/pdftohtml.cat new file mode 100644 index 0000000..5ddbfa0 --- /dev/null +++ b/doc/pdftohtml.cat @@ -0,0 +1,144 @@ +pdftohtml(1) General Commands Manual pdftohtml(1) + + + +NAME + pdftohtml - Portable Document Format (PDF) to HTML converter (version + 4.04) + +SYNOPSIS + pdftohtml [options] PDF-file HTML-dir + +DESCRIPTION + Pdftohtml converts Portable Document Format (PDF) files to HTML. + + Pdftohtml reads the PDF file, PDF-file, and places an HTML file for + each page, along with auxiliary images in the directory, HTML-dir. The + HTML directory will be created; if it already exists, pdftohtml will + report an error. + +CONFIGURATION FILE + Pdftohtml 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 /etc/xpdfrc (but this + location can be changed when pdftohtml is built). See the xpdfrc(5) + man page for details. + +OPTIONS + Many of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -f number + Specifies the first page to convert. + + -l number + Specifies the last page to convert. + + -z number + Specifies the initial zoom level. The default is 1.0, which + means 72dpi, i.e., 1 point in the PDF file will be 1 pixel in + the HTML. Using '-z 1.5', for example, will make the initial + view 50% larger. + + -r number + Specifies the resolution, in DPI, for background images. This + controls the pixel size of the background image files. The ini- + tial zoom level is controlled by the '-z' option. Specifying a + larger '-r' value will allow the viewer to zoom in farther with- + out upscaling artifacts in the background. + + -vstretch number + Specifies a vertical stretch factor. Setting this to a value + greater than 1.0 will stretch each page vertically, spreading + out the lines. This also stretches the background image to + match. + + -embedbackground + Embeds the background image as base64-encoded data directly in + the HTML file, rather than storing it as a separate file. + + -nofonts + Disable extraction of embedded fonts. By default, pdftohtml + extracts TrueType and OpenType fonts. Disabling extraction can + work around problems with buggy fonts. + + -embedfonts + Embeds any extracted fonts as base64-encoded data directly in + the HTML file, rather than storing them as separate files. + + -skipinvisible + Don't draw invisible text. By default, invisible text (commonly + used in OCR'ed PDF files) is drawn as transparent (alpha=0) HTML + text. This option tells pdftohtml to discard invisible text + entirely. + + -allinvisible + Treat all text as invisible. By default, regular (non-invisi- + ble) text is not drawn in the background image, and is instead + drawn with HTML on top of the image. This option tells pdfto- + html to include the regular text in the background image, and + then draw it as transparent (alpha=0) HTML text. + + -formfields + Convert AcroForm text and checkbox fields to HTML input ele- + ments. This also removes text (e.g., underscore characters) and + erases background image content (e.g., lines or boxes) in the + field areas. + + -table Use table mode when performing the underlying text extraction. + This will generally produce better output when the PDF content + is a full-page table. NB: This does not generate HTML tables; + it just changes the way text is split up. + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -verbose + Print a status message (to stdout) before processing each page. + [config file: printStatusInfo] + + -q Don't print any messages or errors. [config file: errQuiet] + + -cfg config-file + Read config-file in place of ~/.xpdfrc or the system-wide config + file. + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +BUGS + Some PDF files contain fonts whose encodings have been mangled beyond + recognition. There is no way (short of OCR) to extract text from these + files. + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdftohtml software and documentation are copyright 1996-2022 Glyph + & Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftotext(1), pdfinfo(1), pdffonts(1), pdfde- + tach(1), pdftoppm(1), pdftopng(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdftohtml(1) diff --git a/doc/pdftopng.1 b/doc/pdftopng.1 new file mode 100644 index 0000000..1193120 --- /dev/null +++ b/doc/pdftopng.1 @@ -0,0 +1,130 @@ +.\" Copyright 2017-2022 Glyph & Cog, LLC +.TH pdftopng 1 "18 Apr 2022" +.SH NAME +pdftopng \- Portable Document Format (PDF) to Portable Network Graphics +(PNG) converter (version 4.04) +.SH SYNOPSIS +.B pdftopng +[options] +.I PDF-file PNG-root +.SH DESCRIPTION +.B Pdftopng +converts Portable Document Format (PDF) files to color, grayscale, or +monochrome image files in Portable Network Graphics (PNG) format. +.PP +Pdftopng reads the PDF file, +.IR PDF-file , +and writes one PNG file for each page, +.IR PNG-root - nnnnnn .png, +where +.I nnnnnn +is the page number. +If +.I PNG-root +is \'-', the image is sent to stdout (this is probably only useful +when converting a single page). +.SH CONFIGURATION FILE +Pdftopng 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 /etc/xpdfrc +(but this location can be changed when pdftopng is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +Many 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. +.TP +.BI \-f " number" +Specifies the first page to convert. +.TP +.BI \-l " number" +Specifies the last page to convert. +.TP +.BI \-r " number" +Specifies the resolution, in DPI. The default is 150 DPI. +.TP +.B \-mono +Generate a monochrome image (instead of a color image). +.TP +.B \-gray +Generate a grayscale image (instead of a color image). +.TP +.B \-alpha +Generate an alpha channel in the PNG file. This is only useful with +PDF files that have been constructed with a transparent background. +The \-alpha flag cannot be used with \-mono. +.TP +.BI \-rot " angle" +Rotate pages by 0 (the default), 90, 180, or 270 degrees. +.TP +.BI \-freetype " yes | no" +Enable or disable FreeType (a TrueType / Type 1 font rasterizer). +This defaults to "yes". +.RB "[config file: " enableFreeType ] +.TP +.BI \-aa " yes | no" +Enable or disable font anti-aliasing. This defaults to "yes". +.RB "[config file: " antialias ] +.TP +.BI \-aaVector " yes | no" +Enable or disable vector anti-aliasing. This defaults to "yes". +.RB "[config file: " vectorAntialias ] +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.B \-verbose +Print a status message (to stdout) before processing each page. +.RB "[config file: " printStatusInfo ] +.TP +.B \-q +Don't print any messages or errors. +.RB "[config file: " errQuiet ] +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdftopng software and documentation are copyright 1996-2022 Glyph +& Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdftopng.cat b/doc/pdftopng.cat new file mode 100644 index 0000000..10a4408 --- /dev/null +++ b/doc/pdftopng.cat @@ -0,0 +1,107 @@ +pdftopng(1) General Commands Manual pdftopng(1) + + + +NAME + pdftopng - Portable Document Format (PDF) to Portable Network Graphics + (PNG) converter (version 4.04) + +SYNOPSIS + pdftopng [options] PDF-file PNG-root + +DESCRIPTION + Pdftopng converts Portable Document Format (PDF) files to color, + grayscale, or monochrome image files in Portable Network Graphics (PNG) + format. + + Pdftopng reads the PDF file, PDF-file, and writes one PNG file for each + page, PNG-root-nnnnnn.png, where nnnnnn is the page number. If PNG- + root is '-', the image is sent to stdout (this is probably only useful + when converting a single page). + +CONFIGURATION FILE + Pdftopng 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 /etc/xpdfrc (but this + location can be changed when pdftopng is built). See the xpdfrc(5) man + page for details. + +OPTIONS + Many of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -f number + Specifies the first page to convert. + + -l number + Specifies the last page to convert. + + -r number + Specifies the resolution, in DPI. The default is 150 DPI. + + -mono Generate a monochrome image (instead of a color image). + + -gray Generate a grayscale image (instead of a color image). + + -alpha Generate an alpha channel in the PNG file. This is only useful + with PDF files that have been constructed with a transparent + background. The -alpha flag cannot be used with -mono. + + -rot angle + Rotate pages by 0 (the default), 90, 180, or 270 degrees. + + -freetype yes | no + Enable or disable FreeType (a TrueType / Type 1 font raster- + izer). This defaults to "yes". [config file: enableFreeType] + + -aa yes | no + Enable or disable font anti-aliasing. This defaults to "yes". + [config file: antialias] + + -aaVector yes | no + Enable or disable vector anti-aliasing. This defaults to "yes". + [config file: vectorAntialias] + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -verbose + Print a status message (to stdout) before processing each page. + [config file: printStatusInfo] + + -q Don't print any messages or errors. [config file: errQuiet] + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdftopng software and documentation are copyright 1996-2022 Glyph & + Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftotext(1), pdftohtml(1), pdfinfo(1), pdf- + fonts(1), pdfdetach(1), pdftoppm(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdftopng(1) diff --git a/doc/pdftoppm.1 b/doc/pdftoppm.1 new file mode 100644 index 0000000..d485b2b --- /dev/null +++ b/doc/pdftoppm.1 @@ -0,0 +1,130 @@ +.\" Copyright 2005-2022 Glyph & Cog, LLC +.TH pdftoppm 1 "18 Apr 2022" +.SH NAME +pdftoppm \- Portable Document Format (PDF) to Portable Pixmap (PPM) +converter (version 4.04) +.SH SYNOPSIS +.B pdftoppm +[options] +.I PDF-file PPM-root +.SH DESCRIPTION +.B Pdftoppm +converts Portable Document Format (PDF) files to color image files in +Portable Pixmap (PPM) format, grayscale image files in Portable +Graymap (PGM) format, or monochrome image files in Portable Bitmap +(PBM) format. +.PP +Pdftoppm reads the PDF file, +.IR PDF-file , +and writes one PPM file for each page, +.IR PPM-root - nnnnnn .ppm, +where +.I nnnnnn +is the page number. +If +.I PPM-root +is \'-', the image is sent to stdout (this is probably only useful +when converting a single page). +.SH CONFIGURATION FILE +Pdftoppm 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 /etc/xpdfrc +(but this location can be changed when pdftoppm is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +Many 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. +.TP +.BI \-f " number" +Specifies the first page to convert. +.TP +.BI \-l " number" +Specifies the last page to convert. +.TP +.BI \-r " number" +Specifies the resolution, in DPI. The default is 150 DPI. +.TP +.B \-mono +Generate a monochrome PBM file (instead of an RGB PPM file). +.TP +.B \-gray +Generate a grayscale PGM file (instead of an RGB PPM file). +.TP +.B \-cmyk +Generate a CMYK PAM file (instead of an RGB PPM file). +.TP +.BI \-rot " angle" +Rotate pages by 0 (the default), 90, 180, or 270 degrees. +.TP +.BI \-freetype " yes | no" +Enable or disable FreeType (a TrueType / Type 1 font rasterizer). +This defaults to "yes". +.RB "[config file: " enableFreeType ] +.TP +.BI \-aa " yes | no" +Enable or disable font anti-aliasing. This defaults to "yes". +.RB "[config file: " antialias ] +.TP +.BI \-aaVector " yes | no" +Enable or disable vector anti-aliasing. This defaults to "yes". +.RB "[config file: " vectorAntialias ] +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.B \-verbose +Print a status message (to stdout) before processing each page. +.RB "[config file: " printStatusInfo ] +.TP +.B \-q +Don't print any messages or errors. +.RB "[config file: " errQuiet ] +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdftoppm software and documentation are copyright 1996-2022 Glyph +& Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftopng (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdftoppm.cat b/doc/pdftoppm.cat new file mode 100644 index 0000000..30d012d --- /dev/null +++ b/doc/pdftoppm.cat @@ -0,0 +1,106 @@ +pdftoppm(1) General Commands Manual pdftoppm(1) + + + +NAME + pdftoppm - Portable Document Format (PDF) to Portable Pixmap (PPM) con- + verter (version 4.04) + +SYNOPSIS + pdftoppm [options] PDF-file PPM-root + +DESCRIPTION + Pdftoppm converts Portable Document Format (PDF) files to color image + files in Portable Pixmap (PPM) format, grayscale image files in Porta- + ble Graymap (PGM) format, or monochrome image files in Portable Bitmap + (PBM) format. + + Pdftoppm reads the PDF file, PDF-file, and writes one PPM file for each + page, PPM-root-nnnnnn.ppm, where nnnnnn is the page number. If PPM- + root is '-', the image is sent to stdout (this is probably only useful + when converting a single page). + +CONFIGURATION FILE + Pdftoppm 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 /etc/xpdfrc (but this + location can be changed when pdftoppm is built). See the xpdfrc(5) man + page for details. + +OPTIONS + Many of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -f number + Specifies the first page to convert. + + -l number + Specifies the last page to convert. + + -r number + Specifies the resolution, in DPI. The default is 150 DPI. + + -mono Generate a monochrome PBM file (instead of an RGB PPM file). + + -gray Generate a grayscale PGM file (instead of an RGB PPM file). + + -cmyk Generate a CMYK PAM file (instead of an RGB PPM file). + + -rot angle + Rotate pages by 0 (the default), 90, 180, or 270 degrees. + + -freetype yes | no + Enable or disable FreeType (a TrueType / Type 1 font raster- + izer). This defaults to "yes". [config file: enableFreeType] + + -aa yes | no + Enable or disable font anti-aliasing. This defaults to "yes". + [config file: antialias] + + -aaVector yes | no + Enable or disable vector anti-aliasing. This defaults to "yes". + [config file: vectorAntialias] + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -verbose + Print a status message (to stdout) before processing each page. + [config file: printStatusInfo] + + -q Don't print any messages or errors. [config file: errQuiet] + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdftoppm software and documentation are copyright 1996-2022 Glyph & + Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftotext(1), pdftohtml(1), pdfinfo(1), pdf- + fonts(1), pdfdetach(1), pdftopng(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdftoppm(1) diff --git a/doc/pdftops.1 b/doc/pdftops.1 new file mode 100644 index 0000000..028e983 --- /dev/null +++ b/doc/pdftops.1 @@ -0,0 +1,257 @@ +.\" Copyright 1996-2022 Glyph & Cog, LLC +.TH pdftops 1 "18 Apr 2022" +.SH NAME +pdftops \- Portable Document Format (PDF) to PostScript converter +(version 4.04) +.SH SYNOPSIS +.B pdftops +[options] +.RI [ PDF-file +.RI [ PS-file ]] +.SH DESCRIPTION +.B Pdftops +converts Portable Document Format (PDF) files to PostScript so they +can be printed. +.PP +Pdftops reads the PDF file, +.IR PDF-file , +and writes a PostScript file, +.IR PS-file . +If +.I PS-file +is not specified, pdftops converts +.I file.pdf +to +.I file.ps +(or +.I file.eps +with the \-eps option). If +.I PS-file +is \'-', the PostScript is sent to stdout. +.SH CONFIGURATION FILE +Pdftops 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 /etc/xpdfrc (but this +location can be changed when pdftops is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +Many 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. +.TP +.BI \-f " number" +Specifies the first page to print. +.TP +.BI \-l " number" +Specifies the last page to print. +.TP +.B \-level1 +Generate Level 1 PostScript. The resulting PostScript files will be +significantly larger (if they contain images), but will print on Level +1 printers. This also converts all images to black and white. No +more than one of the PostScript level options (\-level1, \-level1sep, +\-level2, \-level2sep, \-level3, \-level3sep) may be given. +.RB "[config file: " psLevel ] +.TP +.B \-level1sep +Generate Level 1 separable PostScript. All colors are converted to +CMYK. Images are written with separate stream data for the four +components. +.RB "[config file: " psLevel ] +.TP +.B \-level2 +Generate Level 2 PostScript. Level 2 supports color images and image +compression. This is the default setting. +.RB "[config file: " psLevel ] +.TP +.B \-level2gray +Generate grayscale Level 2 PostScript. All colors, including images, +are converted to grayscale. +.RB "[config file: " psLevel ] +.TP +.B \-level2sep +Generate Level 2 separable PostScript. All colors are converted to +CMYK. The PostScript separation convention operators are used to +handle custom (spot) colors. +.RB "[config file: " psLevel ] +.TP +.B \-level3 +Generate Level 3 PostScript. This enables all Level 2 features plus +CID font embedding and masked image generation. +.RB "[config file: " psLevel ] +.TP +.B \-level3gray +Generate grayscale Level 3 PostScript. All colors, including images, +are converted to grayscale. +.RB "[config file: " psLevel ] +.TP +.B \-level3sep +Generate Level 3 separable PostScript. The separation handling is the +same as for \-level2sep. +.RB "[config file: " psLevel ] +.TP +.B \-eps +Generate an Encapsulated PostScript (EPS) file. An EPS file contains +a single image, so if you use this option with a multi-page PDF file, +you must use \-f and \-l to specify a single page. No more than one of +the mode options (\-eps, \-form) may be given. +.TP +.B \-form +Generate a PostScript form which can be imported by software that +understands forms. A form contains a single page, so if you use this +option with a multi-page PDF file, you must use \-f and \-l to specify a +single page. The \-level1 option cannot be used with \-form. +.TP +.B \-opi +Generate OPI comments for all images and forms which have OPI +information. (This option is only available if pdftops was compiled +with OPI support.) +.RB "[config file: " psOPI ] +.TP +.B \-noembt1 +By default, any Type 1 fonts which are embedded in the PDF file are +copied into the PostScript file. This option causes pdftops to +substitute base fonts instead. Embedded fonts make PostScript files +larger, but may be necessary for readable output. +.RB "[config file: " psEmbedType1Fonts ] +.TP +.B \-noembtt +By default, any TrueType fonts which are embedded in the PDF file are +copied into the PostScript file. This option causes pdftops to +substitute base fonts instead. Embedded fonts make PostScript files +larger, but may be necessary for readable output. Also, some +PostScript interpreters do not have TrueType rasterizers. +.RB "[config file: " psEmbedTrueTypeFonts ] +.TP +.B \-noembcidps +By default, any CID PostScript fonts which are embedded in the PDF +file are copied into the PostScript file. This option disables that +embedding. No attempt is made to substitute for non-embedded CID +PostScript fonts. +.RB "[config file: " psEmbedCIDPostScriptFonts ] +.TP +.B \-noembcidtt +By default, any CID TrueType fonts which are embedded in the PDF file +are copied into the PostScript file. This option disables that +embedding. No attempt is made to substitute for non-embedded CID +TrueType fonts. +.RB "[config file: " psEmbedCIDTrueTypeFonts ] +.TP +.B \-preload +Convert PDF forms to PS procedures, and preload image data. This uses +more memory in the PostScript interpreter, but generates significantly +smaller PS files in situations where, e.g., the same image is drawn on +every page of a long document. +.TP +.BI \-paper " size" +Set the paper size to one of "letter", "legal", "A4", or "A3". This +can also be set to "match", which will set the paper size to match the +size specified in the PDF file. +.RB "[config file: " psPaperSize ] +.TP +.BI \-paperw " size" +Set the paper width, in points. +.RB "[config file: " psPaperSize ] +.TP +.BI \-paperh " size" +Set the paper height, in points. +.RB "[config file: " psPaperSize ] +.TP +.B \-nocrop +By default, output is cropped to the CropBox specified in the PDF +file. This option disables cropping. +.RB "[config file: " psCrop ] +.TP +.B \-expand +Expand PDF pages smaller than the paper to fill the paper. By +default, these pages are not scaled. +.RB "[config file: " psExpandSmaller ] +.TP +.B \-noshrink +Don't scale PDF pages which are larger than the paper. By default, +pages larger than the paper are shrunk to fit. +.RB "[config file: " psShrinkLarger ] +.TP +.B \-nocenter +By default, PDF pages smaller than the paper (after any scaling) are +centered on the paper. This option causes them to be aligned to the +lower-left corner of the paper instead. +.RB "[config file: " psCenter ] +.TP +.B \-pagecrop +Treat the CropBox as the PDF page size. By default, the MediaBox is +used as the page size. +.RB "[config file: " psUseCropBoxAsPage ] +.TP +.B \-userunit +Honor the UserUnit settings on PDF pages when computing page/paper +size. By default, pdftops ignores UserUnit. +.TP +.B \-duplex +Set the Duplex pagedevice entry in the PostScript file. This tells +duplex-capable printers to enable duplexing. +.RB "[config file: " psDuplex ] +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.B \-verbose +Print a status message (to stdout) before processing each page. +.RB "[config file: " printStatusInfo ] +.TP +.B \-q +Don't print any messages or errors. +.RB "[config file: " errQuiet ] +.TP +.BI \-cfg " config-file" +Read +.I config-file +in place of ~/.xpdfrc or the system-wide config file. +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdftops software and documentation are copyright 1996-2022 Glyph & +Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdftops.cat b/doc/pdftops.cat new file mode 100644 index 0000000..ed1c8b7 --- /dev/null +++ b/doc/pdftops.cat @@ -0,0 +1,218 @@ +pdftops(1) General Commands Manual pdftops(1) + + + +NAME + pdftops - Portable Document Format (PDF) to PostScript converter (ver- + sion 4.04) + +SYNOPSIS + pdftops [options] [PDF-file [PS-file]] + +DESCRIPTION + Pdftops converts Portable Document Format (PDF) files to PostScript so + they can be printed. + + Pdftops reads the PDF file, PDF-file, and writes a PostScript file, PS- + file. If PS-file is not specified, pdftops converts file.pdf to + file.ps (or file.eps with the -eps option). If PS-file is '-', the + PostScript is sent to stdout. + +CONFIGURATION FILE + Pdftops 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 /etc/xpdfrc (but this + location can be changed when pdftops is built). See the xpdfrc(5) man + page for details. + +OPTIONS + Many of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -f number + Specifies the first page to print. + + -l number + Specifies the last page to print. + + -level1 + Generate Level 1 PostScript. The resulting PostScript files + will be significantly larger (if they contain images), but will + print on Level 1 printers. This also converts all images to + black and white. No more than one of the PostScript level + options (-level1, -level1sep, -level2, -level2sep, -level3, + -level3sep) may be given. [config file: psLevel] + + -level1sep + Generate Level 1 separable PostScript. All colors are converted + to CMYK. Images are written with separate stream data for the + four components. [config file: psLevel] + + -level2 + Generate Level 2 PostScript. Level 2 supports color images and + image compression. This is the default setting. [config file: + psLevel] + + -level2gray + Generate grayscale Level 2 PostScript. All colors, including + images, are converted to grayscale. [config file: psLevel] + + -level2sep + Generate Level 2 separable PostScript. All colors are converted + to CMYK. The PostScript separation convention operators are + used to handle custom (spot) colors. [config file: psLevel] + + -level3 + Generate Level 3 PostScript. This enables all Level 2 features + plus CID font embedding and masked image generation. [config + file: psLevel] + + -level3gray + Generate grayscale Level 3 PostScript. All colors, including + images, are converted to grayscale. [config file: psLevel] + + -level3sep + Generate Level 3 separable PostScript. The separation handling + is the same as for -level2sep. [config file: psLevel] + + -eps Generate an Encapsulated PostScript (EPS) file. An EPS file + contains a single image, so if you use this option with a multi- + page PDF file, you must use -f and -l to specify a single page. + No more than one of the mode options (-eps, -form) may be given. + + -form Generate a PostScript form which can be imported by software + that understands forms. A form contains a single page, so if + you use this option with a multi-page PDF file, you must use -f + and -l to specify a single page. The -level1 option cannot be + used with -form. + + -opi Generate OPI comments for all images and forms which have OPI + information. (This option is only available if pdftops was com- + piled with OPI support.) [config file: psOPI] + + -noembt1 + By default, any Type 1 fonts which are embedded in the PDF file + are copied into the PostScript file. This option causes pdftops + to substitute base fonts instead. Embedded fonts make Post- + Script files larger, but may be necessary for readable output. + [config file: psEmbedType1Fonts] + + -noembtt + By default, any TrueType fonts which are embedded in the PDF + file are copied into the PostScript file. This option causes + pdftops to substitute base fonts instead. Embedded fonts make + PostScript files larger, but may be necessary for readable out- + put. Also, some PostScript interpreters do not have TrueType + rasterizers. [config file: psEmbedTrueTypeFonts] + + -noembcidps + By default, any CID PostScript fonts which are embedded in the + PDF file are copied into the PostScript file. This option dis- + ables that embedding. No attempt is made to substitute for non- + embedded CID PostScript fonts. [config file: psEmbedCID- + PostScriptFonts] + + -noembcidtt + By default, any CID TrueType fonts which are embedded in the PDF + file are copied into the PostScript file. This option disables + that embedding. No attempt is made to substitute for non-embed- + ded CID TrueType fonts. [config file: psEmbedCIDTrueTypeFonts] + + -preload + Convert PDF forms to PS procedures, and preload image data. + This uses more memory in the PostScript interpreter, but gener- + ates significantly smaller PS files in situations where, e.g., + the same image is drawn on every page of a long document. + + -paper size + Set the paper size to one of "letter", "legal", "A4", or "A3". + This can also be set to "match", which will set the paper size + to match the size specified in the PDF file. [config file: + psPaperSize] + + -paperw size + Set the paper width, in points. [config file: psPaperSize] + + -paperh size + Set the paper height, in points. [config file: psPaperSize] + + -nocrop + By default, output is cropped to the CropBox specified in the + PDF file. This option disables cropping. [config file: psCrop] + + -expand + Expand PDF pages smaller than the paper to fill the paper. By + default, these pages are not scaled. [config file: psExpandS- + maller] + + -noshrink + Don't scale PDF pages which are larger than the paper. By + default, pages larger than the paper are shrunk to fit. [config + file: psShrinkLarger] + + -nocenter + By default, PDF pages smaller than the paper (after any scaling) + are centered on the paper. This option causes them to be + aligned to the lower-left corner of the paper instead. [config + file: psCenter] + + -pagecrop + Treat the CropBox as the PDF page size. By default, the Media- + Box is used as the page size. [config file: psUseCropBoxAsPage] + + -userunit + Honor the UserUnit settings on PDF pages when computing + page/paper size. By default, pdftops ignores UserUnit. + + -duplex + Set the Duplex pagedevice entry in the PostScript file. This + tells duplex-capable printers to enable duplexing. [config + file: psDuplex] + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -verbose + Print a status message (to stdout) before processing each page. + [config file: printStatusInfo] + + -q Don't print any messages or errors. [config file: errQuiet] + + -cfg config-file + Read config-file in place of ~/.xpdfrc or the system-wide config + file. + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdftops software and documentation are copyright 1996-2022 Glyph & + Cog, LLC. + +SEE ALSO + xpdf(1), pdftotext(1), pdftohtml(1), pdfinfo(1), pdffonts(1), pdfde- + tach(1), pdftoppm(1), pdftopng(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdftops(1) diff --git a/doc/pdftotext.1 b/doc/pdftotext.1 new file mode 100644 index 0000000..e5e7d65 --- /dev/null +++ b/doc/pdftotext.1 @@ -0,0 +1,222 @@ +.\" Copyright 1997-2022 Glyph & Cog, LLC +.TH pdftotext 1 "18 Apr 2022" +.SH NAME +pdftotext \- Portable Document Format (PDF) to text converter +(version 4.04) +.SH SYNOPSIS +.B pdftotext +[options] +.RI [ PDF-file +.RI [ text-file ]] +.SH DESCRIPTION +.B Pdftotext +converts Portable Document Format (PDF) files to plain text. +.PP +Pdftotext reads the PDF file, +.IR PDF-file , +and writes a text file, +.IR text-file . +If +.I text-file +is not specified, pdftotext converts +.I file.pdf +to +.IR file.txt . +If +.I text-file +is \'-', the text is sent to stdout. +.SH CONFIGURATION FILE +Pdftotext 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 /etc/xpdfrc +(but this location can be changed when pdftotext is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +Many 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. +.TP +.BI \-f " number" +Specifies the first page to convert. +.TP +.BI \-l " number" +Specifies the last page to convert. +.TP +.B \-layout +Maintain (as best as possible) the original physical layout of the +text. The default is to \'undo' physical layout (columns, +hyphenation, etc.) and output the text in reading order. If the +.B \-fixed +option is given, character spacing within each line will be determined +by the specified character pitch. +.TP +.B \-simple +Similar to +.BR \-layout , +but optimized for simple one-column pages. This mode will do a better +job of maintaining horizontal spacing, but it will only work properly +with a single column of text. +.TP +.B \-simple2 +Similar to +.BR \-simple , +but handles slightly rotated text (e.g., OCR output) better. Only works +for pages with a single column of text. +.TP +.B \-table +Table mode is similar to physical layout mode, but optimized for +tabular data, with the goal of keeping rows and columns aligned (at +the expense of inserting extra whitespace). If the +.B \-fixed +option is given, character spacing within each line will be determined +by the specified character pitch. +.TP +.B \-lineprinter +Line printer mode uses a strict fixed-character-pitch and -height +layout. That is, the page is broken into a grid, and characters are +placed into that grid. If the grid spacing is too small for the +actual characters, the result is extra whitespace. If the grid +spacing is too large, the result is missing whitespace. The grid +spacing can be specified using the +.B \-fixed +and +.B \-linespacing +options. +If one or both are not given on the command line, pdftotext will +attempt to compute appropriate value(s). +.TP +.B \-raw +Keep the text in content stream order. Depending on how the PDF file +was generated, this may or may not be useful. +.TP +.BI \-fixed " number" +Specify the character pitch (character width), in points, for physical +layout, table, or line printer mode. This is ignored in all other +modes. +.TP +.BI \-linespacing " number" +Specify the line spacing, in points, for line printer mode. This is +ignored in all other modes. +.TP +.B \-clip +Text which is hidden because of clipping is removed before doing +layout, and then added back in. This can be helpful for tables where +clipped (invisible) text would overlap the next column. +.TP +.B \-nodiag +Diagonal text, i.e., text that is not close to one of the 0, 90, 180, +or 270 degree axes, is discarded. This is useful to skip watermarks +drawn on top of body text, etc. +.TP +.BI \-enc " encoding-name" +Sets the encoding to use for text output. The +.I encoding\-name +must be defined with the unicodeMap command (see +.BR xpdfrc (5)). +The encoding name is case-sensitive. This defaults to "Latin1" (which +is a built-in encoding). +.RB "[config file: " textEncoding ] +.TP +.BI \-eol " unix | dos | mac" +Sets the end-of-line convention to use for text output. +.RB "[config file: " textEOL ] +.TP +.B \-nopgbrk +Don't insert a page breaks (form feed character) at the end of each +page. +.RB "[config file: " textPageBreaks ] +.TP +.B \-bom +Insert a Unicode byte order marker (BOM) at the start of the text +output. +.TP +.BI \-marginl " number" +Specifies the left margin, in points. Text in the left margin (i.e., +within that many points of the left edge of the page) is discarded. +The default value is zero. +.TP +.BI \-marginr " number" +Specifies the right margin, in points. Text in the right margin +(i.e., within that many points of the right edge of the page) is +discarded. The default value is zero. +.TP +.BI \-margint " number" +Specifies the top margin, in points. Text in the top margin (i.e., +within that many points of the top edge of the page) is discarded. +The default value is zero. +.TP +.BI \-marginb " number" +Specifies the bottom margin, in points. Text in the bottom margin +(i.e., within that many points of the bottom edge of the page) is +discarded. The default value is zero. +.TP +.BI \-opw " password" +Specify the owner password for the PDF file. Providing this will +bypass all security restrictions. +.TP +.BI \-upw " password" +Specify the user password for the PDF file. +.TP +.B \-verbose +Print a status message (to stdout) before processing each page. +.RB "[config file: " printStatusInfo ] +.TP +.B \-q +Don't print any messages or errors. +.RB "[config file: " errQuiet ] +.TP +.BI \-cfg " config-file" +Read +.I config-file +in place of ~/.xpdfrc or the system-wide config file. +.TP +.B \-listencodings +List all available text output encodings, then exit. +.TP +.B \-v +Print copyright and version information, then exit. +.TP +.B \-h +Print usage information, then exit. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.SH BUGS +Some PDF files contain fonts whose encodings have been mangled beyond +recognition. There is no way (short of OCR) to extract text from +these files. +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The pdftotext software and documentation are copyright 1996-2022 Glyph +& Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/pdftotext.cat b/doc/pdftotext.cat new file mode 100644 index 0000000..face257 --- /dev/null +++ b/doc/pdftotext.cat @@ -0,0 +1,184 @@ +pdftotext(1) General Commands Manual pdftotext(1) + + + +NAME + pdftotext - Portable Document Format (PDF) to text converter (version + 4.04) + +SYNOPSIS + pdftotext [options] [PDF-file [text-file]] + +DESCRIPTION + Pdftotext converts Portable Document Format (PDF) files to plain text. + + Pdftotext reads the PDF file, PDF-file, and writes a text file, text- + file. If text-file is not specified, pdftotext converts file.pdf to + file.txt. If text-file is '-', the text is sent to stdout. + +CONFIGURATION FILE + Pdftotext 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 /etc/xpdfrc (but this + location can be changed when pdftotext is built). See the xpdfrc(5) + man page for details. + +OPTIONS + Many of the following options can be set with configuration file com- + mands. These are listed in square brackets with the description of the + corresponding command line option. + + -f number + Specifies the first page to convert. + + -l number + Specifies the last page to convert. + + -layout + Maintain (as best as possible) the original physical layout of + the text. The default is to 'undo' physical layout (columns, + hyphenation, etc.) and output the text in reading order. If the + -fixed option is given, character spacing within each line will + be determined by the specified character pitch. + + -simple + Similar to -layout, but optimized for simple one-column pages. + This mode will do a better job of maintaining horizontal spac- + ing, but it will only work properly with a single column of + text. + + -simple2 + Similar to -simple, but handles slightly rotated text (e.g., OCR + output) better. Only works for pages with a single column of + text. + + -table Table mode is similar to physical layout mode, but optimized for + tabular data, with the goal of keeping rows and columns aligned + (at the expense of inserting extra whitespace). If the -fixed + option is given, character spacing within each line will be + determined by the specified character pitch. + + -lineprinter + Line printer mode uses a strict fixed-character-pitch and + -height layout. That is, the page is broken into a grid, and + characters are placed into that grid. If the grid spacing is + too small for the actual characters, the result is extra white- + space. If the grid spacing is too large, the result is missing + whitespace. The grid spacing can be specified using the -fixed + and -linespacing options. If one or both are not given on the + command line, pdftotext will attempt to compute appropriate + value(s). + + -raw Keep the text in content stream order. Depending on how the PDF + file was generated, this may or may not be useful. + + -fixed number + Specify the character pitch (character width), in points, for + physical layout, table, or line printer mode. This is ignored + in all other modes. + + -linespacing number + Specify the line spacing, in points, for line printer mode. + This is ignored in all other modes. + + -clip Text which is hidden because of clipping is removed before doing + layout, and then added back in. This can be helpful for tables + where clipped (invisible) text would overlap the next column. + + -nodiag + Diagonal text, i.e., text that is not close to one of the 0, 90, + 180, or 270 degree axes, is discarded. This is useful to skip + watermarks drawn on top of body text, etc. + + -enc encoding-name + Sets the encoding to use for text output. The encoding-name + must be defined with the unicodeMap command (see xpdfrc(5)). + The encoding name is case-sensitive. This defaults to "Latin1" + (which is a built-in encoding). [config file: textEncoding] + + -eol unix | dos | mac + Sets the end-of-line convention to use for text output. [config + file: textEOL] + + -nopgbrk + Don't insert a page breaks (form feed character) at the end of + each page. [config file: textPageBreaks] + + -bom Insert a Unicode byte order marker (BOM) at the start of the + text output. + + -marginl number + Specifies the left margin, in points. Text in the left margin + (i.e., within that many points of the left edge of the page) is + discarded. The default value is zero. + + -marginr number + Specifies the right margin, in points. Text in the right margin + (i.e., within that many points of the right edge of the page) is + discarded. The default value is zero. + + -margint number + Specifies the top margin, in points. Text in the top margin + (i.e., within that many points of the top edge of the page) is + discarded. The default value is zero. + + -marginb number + Specifies the bottom margin, in points. Text in the bottom mar- + gin (i.e., within that many points of the bottom edge of the + page) is discarded. The default value is zero. + + -opw password + Specify the owner password for the PDF file. Providing this + will bypass all security restrictions. + + -upw password + Specify the user password for the PDF file. + + -verbose + Print a status message (to stdout) before processing each page. + [config file: printStatusInfo] + + -q Don't print any messages or errors. [config file: errQuiet] + + -cfg config-file + Read config-file in place of ~/.xpdfrc or the system-wide config + file. + + -listencodings + List all available text output encodings, then exit. + + -v Print copyright and version information, then exit. + + -h Print usage information, then exit. (-help and --help are + equivalent.) + +BUGS + Some PDF files contain fonts whose encodings have been mangled beyond + recognition. There is no way (short of OCR) to extract text from these + files. + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The pdftotext software and documentation are copyright 1996-2022 Glyph + & Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftohtml(1), pdfinfo(1), pdffonts(1), pdfde- + tach(1), pdftoppm(1), pdftopng(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 pdftotext(1) diff --git a/doc/sample-xpdfrc b/doc/sample-xpdfrc new file mode 100644 index 0000000..76b45c6 --- /dev/null +++ b/doc/sample-xpdfrc @@ -0,0 +1,86 @@ +#======================================================================== +# +# Sample xpdfrc file +# +# The Xpdf tools look for a config file in two places: +# 1. ~/.xpdfrc +# 2. in a system-wide directory, typically /usr/local/etc/xpdfrc +# +# This sample config file demonstrates some of the more common +# configuration options. Everything here is commented out. You +# should edit things (especially the file/directory paths, since +# they'll likely be different on your system), and uncomment whichever +# options you want to use. For complete details on config file syntax +# and available options, please see the xpdfrc(5) man page. +# +# Also, the Xpdf language support packages each include a set of +# options to be added to the xpdfrc file. +# +# http://www.xpdfreader.com/ +# +#======================================================================== + +#----- display fonts + +# These map the Base-14 fonts to the Type 1 fonts that ship with +# ghostscript. You'll almost certainly want to use something like +# this, but you'll need to adjust this to point to wherever +# ghostscript is installed on your system. (But if the fonts are +# installed in a "standard" location, xpdf will find them +# automatically.) + +#fontFile Times-Roman /usr/local/share/ghostscript/fonts/n021003l.pfb +#fontFile Times-Italic /usr/local/share/ghostscript/fonts/n021023l.pfb +#fontFile Times-Bold /usr/local/share/ghostscript/fonts/n021004l.pfb +#fontFile Times-BoldItalic /usr/local/share/ghostscript/fonts/n021024l.pfb +#fontFile Helvetica /usr/local/share/ghostscript/fonts/n019003l.pfb +#fontFile Helvetica-Oblique /usr/local/share/ghostscript/fonts/n019023l.pfb +#fontFile Helvetica-Bold /usr/local/share/ghostscript/fonts/n019004l.pfb +#fontFile Helvetica-BoldOblique /usr/local/share/ghostscript/fonts/n019024l.pfb +#fontFile Courier /usr/local/share/ghostscript/fonts/n022003l.pfb +#fontFile Courier-Oblique /usr/local/share/ghostscript/fonts/n022023l.pfb +#fontFile Courier-Bold /usr/local/share/ghostscript/fonts/n022004l.pfb +#fontFile Courier-BoldOblique /usr/local/share/ghostscript/fonts/n022024l.pfb +#fontFile Symbol /usr/local/share/ghostscript/fonts/s050000l.pfb +#fontFile ZapfDingbats /usr/local/share/ghostscript/fonts/d050000l.pfb + +# If you need to display PDF files that refer to non-embedded fonts, +# you should add one or more fontDir options to point to the +# directories containing the font files. Xpdf will only look at .pfa, +# .pfb, .ttf, and .ttc files in those directories (other files will +# simply be ignored). + +#fontDir /usr/local/fonts/bakoma + +#----- PostScript output control + +# Set the default PostScript paper size -- this can be letter, legal, +# A4, or A3. You can also specify a paper size as width and height +# (in points). + +#psPaperSize letter + +#----- text output control + +# Choose a text encoding for copy-and-paste and for pdftotext output. +# The Latin1, ASCII7, and UTF-8 encodings are built into Xpdf. Other +# encodings are available in the language support packages. + +#textEncoding UTF-8 + +# Choose the end-of-line convention for multi-line copy-and-past and +# for pdftotext output. The available options are unix, mac, and dos. + +#textEOL unix + +#----- misc settings + +# Enable FreeType, and anti-aliased text. + +#enableFreeType yes +#antialias yes + +# Set the command used to run a web browser when a URL hyperlink is +# clicked. + +#launchCommand viewer-script diff --git a/doc/xpdf.1 b/doc/xpdf.1 new file mode 100644 index 0000000..2eaa95a --- /dev/null +++ b/doc/xpdf.1 @@ -0,0 +1,965 @@ +.\" Copyright 1996-2022 Glyph & Cog, LLC +.TH xpdf 1 "18 Apr 2022" +.SH NAME +xpdf \- Portable Document Format (PDF) file viewer (version 4.04) +.SH SYNOPSIS +.B xpdf +[options] +.RI [ PDF-file +.RI [: page " | +" dest "]] ..." +.PP +.B xpdf +[options] +.B -remote +.IR remote-name " [" command " ...]" +.PP +.B xpdf +[options] +.B -open +.RI "[" PDF-file "]" +.SH DESCRIPTION +.B Xpdf +is a viewer for Portable Document Format (PDF) files. (These are also +sometimes also called \'Acrobat' files, from the name of Adobe's PDF +software.) Xpdf uses the Qt GUI toolkit and runs on Unix, OS X, and +Windows. +.PP +To run xpdf, type: +.PP +.RS +xpdf file.pdf +.RE +.PP +where +.I file.pdf +is your PDF file. The file name can be followed by a page number to +be displayed, prefixed with a colon: +.PP +.RS +xpdf file.pdf :18 +.RE +.PP +or by a named destination, prefixed with \'+' (this is only useful +with PDF files that provide named destination targets): +.PP +.RS +xpdf file.pdf +destinationA +.RE +.PP +If you specify multiple files, they will each be opened in a separate +tab: +.PP +.RS +xpdf file1.pdf file2.pdf :18 file3.pdf +.RE +.PP +You can also start xpdf without opening any files: +.PP +.RS +xpdf +.RE +.SH CONFIGURATION FILE +Xpdf 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 /etc/xpdfrc (but this +location can be changed when xpdf is built). See the +.BR xpdfrc (5) +man page for details. +.SH OPTIONS +The following command line options are available. All command line +options must come before any PDF files to be opened. +.PP +Many of the options can be set with configuration file commands. +These are listed in square brackets with the description of the +corresponding command line option. +.TP +.BI \-geometry " geometry" +Set the initial window geometry. +.TP +.BI \-title " title" +Set the window title. By default, the title will be "xpdf: foo.pdf". +.TP +.BI \-open " \fR[\fPPDF-file\fR]\fP" +This option sets up a default remote server. If Xpdf is already +running (with the "-open" switch), the PDF file (if any) is opened in +a new tab. If Xpdf (with the "-open" switch) is not already running, +starts Xpdf and opens the PDF file (if any). This is useful for GUI +desktop environments, e.g., the typical double-click on a PDF file +case. +.TP +.B \-rv +Set reverse video mode. This reverses the colors of everything except +images. It may not always produce great results for PDF files which +do weird things with color. This also causes the paper color to +default to black. +.TP +.BI \-papercolor " color" +Set the "paper color", i.e., the background of the page display. The +color can be #RRGGBB (hexadecimal) or a named color. This option will +not work well with PDF files that do things like filling in white +behind the text. +.RB "[config file: " paperColor ] +.TP +.BI \-mattecolor " color" +Set the matte color, i.e., the color used for background outside the +actual page area. The color can be #RRGGBB (hexadecimal) or a named +color. +.RB "[config file: " matteColor ] +.TP +.BI \-fsmattecolor " color" +Set the matte color for full-screen mode. The color can be #RRGGBB +(hexadecimal) or a named color. +.RB "[config file: " fullScreenMatteColor ] +.TP +.BI \-z " zoom" +Set the initial zoom factor. A number specifies a zoom percentage, +where 100 means 72 dpi. You may also specify \'page', to fit the page +to the window size, or \'width', to fit the page width to the window +width. +.RB "[config file: " initialZoom ] +.TP +.BI \-rot " angle" +Rotate pages by 0 (the default), 90, 180, or 270 degrees. +.TP +.BI \-aa " yes | no" +Enable or disable font anti-aliasing. This defaults to "yes". +.RB "[config file: " antialias ] +.TP +.BI \-aaVector " yes | no" +Enable or disable vector anti-aliasing. This defaults to "yes". +.RB "[config file: " vectorAntialias ] +.TP +.BI \-enc " encoding-name" +Sets the encoding to use for text output. 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 ] +.TP +.BI \-pw " password" +Specify the password for the PDF file. This can be either the owner +password (which will bypass all security restrictions) or the user +password. +.TP +.B \-fullscreen +Open xpdf in full-screen mode, useful for presentations. +.TP +.BI \-remote " remote-name" +Start Xpdf in remote server mode. See the REMOVE SERVER MODE section. +.TP +.BI \-display " display" +Set the X display (only available with X11). +.TP +.B \-cmd +Print commands as they're executed (useful for debugging). +.RB "[config file: " printCommands ] +.TP +.BI \-tabstate " tabstate-file" +Sets the file used by the loadTabState and saveTabState commands. +.RB "[config file: " tabStateFile ] +.TP +.BI \-cfg " config-file" +Read +.I config-file +in place of ~/.xpdfrc or the system-wide config file. +.TP +.B \-v +Print copyright and version information. +.TP +.B \-h +Print usage information. +.RB ( \-help +and +.B \-\-help +are equivalent.) +.PP +.SH CONTROLS +.SS Toolbar +.TP +.B "toggle sidebar button" +Toggles (i.e., shows or hides) the sidebar. +.TP +.B "status indicator" +This icon is animated while Xpdf is rendering a page. It turns red +when an error or warning has been issued. Clicking on it opens the +error dialog. +.TP +.B "selection mode" +This icon is an "I-beam" in linear selection mode, and an arrow in +block selection mode. Clicking on it toggles between the two +selection modes. +.TP +.B "page number entry box" +Move to a specific page number. Click in the box to activate it, type +the page number, then hit return. This will instead display and +accept page labels, if the "view - page labels" menu item is checked. +.TP +.B "left/right arrow buttons" +Go backward or forward along the history path. +.TP +.B "zoom out/in buttons" +Zoom out or in (i.e., change magnification) incrementally. +.TP +.B "zoom popup menu" +Change the zoom factor (see the description of the \-z option above). +.TP +.B "fit width button" +Change the zoom factor to fit the page width to the window width. +.TP +.B "fit page button" +Change the zoom factor to fit the page to the window size. +.TP +.B "find entry box" +Find a text string. Click in the box to activate it, type a search +string, then hit return. +.TP +.B "find next button" +Find the next occurrence of the search string. +.TP +.B "find previous button" +Find the previous occurrence of the search string. +.TP +.B "find settings button" +Display the current find settings: case sensitive (on/off), find whole +words (on/off). +.PP +.SS Menu bar +The menu bar is above the toolbar. The menu items should be +self-explanatory. +.PP +.SS Tab list +The tab list is on the left, just below the toolbar. It lists all +open tabs. +.PP +.SS Outline/layers/attachments pane +This pane is on the left, below the tab list. The popup allows you to +select from outline, layers, or attachments. +.PP +The outline is a tree-like structure of bookmarks that allows moving +within the PDF file. Not all PDF files have outlines. +.PP +Layers (a.k.a. optional content) allow parts of the PDF content to be +shown or hidden. Not all PDF files have layers. +.PP +Attachments are other files embedded within the PDF file. There is +a 'save' button for each attached file. Not all PDF files have +attachments. +.PP +.SS Text selection +In block selection mode, dragging the mouse with the left button held +down will highlight an arbitrary rectangle. Shift-clicking will +extend the selection. +.PP +In linear selection mode, dragging with the left button will highlight +text in reading order. Double-clicking or triple-clicking will select +a word or a line, respectively. Shift-clicking will extend the +selection. +.PP +Selected text can be copied to the clipboard (with the edit/copy menu +item). On X11, selected text will be available in the X selection +buffer. +.PP +.SS Links +When the mouse is over a hyperlink, the link target will be shown in a +popup near the bottom of the window. +.PP +Clicking on a hyperlink will jump to the link's destination. A link +to another PDF document will make xpdf load that document. A +\'launch' link to an executable program will display a dialog, and if +you click \'ok', execute the program. URL links are opened in a +system-dependent way. (On UNIX, Qt uses the $BROWSER environment +variable.) +.PP +.SS Mouse bindings +The left mouse button is used to select text (see above). +.PP +Clicking on a link with the middle button opens the link in a new tab. +.PP +Dragging the mouse with the middle button held down pans the window. +.PP +The right mouse button opens a popup menu (see +.BR popupMenuCmd " in " xpdfrc (5)). +.PP +.SS Key bindings +This section lists the default key bindings. Bindings can be changed +using the config file (see +.BR xpdfrc (5)). +.TP +.B control-o +Open a new PDF file via a file requester. +.TP +.B control-r +Reload the current PDF file. Note that Xpdf will reload the file +automatically (on a page change or redraw) if it has changed since it +was last loaded. +.TP +.B control-f +Find a text string. This sets keyboard focus to the \'find' box. +.TP +.B control-G +Find next occurrence. +.TP +.B control-C +Copy selected text to the clipboard. +.TP +.B control-P +Print. +.TP +.BR control-0 " (control-zero)" +Set the zoom factor to 125%. +.TP +.BR control-+ " (control-plus)" +Zoom in (increment the zoom factor by 1). +.TP +.BR control-- " (control-minus)" +Zoom out (decrement the zoom factor by 1). +.TP +.B control-s +Save PDF via a file requester. +.TP +.B control-t +Open a new tab. +.TP +.B control-n +Open a new window. +.TP +.B control-w +Close the current tab. Closes the window if this was the last open +tab. Quits the application if this was the last open window. +.TP +.B control-l +Toggle between full-screen and window modes. +.TP +.B control-q +Quit. +.TP +.B control-<tab> +Next tab. +.TP +.B control-shift-<tab> +Previous tab. +.TP +.B control-? +Help. +.TP +.B alt-<left-arrow> +Go backward along the history path. +.TP +.B alt-<right-arrow> +Go forward along the history path. +.TP +.B home +Go to the top left of current page. +.TP +.B control-<home> +Go to the first page. +.TP +.B end +Go to the bottom right of current page. +.TP +.B control-<end> +Go to the last page. +.TP +.BR <space> " or " <PageDown> +Scroll down on the current page; if already at bottom, move to next +page. +.TP +.BR control-<PageDown> " or " control-<down-arrow> +Go to the next page. If <ScrollLock> is active, this maintains the +relative position on the page. +.TP +.B <PageUp> +Scroll up on the current page; if already at top, move to previous +page. +.TP +.BR control-<PageUp> " or " control-<up-arrow> +Go to the previous page. If <ScrollLock> is active, this maintains +the relative position on the page. +.TP +.B <esc> +Exit full-screen mode. +.TP +.B arrows +Scroll the current page. +.TP +.B g +Set keyboard focus to the page number entry box. +.TP +.B z +Set the zoom factor to \'page' (fit page to window). +.TP +.B w +Set the zoom factor to \'width' (fit page width to window). +.SH Full-screen mode +Xpdf can be placed into full-screen mode via the +.B \-fullscreen +command line option, the \'full screen' menu item, or a binding to the +.B fullScreenMode +or +.B toggleFullScreenMode +command. +.PP +Entering full-screen mode automatically switches to single-page view +mode and to the fit-page zoom factor. +.PP +Full-screen mode can be exited via the default <esc> key binding, +or via a binding to the +.B windowMode +or +.BR toggleFullScreenMode command . +.SH COMMANDS +Xpdf's key and mouse bindings are user-configurable, using the bind +and unbind commands in the config file (see +.BR xpdfrc (5)). +The bind command allows you to bind a key or mouse button to a +sequence of one or more commands. +.PP +In commands that take arguments (inside parentheses), special +characters (namely '(', ')', ',', and '\\x01') can be escaped by +preceding them with a '\\x01' character. This is mostly useful in +things like scripts that need to be able to open arbitrary PDF files, +using the \'openFile' command. +.PP +The following commands are supported: +.TP +.B about +Open the \'about' dialog. +.TP +.B blockSelectMode +Set block selection mode. In this mode, the selection is a simple +rectangle. Any part of the page can be selected, regardless of the +content on the page. +.TP +.BI checkOpenFile( file ) +Check that +.I file +is open in the current tab, and open it if not. +.TP +.BI checkOpenFileAtDest( file, dest ) +Check that +.I file +is open in the current tab, and open it if not. In either case go to +the specified named destination. +.TP +.BI checkOpenFileAtPage( file, page ) +Check that +.I file +is open in the current tab, and open it if not. In either case go to +the specified page. +.TP +.B closeSidebar +Close the sidebar. +.TP +.B closeSidebarMoveResizeWin +Close the sidebar, resizing the window so that the document size +doesn't change, and moving the window so that the document stays in +the same place on the screen. +.TP +.B closeSidebarResizeWin +Close the sidebar, resizing the window so that the document size +doesn't change. +.TP +.B closeTabOrQuit +Close the tab. If this was the last open tab, close the window. If +this was the last window open, quit. +.TP +.B closeWindowOrQuit +Close the window. If this was the last open window, quit. +.TP +.B continuousMode +Switch to continuous view mode. +.TP +.B copy +Copy selected text to the clipboard. +.TP +.B copyLinkTarget +Copy the target of the link under the mouse cursor to the clipboard. +.TP +.B endPan +End a pan operation. +.TP +.B endSelection +End a selection. +.TP +.BI expandSidebar( n ) +Expand the sidebar by +.I n +pixels. Opens the sidebar if it is currently closed. +.TP +.B find +Set keyboard focus to the \'find' box. +.TP +.B findFirst +Find the first occurrence of the search string. +.TP +.B findNext +Find the next occurrence of the search string. +.TP +.B findPrevious +Find the previous occurrence of the search string. +.TP +.B focusToDocWin +Set keyboard focus to the main document window. +.TP +.B focusToPageNum +Set keyboard focus to the page number text box. +.TP +.B followLink +Follow a hyperlink (does nothing if the mouse is not over a link). +.TP +.B followLinkInNewTab +Follow a hyperlink, opening PDF files in a new tab (does nothing if +the mouse is not over a link). For links to non-PDF files, this +command is identical to followLink. +.TP +.B followLinkInNewTabNoSel +Same as followLinkInNewTab, but does nothing if there is a non-empty +selection. (This is useful as a mouse button binding.) +.TP +.B followLinkInNewWin +Follow a hyperlink, opening PDF files in a new window (does nothing if +the mouse is not over a link). For links to non-PDF files, this +command is identical to followLink. +.TP +.B followLinkInNewWinNoSel +Same as followLinkInNewWin, but does nothing if there is a non-empty +selection. (This is useful as a mouse button binding.) +.TP +.B followLinkNoSel +Same as followLink, but does nothing if there is a non-empty selection. +(This is useful as a mouse button binding.) +.TP +.B fullScreenMode +Go to full-screen mode. +.TP +.B goBackward +Move backward along the history path. +.TP +.B goForward +Move forward along the history path. +.TP +.BI gotoDest( dest ) +Go to a named destination. +.TP +.B gotoLastPage +Go to the last page in the PDF file. +.TP +.BI gotoPage( page ) +Go to the specified page. +.TP +.BI help +Open the help URL. +.TP +.B hideMenuBar +Hide the menu bar. +.TP +.B hideToolbar +Hide the toolbar. +.TP +.B horizontalContinuousMode +Switch to horizontal continuous view mode. +.TP +.B linearSelectMode +Set linear selection mode. In this mode, the selection follows text. +Non-text regions cannot be selected. +.TP +.BI loadTabState +Load the tab state file (which was written via the saveTabState +command), and restore the tabs listed in that file. The path for the +tab state file is specified with the tabStateFile setting (see +.BR xpdfrc (5)). +.TP +.B newTab +Open an empty new tab. +.TP +.B newWindow +Open an empty new window. +.TP +.B nextPage +Go to the next page. +.TP +.B nextPageNoScroll +Go to the next page, with the current relative scroll position. +.TP +.B nextTab +Switch to the next tab. +.TP +.B open +Open a PDF file in the current tab, using the open dialog. +.TP +.B openErrorWindow +Open the error window. +.TP +.BI openFile( file ) +Open the specified file in the current tab. +.TP +.BI openFile2( file, page, dest, passwd, location ) +Open the specified file. If +.I dest +is not empty, go to the specified named destination. Else, if +.I page +is not empty, go to the specified page number. If +.I password +is not empty, it is used as the PDF password. If +.I location +is "win", open the file in a new window; if it is "tab", open in a new +tab; if it is "check", open in the current tab, but only if the +specified PDF file isn't already open; else open in the current tab. +Any/all of the arguments, other than +.IR file , +can be empty strings. For example: +.nf +openFile2(test.pdf,7,,,tab) +.fi +.TP +.BI openFileAtDest( file, dest ) +Open the specified file in the current tab at the specified named +destination. +.TP +.BI openFileAtDestIn( file, dest, location ) +Open the specified file at the specified named destination. Location +must be "win" for a new window or "tab" for a new tab. +.TP +.BI openFileAtPage( file, page ) +Open the specified file in the current tab at the specified page. +.TP +.BI openFileAtPageIn( file, page, location ) +Open the specified file at the specified page. Location must be "win" +for a new window or "tab" for a new tab. +.TP +.BI openFileIn( file, location ) +Open the specified file. Location must be "win" for a new window or +"tab" for a new tab. +.TP +.BI openIn( location ) +Open a PDF file, using the open dialog. Location must be "win" for a +new window or "tab" for a new tab. +.TP +.B openSidebar +Open the sidebar. +.TP +.B openSidebarMoveResizeWin +Open the sidebar, resizing the window so that the document size +doesn't change, and moving the window so that the document stays in +the same place on the screen. +.TP +.B openSidebarResizeWin +Open the sidebar, resizing the window so that the document size +doesn't change. +.TP +.B pageDown +Scroll down by one screenful. +.TP +.B pageUp +Scroll up by one screenful. +.TP +.B postPopupMenu +Display the popup menu. +.TP +.B prevPage +Go to the previous page. +.TP +.B prevPageNoScroll +Go to the previous page, with the current relative scroll position. +.TP +.B prevTab +Switch to the previous tab. +.TP +.B print +Open the \'print' dialog. +.TP +.B quit +Quit from xpdf. +.TP +.B raise +Bring the xpdf window to the front. +.TP +.B reload +Reload the current PDF file. +.TP +.B rotateCCW +Rotate the page 90 degrees counterclockwise. +.TP +.B rotateCW +Rotate the page 90 degrees clockwise. +.TP +.BI run( external-command-string ) +Run an external command. The following escapes are allowed in the +command string: +.nf + + %f => PDF file name (or an empty string if no + file is open) + %b => PDF file base name, i.e., file name minus + the extension (or an empty string if no + file is open) + %u => link URL (or an empty string if not over + a URL link) + %p => current page number (or an empty string if + no file is open) + %x => selection upper-left x coordinate + (or 0 if there is no selection) + %y => selection upper-left y coordinate + (or 0 if there is no selection) + %X => selection lower-right x coordinate + (or 0 if there is no selection) + %Y => selection lower-right y coordinate + (or 0 if there is no selection) + %i => page containing the mouse pointer + %j => x coordinate of the mouse pointer + %k => y coordinate of the mouse pointer + %% => % + +.fi +The external command string will often contain spaces, so the whole +command must be quoted in the xpdfrc file: +.nf + + bind x "run(ls -l)" + +.fi +The command string may not be run through a shell. It is recommended +to keep the command simple, so that it doesn't depend on specific +shell functionality. For complex things, you can have the command +string run a shell script. +.TP +.B saveAs +Save PDF via a file requester. +.TP +.B saveImage +Open the \'save image' dialog. +.TP +.BI saveTabState +Save a list of all tabs open in this window to the tab state file. +For each tab, this writes the PDF file name and page number (on +separate lines). This file can be loaded later with the loadTabState +command. The path for the tab state file is specified with the +tabStateFile setting (see +.BR xpdfrc (5)). +.TP +.BI scrollDown( n ) +Scroll down by +.I n +pixels. +.TP +.BI scrollDownNextPage( n ) +Scroll down by +.I n +pixels, moving to the next page if appropriate. +.TP +.BI scrollLeft( n ) +Scroll left by +.I n +pixels. +.TP +.BI scrollOutlineDown( n ) +Scroll the outline down by +.I n +increments. +.TP +.BI scrollOutlineUp( n ) +Scroll the outline up by +.I n +increments. +.TP +.BI scrollRight( n ) +Scroll right by +.I n +pixels. +.TP +.B scrollToBottomEdge +Scroll to the bottom edge of the last displayed page, with no +horizontal movement. +.TP +.B scrollToBottomRight +Scroll to the bottom-right corner of the last displayed page. +.TP +.B scrollToLeftEdge +Scroll to the left edge of the current page, with no vertical +movement. +.TP +.B scrollToRightEdge +Scroll to the right edge of the current page, with no vertical +movement. +.TP +.B scrollToTopEdge +Scroll to the top edge of the first displayed page, with no horizontal +movement. +.TP +.B scrollToTopLeft +Scroll to the top-left corner of the first displayed page. +.TP +.BI scrollUp( n ) +Scroll up by +.I n +pixels. +.TP +.BI scrollUpPrevPage( n ) +Scroll up by +.I n +pixels, moving to the previous page if appropriate. +.TP +.B selectLine +Set the selection to the line at the current mouse position. +.TP +.B selectWord +Set the selection to the word at the current mouse position. +.TP +.BI setSelection( pg , ulx , uly , lrx , lry ) +Set the selection to the specified coordinates on the specified page. +.TP +.B showAttachmentsPane +Shows the attachments in the outline/layers/attachments pane. +.TP +.B showDocumentInfo +Open the document information dialog. +.TP +.B showKeyBindings +Open the key bindings dialog. +.TP +.B showLayersPane +Shows the layers in the outline/layers/attachments pane. +.TP +.B showMenuBar +Show the menu bar. +.TP +.B showOutlinePane +Shows the outline in the outline/layers/attachments pane. +.TP +.B showToolbar +Show the toolbar. +.TP +.BI shrinkSidebar( n ) +Shrink the sidebar by +.I n +pixels. Closes the sidebar if shrinking it would go below the minimum +allowed side. +.TP +.B sideBySideContinuousMode +Switch to side-by-side continuous view mode. +.TP +.B sideBySideSingleMode +Switch to side-by-side two-page view mode. +.TP +.B singlePageMode +Switch to single-page view mode. +.TP +.B startExtendedSelection +Extend the selection to the current mouse position, and continue +extending as the mouse moves. +.TP +.B startPan +Start a pan operation at the current mouse position, which will scroll +the document as the mouse moves. +.TP +.B startSelection +Start a selection at the current mouse position, which will be +extended as the mouse moves. +.TP +.B toggleContinuousMode +Toggle between continuous and single page view modes. +.TP +.B toggleFullScreenMode +Toggle between full-screen and window modes. +.TP +.B toggleMenuBar +Toggle the menu bar between shown and hidden. +.TP +.B toggleSelectMode +Toggle between block and linear selection mode. +.TP +.B toggleSidebar +Toggle the sidebar between open and closed. +.TP +.B toggleSidebarMoveResizeWin +Toggle the sidebar between open and closed, resizing the window so +that the document size doesn't change, and moving the window so that +the document stays in the same place on the screen. +.TP +.B toggleSidebarResizeWin +Toggle the sidebar between open and closed, resizing the window so +that the document size doesn't change. +.TP +.B toggleToolbar +Toggle the toolbar between shown and hidden. +.TP +.B viewPageLabels +Show page labels (if the PDF file has them), rather than page numbers. +.TP +.B viewPageNumbers +Show page numbers, rather than page labels. +.TP +.B windowMode +Go to window (non-full-screen) mode. +.TP +.B zoomFitPage +Set the zoom factor to fit-page. +.TP +.B zoomFitWidth +Set the zoom factor to fit-width. +.TP +.B zoomIn +Zoom in - go to the next higher zoom factor. +.TP +.B zoomOut +Zoom out - go the next lower zoom factor. +.TP +.BI zoomPercent( z ) +Set the zoom factor to +.IR z %. +.TP +.B zoomToSelection +Zoom to the current selection. +.SH REMOTE SERVER MODE +Starting xpdf with the "-remote" switch puts it into remote server +mode. All remaining command line options are commands (see the +COMMANDS section). Subsequent invocations of "xpdf -remote" with the +same remote server name will send commands to the already-running +instance of xpdf. The "checkOpenFile" commands are useful here for +things like changing pages. +For example: +.PP +.RS + # Start up xpdf, and open something.pdf. + xpdf -remote foo 'openFile(something.pdf)' + + # Switch to page 7 in the already-open something.pdf. If the user + # has closed xpdf in the meantime, this will restart it and reopen + # the file. + xpdf -remote foo 'checkOpenFileAtPage(something.pdf, 7)' +.RE +.PP +.SH EXIT CODES +The Xpdf tools use the following exit codes: +.TP +0 +No error. +.TP +1 +Error opening a PDF file. +.TP +2 +Error opening an output file. +.TP +3 +Error related to PDF permissions. +.TP +99 +Other error. +.SH AUTHOR +The xpdf software and documentation are copyright 1996-2022 Glyph & +Cog, LLC. +.SH "SEE ALSO" +.BR pdftops (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR pdfimages (1), +.BR xpdfrc (5) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/xpdf.cat b/doc/xpdf.cat new file mode 100644 index 0000000..ba20911 --- /dev/null +++ b/doc/xpdf.cat @@ -0,0 +1,871 @@ +xpdf(1) General Commands Manual xpdf(1) + + + +NAME + xpdf - Portable Document Format (PDF) file viewer (version 4.04) + +SYNOPSIS + xpdf [options] [PDF-file [:page | +dest]] ... + + xpdf [options] -remote remote-name [command ...] + + xpdf [options] -open [PDF-file] + +DESCRIPTION + Xpdf is a viewer for Portable Document Format (PDF) files. (These are + also sometimes also called 'Acrobat' files, from the name of Adobe's + PDF software.) Xpdf uses the Qt GUI toolkit and runs on Unix, OS X, + and Windows. + + To run xpdf, type: + + xpdf file.pdf + + where file.pdf is your PDF file. The file name can be followed by a + page number to be displayed, prefixed with a colon: + + xpdf file.pdf :18 + + or by a named destination, prefixed with '+' (this is only useful with + PDF files that provide named destination targets): + + xpdf file.pdf +destinationA + + If you specify multiple files, they will each be opened in a separate + tab: + + xpdf file1.pdf file2.pdf :18 file3.pdf + + You can also start xpdf without opening any files: + + xpdf + +CONFIGURATION FILE + Xpdf 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 /etc/xpdfrc (but this location + can be changed when xpdf is built). See the xpdfrc(5) man page for + details. + +OPTIONS + The following command line options are available. All command line + options must come before any PDF files to be opened. + + Many of the options can be set with configuration file commands. These + are listed in square brackets with the description of the corresponding + command line option. + + -geometry geometry + Set the initial window geometry. + + -title title + Set the window title. By default, the title will be "xpdf: + foo.pdf". + + -open [PDF-file] + This option sets up a default remote server. If Xpdf is already + running (with the "-open" switch), the PDF file (if any) is + opened in a new tab. If Xpdf (with the "-open" switch) is not + already running, starts Xpdf and opens the PDF file (if any). + This is useful for GUI desktop environments, e.g., the typical + double-click on a PDF file case. + + -rv Set reverse video mode. This reverses the colors of everything + except images. It may not always produce great results for PDF + files which do weird things with color. This also causes the + paper color to default to black. + + -papercolor color + Set the "paper color", i.e., the background of the page display. + The color can be #RRGGBB (hexadecimal) or a named color. This + option will not work well with PDF files that do things like + filling in white behind the text. [config file: paperColor] + + -mattecolor color + Set the matte color, i.e., the color used for background outside + the actual page area. The color can be #RRGGBB (hexadecimal) or + a named color. [config file: matteColor] + + -fsmattecolor color + Set the matte color for full-screen mode. The color can be + #RRGGBB (hexadecimal) or a named color. [config file: + fullScreenMatteColor] + + -z zoom + Set the initial zoom factor. A number specifies a zoom percent- + age, where 100 means 72 dpi. You may also specify 'page', to + fit the page to the window size, or 'width', to fit the page + width to the window width. [config file: initialZoom] + + -rot angle + Rotate pages by 0 (the default), 90, 180, or 270 degrees. + + -aa yes | no + Enable or disable font anti-aliasing. This defaults to "yes". + [config file: antialias] + + -aaVector yes | no + Enable or disable vector anti-aliasing. This defaults to "yes". + [config file: vectorAntialias] + + -enc encoding-name + Sets the encoding to use for text output. The encoding-name + must be defined with the unicodeMap command (see xpdfrc(5)). + This defaults to "Latin1" (which is a built-in encoding). [con- + fig file: textEncoding] + + -pw password + Specify the password for the PDF file. This can be either the + owner password (which will bypass all security restrictions) or + the user password. + + -fullscreen + Open xpdf in full-screen mode, useful for presentations. + + -remote remote-name + Start Xpdf in remote server mode. See the REMOVE SERVER MODE + section. + + -display display + Set the X display (only available with X11). + + -cmd Print commands as they're executed (useful for debugging). + [config file: printCommands] + + -tabstate tabstate-file + Sets the file used by the loadTabState and saveTabState com- + mands. [config file: tabStateFile] + + -cfg config-file + Read config-file in place of ~/.xpdfrc or the system-wide config + file. + + -v Print copyright and version information. + + -h Print usage information. (-help and --help are equivalent.) + +CONTROLS + Toolbar + toggle sidebar button + Toggles (i.e., shows or hides) the sidebar. + + status indicator + This icon is animated while Xpdf is rendering a page. It turns + red when an error or warning has been issued. Clicking on it + opens the error dialog. + + selection mode + This icon is an "I-beam" in linear selection mode, and an arrow + in block selection mode. Clicking on it toggles between the two + selection modes. + + page number entry box + Move to a specific page number. Click in the box to activate + it, type the page number, then hit return. This will instead + display and accept page labels, if the "view - page labels" menu + item is checked. + + left/right arrow buttons + Go backward or forward along the history path. + + zoom out/in buttons + Zoom out or in (i.e., change magnification) incrementally. + + zoom popup menu + Change the zoom factor (see the description of the -z option + above). + + fit width button + Change the zoom factor to fit the page width to the window + width. + + fit page button + Change the zoom factor to fit the page to the window size. + + find entry box + Find a text string. Click in the box to activate it, type a + search string, then hit return. + + find next button + Find the next occurrence of the search string. + + find previous button + Find the previous occurrence of the search string. + + find settings button + Display the current find settings: case sensitive (on/off), find + whole words (on/off). + + Menu bar + The menu bar is above the toolbar. The menu items should be self- + explanatory. + + Tab list + The tab list is on the left, just below the toolbar. It lists all open + tabs. + + Outline/layers/attachments pane + This pane is on the left, below the tab list. The popup allows you to + select from outline, layers, or attachments. + + The outline is a tree-like structure of bookmarks that allows moving + within the PDF file. Not all PDF files have outlines. + + Layers (a.k.a. optional content) allow parts of the PDF content to be + shown or hidden. Not all PDF files have layers. + + Attachments are other files embedded within the PDF file. There is a + 'save' button for each attached file. Not all PDF files have attach- + ments. + + Text selection + In block selection mode, dragging the mouse with the left button held + down will highlight an arbitrary rectangle. Shift-clicking will extend + the selection. + + In linear selection mode, dragging with the left button will highlight + text in reading order. Double-clicking or triple-clicking will select + a word or a line, respectively. Shift-clicking will extend the selec- + tion. + + Selected text can be copied to the clipboard (with the edit/copy menu + item). On X11, selected text will be available in the X selection buf- + fer. + + Links + When the mouse is over a hyperlink, the link target will be shown in a + popup near the bottom of the window. + + Clicking on a hyperlink will jump to the link's destination. A link to + another PDF document will make xpdf load that document. A 'launch' + link to an executable program will display a dialog, and if you click + 'ok', execute the program. URL links are opened in a system-dependent + way. (On UNIX, Qt uses the $BROWSER environment variable.) + + Mouse bindings + The left mouse button is used to select text (see above). + + Clicking on a link with the middle button opens the link in a new tab. + + Dragging the mouse with the middle button held down pans the window. + + The right mouse button opens a popup menu (see popupMenuCmd in + xpdfrc(5)). + + Key bindings + This section lists the default key bindings. Bindings can be changed + using the config file (see xpdfrc(5)). + + control-o + Open a new PDF file via a file requester. + + control-r + Reload the current PDF file. Note that Xpdf will reload the + file automatically (on a page change or redraw) if it has + changed since it was last loaded. + + control-f + Find a text string. This sets keyboard focus to the 'find' box. + + control-G + Find next occurrence. + + control-C + Copy selected text to the clipboard. + + control-P + Print. + + control-0 (control-zero) + Set the zoom factor to 125%. + + control-+ (control-plus) + Zoom in (increment the zoom factor by 1). + + control-- (control-minus) + Zoom out (decrement the zoom factor by 1). + + control-s + Save PDF via a file requester. + + control-t + Open a new tab. + + control-n + Open a new window. + + control-w + Close the current tab. Closes the window if this was the last + open tab. Quits the application if this was the last open win- + dow. + + control-l + Toggle between full-screen and window modes. + + control-q + Quit. + + control-<tab> + Next tab. + + control-shift-<tab> + Previous tab. + + control-? + Help. + + alt-<left-arrow> + Go backward along the history path. + + alt-<right-arrow> + Go forward along the history path. + + home Go to the top left of current page. + + control-<home> + Go to the first page. + + end Go to the bottom right of current page. + + control-<end> + Go to the last page. + + <space> or <PageDown> + Scroll down on the current page; if already at bottom, move to + next page. + + control-<PageDown> or control-<down-arrow> + Go to the next page. If <ScrollLock> is active, this maintains + the relative position on the page. + + <PageUp> + Scroll up on the current page; if already at top, move to previ- + ous page. + + control-<PageUp> or control-<up-arrow> + Go to the previous page. If <ScrollLock> is active, this main- + tains the relative position on the page. + + <esc> Exit full-screen mode. + + arrows Scroll the current page. + + g Set keyboard focus to the page number entry box. + + z Set the zoom factor to 'page' (fit page to window). + + w Set the zoom factor to 'width' (fit page width to window). + +Full-screen mode + Xpdf can be placed into full-screen mode via the -fullscreen command + line option, the 'full screen' menu item, or a binding to the + fullScreenMode or toggleFullScreenMode command. + + Entering full-screen mode automatically switches to single-page view + mode and to the fit-page zoom factor. + + Full-screen mode can be exited via the default <esc> key binding, or + via a binding to the windowMode or toggleFullScreenModecommand. + +COMMANDS + Xpdf's key and mouse bindings are user-configurable, using the bind and + unbind commands in the config file (see xpdfrc(5)). The bind command + allows you to bind a key or mouse button to a sequence of one or more + commands. + + In commands that take arguments (inside parentheses), special charac- + ters (namely '(', ')', ',', and '\x01') can be escaped by preceding + them with a '\x01' character. This is mostly useful in things like + scripts that need to be able to open arbitrary PDF files, using the + 'openFile' command. + + The following commands are supported: + + about Open the 'about' dialog. + + blockSelectMode + Set block selection mode. In this mode, the selection is a sim- + ple rectangle. Any part of the page can be selected, regardless + of the content on the page. + + checkOpenFile(file) + Check that file is open in the current tab, and open it if not. + + checkOpenFileAtDest(file,dest) + Check that file is open in the current tab, and open it if not. + In either case go to the specified named destination. + + checkOpenFileAtPage(file,page) + Check that file is open in the current tab, and open it if not. + In either case go to the specified page. + + closeSidebar + Close the sidebar. + + closeSidebarMoveResizeWin + Close the sidebar, resizing the window so that the document size + doesn't change, and moving the window so that the document stays + in the same place on the screen. + + closeSidebarResizeWin + Close the sidebar, resizing the window so that the document size + doesn't change. + + closeTabOrQuit + Close the tab. If this was the last open tab, close the window. + If this was the last window open, quit. + + closeWindowOrQuit + Close the window. If this was the last open window, quit. + + continuousMode + Switch to continuous view mode. + + copy Copy selected text to the clipboard. + + copyLinkTarget + Copy the target of the link under the mouse cursor to the clip- + board. + + endPan End a pan operation. + + endSelection + End a selection. + + expandSidebar(n) + Expand the sidebar by n pixels. Opens the sidebar if it is cur- + rently closed. + + find Set keyboard focus to the 'find' box. + + findFirst + Find the first occurrence of the search string. + + findNext + Find the next occurrence of the search string. + + findPrevious + Find the previous occurrence of the search string. + + focusToDocWin + Set keyboard focus to the main document window. + + focusToPageNum + Set keyboard focus to the page number text box. + + followLink + Follow a hyperlink (does nothing if the mouse is not over a + link). + + followLinkInNewTab + Follow a hyperlink, opening PDF files in a new tab (does nothing + if the mouse is not over a link). For links to non-PDF files, + this command is identical to followLink. + + followLinkInNewTabNoSel + Same as followLinkInNewTab, but does nothing if there is a non- + empty selection. (This is useful as a mouse button binding.) + + followLinkInNewWin + Follow a hyperlink, opening PDF files in a new window (does + nothing if the mouse is not over a link). For links to non-PDF + files, this command is identical to followLink. + + followLinkInNewWinNoSel + Same as followLinkInNewWin, but does nothing if there is a non- + empty selection. (This is useful as a mouse button binding.) + + followLinkNoSel + Same as followLink, but does nothing if there is a non-empty + selection. (This is useful as a mouse button binding.) + + fullScreenMode + Go to full-screen mode. + + goBackward + Move backward along the history path. + + goForward + Move forward along the history path. + + gotoDest(dest) + Go to a named destination. + + gotoLastPage + Go to the last page in the PDF file. + + gotoPage(page) + Go to the specified page. + + help Open the help URL. + + hideMenuBar + Hide the menu bar. + + hideToolbar + Hide the toolbar. + + horizontalContinuousMode + Switch to horizontal continuous view mode. + + linearSelectMode + Set linear selection mode. In this mode, the selection follows + text. Non-text regions cannot be selected. + + loadTabState + Load the tab state file (which was written via the saveTabState + command), and restore the tabs listed in that file. The path + for the tab state file is specified with the tabStateFile set- + ting (see xpdfrc(5)). + + newTab Open an empty new tab. + + newWindow + Open an empty new window. + + nextPage + Go to the next page. + + nextPageNoScroll + Go to the next page, with the current relative scroll position. + + nextTab + Switch to the next tab. + + open Open a PDF file in the current tab, using the open dialog. + + openErrorWindow + Open the error window. + + openFile(file) + Open the specified file in the current tab. + + openFile2(file,page,dest,passwd,location) + Open the specified file. If dest is not empty, go to the speci- + fied named destination. Else, if page is not empty, go to the + specified page number. If password is not empty, it is used as + the PDF password. If location is "win", open the file in a new + window; if it is "tab", open in a new tab; if it is "check", + open in the current tab, but only if the specified PDF file + isn't already open; else open in the current tab. Any/all of + the arguments, other than file, can be empty strings. For exam- + ple: + openFile2(test.pdf,7,,,tab) + + openFileAtDest(file,dest) + Open the specified file in the current tab at the specified + named destination. + + openFileAtDestIn(file,dest,location) + Open the specified file at the specified named destination. + Location must be "win" for a new window or "tab" for a new tab. + + openFileAtPage(file,page) + Open the specified file in the current tab at the specified + page. + + openFileAtPageIn(file,page,location) + Open the specified file at the specified page. Location must be + "win" for a new window or "tab" for a new tab. + + openFileIn(file,location) + Open the specified file. Location must be "win" for a new win- + dow or "tab" for a new tab. + + openIn(location) + Open a PDF file, using the open dialog. Location must be "win" + for a new window or "tab" for a new tab. + + openSidebar + Open the sidebar. + + openSidebarMoveResizeWin + Open the sidebar, resizing the window so that the document size + doesn't change, and moving the window so that the document stays + in the same place on the screen. + + openSidebarResizeWin + Open the sidebar, resizing the window so that the document size + doesn't change. + + pageDown + Scroll down by one screenful. + + pageUp Scroll up by one screenful. + + postPopupMenu + Display the popup menu. + + prevPage + Go to the previous page. + + prevPageNoScroll + Go to the previous page, with the current relative scroll posi- + tion. + + prevTab + Switch to the previous tab. + + print Open the 'print' dialog. + + quit Quit from xpdf. + + raise Bring the xpdf window to the front. + + reload Reload the current PDF file. + + rotateCCW + Rotate the page 90 degrees counterclockwise. + + rotateCW + Rotate the page 90 degrees clockwise. + + run(external-command-string) + Run an external command. The following escapes are allowed in + the command string: + + %f => PDF file name (or an empty string if no + file is open) + %b => PDF file base name, i.e., file name minus + the extension (or an empty string if no + file is open) + %u => link URL (or an empty string if not over + a URL link) + %p => current page number (or an empty string if + no file is open) + %x => selection upper-left x coordinate + (or 0 if there is no selection) + %y => selection upper-left y coordinate + (or 0 if there is no selection) + %X => selection lower-right x coordinate + (or 0 if there is no selection) + %Y => selection lower-right y coordinate + (or 0 if there is no selection) + %i => page containing the mouse pointer + %j => x coordinate of the mouse pointer + %k => y coordinate of the mouse pointer + %% => % + + The external command string will often contain spaces, so the + whole command must be quoted in the xpdfrc file: + + bind x "run(ls -l)" + + The command string may not be run through a shell. It is recom- + mended to keep the command simple, so that it doesn't depend on + specific shell functionality. For complex things, you can have + the command string run a shell script. + + saveAs Save PDF via a file requester. + + saveImage + Open the 'save image' dialog. + + saveTabState + Save a list of all tabs open in this window to the tab state + file. For each tab, this writes the PDF file name and page num- + ber (on separate lines). This file can be loaded later with the + loadTabState command. The path for the tab state file is speci- + fied with the tabStateFile setting (see xpdfrc(5)). + + scrollDown(n) + Scroll down by n pixels. + + scrollDownNextPage(n) + Scroll down by n pixels, moving to the next page if appropriate. + + scrollLeft(n) + Scroll left by n pixels. + + scrollOutlineDown(n) + Scroll the outline down by n increments. + + scrollOutlineUp(n) + Scroll the outline up by n increments. + + scrollRight(n) + Scroll right by n pixels. + + scrollToBottomEdge + Scroll to the bottom edge of the last displayed page, with no + horizontal movement. + + scrollToBottomRight + Scroll to the bottom-right corner of the last displayed page. + + scrollToLeftEdge + Scroll to the left edge of the current page, with no vertical + movement. + + scrollToRightEdge + Scroll to the right edge of the current page, with no vertical + movement. + + scrollToTopEdge + Scroll to the top edge of the first displayed page, with no hor- + izontal movement. + + scrollToTopLeft + Scroll to the top-left corner of the first displayed page. + + scrollUp(n) + Scroll up by n pixels. + + scrollUpPrevPage(n) + Scroll up by n pixels, moving to the previous page if appropri- + ate. + + selectLine + Set the selection to the line at the current mouse position. + + selectWord + Set the selection to the word at the current mouse position. + + setSelection(pg,ulx,uly,lrx,lry) + Set the selection to the specified coordinates on the specified + page. + + showAttachmentsPane + Shows the attachments in the outline/layers/attachments pane. + + showDocumentInfo + Open the document information dialog. + + showKeyBindings + Open the key bindings dialog. + + showLayersPane + Shows the layers in the outline/layers/attachments pane. + + showMenuBar + Show the menu bar. + + showOutlinePane + Shows the outline in the outline/layers/attachments pane. + + showToolbar + Show the toolbar. + + shrinkSidebar(n) + Shrink the sidebar by n pixels. Closes the sidebar if shrinking + it would go below the minimum allowed side. + + sideBySideContinuousMode + Switch to side-by-side continuous view mode. + + sideBySideSingleMode + Switch to side-by-side two-page view mode. + + singlePageMode + Switch to single-page view mode. + + startExtendedSelection + Extend the selection to the current mouse position, and continue + extending as the mouse moves. + + startPan + Start a pan operation at the current mouse position, which will + scroll the document as the mouse moves. + + startSelection + Start a selection at the current mouse position, which will be + extended as the mouse moves. + + toggleContinuousMode + Toggle between continuous and single page view modes. + + toggleFullScreenMode + Toggle between full-screen and window modes. + + toggleMenuBar + Toggle the menu bar between shown and hidden. + + toggleSelectMode + Toggle between block and linear selection mode. + + toggleSidebar + Toggle the sidebar between open and closed. + + toggleSidebarMoveResizeWin + Toggle the sidebar between open and closed, resizing the window + so that the document size doesn't change, and moving the window + so that the document stays in the same place on the screen. + + toggleSidebarResizeWin + Toggle the sidebar between open and closed, resizing the window + so that the document size doesn't change. + + toggleToolbar + Toggle the toolbar between shown and hidden. + + viewPageLabels + Show page labels (if the PDF file has them), rather than page + numbers. + + viewPageNumbers + Show page numbers, rather than page labels. + + windowMode + Go to window (non-full-screen) mode. + + zoomFitPage + Set the zoom factor to fit-page. + + zoomFitWidth + Set the zoom factor to fit-width. + + zoomIn Zoom in - go to the next higher zoom factor. + + zoomOut + Zoom out - go the next lower zoom factor. + + zoomPercent(z) + Set the zoom factor to z%. + + zoomToSelection + Zoom to the current selection. + +REMOTE SERVER MODE + Starting xpdf with the "-remote" switch puts it into remote server + mode. All remaining command line options are commands (see the COM- + MANDS section). Subsequent invocations of "xpdf -remote" with the same + remote server name will send commands to the already-running instance + of xpdf. The "checkOpenFile" commands are useful here for things like + changing pages. For example: + + # Start up xpdf, and open something.pdf. + xpdf -remote foo 'openFile(something.pdf)' + + # Switch to page 7 in the already-open something.pdf. If + the user + # has closed xpdf in the meantime, this will restart it and + reopen + # the file. + xpdf -remote foo 'checkOpenFileAtPage(something.pdf, 7)' + +EXIT CODES + The Xpdf tools use the following exit codes: + + 0 No error. + + 1 Error opening a PDF file. + + 2 Error opening an output file. + + 3 Error related to PDF permissions. + + 99 Other error. + +AUTHOR + The xpdf software and documentation are copyright 1996-2022 Glyph & + Cog, LLC. + +SEE ALSO + pdftops(1), pdftotext(1), pdftohtml(1), pdfinfo(1), pdffonts(1), pdfde- + tach(1), pdftoppm(1), pdftopng(1), pdfimages(1), xpdfrc(5) + http://www.xpdfreader.com/ + + + + 18 Apr 2022 xpdf(1) diff --git a/doc/xpdfrc.5 b/doc/xpdfrc.5 new file mode 100644 index 0000000..1c47e2e --- /dev/null +++ b/doc/xpdfrc.5 @@ -0,0 +1,854 @@ +.\" Copyright 2002-2022 Glyph & Cog, LLC +.TH xpdfrc 5 "18 Apr 202" +.SH NAME +xpdfrc \- configuration file for Xpdf tools (version 4.04) +.SH DESCRIPTION +All of the Xpdf tools read a single configuration file. +.PP +On Linux/Unix/MacOS: if you have a +.I .xpdfrc +file in your home directory, it will be read. Otherwise, a +system-wide configuration file will be read from +.IR /etc/xpdfrc , +if it exists. (This is its default location; depending on build +options, it may be placed elsewhere.) +.PP +On Windows: the file must be named +.I xpdfrc +(no leading dot, no extension), and must be placed in the same +directory as the executable (pdftotext.exe, xpdf.exe, etc.) +.PP +The xpdfrc file consists of a series of configuration options, one +per line. Blank lines and lines starting with a \'#' (comments) are +ignored. +.PP +Arguments can be single-quoted or double-quoted, e.g., for file names +that contain spaces ("aaa bbb", 'aaa bbb'). This quoting does not +provide any escaping, so there's no way to include a double quote in a +double-quoted argument or a single quote in a single-quoted argument. +.PP + +Arguments can also be at-quoted: @"aaa bbb". At-quoted strings allow +use of the DATADIR variable, which is set to the 'data' subdirectory +in the xpdf install directory. The percent sign (%) is an escape +character: a percent sign followed by any other character is replaced +with that character. +.PP +.RS +.nf +@"abc %"def%" ghi" --> abc "def" ghi +@"${DATADIR}/foo" --> ...install-dir.../data/foo +@"%${DATADIR}/foo" --> ${DATADIR}/foo +.fi +.RE +.PP +The following sections list all of the configuration options, sorted +into functional groups. There is an examples section at the end. +.SH INCLUDE FILES +.TP +.BI include " config\-file" +Includes the specified config file. The effect of this is equivalent +to inserting the contents of +.I config\-file +directly into the parent config file in place of the +.I include +command. Config files can be nested arbitrarily deeply. +.SH GENERAL FONT CONFIGURATION +.TP +.BI fontFile " PDF\-font\-name font\-file" +Maps a PDF font, +.IR PDF\-font\-name , +to a font for display or PostScript output. The font file, +.IR font\-file , +can be any type allowed in a PDF file. This command can be used for +8-bit or 16-bit (CID) fonts. +.TP +.BI fontDir " dir" +Specifies a search directory for font files. There can be multiple +fontDir commands; all of the specified directories will be searched in +order. The font files can be Type 1 (.pfa or .pfb) or TrueType (.ttf +or .ttc); other files in the directory will be ignored. The font file +name (not including the extension) must exactly match the PDF font +name. This search is performed if the font name doesn't match any of +the fonts declared with the fontFile command. There are no default +fontDir directories. +.TP +.BI fontFileCC " registry\-ordering font\-file" +Maps the +.I registry\-ordering +character collection to a font for display or PostScript output. This +mapping is used if the font name doesn't match any of the fonts +declared with the fontFile, fontDir, psResidentFont16, or +psResidentFontCC commands. +.SH POSTSCRIPT FONT CONFIGURATION +.TP +.BR psFontPassthrough " yes | no" +If set to "yes", pass 8-bit font names through to the PostScript +output without substitution. Fonts which are not embedded in the PDF +file are expected to be available on the printer. This defaults to +"no". +.TP +.BI psResidentFont " PDF\-font\-name PS\-font\-name" +When the 8-bit font +.I PDF\-font\-name +is used (without embedding) in a PDF file, it will be translated to +the PostScript font +.IR PS\-font\-name , +which is assumed to be resident in the printer. Typically, +.I PDF\-font\-name +and +.I PS\-font\-name +are the same. By default, only the Base-14 fonts are assumed to be +resident. +.TP +.BI psResidentFont16 " PDF\-font\-name wMode PS\-font\-name encoding" +When the 16-bit (CID) font +.I PDF\-font\-name +with writing mode +.I wMode +is used (without embedding) in a PDF file, it will be translated to +the PostScript font +.IR PS\-font\-name , +which is assumed to be resident in the printer. The writing mode +must be either \'H' for horizontal or \'V' for vertical. The resident +font is assumed to use the specified encoding (which must have been +defined with the unicodeMap command). +.TP +.BI psResidentFontCC " registry\-ordering wMode PS\-font\-name encoding" +When a 16-bit (CID) font using the +.I registry\-ordering +character collection and +.I wMode +writing mode is used (without embedding) in a PDF file, the PostScript +font, +.IR PS\-font\-name , +is substituted for it. The substituted font is assumed to be +resident in the printer. The writing mode must be either \'H' for +horizontal or \'V' for vertical. The resident font is assumed to use +the specified encoding (which must have been defined with the +unicodeMap command). +.TP +.BR psEmbedType1Fonts " yes | no" +If set to "no", prevents embedding of Type 1 fonts in generated +PostScript. This defaults to "yes". +.TP +.BR psEmbedTrueTypeFonts " yes | no" +If set to "no", prevents embedding of TrueType fonts in generated +PostScript. This defaults to "yes". +.TP +.BR psEmbedCIDTrueTypeFonts " yes | no" +If set to "no", prevents embedding of CID TrueType fonts in generated +PostScript. For Level 3 PostScript, this generates a CID font, for +lower levels it generates a non-CID composite font. This defaults to +"yes". +.TP +.BR psEmbedCIDPostScriptFonts " yes | no" +If set to "no", prevents embedding of CID PostScript fonts in +generated PostScript. For Level 3 PostScript, this generates a CID +font, for lower levels it generates a non-CID composite font. This +defaults to "yes". +.SH POSTSCRIPT CONTROL +.TP +.BI psPaperSize " width(pts) height(pts)" +Sets the paper size for PostScript output. The +.I width +and +.I height +parameters give the paper size in PostScript points (1 point = 1/72 +inch). +.TP +.BR psPaperSize " letter | legal | A4 | A3 | match" +Sets the paper size for PostScript output to a standard size. The +default paper size is set when xpdf and pdftops are built, typically +to "letter" or "A4". This can also be set to "match", which will set +the paper size to match the size specified in the PDF file. +.TP +.BR psImageableArea " llx lly urx ury" +Sets the imageable area for PostScript output. The four integers are +the coordinates of the lower-left and upper-right corners of the +imageable region, specified in points (with the origin being the +lower-left corner of the paper). This defaults to the full paper +size; the psPaperSize option will reset the imageable area +coordinates. +.TP +.BR psCrop " yes | no" +If set to "yes", PostScript output is cropped to the CropBox specified +in the PDF file; otherwise no cropping is done. This defaults to +"yes". +.TP +.BR psUseCropBoxAsPage " yes | no" +If set to "yes", PostScript output treats the CropBox as the page size. +By default, this is "no", and the MediaBox is used as the page size. +.TP +.BR psExpandSmaller " yes | no" +If set to "yes", PDF pages smaller than the PostScript imageable area +are expanded to fill the imageable area. Otherwise, no scaling is +done on smaller pages. This defaults to "no". +.TP +.BR psShrinkLarger " yes | no" +If set to yes, PDF pages larger than the PostScript imageable area are +shrunk to fit the imageable area. Otherwise, no scaling is done on +larger pages. This defaults to "yes". +.TP +.BR psCenter " yes | no" +If set to yes, PDF pages smaller than the PostScript imageable area +(after any scaling) are centered in the imageable area. Otherwise, +they are aligned at the lower-left corner of the imageable area. This +defaults to "yes". +.TP +.BR psDuplex " yes | no" +If set to "yes", the generated PostScript will set the "Duplex" +pagedevice entry. This tells duplex-capable printers to enable +duplexing. This defaults to "no". +.TP +.BR psLevel " level1 | level1sep | level2 | level2gray | level2sep | level3 | level3gray | level3Sep" +Sets the PostScript level to generate. This defaults to "level2". +.TP +.BR psPreload " yes | no" +If set to "yes", PDF forms are converted to PS procedures, and image +data is preloaded. This uses more memory in the PostScript +interpreter, but generates significantly smaller PS files in +situations where, e.g., the same image is drawn on every page of a +long document. This defaults to "no". +.TP +.BR psOPI " yes | no" +If set to "yes", generates PostScript OPI comments for all images and +forms which have OPI information. This option is only available if +the Xpdf tools were compiled with OPI support. This defaults to "no". +.TP +.BR psASCIIHex " yes | no" +If set to "yes", the ASCIIHexEncode filter will be used instead of +ASCII85Encode for binary data. This defaults to "no". +.TP +.BR psLZW " yes | no" +If set to "yes", the LZWEncode filter will be used for lossless +compression in PostScript output; if set to "no", the RunLengthEncode +filter will be used instead. LZW generates better compression +(smaller PS files), but may not be supported by some printers. This +defaults to "yes". +.TP +.BR psUncompressPreloadedImages " yes | no" +If set to "yes", all preloaded images in PS files will uncompressed. +If set to "no", the original compressed images will be used when +possible. The "yes" setting is useful to work around certain buggy +PostScript interpreters. This defaults to "no". +.TP +.BR psMinLineWidth " float" +Set the minimum line width, in points, for PostScript output. The +default value is 0 (no minimum). +.TP +.BR psRasterResolution " float" +Set the resolution (in dpi) for rasterized pages in PostScript output. +(Pdftops will rasterize pages which use transparency.) This defaults +to 300. +.TP +.BR psRasterMono " yes | no" +If set to "yes", rasterized pages in PS files will be monochrome +(8-bit gray) instead of color. This defaults to "no". +.TP +.BR psRasterSliceSize " pixels" +When rasterizing pages, pdftops splits the page into horizontal +"slices", to limit memory usage. This option sets the maximum slice +size, in pixels. This defaults to 20000000 (20 million). +.TP +.BR psAlwaysRasterize " yes | no" +If set to "yes", all PostScript output will be rasterized. This +defaults to "no". +.TP +.BR psNeverRasterize " yes | no" +Pdftops rasterizes an pages that use transparency (because PostScript +doesn't support transparency). If psNeverRasterize is set to "yes", +rasterization is disabled: pages will never be rasterized, even if +they contain transparency. This will likely result in incorrect +output for PDF files that use transparency, and a warning message to +that effect will be printed. This defaults to "no". +.TP +.BI fontDir " dir" +See the description above, in the DISPLAY FONTS section. +.SH TEXT CONTROL AND CHARACTER MAPPING +.TP +.BI textEncoding " encoding\-name" +Sets the encoding to use for text output. (This can be overridden +with the "\-enc" switch on the command line.) The +.I encoding\-name +must be defined with the unicodeMap command (see above). This +defaults to "Latin1". +.TP +.BR textEOL " unix | dos | mac" +Sets the end-of-line convention to use for text output. The options +are: +.nf + + unix = LF + dos = CR+LF + mac = CR + +.fi +(This can be overridden with the "\-eol" switch on the command line.) +The default value is based on the OS where xpdf and pdftotext were +built. +.TP +.BR textPageBreaks " yes | no" +If set to "yes", text extraction will insert page breaks (form feed +characters) between pages. This defaults to "yes". +.TP +.BR textKeepTinyChars " yes | no" +If set to "yes", text extraction will keep all characters. If set to +"no", text extraction will discard tiny (smaller than 3 point) +characters after the first 50000 per page, avoiding extremely slow run +times for PDF files that use special fonts to do shading or +cross-hatching. This defaults to "yes". +.TP +.BI nameToUnicode " map\-file" +Specifies a file with the mapping from character names to Unicode. +This is used to handle PDF fonts that have valid encodings but no +ToUnicode entry. Each line of a nameToUnicode file looks like this: + +.I " " hex\-string name + +The +.I hex\-string +is the Unicode (UCS-2) character index, and +.I name +is the corresponding character name. Multiple nameToUnicode files can +be used; if a character name is given more than once, the code in the +last specified file is used. There is a built-in default +nameToUnicode table with all of Adobe's standard character names. +.TP +.BI cidToUnicode " registry\-ordering map\-file" +Specifies the file with the mapping from character collection to +Unicode. Each line of a cidToUnicode file represents one character: + +.I " " hex\-string + +The +.I hex\-string +is the Unicode (UCS-2) index for that character. The first line maps +CID 0, the second line CID 1, etc. File size is determined by size of +the character collection. Only one file is allowed per character +collection; the last specified file is used. There are no built-in +cidToUnicode mappings. +.TP +.BI unicodeToUnicode " font\-name\-substring map\-file" +This is used to work around PDF fonts which have incorrect Unicode +information. It specifies a file which maps from the given +(incorrect) Unicode indexes to the correct ones. The mapping will be +used for any font whose name contains +.IR font\-name\-substring . +Each line of a unicodeToUnicode file represents one Unicode character: + +.RI " " in\-hex " " out\-hex1 " " out\-hex2 " ..." + +The +.I in\-hex +field is an input (incorrect) Unicode index, and the rest of the +fields are one or more output (correct) Unicode indexes. Each +occurrence of +.I in\-hex +will be converted to the specified output sequence. +.TP +.BI unicodeRemapping " remap\-file" +Remap Unicode characters when doing text extraction. This specifies a +file that maps from a particular Unicode index to zero or more +replacement Unicode indexes. Each line of the remap file represents +one Unicode character: + +.RI " " in\-hex " " out\-hex1 " " out\-hex2 " ..." + +Any Unicode characters not listed will be left unchanged. This +function is typically used to remap things like non-breaking spaces, +soft hyphens, ligatures, etc. +.TP +.BI unicodeMap " encoding\-name map\-file" +Specifies the file with mapping from Unicode to +.IR encoding\-name . +These encodings are used for text output (see below). Each line of a +unicodeMap file represents a range of one or more Unicode characters +which maps linearly to a range in the output encoding: +.nf + +.I " " in\-start\-hex in\-end\-hex out\-start\-hex + +.fi +Entries for single characters can be abbreviated to: +.nf + +.I " " in\-hex out\-hex + +.fi +The +.I in\-start\-hex +and +.I in\-end\-hex +fields (or the single +.I in\-hex +field) specify the Unicode range. The +.I out\-start\-hex +field (or the +.I out\-hex +field) specifies the start of the output encoding range. The length +of the +.I out\-start\-hex +(or +.IR out\-hex ) +string determines the length of the output characters (e.g., UTF-8 +uses different numbers of bytes to represent characters in different +ranges). Entries must be given in increasing Unicode order. Only one +file is allowed per encoding; the last specified file is used. The +.IR Latin1 , +.IR ASCII7 , +.IR Symbol , +.IR ZapfDingbats , +.IR UTF-8 , +and +.I UCS-2 +encodings are predefined. +.TP +.BI cMapDir " registry\-ordering dir" +Specifies a search directory, +.IR dir , +for CMaps for the +.I registry\-ordering +character collection. There can be multiple directories for a +particular collection. There are no default CMap directories. +.TP +.BI toUnicodeDir " dir" +Specifies a search directory, +.IR dir , +for ToUnicode CMaps. There can be multiple ToUnicode directories. +There are no default ToUnicode directories. +.TP +.BI mapNumericCharNames " yes | no" +If set to "yes", the Xpdf tools will attempt to map various numeric +character names sometimes used in font subsets. In some cases this +leads to usable text, and in other cases it leads to gibberish -- +there is no way for Xpdf to tell. This defaults to "yes". +.TP +.BI mapUnknownCharNames " yes | no" +If set to "yes", and mapNumericCharNames is set to "no", the Xpdf +tools will apply a simple pass-through mapping (Unicode index = +character code) for all unrecognized glyph names. (For CID fonts, +setting mapNumericCharNames to "no" is unnecessary.) In some cases, +this leads to usable text, and in other cases it leads to gibberish -- +there is no way for Xpdf to tell. This defaults to "no". +.TP +.BI mapExtTrueTypeFontsViaUnicode " yes | no" +When rasterizing text using an external TrueType font, there are two +options for handling character codes. If +mapExtTrueTypeFontsViaUnicode is set to "yes", Xpdf will use the font +encoding/ToUnicode info to map character codes to Unicode, and then +use the font's Unicode cmap to map Unicode to GIDs. If +mapExtTrueTypeFontsViaUnicode is set to "no", Xpdf will assume the +character codes are GIDs (i.e., use an identity mapping). This +defaults to "yes". +.TP +.BI useTrueTypeUnicodeMapping " yes | no" +If set to "yes", the Xpdf tools will use the Unicode encoding +information in TrueType fonts (16-bit only), if avaiable, to override +the PDF ToUnicode maps. Otherwise, the ToUnicode maps are always used +when present. This defaults to "no". +.TP +.BI dropFont " font-name" +Drop all text drawn in the specified font. To drop text drawn in +unnamed fonts, use: +.nf + + dropFont "" + +.fi +There can be any number of dropFont commands. +.SH RASTERIZER SETTINGS +.TP +.BR enableFreeType " yes | no" +Enables or disables use of FreeType (a TrueType / Type 1 font +rasterizer). This is only relevant if the Xpdf tools were built with +FreeType support. ("enableFreeType" replaces the old +"freetypeControl" option.) This option defaults to "yes". +.TP +.BR disableFreeTypeHinting " yes | no" +If this is set to "yes", FreeType hinting will be forced off. This +option defaults to "no". +.TP +.BR antialias " yes | no" +Enables or disables font anti-aliasing in the PDF rasterizer. This +option affects all font rasterizers. ("antialias" replaces the +anti-aliasing control provided by the old "t1libControl" and +"freetypeControl" options.) This default to "yes". +.TP +.BR vectorAntialias " yes | no" +Enables or disables anti-aliasing of vector graphics in the PDF +rasterizer. This defaults to "yes". +.TP +.BR imageMaskAntialias " yes | no" +Enables or disables anti-aliasing of image masks (when downsampling or +upsampling) in the PDF rasterizer. This defaults to "yes". +.TP +.BR antialiasPrinting " yes | no" +If this is "yes", bitmaps sent to the printer will be antialiased +(according to the "antialias" and "vectorAntialias" settings). If +this is "no", printed bitmaps will not be antialiased. This defaults +to "no". +.TP +.BR strokeAdjust " yes | no | cad" +Sets the stroke adjustment mode. If set to "no", no stroke adjustment +will be done. If set to "yes", normal stroke adjustment will be done: +horizontal and vertical lines will be moved by up to half a pixel to +make them look cleaner when vector anti-aliasing is enabled. If set +to "cad", a slightly different stroke adjustment algorithm will be +used to ensure that lines of the same original width will always have +the same adjusted width (at the expense of allowing gaps and overlaps +between adjacent lines). This defaults to "yes". +.TP +.BR forceAccurateTiling " yes | no" +If this is set to "yes", the TilingType is forced to 2 (no distortion) +for all tiling patterns, regardless of the setting in the pattern +dictionary. This defaults to "no". +.TP +.BR screenType " dispersed | clustered | stochasticClustered" +Sets the halftone screen type, which will be used when generating a +monochrome (1-bit) bitmap. The three options are dispersed-dot +dithering, clustered-dot dithering (with a round dot and 45-degree +screen angle), and stochastic clustered-dot dithering. By default, +"stochasticClustered" is used for resolutions of 300 dpi and higher, +and "dispersed" is used for resolutions lower then 300 dpi. +.TP +.BI screenSize " integer" +Sets the size of the (square) halftone screen threshold matrix. By +default, this is 4 for dispersed-dot dithering, 10 for clustered-dot +dithering, and 100 for stochastic clustered-dot dithering. +.TP +.BI screenDotRadius " integer" +Sets the halftone screen dot radius. This is only used when +screenType is set to stochasticClustered, and it defaults to 2. In +clustered-dot mode, the dot radius is half of the screen size. +Dispersed-dot dithering doesn't have a dot radius. +.TP +.BI screenGamma " float" +Sets the halftone screen gamma correction parameter. Gamma values +greater than 1 make the output brighter; gamma values less than 1 make +it darker. The default value is 1. +.TP +.BI screenBlackThreshold " float" +When halftoning, all values below this threshold are forced to solid +black. This parameter is a floating point value between 0 (black) and +1 (white). The default value is 0. +.TP +.BI screenWhiteThreshold " float" +When halftoning, all values above this threshold are forced to solid +white. This parameter is a floating point value between 0 (black) and +1 (white). The default value is 1. +.TP +.BI minLineWidth " float" +Set the minimum line width, in device pixels. This affects the +rasterizer only, not the PostScript converter (except when it uses +rasterization to handle transparency). The default value is 0 (no +minimum). +.TP +.BI enablePathSimplification " yes | no" +If set to "yes", simplify paths by removing points where it won't make +a significant difference to the shape. The default value is "no". +.TP +.BI overprintPreview " yes | no" +If set to "yes", generate overprint preview output, honoring the +OP/op/OPM settings in the PDF file. Ignored for non-CMYK output. The +default value is "no". +.SH VIEWER SETTINGS +These settings only apply to the Xpdf GUI PDF viewer. +.TP +.BR initialZoom " \fIpercentage\fR | page | width" +Sets the initial zoom factor. A number specifies a zoom percentage, +where 100 means 72 dpi. You may also specify \'page', to fit the page +to the window size, or \'width', to fit the page width to the window +width. +.TP +.BI defaultFitZoom " percentage" +If xpdf is started with fit-page or fit-width zoom and no window +geometry, it will calculate a desired window size based on the PDF +page size and this defaultFitZoom value. I.e., the window size will +be chosen such that exactly one page will fit in the window at this +zoom factor (which must be a percentage). The default value is +based on the screen resolution. +.TP +.BR initialDisplayMode " single | continuous | sideBySideSingle | sideBySideContinuous | horizontalContinuous" +Sets the initial display mode. The default setting is "continuous". +.TP +.BI initialToolbarState " yes | no" +If set to "yes", xpdf opens with the toolbar visible. If set to "no", +xpdf opens with the toolbar hidden. The default is "yes". +.TP +.BI initialSidebarState " yes | no" +If set to "yes", xpdf opens with the sidebar (tabs, outline, etc.) +visible. If set to "no", xpdf opens with the sidebar collapsed. The +default is "yes". +.TP +.BI initialSidebarWidth " width" +Sets the initial sidebar width, in pixels. This is only relevant if +initialSidebarState is "yes". The default value is zero, which tells +xpdf to use an internal default size. +.TP +.BR initialSelectMode " block | linear" +Sets the initial selection mode. The default setting is "linear". +.TP +.BI paperColor " color" +Set the "paper color", i.e., the background of the page display. The +color can be #RRGGBB (hexadecimal) or a named color. This option will +not work well with PDF files that do things like filling in white +behind the text. +.TP +.BI matteColor " color" +Set the matte color, i.e., the color used for background outside the +actual page area. The color can be #RRGGBB (hexadecimal) or a named +color. +.TP +.BI fullScreenMatteColor " color" +Set the matte color for full-screen mode. The color can be #RRGGBB +(hexadecimal) or a named color. +.TP +.BI selectionColor " color" +Set the selection color. The color can be #RRGGBB (hexadecimal) or a +named color. +.TP +.BI reverseVideoInvertImages " yes | no" +If set to "no", xpdf's reverse-video mode inverts text and vector +graphic content, but not images. If set to "yes", xpdf inverts images +as well. The default is "no". +.TP +.BI popupMenuCmd " title command ..." +Add a command to the popup menu. +.I Title +is the text to be displayed in the menu. +.I Command +is an Xpdf command (see the COMMANDS section of the +.BR xpdf (1) +man page for details). Multiple commands are separated by whitespace. +.TP +.BI maxTileWidth " pixels" +Set the maximum width of tiles to be used by xpdf when rasterizing +pages. This defaults to 1500. +.TP +.BI maxTileHeight " pixels" +Set the maximum height of tiles to be used by xpdf when rasterizing +pages. This defaults to 1500. +.TP +.BI tileCacheSize " tiles" +Set the maximum number of tiles to be cached by xpdf when rasterizing +pages. This defaults to 10. +.TP +.BI workerThreads " numThreads" +Set the number of worker threads to be used by xpdf when rasterizing +pages. This defaults to 1. +.TP +.BI launchCommand " command" +Sets the command executed when you click on a "launch"-type link. The +intent is for the command to be a program/script which determines the +file type and runs the appropriate viewer. The command line will +consist of the file to be launched, followed by any parameters +specified with the link. Do not use "%s" in "command". By default, +this is unset, and Xpdf will simply try to execute the file (after +prompting the user). +.TP +.BI movieCommand " command" +Sets the command executed when you click on a movie annotation. The +string "%s" will be replaced with the movie file name. This has no +default value. +.TP +.BI defaultPrinter " printer" +Sets the default printer used in the viewer's print dialog. +.TP +.BI bind " modifiers-key context command ..." +Add a key or mouse button binding. +.I Modifiers +can be zero or more of: +.nf + + shift- + ctrl- + alt- + +.fi +.I Key +can be a regular ASCII character, or any one of: +.nf + + space + tab + return + enter + backspace + esc + insert + delete + home + end + pgup + pgdn + left / right / up / down (arrow keys) + f1 .. f35 (function keys) + mousePress1 .. mousePress7 (mouse buttons) + mouseRelease1 .. mouseRelease7 (mouse buttons) + mouseClick1 .. mouseClick7 (mouse buttons) + mouseDoubleClick1 .. mouseDoubleClick7 (mouse buttons) + mouseTripleClick1 .. mouseTripleClick7 (mouse buttons) + +.fi +.I Context +is either "any" or a comma-separated combination of: +.nf + + fullScreen / window (full screen mode on/off) + continuous / singlePage (continuous mode on/off) + overLink / offLink (mouse over link or not) + scrLockOn / scrLockOff (scroll lock on/off) + +.fi +The context string can include only one of each pair in the above +list. + +.I Command +is an Xpdf command (see the COMMANDS section of the +.BR xpdf (1) +man page for details). Multiple commands are separated by whitespace. + +The bind command replaces any existing binding, but only if it was +defined for the exact same modifiers, key, and context. All tokens +(modifiers, key, context, commands) are case-sensitive. + +Example key bindings: +.nf + + # bind ctrl-a in any context to the nextPage + # command + bind ctrl-a any nextPage + + # bind uppercase B, when in continuous mode + # with scroll lock on, to the reload command + # followed by the prevPage command + bind B continuous,scrLockOn reload prevPage + +.fi +See the +.BR xpdf (1) +man page for more examples. +.TP +.BI unbind " modifiers-key context" +Removes a key binding established with the bind command. This is most +useful to remove default key bindings before establishing new ones +(e.g., if the default key binding is given for "any" context, and you +want to create new key bindings for multiple contexts). +.TP +.BI tabStateFile " path" +Sets the file used by the loadTabState and saveTabState commands (see +the +.BR xpdf (1) +man page for more information). +.SH MISCELLANEOUS SETTINGS +.TP +.BI drawAnnotations " yes | no" +If set to "no", annotations will not be drawn or printed. The default +value is "yes". +.TP +.BI drawFormFields " yes | no" +If set to "no", form fields will not be drawn or printed. The default +value is "yes". +.TP +.BI enableXFA " yes | no" +If an XFA form is present, and this option is set to "yes", Xpdf will +parse the XFA form and use certain XFA information to override +AcroForm information. If set to "no", the XFA form will not be read. +The default value is "yes". +.TP +.BI savePageNumbers " yes | no" +If set to "yes", xpdf will save the current page numbers of all open +files in ~/.xpdf.pages when the files are closed (or when quitting +xpdf). Next time the file is opened, the last-viewed page number will +be restored. The default value is "yes". +.TP +.BI printCommands " yes | no" +If set to "yes", drawing commands are printed as they're executed +(useful for debugging). This defaults to "no". +.TP +.BI printStatusInfo +If set to "yes", print a status message (to stdout) before each page +is processed. This defaults to "no". +.TP +.BI errQuiet " yes | no" +If set to "yes", this suppresses all error and warning messages from +all of the Xpdf tools. This defaults to "no". +.SH EXAMPLES +The following is a sample xpdfrc file. +.nf + +# from the Thai support package +nameToUnicode /usr/local/share/xpdf/Thai.nameToUnicode + +# from the Japanese support package +cidToUnicode Adobe-Japan1 /usr/local/share/xpdf/Adobe-Japan1.cidToUnicode +unicodeMap JISX0208 /usr/local/share/xpdf/JISX0208.unicodeMap +cMapDir Adobe-Japan1 /usr/local/share/xpdf/cmap/Adobe-Japan1 + +# use the Base-14 Type 1 fonts from ghostscript +fontFile Times-Roman /usr/local/share/ghostscript/fonts/n021003l.pfb +fontFile Times-Italic /usr/local/share/ghostscript/fonts/n021023l.pfb +fontFile Times-Bold /usr/local/share/ghostscript/fonts/n021004l.pfb +fontFile Times-BoldItalic /usr/local/share/ghostscript/fonts/n021024l.pfb +fontFile Helvetica /usr/local/share/ghostscript/fonts/n019003l.pfb +fontFile Helvetica-Oblique /usr/local/share/ghostscript/fonts/n019023l.pfb +fontFile Helvetica-Bold /usr/local/share/ghostscript/fonts/n019004l.pfb +fontFile Helvetica-BoldOblique /usr/local/share/ghostscript/fonts/n019024l.pfb +fontFile Courier /usr/local/share/ghostscript/fonts/n022003l.pfb +fontFile Courier-Oblique /usr/local/share/ghostscript/fonts/n022023l.pfb +fontFile Courier-Bold /usr/local/share/ghostscript/fonts/n022004l.pfb +fontFile Courier-BoldOblique /usr/local/share/ghostscript/fonts/n022024l.pfb +fontFile Symbol /usr/local/share/ghostscript/fonts/s050000l.pfb +fontFile ZapfDingbats /usr/local/share/ghostscript/fonts/d050000l.pfb + +# use the Bakoma Type 1 fonts +# (this assumes they happen to be installed in /usr/local/fonts/bakoma) +fontDir /usr/local/fonts/bakoma + +# set some PostScript options +psPaperSize letter +psDuplex no +psLevel level2 +psEmbedType1Fonts yes +psEmbedTrueTypeFonts yes + +# assume that the PostScript printer has the Univers and +# Univers-Bold fonts +psResidentFont Univers Univers +psResidentFont Univers-Bold Univers-Bold + +# set the text output options +textEncoding UTF-8 +textEOL unix + +# misc options +enableFreeType yes +launchCommand viewer-script + +.fi +.SH FILES +.TP +.B /etc/xpdfrc +This is the default location for the system-wide configuration file. +Depending on build options, it may be placed elsewhere. +.TP +.B $HOME/.xpdfrc +This is the user's configuration file. If it exists, it will be read +in place of the system-wide file. +.SH AUTHOR +The Xpdf software and documentation are copyright 1996-2022 Glyph & +Cog, LLC. +.SH "SEE ALSO" +.BR xpdf (1), +.BR pdftops (1), +.BR pdftotext (1), +.BR pdftohtml (1), +.BR pdfinfo (1), +.BR pdffonts (1), +.BR pdfdetach (1), +.BR pdftoppm (1), +.BR pdftopng (1), +.BR pdfimages (1) +.br +.B http://www.xpdfreader.com/ diff --git a/doc/xpdfrc.cat b/doc/xpdfrc.cat new file mode 100644 index 0000000..c38791e --- /dev/null +++ b/doc/xpdfrc.cat @@ -0,0 +1,786 @@ +xpdfrc(5) File Formats Manual xpdfrc(5) + + + +NAME + xpdfrc - configuration file for Xpdf tools (version 4.04) + +DESCRIPTION + All of the Xpdf tools read a single configuration file. + + On Linux/Unix/MacOS: if you have a .xpdfrc file in your home directory, + it will be read. Otherwise, a system-wide configuration file will be + read from /etc/xpdfrc, if it exists. (This is its default location; + depending on build options, it may be placed elsewhere.) + + On Windows: the file must be named xpdfrc (no leading dot, no exten- + sion), and must be placed in the same directory as the executable + (pdftotext.exe, xpdf.exe, etc.) + + The xpdfrc file consists of a series of configuration options, one per + line. Blank lines and lines starting with a '#' (comments) are + ignored. + + Arguments can be single-quoted or double-quoted, e.g., for file names + that contain spaces ("aaa bbb", 'aaa bbb'). This quoting does not pro- + vide any escaping, so there's no way to include a double quote in a + double-quoted argument or a single quote in a single-quoted argument. + + Arguments can also be at-quoted: @"aaa bbb". At-quoted strings allow + use of the DATADIR variable, which is set to the 'data' subdirectory in + the xpdf install directory. The percent sign (%) is an escape charac- + ter: a percent sign followed by any other character is replaced with + that character. + + @"abc %"def%" ghi" --> abc "def" ghi + @"${DATADIR}/foo" --> ...install-dir.../data/foo + @"%${DATADIR}/foo" --> ${DATADIR}/foo + + The following sections list all of the configuration options, sorted + into functional groups. There is an examples section at the end. + +INCLUDE FILES + include config-file + Includes the specified config file. The effect of this is + equivalent to inserting the contents of config-file directly + into the parent config file in place of the include command. + Config files can be nested arbitrarily deeply. + +GENERAL FONT CONFIGURATION + fontFile PDF-font-name font-file + Maps a PDF font, PDF-font-name, to a font for display or Post- + Script output. The font file, font-file, can be any type + allowed in a PDF file. This command can be used for 8-bit or + 16-bit (CID) fonts. + + fontDir dir + Specifies a search directory for font files. There can be mul- + tiple fontDir commands; all of the specified directories will be + searched in order. The font files can be Type 1 (.pfa or .pfb) + or TrueType (.ttf or .ttc); other files in the directory will be + ignored. The font file name (not including the extension) must + exactly match the PDF font name. This search is performed if + the font name doesn't match any of the fonts declared with the + fontFile command. There are no default fontDir directories. + + fontFileCC registry-ordering font-file + Maps the registry-ordering character collection to a font for + display or PostScript output. This mapping is used if the font + name doesn't match any of the fonts declared with the fontFile, + fontDir, psResidentFont16, or psResidentFontCC commands. + +POSTSCRIPT FONT CONFIGURATION + psFontPassthrough yes | no + If set to "yes", pass 8-bit font names through to the PostScript + output without substitution. Fonts which are not embedded in + the PDF file are expected to be available on the printer. This + defaults to "no". + + psResidentFont PDF-font-name PS-font-name + When the 8-bit font PDF-font-name is used (without embedding) in + a PDF file, it will be translated to the PostScript font + PS-font-name, which is assumed to be resident in the printer. + Typically, PDF-font-name and PS-font-name are the same. By + default, only the Base-14 fonts are assumed to be resident. + + psResidentFont16 PDF-font-name wMode PS-font-name encoding + When the 16-bit (CID) font PDF-font-name with writing mode wMode + is used (without embedding) in a PDF file, it will be translated + to the PostScript font PS-font-name, which is assumed to be res- + ident in the printer. The writing mode must be either 'H' for + horizontal or 'V' for vertical. The resident font is assumed to + use the specified encoding (which must have been defined with + the unicodeMap command). + + psResidentFontCC registry-ordering wMode PS-font-name encoding + When a 16-bit (CID) font using the registry-ordering character + collection and wMode writing mode is used (without embedding) in + a PDF file, the PostScript font, PS-font-name, is substituted + for it. The substituted font is assumed to be resident in the + printer. The writing mode must be either 'H' for horizontal or + 'V' for vertical. The resident font is assumed to use the spec- + ified encoding (which must have been defined with the unicodeMap + command). + + psEmbedType1Fonts yes | no + If set to "no", prevents embedding of Type 1 fonts in generated + PostScript. This defaults to "yes". + + psEmbedTrueTypeFonts yes | no + If set to "no", prevents embedding of TrueType fonts in gener- + ated PostScript. This defaults to "yes". + + psEmbedCIDTrueTypeFonts yes | no + If set to "no", prevents embedding of CID TrueType fonts in gen- + erated PostScript. For Level 3 PostScript, this generates a CID + font, for lower levels it generates a non-CID composite font. + This defaults to "yes". + + psEmbedCIDPostScriptFonts yes | no + If set to "no", prevents embedding of CID PostScript fonts in + generated PostScript. For Level 3 PostScript, this generates a + CID font, for lower levels it generates a non-CID composite + font. This defaults to "yes". + +POSTSCRIPT CONTROL + psPaperSize width(pts) height(pts) + Sets the paper size for PostScript output. The width and height + parameters give the paper size in PostScript points (1 point = + 1/72 inch). + + psPaperSize letter | legal | A4 | A3 | match + Sets the paper size for PostScript output to a standard size. + The default paper size is set when xpdf and pdftops are built, + typically to "letter" or "A4". This can also be set to "match", + which will set the paper size to match the size specified in the + PDF file. + + psImageableArea llx lly urx ury + Sets the imageable area for PostScript output. The four inte- + gers are the coordinates of the lower-left and upper-right cor- + ners of the imageable region, specified in points (with the ori- + gin being the lower-left corner of the paper). This defaults to + the full paper size; the psPaperSize option will reset the + imageable area coordinates. + + psCrop yes | no + If set to "yes", PostScript output is cropped to the CropBox + specified in the PDF file; otherwise no cropping is done. This + defaults to "yes". + + psUseCropBoxAsPage yes | no + If set to "yes", PostScript output treats the CropBox as the + page size. By default, this is "no", and the MediaBox is used + as the page size. + + psExpandSmaller yes | no + If set to "yes", PDF pages smaller than the PostScript imageable + area are expanded to fill the imageable area. Otherwise, no + scaling is done on smaller pages. This defaults to "no". + + psShrinkLarger yes | no + If set to yes, PDF pages larger than the PostScript imageable + area are shrunk to fit the imageable area. Otherwise, no scal- + ing is done on larger pages. This defaults to "yes". + + psCenter yes | no + If set to yes, PDF pages smaller than the PostScript imageable + area (after any scaling) are centered in the imageable area. + Otherwise, they are aligned at the lower-left corner of the + imageable area. This defaults to "yes". + + psDuplex yes | no + If set to "yes", the generated PostScript will set the "Duplex" + pagedevice entry. This tells duplex-capable printers to enable + duplexing. This defaults to "no". + + psLevel level1 | level1sep | level2 | level2gray | level2sep | level3 | + level3gray | level3Sep + Sets the PostScript level to generate. This defaults to + "level2". + + psPreload yes | no + If set to "yes", PDF forms are converted to PS procedures, and + image data is preloaded. This uses more memory in the Post- + Script interpreter, but generates significantly smaller PS files + in situations where, e.g., the same image is drawn on every page + of a long document. This defaults to "no". + + psOPI yes | no + If set to "yes", generates PostScript OPI comments for all + images and forms which have OPI information. This option is + only available if the Xpdf tools were compiled with OPI support. + This defaults to "no". + + psASCIIHex yes | no + If set to "yes", the ASCIIHexEncode filter will be used instead + of ASCII85Encode for binary data. This defaults to "no". + + psLZW yes | no + If set to "yes", the LZWEncode filter will be used for lossless + compression in PostScript output; if set to "no", the RunLength- + Encode filter will be used instead. LZW generates better com- + pression (smaller PS files), but may not be supported by some + printers. This defaults to "yes". + + psUncompressPreloadedImages yes | no + If set to "yes", all preloaded images in PS files will uncom- + pressed. If set to "no", the original compressed images will be + used when possible. The "yes" setting is useful to work around + certain buggy PostScript interpreters. This defaults to "no". + + psMinLineWidth float + Set the minimum line width, in points, for PostScript output. + The default value is 0 (no minimum). + + psRasterResolution float + Set the resolution (in dpi) for rasterized pages in PostScript + output. (Pdftops will rasterize pages which use transparency.) + This defaults to 300. + + psRasterMono yes | no + If set to "yes", rasterized pages in PS files will be monochrome + (8-bit gray) instead of color. This defaults to "no". + + psRasterSliceSize pixels + When rasterizing pages, pdftops splits the page into horizontal + "slices", to limit memory usage. This option sets the maximum + slice size, in pixels. This defaults to 20000000 (20 million). + + psAlwaysRasterize yes | no + If set to "yes", all PostScript output will be rasterized. This + defaults to "no". + + psNeverRasterize yes | no + Pdftops rasterizes an pages that use transparency (because Post- + Script doesn't support transparency). If psNeverRasterize is + set to "yes", rasterization is disabled: pages will never be + rasterized, even if they contain transparency. This will likely + result in incorrect output for PDF files that use transparency, + and a warning message to that effect will be printed. This + defaults to "no". + + fontDir dir + See the description above, in the DISPLAY FONTS section. + +TEXT CONTROL AND CHARACTER MAPPING + textEncoding encoding-name + Sets the encoding to use for text output. (This can be overrid- + den with the "-enc" switch on the command line.) The encod- + ing-name must be defined with the unicodeMap command (see + above). This defaults to "Latin1". + + textEOL unix | dos | mac + Sets the end-of-line convention to use for text output. The + options are: + + unix = LF + dos = CR+LF + mac = CR + + (This can be overridden with the "-eol" switch on the command + line.) The default value is based on the OS where xpdf and + pdftotext were built. + + textPageBreaks yes | no + If set to "yes", text extraction will insert page breaks (form + feed characters) between pages. This defaults to "yes". + + textKeepTinyChars yes | no + If set to "yes", text extraction will keep all characters. If + set to "no", text extraction will discard tiny (smaller than 3 + point) characters after the first 50000 per page, avoiding + extremely slow run times for PDF files that use special fonts to + do shading or cross-hatching. This defaults to "yes". + + nameToUnicode map-file + Specifies a file with the mapping from character names to Uni- + code. This is used to handle PDF fonts that have valid encod- + ings but no ToUnicode entry. Each line of a nameToUnicode file + looks like this: + + hex-string name + + The hex-string is the Unicode (UCS-2) character index, and name + is the corresponding character name. Multiple nameToUnicode + files can be used; if a character name is given more than once, + the code in the last specified file is used. There is a built- + in default nameToUnicode table with all of Adobe's standard + character names. + + cidToUnicode registry-ordering map-file + Specifies the file with the mapping from character collection to + Unicode. Each line of a cidToUnicode file represents one char- + acter: + + hex-string + + The hex-string is the Unicode (UCS-2) index for that character. + The first line maps CID 0, the second line CID 1, etc. File + size is determined by size of the character collection. Only + one file is allowed per character collection; the last specified + file is used. There are no built-in cidToUnicode mappings. + + unicodeToUnicode font-name-substring map-file + This is used to work around PDF fonts which have incorrect Uni- + code information. It specifies a file which maps from the given + (incorrect) Unicode indexes to the correct ones. The mapping + will be used for any font whose name contains font-name-sub- + string. Each line of a unicodeToUnicode file represents one + Unicode character: + + in-hex out-hex1 out-hex2 ... + + The in-hex field is an input (incorrect) Unicode index, and the + rest of the fields are one or more output (correct) Unicode + indexes. Each occurrence of in-hex will be converted to the + specified output sequence. + + unicodeRemapping remap-file + Remap Unicode characters when doing text extraction. This spec- + ifies a file that maps from a particular Unicode index to zero + or more replacement Unicode indexes. Each line of the remap + file represents one Unicode character: + + in-hex out-hex1 out-hex2 ... + + Any Unicode characters not listed will be left unchanged. This + function is typically used to remap things like non-breaking + spaces, soft hyphens, ligatures, etc. + + unicodeMap encoding-name map-file + Specifies the file with mapping from Unicode to encoding-name. + These encodings are used for text output (see below). Each line + of a unicodeMap file represents a range of one or more Unicode + characters which maps linearly to a range in the output encod- + ing: + + in-start-hex in-end-hex out-start-hex + + Entries for single characters can be abbreviated to: + + in-hex out-hex + + The in-start-hex and in-end-hex fields (or the single in-hex + field) specify the Unicode range. The out-start-hex field (or + the out-hex field) specifies the start of the output encoding + range. The length of the out-start-hex (or out-hex) string + determines the length of the output characters (e.g., UTF-8 uses + different numbers of bytes to represent characters in different + ranges). Entries must be given in increasing Unicode order. + Only one file is allowed per encoding; the last specified file + is used. The Latin1, ASCII7, Symbol, ZapfDingbats, UTF-8, and + UCS-2 encodings are predefined. + + cMapDir registry-ordering dir + Specifies a search directory, dir, for CMaps for the reg- + istry-ordering character collection. There can be multiple + directories for a particular collection. There are no default + CMap directories. + + toUnicodeDir dir + Specifies a search directory, dir, for ToUnicode CMaps. There + can be multiple ToUnicode directories. There are no default + ToUnicode directories. + + mapNumericCharNames yes | no + If set to "yes", the Xpdf tools will attempt to map various + numeric character names sometimes used in font subsets. In some + cases this leads to usable text, and in other cases it leads to + gibberish -- there is no way for Xpdf to tell. This defaults to + "yes". + + mapUnknownCharNames yes | no + If set to "yes", and mapNumericCharNames is set to "no", the + Xpdf tools will apply a simple pass-through mapping (Unicode + index = character code) for all unrecognized glyph names. (For + CID fonts, setting mapNumericCharNames to "no" is unnecessary.) + In some cases, this leads to usable text, and in other cases it + leads to gibberish -- there is no way for Xpdf to tell. This + defaults to "no". + + mapExtTrueTypeFontsViaUnicode yes | no + When rasterizing text using an external TrueType font, there are + two options for handling character codes. If mapExtTrueType- + FontsViaUnicode is set to "yes", Xpdf will use the font encod- + ing/ToUnicode info to map character codes to Unicode, and then + use the font's Unicode cmap to map Unicode to GIDs. If mapExt- + TrueTypeFontsViaUnicode is set to "no", Xpdf will assume the + character codes are GIDs (i.e., use an identity mapping). This + defaults to "yes". + + useTrueTypeUnicodeMapping yes | no + If set to "yes", the Xpdf tools will use the Unicode encoding + information in TrueType fonts (16-bit only), if avaiable, to + override the PDF ToUnicode maps. Otherwise, the ToUnicode maps + are always used when present. This defaults to "no". + + dropFont font-name + Drop all text drawn in the specified font. To drop text drawn + in unnamed fonts, use: + + dropFont "" + + There can be any number of dropFont commands. + +RASTERIZER SETTINGS + enableFreeType yes | no + Enables or disables use of FreeType (a TrueType / Type 1 font + rasterizer). This is only relevant if the Xpdf tools were built + with FreeType support. ("enableFreeType" replaces the old + "freetypeControl" option.) This option defaults to "yes". + + disableFreeTypeHinting yes | no + If this is set to "yes", FreeType hinting will be forced off. + This option defaults to "no". + + antialias yes | no + Enables or disables font anti-aliasing in the PDF rasterizer. + This option affects all font rasterizers. ("antialias" replaces + the anti-aliasing control provided by the old "t1libControl" and + "freetypeControl" options.) This default to "yes". + + vectorAntialias yes | no + Enables or disables anti-aliasing of vector graphics in the PDF + rasterizer. This defaults to "yes". + + imageMaskAntialias yes | no + Enables or disables anti-aliasing of image masks (when downsam- + pling or upsampling) in the PDF rasterizer. This defaults to + "yes". + + antialiasPrinting yes | no + If this is "yes", bitmaps sent to the printer will be + antialiased (according to the "antialias" and "vectorAntialias" + settings). If this is "no", printed bitmaps will not be + antialiased. This defaults to "no". + + strokeAdjust yes | no | cad + Sets the stroke adjustment mode. If set to "no", no stroke + adjustment will be done. If set to "yes", normal stroke adjust- + ment will be done: horizontal and vertical lines will be moved + by up to half a pixel to make them look cleaner when vector + anti-aliasing is enabled. If set to "cad", a slightly different + stroke adjustment algorithm will be used to ensure that lines of + the same original width will always have the same adjusted width + (at the expense of allowing gaps and overlaps between adjacent + lines). This defaults to "yes". + + forceAccurateTiling yes | no + If this is set to "yes", the TilingType is forced to 2 (no dis- + tortion) for all tiling patterns, regardless of the setting in + the pattern dictionary. This defaults to "no". + + screenType dispersed | clustered | stochasticClustered + Sets the halftone screen type, which will be used when generat- + ing a monochrome (1-bit) bitmap. The three options are dis- + persed-dot dithering, clustered-dot dithering (with a round dot + and 45-degree screen angle), and stochastic clustered-dot + dithering. By default, "stochasticClustered" is used for reso- + lutions of 300 dpi and higher, and "dispersed" is used for reso- + lutions lower then 300 dpi. + + screenSize integer + Sets the size of the (square) halftone screen threshold matrix. + By default, this is 4 for dispersed-dot dithering, 10 for clus- + tered-dot dithering, and 100 for stochastic clustered-dot + dithering. + + screenDotRadius integer + Sets the halftone screen dot radius. This is only used when + screenType is set to stochasticClustered, and it defaults to 2. + In clustered-dot mode, the dot radius is half of the screen + size. Dispersed-dot dithering doesn't have a dot radius. + + screenGamma float + Sets the halftone screen gamma correction parameter. Gamma val- + ues greater than 1 make the output brighter; gamma values less + than 1 make it darker. The default value is 1. + + screenBlackThreshold float + When halftoning, all values below this threshold are forced to + solid black. This parameter is a floating point value between 0 + (black) and 1 (white). The default value is 0. + + screenWhiteThreshold float + When halftoning, all values above this threshold are forced to + solid white. This parameter is a floating point value between 0 + (black) and 1 (white). The default value is 1. + + minLineWidth float + Set the minimum line width, in device pixels. This affects the + rasterizer only, not the PostScript converter (except when it + uses rasterization to handle transparency). The default value + is 0 (no minimum). + + enablePathSimplification yes | no + If set to "yes", simplify paths by removing points where it + won't make a significant difference to the shape. The default + value is "no". + + overprintPreview yes | no + If set to "yes", generate overprint preview output, honoring the + OP/op/OPM settings in the PDF file. Ignored for non-CMYK out- + put. The default value is "no". + +VIEWER SETTINGS + These settings only apply to the Xpdf GUI PDF viewer. + + initialZoom percentage | page | width + Sets the initial zoom factor. A number specifies a zoom per- + centage, where 100 means 72 dpi. You may also specify 'page', + to fit the page to the window size, or 'width', to fit the page + width to the window width. + + defaultFitZoom percentage + If xpdf is started with fit-page or fit-width zoom and no window + geometry, it will calculate a desired window size based on the + PDF page size and this defaultFitZoom value. I.e., the window + size will be chosen such that exactly one page will fit in the + window at this zoom factor (which must be a percentage). The + default value is based on the screen resolution. + + initialDisplayMode single | continuous | sideBySideSingle | sideBySide- + Continuous | horizontalContinuous + Sets the initial display mode. The default setting is "continu- + ous". + + initialToolbarState yes | no + If set to "yes", xpdf opens with the toolbar visible. If set to + "no", xpdf opens with the toolbar hidden. The default is "yes". + + initialSidebarState yes | no + If set to "yes", xpdf opens with the sidebar (tabs, outline, + etc.) visible. If set to "no", xpdf opens with the sidebar + collapsed. The default is "yes". + + initialSidebarWidth width + Sets the initial sidebar width, in pixels. This is only rele- + vant if initialSidebarState is "yes". The default value is + zero, which tells xpdf to use an internal default size. + + initialSelectMode block | linear + Sets the initial selection mode. The default setting is "lin- + ear". + + paperColor color + Set the "paper color", i.e., the background of the page display. + The color can be #RRGGBB (hexadecimal) or a named color. This + option will not work well with PDF files that do things like + filling in white behind the text. + + matteColor color + Set the matte color, i.e., the color used for background outside + the actual page area. The color can be #RRGGBB (hexadecimal) or + a named color. + + fullScreenMatteColor color + Set the matte color for full-screen mode. The color can be + #RRGGBB (hexadecimal) or a named color. + + selectionColor color + Set the selection color. The color can be #RRGGBB (hexadecimal) + or a named color. + + reverseVideoInvertImages yes | no + If set to "no", xpdf's reverse-video mode inverts text and vec- + tor graphic content, but not images. If set to "yes", xpdf + inverts images as well. The default is "no". + + popupMenuCmd title command ... + Add a command to the popup menu. Title is the text to be dis- + played in the menu. Command is an Xpdf command (see the COM- + MANDS section of the xpdf(1) man page for details). Multiple + commands are separated by whitespace. + + maxTileWidth pixels + Set the maximum width of tiles to be used by xpdf when rasteriz- + ing pages. This defaults to 1500. + + maxTileHeight pixels + Set the maximum height of tiles to be used by xpdf when raster- + izing pages. This defaults to 1500. + + tileCacheSize tiles + Set the maximum number of tiles to be cached by xpdf when ras- + terizing pages. This defaults to 10. + + workerThreads numThreads + Set the number of worker threads to be used by xpdf when raster- + izing pages. This defaults to 1. + + launchCommand command + Sets the command executed when you click on a "launch"-type + link. The intent is for the command to be a program/script + which determines the file type and runs the appropriate viewer. + The command line will consist of the file to be launched, fol- + lowed by any parameters specified with the link. Do not use + "%s" in "command". By default, this is unset, and Xpdf will + simply try to execute the file (after prompting the user). + + movieCommand command + Sets the command executed when you click on a movie annotation. + The string "%s" will be replaced with the movie file name. This + has no default value. + + defaultPrinter printer + Sets the default printer used in the viewer's print dialog. + + bind modifiers-key context command ... + Add a key or mouse button binding. Modifiers can be zero or + more of: + + shift- + ctrl- + alt- + + Key can be a regular ASCII character, or any one of: + + space + tab + return + enter + backspace + esc + insert + delete + home + end + pgup + pgdn + left / right / up / down (arrow keys) + f1 .. f35 (function keys) + mousePress1 .. mousePress7 (mouse buttons) + mouseRelease1 .. mouseRelease7 (mouse buttons) + mouseClick1 .. mouseClick7 (mouse buttons) + mouseDoubleClick1 .. mouseDoubleClick7 (mouse buttons) + mouseTripleClick1 .. mouseTripleClick7 (mouse buttons) + + Context is either "any" or a comma-separated combination of: + + fullScreen / window (full screen mode on/off) + continuous / singlePage (continuous mode on/off) + overLink / offLink (mouse over link or not) + scrLockOn / scrLockOff (scroll lock on/off) + + The context string can include only one of each pair in the + above list. + + Command is an Xpdf command (see the COMMANDS section of the + xpdf(1) man page for details). Multiple commands are separated + by whitespace. + + The bind command replaces any existing binding, but only if it + was defined for the exact same modifiers, key, and context. All + tokens (modifiers, key, context, commands) are case-sensitive. + + Example key bindings: + + # bind ctrl-a in any context to the nextPage + # command + bind ctrl-a any nextPage + + # bind uppercase B, when in continuous mode + # with scroll lock on, to the reload command + # followed by the prevPage command + bind B continuous,scrLockOn reload prevPage + + See the xpdf(1) man page for more examples. + + unbind modifiers-key context + Removes a key binding established with the bind command. This + is most useful to remove default key bindings before establish- + ing new ones (e.g., if the default key binding is given for + "any" context, and you want to create new key bindings for mul- + tiple contexts). + + tabStateFile path + Sets the file used by the loadTabState and saveTabState commands + (see the xpdf(1) man page for more information). + +MISCELLANEOUS SETTINGS + drawAnnotations yes | no + If set to "no", annotations will not be drawn or printed. The + default value is "yes". + + drawFormFields yes | no + If set to "no", form fields will not be drawn or printed. The + default value is "yes". + + enableXFA yes | no + If an XFA form is present, and this option is set to "yes", Xpdf + will parse the XFA form and use certain XFA information to over- + ride AcroForm information. If set to "no", the XFA form will + not be read. The default value is "yes". + + savePageNumbers yes | no + If set to "yes", xpdf will save the current page numbers of all + open files in ~/.xpdf.pages when the files are closed (or when + quitting xpdf). Next time the file is opened, the last-viewed + page number will be restored. The default value is "yes". + + printCommands yes | no + If set to "yes", drawing commands are printed as they're exe- + cuted (useful for debugging). This defaults to "no". + + printStatusInfo + If set to "yes", print a status message (to stdout) before each + page is processed. This defaults to "no". + + errQuiet yes | no + If set to "yes", this suppresses all error and warning messages + from all of the Xpdf tools. This defaults to "no". + +EXAMPLES + The following is a sample xpdfrc file. + + # from the Thai support package + nameToUnicode /usr/local/share/xpdf/Thai.nameToUnicode + + # from the Japanese support package + cidToUnicode Adobe-Japan1 /usr/local/share/xpdf/Adobe-Japan1.cidToUnicode + unicodeMap JISX0208 /usr/local/share/xpdf/JISX0208.unicodeMap + cMapDir Adobe-Japan1 /usr/local/share/xpdf/cmap/Adobe-Japan1 + + # use the Base-14 Type 1 fonts from ghostscript + fontFile Times-Roman /usr/local/share/ghostscript/fonts/n021003l.pfb + fontFile Times-Italic /usr/local/share/ghostscript/fonts/n021023l.pfb + fontFile Times-Bold /usr/local/share/ghostscript/fonts/n021004l.pfb + fontFile Times-BoldItalic /usr/local/share/ghostscript/fonts/n021024l.pfb + fontFile Helvetica /usr/local/share/ghostscript/fonts/n019003l.pfb + fontFile Helvetica-Oblique /usr/local/share/ghostscript/fonts/n019023l.pfb + fontFile Helvetica-Bold /usr/local/share/ghostscript/fonts/n019004l.pfb + fontFile Helvetica-BoldOblique /usr/local/share/ghostscript/fonts/n019024l.pfb + fontFile Courier /usr/local/share/ghostscript/fonts/n022003l.pfb + fontFile Courier-Oblique /usr/local/share/ghostscript/fonts/n022023l.pfb + fontFile Courier-Bold /usr/local/share/ghostscript/fonts/n022004l.pfb + fontFile Courier-BoldOblique /usr/local/share/ghostscript/fonts/n022024l.pfb + fontFile Symbol /usr/local/share/ghostscript/fonts/s050000l.pfb + fontFile ZapfDingbats /usr/local/share/ghostscript/fonts/d050000l.pfb + + # use the Bakoma Type 1 fonts + # (this assumes they happen to be installed in /usr/local/fonts/bakoma) + fontDir /usr/local/fonts/bakoma + + # set some PostScript options + psPaperSize letter + psDuplex no + psLevel level2 + psEmbedType1Fonts yes + psEmbedTrueTypeFonts yes + + # assume that the PostScript printer has the Univers and + # Univers-Bold fonts + psResidentFont Univers Univers + psResidentFont Univers-Bold Univers-Bold + + # set the text output options + textEncoding UTF-8 + textEOL unix + + # misc options + enableFreeType yes + launchCommand viewer-script + + +FILES + /etc/xpdfrc + This is the default location for the system-wide configuration + file. Depending on build options, it may be placed elsewhere. + + $HOME/.xpdfrc + This is the user's configuration file. If it exists, it will be + read in place of the system-wide file. + +AUTHOR + The Xpdf software and documentation are copyright 1996-2022 Glyph & + Cog, LLC. + +SEE ALSO + xpdf(1), pdftops(1), pdftotext(1), pdftohtml(1), pdfinfo(1), pdf- + fonts(1), pdfdetach(1), pdftoppm(1), pdftopng(1), pdfimages(1) + http://www.xpdfreader.com/ + + + + 18 Apr 202 xpdfrc(5) |