summaryrefslogtreecommitdiff
path: root/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/libs/xpdf/xpdf-src/doc/xpdf.1')
-rw-r--r--Build/source/libs/xpdf/xpdf-src/doc/xpdf.11005
1 files changed, 432 insertions, 573 deletions
diff --git a/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1 b/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
index c34ad7fb787..b463d0fab43 100644
--- a/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
+++ b/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
@@ -1,20 +1,20 @@
-.\" Copyright 1996-2014 Glyph & Cog, LLC
-.TH xpdf 1 "28 May 2014"
+.\" Copyright 1996-2017 Glyph & Cog, LLC
+.TH xpdf 1 "10 Aug 2017"
.SH NAME
-xpdf \- Portable Document Format (PDF) file viewer for X (version 3.04)
+xpdf \- Portable Document Format (PDF) file viewer (version 4.00)
.SH SYNOPSIS
.B xpdf
[options]
.RI [ PDF-file
-.RI [ page " | +" dest ]]
+.RI [: page " | +" dest "]] ..."
.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 runs under the X Window System on UNIX, VMS, and
-OS/2.
+software.) Xpdf uses the Qt GUI toolkit and runs on Unix, OS X, and
+Windows.
.PP
-To run xpdf, simply type:
+To run xpdf, type:
.PP
.RS
xpdf file.pdf
@@ -22,16 +22,26 @@ xpdf file.pdf
.PP
where
.I file.pdf
-is your PDF file. The file name can be followed by a number
-specifying the page which should be displayed first, e.g.:
+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
+xpdf file.pdf :18
.RE
.PP
-You can also give a named destination, prefixed with \'+' in place of
-the page number. (This is only useful with PDF files that provide
-named destination targets.)
+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
@@ -46,66 +56,49 @@ looks for a system-wide config file, typically /usr/local/etc/xpdfrc
.BR xpdfrc (5)
man page for details.
.SH OPTIONS
-Many of the following options can be set with configuration file
-commands or X resources. These are listed in square brackets with the
-description of the corresponding command line option.
+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 \-g " geometry"
+.BI \-geometry " geometry"
Set the initial window geometry.
-.RB ( \-geometry
-is equivalent.)
-.RB "[X resource: " xpdf.geometry ]
.TP
.BI \-title " title"
Set the window title. By default, the title will be "xpdf: foo.pdf".
-.RB "[X resource: " xpdf.title ]
-.TP
-.B \-cmap
-Install a private colormap. This is ignored on TrueColor visuals.
-.RB "[X resource: " xpdf.installCmap ]
-.TP
-.BI \-rgb " number"
-Set the size of largest RGB cube xpdf will try to allocate. The
-default is 5 (for a 5x5x5 cube); set to a smaller number to conserve
-color table entries. This is ignored with private colormaps and on
-TrueColor visuals.
-.RB "[X resource: " xpdf.rgbCubeSize ]
.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.
-.RB "[X resource: " xpdf.reverseVideo ]
.TP
.BI \-papercolor " color"
-Set the "paper color", i.e., the background of the page display. This
-will not work too well with PDF files that do things like filling in
-white behind the text.
-.RB "[X resource: " xpdf.paperColor ]
+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. (There is a separate setting,
-xpdf.fullScreenMatteColor, for full-screen mode.)
-.RB "[X resource: " xpdf.matteColor ]
+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 "; or X resource: " xpdf.initialZoom ]
-.TP
-.B \-cont
-Start in continuous view mode, i.e., with one vertical scroll bar for
-the whole document.
-.RB "[config file: " continuousView ]
-.TP
-.BI \-freetype " yes | no"
-Enable or disable FreeType (a TrueType / Type 1 font rasterizer).
-This defaults to "yes".
-.RB "[config file: " enableFreeType ]
+.RB "[config file: " initialZoom ]
.TP
.BI \-aa " yes | no"
Enable or disable font anti-aliasing. This defaults to "yes".
@@ -115,32 +108,6 @@ Enable or disable font anti-aliasing. This defaults to "yes".
Enable or disable vector anti-aliasing. This defaults to "yes".
.RB "[config file: " vectorAntialias ]
.TP
-.BI \-ps " PS-file"
-Set the default file name for PostScript output (i.e., the name which
-will appear in the print dialog). This can also be of the form
-\'|command' to pipe the PostScript through a command.
-.RB "[config file: " psFile ]
-.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 \-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.
-.RB "[config file: " psLevel ]
-.TP
.BI \-enc " encoding-name"
Sets the encoding to use for text output. The
.I encoding\-name
@@ -149,47 +116,21 @@ must be defined with the unicodeMap command (see
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
-.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.
+.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 " name"
-Start/contact xpdf remote server with specified name (see the
-.B "REMOTE SERVER MODE"
-section below).
-.TP
-.BI \-exec " command"
-Execute a command (see the
-.B COMMANDS
-section below) in an xpdf remote server window (with \-remote only).
-.TP
-.B \-reload
-Reload xpdf remote server window (with \-remote only).
-.TP
-.B \-raise
-Raise xpdf remote server window (with \-remote only).
-.TP
-.B \-quit
-Kill xpdf remote server (with \-remote only).
+.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
-.B \-q
-Don't print any messages or errors.
-.RB "[config file: " errQuiet ]
-.TP
.BI \-cfg " config-file"
Read
.I config-file
@@ -205,439 +146,403 @@ and
.B \-\-help
are equivalent.)
.PP
-Several other standard X options and resources will work as expected:
-.TP
-.BI \-display " display"
-.RB "[X resource: " xpdf.display ]
-.TP
-.BI \-fg " color"
-.RB ( \-foreground
-is equivalent.)
-.RB "[X resource: " xpdf*Foreground ]
-.TP
-.BI \-bg " color"
-.RB ( \-background
-is equivalent.)
-.RB "[X resource: " xpdf*Background ]
-.TP
-.BI \-font " font"
-.RB ( \-fn
-is equivalent.)
-.RB "[X resource: " xpdf*fontList ]
-.PP
-The color and font options only affect the user interface elements,
-not the PDF display (the \'paper').
-.PP
-The following X resources do not have command line option equivalents:
-.TP
-.B xpdf.toolTipEnable
-Enables (if set to true) or disables (if set to false) the tool-tips
-on the toolbar buttons.
-.TP
-.B xpdf.fullScreenMatteColor
-Sets the matte color to be used in full-screen mode. The default
-setting is "black".
.SH CONTROLS
-.SS On-screen controls, at the bottom of the xpdf window
+.SS Tool bar
.TP
-.B "left/right arrow buttons"
-Move to the previous/next page.
-.TP
-.B "double left/right arrow buttons"
-Move backward or forward by ten pages.
-.TP
-.B "dashed left/right arrow buttons"
-Move backward or forward along the history path.
-.TP
-.B "\'Page' entry box"
+.B "\'page' entry box"
Move to a specific page number. Click in the box to activate it, type
the page number, then hit return.
.TP
-.B "zoom popup menu"
-Change the zoom factor (see the description of the \-z option above).
-.TP
-.B "binoculars button"
-Find a text string.
-.TP
-.B "print button"
-Bring up a dialog for generating a PostScript file. The dialog has
-options to set the pages to be printed and the PostScript file name.
-The file name can be \'-' for stdout or \'|command' to pipe the
-PostScript through a command, e.g., \'|lpr'.
-.TP
-.B "\'?' button"
-Bring up the \'about xpdf' window.
-.TP
-.B "link info"
-The space between the \'?' and \'Quit' buttons is used to show the URL
-or external file name when the mouse is over a link.
-.TP
-.B "\'Quit' button"
-Quit xpdf.
-.PP
-.SS Menu
-Pressing the right mouse button will post a popup menu with the
-following commands:
-.TP
-.B "Open..."
-Open a new PDF file via a file requester.
+.B "left/right arrow buttons"
+Go backward or forward along the history path.
.TP
-.B "Open in new window..."
-Create a new window and open a new PDF file via a file requester.
+.B "zoom out/in buttons"
+Zoom out or in (i.e., change magnification) incrementally.
.TP
-.B "Reload"
-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.
+.B "zoom popup menu"
+Change the zoom factor (see the description of the \-z option above).
.TP
-.B "Save as..."
-Save the current file via a file requester.
+.B "fit width button"
+Change the zoom factor to fit the page width to the window width.
.TP
-.B "Continuous view"
-Toggles between single page and continuous view modes.
+.B "fit page button"
+Change the zoom factor to fit the page to the window size.
.TP
-.B "Rotate counterclockwise"
-Rotate the page 90 degrees counterclockwise.
+.B "working/error 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 "Rotate clockwise"
-Rotate the page 90 degrees clockwise. The two rotate commands are
-intended primarily for PDF files where the rotation isn't correctly
-specified in the file.
+.B "\'find' box"
+Find a text string. Click in the box to activate it, type a search
+string, then hit return.
.TP
-.B "Zoom to selection"
-Zoom in to the currently selected rectangle.
+.B "find next button"
+Find the next occurrence of the search string.
.TP
-.B "Close"
-Close the current window. If this is the only open window, the
-document is closed, but the window is left open (i.e., this menu
-command won't quit xpdf).
+.B "find previous button"
+Find the previous occurrence of the search string.
.TP
-.B "Quit"
-Quit xpdf.
+.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 tool bar. The menu items should be
+self-explanatory.
+.PP
+.SS Tab list
+The tab list is on the left, just below the tool bar. 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
-.SS Outline
-If the PDF contains an outline (a.k.a., bookmarks), there will be an
-outline pane on the left side of the window. The width of the outline
-pane is adjustable with a vertical split bar via the knob near its
-bottom end.
+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
Dragging the mouse with the left button held down will highlight an
-arbitrary rectangle. Any text inside this rectangle will be copied to
-the X selection buffer.
+arbitrary rectangle. 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 call an external
-command (see the
-.B WEB BROWSERS
-section below).
+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
-.SS Panning
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 o
+.B control-o
Open a new PDF file via a file requester.
.TP
-.B r
+.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-L
-Redraw the current page.
-.TP
-.B control-W
-Close the current window.
-.TP
-.B f or control-F
-Find a text string.
+.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
-.B n
-Move to the next page. Scrolls to the top of the page, unless scroll
-lock is turned on.
+.BR control-0 " (control-zero)"
+Set the zoom factor to 125%.
.TP
-.B p
-Move to the previous page. Scrolls to the top of the page, unless
-scroll lock is turned on.
+.BR control-+ " (control-plus)"
+Zoom in (increment the zoom factor by 1).
.TP
-.BR <Space> " or " <PageDown> " or " <Next>
-Scroll down on the current page; if already at bottom, move to next
-page.
+.BR control-- " (control-minus)"
+Zoom out (decrement the zoom factor by 1).
.TP
-.BR <Backspace> " or " <Delete> " or " <PageUp> " or " <Previous>
-Scroll up on the current page; if already at top, move to previous
-page.
+.B control-s
+Save PDF via a file requester.
.TP
-.B v
-Move forward along the history path.
+.B control-t
+Open a new tab.
.TP
-.B b
-Move backward along the history path.
+.B control-n
+Open a new window.
.TP
-.B <Home>
-Scroll to top of current page.
+.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 <End>
-Scroll to bottom of current page.
+.B control-q
+Quit.
.TP
-.B control-<Home>
-Scroll to first page of document.
+.B control-<tab>
+Next tab.
.TP
-.B control-<End>
-Scroll to last page of document.
+.B control-shift-<tab>
+Previous tab.
.TP
-.B arrows
-Scroll the current page.
+.B control-?
+Help.
.TP
-.B g
-Activate the page number text field ("goto page").
+.B alt-<left-arrow>
+Go backward along the history path.
.TP
-.B 0
-Set the zoom factor to 125%.
+.B alt-<right-arrow>
+Go forward along the history path.
.TP
-.B +
-Zoom in (increment the zoom factor by 1).
+.B home
+Go to the top left of current page.
.TP
-.B -
-Zoom out (decrement the zoom factor by 1).
+.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).
+Set the zoom factor to \'page' (fit page to window).
.TP
.B w
-Set the zoom factor to 'width' (fit page width to window).
-.TP
-.B alt-F
-Toggle full-screen mode.
-.TP
-.B q
-Quit xpdf.
-.SH "WEB BROWSERS"
-If you want to run xpdf automatically from netscape or mosaic (and
-probably other browsers) when you click on a link to a PDF file, you
-need to edit (or create) the files
-.I .mime.types
-and
-.I .mailcap
-in your home directory. In
-.I .mime.types
-add the line:
-.PP
-.RS
-application/pdf pdf
-.RE
-.PP
-In
-.I .mailcap
-add the lines:
-.PP
-.RS
-# Use xpdf to view PDF files.
-.RE
-.RS
-application/pdf; xpdf \-q %s
-.RE
-.PP
-Make sure that xpdf is on your executable search path.
+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
+.BR toggleFullScreenMode command .
.PP
-When you click on a URL link in a PDF file, xpdf will execute the
-command specified by the urlCommand config file option, replacing an
-occurrence of \'%s' with the URL. For example, to call netscape with
-the URL, add this line to your config file:
+Entering full-screen mode automatically switches to single-page view
+mode and to the fit-page zoom factor.
.PP
-.RS
-urlCommand "netscape \-remote 'openURL(%s)'"
-.RE
+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 options in the config file (see
+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.
-.SS Available Commands
+.PP
The following commands are supported:
.TP
-.BI gotoPage( page )
-Go to the specified page.
+.B about
+Open the \'about' dialog.
.TP
-.BI gotoPageNoScroll( page )
-Go to the specified page, with the current relative scroll position.
+.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 gotoDest( dest )
-Go to a named destination.
+.B closeSidebar
+Close the sidebar.
.TP
-.B gotoLastPage
-Go to the last page in the PDF file.
+.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 gotoLastPageNoScroll
-Go to the last page in the PDF file, with the current relative scroll
-position.
+.B closeSidebarResizeWin
+Close the sidebar, resizing the window so that the document size
+doesn't change.
.TP
-.B nextPage
-Go to the next page.
+.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 nextPageNoScroll
-Go to the next page, with the current relative scroll position.
+.B closeWindowOrQuit
+Close the window. If this was the last open window, quit.
.TP
-.B prevPage
-Go to the previous page.
+.B continuousMode
+Switch to continuous view mode.
.TP
-.B prevPageNoScroll
-Go to the previous page, with the current relative scroll position.
+.B copy
+Copy selected text to the clipboard.
.TP
-.B pageUp
-Scroll up by one screenful.
+.B endPan
+End a pan operation.
.TP
-.B pageDown
-Scroll down by one screenful.
+.B endSelection
+End a selection.
.TP
-.BI scrollLeft( n )
-Scroll left by
-.I n
-pixels.
+.B find
+Set keyboard focus to the \'find' box.
.TP
-.BI scrollRight( n )
-Scroll right by
-.I n
-pixels.
+.B findFirst
+Find the first occurrence of the search string.
.TP
-.BI scrollUp( n )
-Scroll up by
-.I n
-pixels.
+.B findNext
+Find the next occurrence of the search string.
.TP
-.BI scrollDown( n )
-Scroll down by
-.I n
-pixels.
+.B findPrevious
+Find the previous occurrence of the search string.
.TP
-.BI scrollUpPrevPage( n )
-Scroll up by
-.I n
-pixels, moving to the previous page if appropriate.
+.B focusToDocWin
+Set keyboard focus to the main document window.
.TP
-.BI scrollDownPrevPage( n )
-Scroll down by
-.I n
-pixels, moving to the next page if appropriate.
+.B focusToPageNum
+Set keyboard focus to the page number text box.
.TP
-.B scrollToTopEdge
-Scroll to the top edge of the current page, with no horizontal
-movement.
+.B followLink
+Follow a hyperlink (does nothing if the mouse is not over a link).
.TP
-.B scrollToBottomEdge
-Scroll to the bottom edge of the current page, with no horizontal
-movement.
+.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 scrollToLeftEdge
-Scroll to the left edge of the current page, with no vertical
-movement.
+.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 scrollToRightEdge
-Scroll to the right edge of the current page, with no vertical
-movement.
+.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 scrollToTopLeft
-Scroll to the top-left corner of the current page.
+.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 scrollToBottomRight
-Scroll to the bottom-right corner of the current page.
+.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 goForward
-Move forward along the history path.
+.B fullScreenMode
+Go to full-screen mode.
.TP
.B goBackward
Move backward along the history path.
.TP
-.BI zoomPercent( z )
-Set the zoom factor to
-.IR z %.
+.B goForward
+Move forward along the history path.
.TP
-.B zoomFitPage
-Set the zoom factor to fit-page.
+.BI gotoDest( dest )
+Go to a named destination.
.TP
-.B zoomFitWidth
-Set the zoom factor to fit-width.
+.B gotoLastPage
+Go to the last page in the PDF file.
.TP
-.B zoomIn
-Zoom in - go to the next higher zoom factor.
+.BI gotoPage( page )
+Go to the specified page.
.TP
-.B zoomOut
-Zoom out - go the next lower zoom factor.
+.BI help
+Open the help URL.
.TP
-.B rotateCW
-Rotate the page 90 degrees clockwise.
+.B horizontalContinuousMode
+Switch to horizontal continuous view mode.
.TP
-.B rotateCCW
-Rotate the page 90 degrees counterclockwise.
+.B linearSelectMode
+Set linear selection mode. In this mode, the selection follows text.
+Non-text regions cannot be selected.
.TP
-.BI setSelection( pg , ulx , uly , lrx , lry )
-Set the selection to the specified coordinates on the specified page.
+.B newTab
+Open an empty new tab.
.TP
-.B continuousMode
-Go to continuous view mode.
+.B newWindow
+Open an empty new window.
.TP
-.B singlePageMode
-Go to single-page view mode.
+.B nextPage
+Go to the next page.
.TP
-.B toggleContinuousMode
-Toggle between continuous and single page view modes.
+.B nextPageNoScroll
+Go to the next page, with the current relative scroll position.
.TP
-.B fullScreenMode
-Go to full-screen mode.
+.B nextTab
+Switch to the next tab.
.TP
-.B windowMode
-Go to window (non-full-screen) mode.
+.B open
+Open a PDF file in this tab, using the open dialog.
.TP
-.B toggleFullScreenMode
-Toggle between full-screen and window modes.
+.B openErrorWindow
+Open the error window.
.TP
-.B open
-Open a PDF file in this window, using the open dialog.
+.B openSidebar
+Open the sidebar.
.TP
-.B openInNewWin
-Open a PDF file in a new window, using the open dialog.
+.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
-.BI openFile( file )
-Open a specified PDF file in this window.
+.B openSidebarResizeWin
+Open the sidebar, resizing the window so that the document size
+doesn't change.
.TP
-.BI openFileInNewWin( file )
-Open a specified PDF file in a new window.
+.B pageDown
+Scroll down by one screenful.
.TP
-.BI openFileAtDest( file , dest )
-Open a specified PDF file in this window and go to a named
-destination.
+.B pageUp
+Scroll up by one screenful.
.TP
-.BI openFileAtDestInNewWin( file , dest )
-Open a specified PDF file in a new window and go to a named
-destination.
+.B postPopupMenu
+Display the popup menu.
.TP
-.B reload
-Reload the current PDF file.
+.B prevPage
+Go to the previous page.
.TP
-.B redraw
-Redraw the window.
+.B prevPageNoScroll
+Go to the previous page, with the current relative scroll position.
.TP
-.B raise
-Raise the window to the front.
+.B prevTab
+Switch to the previous tab.
.TP
-.B closeWindow
-Close the window. If this was the last open window, clear the window,
-but don't quit from Xpdf.
+.B print
+Open the \'print' dialog.
.TP
-.B closeWindowOrQuit
-Close the window. If this was the last open window, quit from Xpdf.
+.B quit
+Quit from xpdf.
+.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
@@ -675,14 +580,26 @@ command must be quoted in the xpdfrc file:
.fi
.TP
-.B openOutline
-Open the outline pane.
+.B saveAs
+Save PDF via a file requester.
.TP
-.B closeOutline
-Close the outline pane.
+.B saveImage
+Open the \'save image' dialog.
.TP
-.B toggleOutline
-Toggle the outline pane between open and closed.
+.BI scrollDown( n )
+Scroll down by
+.I n
+pixels.
+.TP
+.BI scrollDownPrevPage( 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
@@ -694,163 +611,105 @@ Scroll the outline up by
.I n
increments.
.TP
-.B focusToDocWin
-Set the keyboard focus to the main document window.
+.BI scrollRight( n )
+Scroll right by
+.I n
+pixels.
.TP
-.B focusToPageNum
-Set the keyboard focus to the page number text box.
+.B scrollToBottomEdge
+Scroll to the bottom edge of the current page, with no horizontal
+movement.
.TP
-.B find
-Open the 'find' dialog.
+.B scrollToBottomRight
+Scroll to the bottom-right corner of the current page.
.TP
-.B findNext
-Finds the next occurrence of the search string (no dialog).
+.B scrollToLeftEdge
+Scroll to the left edge of the current page, with no vertical
+movement.
.TP
-.B print
-Open the 'print' dialog.
+.B scrollToRightEdge
+Scroll to the right edge of the current page, with no vertical
+movement.
.TP
-.B about
-Open the 'about' dialog.
+.B scrollToTopEdge
+Scroll to the top edge of the current page, with no horizontal
+movement.
.TP
-.B quit
-Quit from xpdf.
-.PP
-The following commands depend on the current mouse position:
+.B scrollToTopLeft
+Scroll to the top-left corner of the current page.
.TP
-.B startSelection
-Start a selection, which will be extended as the mouse moves.
+.BI scrollUp( n )
+Scroll up by
+.I n
+pixels.
.TP
-.B endSelection
-End a selection.
+.BI scrollUpPrevPage( n )
+Scroll up by
+.I n
+pixels, moving to the previous page if appropriate.
+.TP
+.BI setSelection( pg , ulx , uly , lrx , lry )
+Set the selection to the specified coordinates on the specified page.
+.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 startPan
-Start a pan, which will scroll the document as the mouse moves
+Start a pan operation at the current mouse position, which will scroll
+the document as the mouse moves.
.TP
-.B endPan
-End a pan.
+.B startSelection
+Start a selection at the current mouse position, which will be
+extended as the mouse moves.
.TP
-.B postPopupMenu
-Display the popup menu.
+.B toggleContinuousMode
+Toggle between continuous and single page view modes.
.TP
-.B followLink
-Follow a hyperlink (does nothing if the mouse is not over a link).
+.B toggleFullScreenMode
+Toggle between full-screen and window modes.
.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.
+.B toggleSelectMode
+Toggle between block and linear selection mode.
.TP
-.B followLinkNoSel
-Same as followLink, but does nothing if there is a non-empty selection.
-(This is useful as a mouse button binding.)
+.B toggleSidebar
+Toggle the sidebar between open and closed.
.TP
-.B followLinkInNewWinNoSel
-Same as followLinkInNewWin, but does nothing if there is a non-empty
-selection. (This is useful as a mouse button binding.)
-.SS Default Bindings
-The default mouse bindings are as follows:
-.nf
-
- bind mousePress1 any startSelection
- bind mouseRelease1 any endSelection followLinkNoSel
- bind mousePress2 any startPan
- bind mouseRelease2 any endPan
- bind mousePress3 any postPopupMenu
- bind mousePress4 any scrollUpPrevPage(16)
- bind mousePress5 any scrollDownNextPage(16)
- bind mousePress6 any scrollLeft(16)
- bind mousePress7 any scrollRight(16)
-
-.fi
-The default key bindings are as follows:
-.nf
-
- bind ctrl-home any gotoPage(1)
- bind home any scrollToTopLeft
- bind ctrl-end any gotoLastPage
- bind end any scrollToBottomRight
- bind pgup any pageUp
- bind backspace any pageUp
- bind delete any pageUp
- bind pgdn any pageDown
- bind space any pageDown
- bind left any scrollLeft(16)
- bind right any scrollRight(16)
- bind up any scrollUp(16)
- bind down any scrollDown(16)
- bind o any open
- bind O any open
- bind r any reload
- bind R any reload
- bind f any find
- bind F any find
- bind ctrl-f any find
- bind ctrl-g any findNext
- bind ctrl-p any print
- bind n scrLockOff nextPage
- bind N scrLockOff nextPage
- bind n scrLockOn nextPageNoScroll
- bind N scrLockOn nextPageNoScroll
- bind p scrLockOff prevPage
- bind P scrLockOff prevPage
- bind p scrLockOn prevPageNoScroll
- bind P scrLockOn prevPageNoScroll
- bind v any goForward
- bind b any goBackward
- bind g any focusToPageNum
- bind 0 any zoomPercent(125)
- bind + any zoomIn
- bind - any zoomOut
- bind z any zoomFitPage
- bind w any zoomFitWidth
- bind alt-f any toggleFullScreenMode
- bind ctrl-l any redraw
- bind ctrl-w any closeWindowOrQuit
- bind ? any about
- bind q any quit
- bind Q any quit
-
-.fi
-Previous versions of xpdf included a "viKeys" X resource. It is no
-longer available, but the following bindings are equivalent:
-.nf
-
- bind h any scrollLeft(16)
- bind l any scrollRight(16)
- bind k any scrollUp(16)
- bind j any scrollDown(16)
-
-.fi
-.SH "REMOTE SERVER MODE"
-Xpdf can be started in remote server mode by specifying a server name
-(in addition to the file name and page number). For example:
-.PP
-.RS
-xpdf \-remote myServer file.pdf
-.RE
-.PP
-If there is currently no xpdf running in server mode with the name
-\'myServer', a new xpdf window will be opened. If another command:
-.PP
-.RS
-xpdf \-remote myServer another.pdf 9
-.RE
-.PP
-is issued, a new copy of xpdf will not be started. Instead, the first
-xpdf (the server) will load
-.I another.pdf
-and display page nine. If the file name is the same:
-.PP
-.RS
-xpdf \-remote myServer another.pdf 4
-.RE
-.PP
-the xpdf server will simply display the specified page.
-.PP
-The \-raise option tells the server to raise its window; it can be
-specified with or without a file name and page number.
-.PP
-The \-quit option tells the server to close its window and exit.
+.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 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 EXIT CODES
The Xpdf tools use the following exit codes:
.TP
@@ -869,7 +728,7 @@ Error related to PDF permissions.
99
Other error.
.SH AUTHOR
-The xpdf software and documentation are copyright 1996-2014 Glyph &
+The xpdf software and documentation are copyright 1996-2017 Glyph &
Cog, LLC.
.SH "SEE ALSO"
.BR pdftops (1),
@@ -883,4 +742,4 @@ Cog, LLC.
.BR pdfimages (1),
.BR xpdfrc (5)
.br
-.B http://www.foolabs.com/xpdf/
+.B http://www.xpdfreader.com/