1 ! Generated automatically by mantohlp
4 xpdf - Portable Document Format (PDF) file viewer for X
7 xpdf [options] [PDF-file [page | +dest]]
9 Xpdf is a viewer for Portable Document Format (PDF) files.
10 (These are also sometimes also called 'Acrobat' files,
11 from the name of Adobe's PDF software.) Xpdf runs under
12 the X Window System on UNIX, VMS, and OS/2.
14 To run xpdf, simply type:
18 where file.pdf is your PDF file. The file name can be
19 followed by a number specifying the page which should be
20 displayed first, e.g.:
24 You can also give a named destination, prefixed with '+'
25 in place of the page number. (This is only useful with
26 PDF files that provide named destination targets.)
28 You can also start xpdf without opening any files:
36 Xpdf reads a configuration file at startup. It first
37 tries to find the user's private config file, ~/.xpdfrc.
38 If that doesn't exist, it looks for a system-wide config
39 file, typically /usr/local/etc/xpdfrc (but this location
40 can be changed when xpdf is built). See the xpdfrc(5) man
47 Many of the following options can be set with configura-
48 tion file commands or X resources. These are listed in
49 square brackets with the description of the corresponding
53 Set the initial window geometry. (-geometry is
54 equivalent.) [X resource: xpdf.geometry]
57 Set the window title. By default, the title will
58 be "xpdf: foo.pdf". [X resource: xpdf.title]
60 -cmap Install a private colormap. This is ignored on
61 TrueColor visuals. [X resource: xpdf.installCmap]
64 Set the size of largest RGB cube xpdf will try to
65 allocate. The default is 5 (for a 5x5x5 cube); set
66 to a smaller number to conserve color table
67 entries. This is ignored with private colormaps
68 and on TrueColor visuals. [X resource:
71 -rv Set reverse video mode. This reverses the colors
72 of everything except images. It may not always
73 produce great results for PDF files which do weird
74 things with color. This also causes the paper
75 color to default to black. [X resource:
79 Set the "paper color", i.e., the background of the
80 page display. This will not work too well with PDF
81 files that do things like filling in white behind
82 the text. [X resource: xpdf.paperColor]
85 Set the matte color, i.e., the color used for back-
86 ground outside the actual page area. (There is a
87 separate setting, xpdf.fullScreenMatteColor, for
88 full-screen mode.) [X resource: xpdf.matteColor]
91 Set the initial zoom factor. A number specifies a
92 zoom percentage, where 100 means 72 dpi.You may
93 also specify 'page', to fit the page to the window
94 size, or 'width', to fit the page width to the win-
95 dow width. [config file: initialZoom; or X
96 resource: xpdf.initialZoom]
98 -cont Start in continuous view mode, i.e., with one ver-
99 tical scroll bar for the whole document. [config
100 file: continuousView]
103 Enable or disable t1lib (a Type 1 font rasterizer).
104 This defaults to "yes". [config file: enableT1lib]
107 Enable or disable FreeType (a TrueType / Type 1
108 font rasterizer). This defaults to "yes". [config
109 file: enableFreeType]
112 Enable or disable font anti-aliasing. This
113 defaults to "yes". [config file: antialias]
116 Enable or disable vector anti-aliasing. This
117 defaults to "yes". [config file: vectorAntialias]
120 Set the default file name for PostScript output
121 (i.e., the name which will appear in the print dia-
122 log). This can also be of the form '|command' to
123 pipe the PostScript through a command. [config
127 Set the paper size to one of "letter", "legal",
128 "A4", or "A3". This can also be set to "match",
129 which will set the paper size to match the size
130 specified in the PDF file. [config file: psPaper-
134 Set the paper width, in points. [config file:
138 Set the paper height, in points. [config file:
142 Generate Level 1 PostScript. The resulting
143 PostScript files will be significantly larger (if
144 they contain images), but will print on Level 1
145 printers. This also converts all images to black
146 and white. [config file: psLevel]
149 Sets the encoding to use for text output. The
150 encoding-name must be defined with the unicodeMap
151 command (see xpdfrc(5)). This defaults to "Latin1"
152 (which is a built-in encoding). [config file: tex-
155 -eol unix | dos | mac
156 Sets the end-of-line convention to use for text
157 output. [config file: textEOL]
160 Specify the owner password for the PDF file. Pro-
161 viding this will bypass all security restrictions.
164 Specify the user password for the PDF file.
167 Open xpdf in full-screen mode, useful for presenta-
171 Start/contact xpdf remote server with specified
172 name (see the REMOTE SERVER MODE section below).
175 Execute a command (see the COMMANDS section below)
176 in an xpdf remote server window (with -remote
180 Reload xpdf remote server window (with -remote
183 -raise Raise xpdf remote server window (with -remote
186 -quit Kill xpdf remote server (with -remote only).
188 -cmd Print commands as they're executed (useful for
189 debugging). [config file: printCommands]
191 -q Don't print any messages or errors. [config file:
195 Read config-file in place of ~/.xpdfrc or the sys-
196 tem-wide config file.
198 -v Print copyright and version information.
200 -h Print usage information. (-help and --help are
203 Several other standard X options and resources will work
207 [X resource: xpdf.display]
210 (-foreground is equivalent.) [X resource:
214 (-background is equivalent.) [X resource:
218 (-fn is equivalent.) [X resource: xpdf*fontList]
220 The color and font options only affect the user interface
221 elements, not the PDF display (the 'paper').
223 The following X resources do not have command line option
227 Enables (if set to true) or disables (if set to
228 false) the tool-tips on the toolbar buttons.
230 xpdf.fullScreenMatteColor
231 Sets the matte color to be used in full-screen
232 mode. The default setting is "black".
238 On-screen controls, at the bottom of the xpdf window
239 left/right arrow buttons
240 Move to the previous/next page.
242 double left/right arrow buttons
243 Move backward or forward by ten pages.
245 dashed left/right arrow buttons
246 Move backward or forward along the history path.
249 Move to a specific page number. Click in the box
250 to activate it, type the page number, then hit
254 Change the zoom factor (see the description of the
261 Bring up a dialog for generating a PostScript file.
262 The dialog has options to set the pages to be
263 printed and the PostScript file name. The file
264 name can be '-' for stdout or '|command' to pipe
265 the PostScript through a command, e.g., '|lpr'.
268 Bring up the 'about xpdf' window.
271 The space between the '?' and 'Quit' buttons is
272 used to show the URL or external file name when the
273 mouse is over a link.
279 Pressing the right mouse button will post a popup menu
280 with the following commands:
283 Open a new PDF file via a file requester.
285 Open in new window...
286 Create a new window and open a new PDF file via a
289 Reload Reload the current PDF file. Note that Xpdf will
290 reload the file automatically (on a page change or
291 redraw) if it has changed since it was last loaded.
294 Save the current file via a file requester.
297 Toggles between single page and continuous view
300 Rotate counterclockwise
301 Rotate the page 90 degrees counterclockwise.
304 Rotate the page 90 degrees clockwise. The two
305 rotate commands are intended primarily for PDF
306 files where the rotation isn't correctly specified
310 Zoom in to the currently selected rectangle.
312 Close Close the current window. If this is the only open
313 window, the document is closed, but the window is
314 left open (i.e., this menu command won't quit
320 If the PDF contains an outline (a.k.a., bookmarks), there
321 will be an outline pane on the left side of the window.
322 The width of the outline pane is adjustable with a verti-
323 cal split bar via the knob near its bottom end.
326 Dragging the mouse with the left button held down will
327 highlight an arbitrary rectangle. Any text inside this
328 rectangle will be copied to the X selection buffer.
331 Clicking on a hyperlink will jump to the link's destina-
332 tion. A link to another PDF document will make xpdf load
333 that document. A 'launch' link to an executable program
334 will display a dialog, and if you click 'ok', execute the
335 program. URL links call an external command (see the WEB
336 BROWSERS section below).
339 Dragging the mouse with the middle button held down pans
343 o Open a new PDF file via a file requester.
345 r Reload the current PDF file. Note that Xpdf will
346 reload the file automatically (on a page change or
347 redraw) if it has changed since it was last loaded.
350 Redraw the current page.
353 Close the current window.
359 Find next occurrence.
364 n Move to the next page. Scrolls to the top of the
365 page, unless scroll lock is turned on.
367 p Move to the previous page. Scrolls to the top of
368 the page, unless scroll lock is turned on.
370 <Space> or <PageDown> or <Next>
371 Scroll down on the current page; if already at bot-
372 tom, move to next page.
374 <Backspace> or <Delete> or <PageUp> or <Previous>
375 Scroll up on the current page; if already at top,
376 move to previous page.
378 v Move forward along the history path.
380 b Move backward along the history path.
382 <Home> Scroll to top of current page.
384 <End> Scroll to bottom of current page.
387 Scroll to first page of document.
390 Scroll to last page of document.
392 arrows Scroll the current page.
394 g Activate the page number text field ("goto page").
396 0 Set the zoom factor to 125%.
398 + Zoom in (increment the zoom factor by 1).
400 - Zoom out (decrement the zoom factor by 1).
402 z Set the zoom factor to 'page' (fit page to window).
404 w Set the zoom factor to 'width' (fit page width to
407 alt-F Toggle full-screen mode.
415 If you want to run xpdf automatically from netscape or
416 mosaic (and probably other browsers) when you click on a
417 link to a PDF file, you need to edit (or create) the files
418 .mime.types and .mailcap in your home directory. In
419 .mime.types add the line:
423 In .mailcap add the lines:
425 # Use xpdf to view PDF files.
426 application/pdf; xpdf -q %s
428 Make sure that xpdf is on your executable search path.
430 When you click on a URL link in a PDF file, xpdf will exe-
431 cute the command specified by the urlCommand config file
432 option, replacing an occurrence of '%s' with the URL. For
433 example, to call netscape with the URL, add this line to
436 urlCommand "netscape -remote 'openURL(%s)'"
442 Xpdf's key and mouse bindings are user-configurable, using
443 the bind and unbind options in the config file (see
444 xpdfrc(5)). The bind command allows you to bind a key or
445 mouse button to a sequence of one or more commands.
448 The following commands are supported:
451 Go to the specified page.
453 gotoPageNoScroll(page)
454 Go to the specified page, with the current relative
458 Go to a named destination.
461 Go to the last page in the PDF file.
464 Go to the last page in the PDF file, with the cur-
465 rent relative scroll position.
471 Go to the next page, with the current relative
475 Go to the previous page.
478 Go to the previous page, with the current relative
481 pageUp Scroll up by one screenful.
484 Scroll down by one screenful.
487 Scroll left by n pixels.
490 Scroll right by n pixels.
493 Scroll up by n pixels.
496 Scroll down by n pixels.
499 Scroll up by n pixels, moving to the previous page
502 scrollDownPrevPage(n)
503 Scroll down by n pixels, moving to the next page if
507 Scroll to the top edge of the current page, with no
511 Scroll to the bottom edge of the current page, with
512 no horizontal movement.
515 Scroll to the left edge of the current page, with
516 no vertical movement.
519 Scroll to the right edge of the current page, with
520 no vertical movement.
523 Scroll to the top-left corner of the current page.
526 Scroll to the bottom-right corner of the current
530 Move forward along the history path.
533 Move backward along the history path.
536 Set the zoom factor to z%.
539 Set the zoom factor to fit-page.
542 Set the zoom factor to fit-width.
544 zoomIn Zoom in - go to the next higher zoom factor.
547 Zoom out - go the next lower zoom factor.
550 Go to continuous view mode.
553 Go to single-page view mode.
556 Toggle between continuous and single page view
560 Go to full-screen mode.
563 Go to window (non-full-screen) mode.
566 Toggle between full-screen and window modes.
568 open Open a PDF file in this window, using the open
572 Open a PDF file in a new window, using the open
576 Open a specified PDF file in this window.
578 openFileInNewWin(file)
579 Open a specified PDF file in a new window.
581 openFileAtDest(file,dest)
582 Open a specified PDF file in this window and go to
585 openFileAtDestInNewWin(file,dest)
586 Open a specified PDF file in a new window and go to
589 reload Reload the current PDF file.
591 redraw Redraw the window.
593 raise Raise the window to the front.
598 run(external-command-string)
599 Run an external command. The following escapes are
600 allowed in the command string:
602 %f => PDF file name (or an empty string if no
604 %b => PDF file base name, i.e., file name minus
605 the extension (or an empty string if no
607 %u => link URL (or an empty string if not over
609 %x => selection upper-left x coordinate
610 (or 0 if there is no selection)
611 %y => selection upper-left y coordinate
612 (or 0 if there is no selection)
613 %X => selection lower-right x coordinate
614 (or 0 if there is no selection)
615 %Y => selection lower-right y coordinate
616 (or 0 if there is no selection)
620 Open the outline pane.
623 Close the outline pane.
626 Toggle the outline pane between open and closed.
629 Scroll the outline down by n increments.
632 Scroll the outline up by n increments.
635 Set the keyboard focus to the main document window.
638 Set the keyboard focus to the page number text box.
640 find Open the 'find' dialog.
643 Finds the next occurrence of the search string (no
646 print Open the 'print' dialog.
648 about Open the 'about' dialog.
652 The following commands depend on the current mouse posi-
656 Start a selection, which will be extended as the
663 Start a pan, which will scroll the document as the
669 Display the popup menu.
672 Follow a hyperlink (does nothing if the mouse is
676 Follow a hyperlink, opening PDF files in a new win-
677 dow (does nothing if the mouse is not over a link).
678 For links to non-PDF files, this command is identi-
682 Same as followLink, but does nothing if there is a
683 non-empty selection. (This is useful as a mouse
686 followLinkInNewWinNoSel
687 Same as followLinkInNewWin, but does nothing if
688 there is a non-empty selection. (This is useful as
689 a mouse button binding.)
692 The default mouse bindings are as follows:
694 bind mousePress1 any startSelection
695 bind mouseRelease1 any endSelection followLinkNoSel
696 bind mousePress2 any startPan
697 bind mouseRelease2 any endPan
698 bind mousePress3 any postPopupMenu
699 bind mousePress4 any scrollUpPrevPage(16)
700 bind mousePress5 any scrollDownNextPage(16)
701 bind mousePress6 any scrollLeft(16)
702 bind mousePress7 any scrollRight(16)
704 The default key bindings are as follows:
706 bind ctrl-home any gotoPage(1)
707 bind home any scrollToTopLeft
708 bind ctrl-end any gotoLastPage
709 bind end any scrollToBottomRight
711 bind backspace any pageUp
712 bind delete any pageUp
713 bind pgdn any pageDown
714 bind space any pageDown
715 bind left any scrollLeft(16)
716 bind right any scrollRight(16)
717 bind up any scrollUp(16)
718 bind down any scrollDown(16)
726 bind ctrl-g any findNext
727 bind ctrl-p any print
728 bind n scrLockOff nextPage
729 bind N scrLockOff nextPage
730 bind n scrLockOn nextPageNoScroll
731 bind N scrLockOn nextPageNoScroll
732 bind p scrLockOff prevPage
733 bind P scrLockOff prevPage
734 bind p scrLockOn prevPageNoScroll
735 bind P scrLockOn prevPageNoScroll
737 bind b any goBackward
738 bind g any focusToPageNum
739 bind 0 any zoomPercent(125)
742 bind z any zoomFitPage
743 bind w any zoomFitWidth
744 bind alt-f any toggleFullScreenMode
745 bind ctrl-l any redraw
746 bind ctrl-w any closeWindow
751 Previous versions of xpdf included a "viKeys" X resource.
752 It is no longer available, but the following bindings are
755 bind h any scrollLeft(16)
756 bind l any scrollRight(16)
757 bind k any scrollUp(16)
758 bind j any scrollDown(16)
764 Xpdf can be started in remote server mode by specifying a
765 server name (in addition to the file name and page num-
768 xpdf -remote myServer file.pdf
770 If there is currently no xpdf running in server mode with
771 the name 'myServer', a new xpdf window will be opened. If
774 xpdf -remote myServer another.pdf 9
776 is issued, a new copy of xpdf will not be started.
777 Instead, the first xpdf (the server) will load another.pdf
778 and display page nine. If the file name is the same:
780 xpdf -remote myServer another.pdf 4
782 the xpdf server will simply display the specified page.
784 The -raise option tells the server to raise its window; it
785 can be specified with or without a file name and page num-
788 The -quit option tells the server to close its window and
795 The Xpdf tools use the following exit codes:
799 1 Error opening a PDF file.
801 2 Error opening an output file.
803 3 Error related to PDF permissions.
811 The xpdf software and documentation are copyright
812 1996-2007 Glyph & Cog, LLC.
818 pdftops(1), pdftotext(1), pdfinfo(1), pdffonts(1),
819 pdftoppm(1), pdfimages(1), xpdfrc(5)
820 http://www.foolabs.com/xpdf/