summaryrefslogtreecommitdiff
path: root/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
diff options
context:
space:
mode:
authorAkira Kakuto <kakuto@fuk.kindai.ac.jp>2019-02-25 03:01:12 +0000
committerAkira Kakuto <kakuto@fuk.kindai.ac.jp>2019-02-25 03:01:12 +0000
commit3112e1aed533fe7ee58dd8cba2e4cd768372dfd6 (patch)
tree02077f80cf4a13a6c571bace448a53a38a9b6768 /Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
parent73052dd2c8e70e61b653151192fe1f000fcf626d (diff)
xpdf-4.01
git-svn-id: svn://tug.org/texlive/trunk@50122 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Build/source/libs/xpdf/xpdf-src/doc/xpdf.1')
-rw-r--r--Build/source/libs/xpdf/xpdf-src/doc/xpdf.195
1 files changed, 84 insertions, 11 deletions
diff --git a/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1 b/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
index b463d0fab43..63f3efd3fc9 100644
--- a/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
+++ b/Build/source/libs/xpdf/xpdf-src/doc/xpdf.1
@@ -1,12 +1,17 @@
-.\" Copyright 1996-2017 Glyph & Cog, LLC
-.TH xpdf 1 "10 Aug 2017"
+.\" Copyright 1996-2019 Glyph & Cog, LLC
+.TH xpdf 1 "18 Feb 2019"
.SH NAME
-xpdf \- Portable Document Format (PDF) file viewer (version 4.00)
+xpdf \- Portable Document Format (PDF) file viewer (version 4.01)
.SH SYNOPSIS
.B xpdf
[options]
.RI [ PDF-file
.RI [: page " | +" dest "]] ..."
+.PP
+.B xpdf
+[options]
+.B -remote
+.IR remote-name " [" command " ...]"
.SH DESCRIPTION
.B Xpdf
is a viewer for Portable Document Format (PDF) files. (These are also
@@ -124,6 +129,9 @@ password.
.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
@@ -349,7 +357,8 @@ Xpdf can be placed into full-screen mode via the
command line option, the \'full screen' menu item, or a binding to the
.B fullScreenMode
or
-.BR toggleFullScreenMode command .
+.B toggleFullScreenMode
+command.
.PP
Entering full-screen mode automatically switches to single-page view
mode and to the fit-page zoom factor.
@@ -376,6 +385,23 @@ 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
@@ -478,6 +504,12 @@ Switch to horizontal continuous view mode.
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
@@ -499,6 +531,16 @@ Open a PDF file in this tab, using the open dialog.
.B openErrorWindow
Open the error window.
.TP
+.BI openFile( file )
+Open the specified file in the current tab.
+.TP
+.BI openFileAtDest( file, dest )
+Open the specified file in the current tab at the specified named
+destination.
+.TP
+.BI openFileAtPage( file, page )
+Open the specified file in the current tab at the specified page.
+.TP
.B openSidebar
Open the sidebar.
.TP
@@ -579,6 +621,10 @@ command must be quoted in the xpdfrc file:
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.
@@ -586,12 +632,20 @@ Save PDF via a file requester.
.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 scrollDownPrevPage( n )
+.BI scrollDownNextPage( n )
Scroll down by
.I n
pixels, moving to the next page if appropriate.
@@ -617,11 +671,11 @@ Scroll right by
pixels.
.TP
.B scrollToBottomEdge
-Scroll to the bottom edge of the current page, with no horizontal
-movement.
+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 current page.
+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
@@ -632,11 +686,11 @@ Scroll to the right edge of the current page, with no vertical
movement.
.TP
.B scrollToTopEdge
-Scroll to the top edge of the current page, with no horizontal
+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 current page.
+Scroll to the top-left corner of the first displayed page.
.TP
.BI scrollUp( n )
Scroll up by
@@ -710,6 +764,25 @@ Set the zoom factor to
.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
@@ -728,7 +801,7 @@ Error related to PDF permissions.
99
Other error.
.SH AUTHOR
-The xpdf software and documentation are copyright 1996-2017 Glyph &
+The xpdf software and documentation are copyright 1996-2019 Glyph &
Cog, LLC.
.SH "SEE ALSO"
.BR pdftops (1),