diff options
Diffstat (limited to 'Build/source/utils/xpdfopen/xpdfopen-0.86/pdfopen.1')
-rw-r--r-- | Build/source/utils/xpdfopen/xpdfopen-0.86/pdfopen.1 | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/Build/source/utils/xpdfopen/xpdfopen-0.86/pdfopen.1 b/Build/source/utils/xpdfopen/xpdfopen-0.86/pdfopen.1 new file mode 100644 index 00000000000..23b8f84f61b --- /dev/null +++ b/Build/source/utils/xpdfopen/xpdfopen-0.86/pdfopen.1 @@ -0,0 +1,166 @@ +.\" This manpage is licensed under the GNU Public License +.TH PDFOPEN 1 2014-05-24 "pdfopen 0.86" "" +. +.SH NAME +pdfopen, pdfclose \- open or close a PDF file viewer +. +.SH SYNOPSIS +.B pdfopen +[ \fIoptions\fP ]\ +[ +.B --file +]\ +\fIfile.pdf\fP +.br +.B pdfclose +[ +.B --file +]\ +\fIfile.pdf\fP +. +.SH OPTIONS +.TP 8 +.B -h, --help, -? +output help and exit. +.TP +.B -v, --version, -V +output the version number and exit. +.TP +.B -p <n>, --page <n> +when starting the viewer, display page <n> of the document (notes: not +all viewers support this feature, and even in those cases this option +only has effect when the document is initially loaded). This option +is over-ridden by \fB-g\fP. +.TP +.B -g <named destination>, --goto <named destination> +when starting the viewer, display the page of the document containing +the named destination (notes: not all viewers support this feature, +and even in those cases this option only has effect when the document +is initially loaded). +.TP +.B -r, --reset_focus +after sending commands to the PDF viewer, attempt to reset the input focus to +the window which had focus before the commands were sent. +.TP +.B -viewer, --viewer <\fIar9\fP|\fIar9-tab\fP|\fIar8\fP|\fIar7\fP|\fIar5\fP|\fIxpdf\fP|\fIevince\fP> +use (respectively) Adobe Reader 9 (in a new window), Adobe Reader 9 +(in a new tab of a running AR9, if any), +Adobe Reader 8, Adobe Reader 7, Adobe Reader 5, xpdf or evince as the +PDF viewer program. +Adobe Reader 9 (in a new window) is the default. +. +.SH RATIONALE +At certain points of TeX document preparation, many people repeat a +"edit-compile-view" cycle. Since PDF viewers such as Adobe's Acrobat +Reader ("\fBacroread\fP") do not automatically refresh the display when the +PDF file changes, this cycle can be more cumbersome than desired. +The +.B pdfopen +program provides the ability to automate the reloading of the PDF +document when it is changed. + +Note: there seems to be little need for +.B pdfclose +under GNU/Linux, since (unlike the situation for MS windows) +.B acroread +does not lock the PDF file, which would prevent +.B pdftex +(or a DVI to PDF converter) from creating a new version of the PDF +output file. However, +.B pdfclose +is provided in case someone finds it useful. +. +.SH DESCRIPTION +.B pdfopen +searches for an instance of the specified (or default) PDF viewer +displaying the specified PDF file. +If there is already an instance of the given viewer displaying the +given file, the viewer is instructed to reload the file. If no such +instance is found, \fBpdfopen\fP attempts to run the specified viewer +on the specified document. + +The default viewer is "\fBacroread\fP", which could start any one +of a number of versions of Acrobat Reader, depending on what is +installed on your system. However, the commands to reload the current +document vary from one version of \fBacroread\fP to another; +consequently, if you are using a version of \fBacroread\fP other than +AR9, you should explicitly specify the viewer program. + +This version of \fBpdfopen\fP accepts the following viewer options: +.br +\fIar9\fP, \fIar9-tab\fP, \fIar8\fP, \fIar7\fP, \fIar5\fP, \fIxpdf\fP, +and \fIevince\fP. +.br +The difference between \fIar9\fP and \fIar9-tab\fP is significant +when there is no instance of AR9 already displaying the requested +document. In this situation, while \fIar9\fP will +request \fBacroread\fP to create a new instance of \fBacroread\fP +(and thus open a new window) by using the \fB-openInNewInstance\fP +argument, \fIar9-tab\fP starts \fBacroread\fP without this argument; +if there is already an instance of \fBacroread\fP running, a new +tab will be opened in an existing window. + +.B pdfclose +searches for one of the above PDF viewers displaying the given file +and instructs the viewer to "close" the window. In most cases, the +PDF viewer continues to run, possibly now displaying just a blank +window. (This behaviour varies somewhat from one PDF viewer to another.) +. +.SH PORTABILITY AND AVAILABILITY +These programs have been tested on Slackware64 Version 14.1 and a few +other versions / distributions of GNU/Linux. The code is reasonably +generic and should work out of the box using most recent X11 +implementations. (Reports to the contrary are welcome, particularly +if they come with robust fixes.) + +These programs are designed for X11-based systems. If you somehow +find compiled versions of these programs on a system using another +window system, they are very unlikely to be of any use to you. + +Source and binaries of the programs can be downloaded from +\f(CWCTAN://support/xpdfopen/\fR +(e.g., \f(CWhttp://mirror.ctan.org/support/xpdfopen\fR). +. +.SH CAVEATS +If you use +.I ar9-tab +to reload the PDF document and the instance +of +.B acroread +with the given document is currently displaying some other document, +the command causes your document to be displayed, but not reloaded. + +.B pdfopen +works by looking for a window with a name (window title) matching that +expected for the given viewer and document. If for some reason your +viewer's window name is not as expected, +.B pdfopen +may not work for you. + +With at least AR9 and some window managers, using +.B pdfopen +to reload the document gives focus to the +.B acroread +window, even though the mouse cursor is not necessarily in that +window. This can be annoying. The \fB-reset_focus\fP option can be +used to deal with this problem. +. +.SH AUTHOR +This manual page was written by Jim Diamond <\f(CWJim.Diamond@acadiau.ca\fP>. +I am the current maintainer of the X11 versions of +.B pdfopen +and +\fBpdfclose\fP. +Report any bugs you find to me. Feature enhancement requests are +welcome, coded enhancements even more so. + +Past authors: +Fabrice Popineau wrote the MS-windows versions of +.B pdfopen +and +.B pdfclose +upon which these programs were originally based. +Taco Hoekwater created the GNU/Linux versions, up to Version 0.61 +(including some documentation which inspired parts of this man page). +Peter Breitenlohner has contributed both code and suggestions to +versions later than 0.61. |