| 1 | .\" |
|---|
| 2 | .\" |
|---|
| 3 | .\" Copyright 2012-2013 Benjamin Eltzner |
|---|
| 4 | .\" Copyright 2012-2015 Adam Reichold |
|---|
| 5 | .\" Copyright 2012 Michał Trybus |
|---|
| 6 | .\" |
|---|
| 7 | .\" This file is part of qpdfview. |
|---|
| 8 | .\" |
|---|
| 9 | .\" qpdfview is free software: you can redistribute it and/or modify |
|---|
| 10 | .\" it under the terms of the GNU General Public License as published by |
|---|
| 11 | .\" the Free Software Foundation, either version 2 of the License, or |
|---|
| 12 | .\" (at your option) any later version. |
|---|
| 13 | .\" |
|---|
| 14 | .\" qpdfview is distributed in the hope that it will be useful, |
|---|
| 15 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 16 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 17 | .\" GNU General Public License for more details. |
|---|
| 18 | .\" |
|---|
| 19 | .\" You should have received a copy of the GNU General Public License |
|---|
| 20 | .\" along with qpdfview. If not, see <http://www.gnu.org/licenses/>. |
|---|
| 21 | .\" |
|---|
| 22 | .\" This file is additionally licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported (CC-BY-SA) license. The full text of the license can be found at https://creativecommons.org/licenses/by-sa/3.0/legalcode |
|---|
| 23 | .\" |
|---|
| 24 | .\" |
|---|
| 25 | .TH QPDFVIEW 1 "July 2012" |
|---|
| 26 | .SH NAME |
|---|
| 27 | murrupuy \- tabbed document viewer |
|---|
| 28 | .SH SYNOPSIS |
|---|
| 29 | .B murrupuy |
|---|
| 30 | .I [options] [--] [file[#page]] [file[#src:name:line:column]] ... |
|---|
| 31 | .SH DESCRIPTION |
|---|
| 32 | .B murrupuy |
|---|
| 33 | is a simple viewer for document files in the portable document format (PDF). It uses the Poppler library for rendering and the Qt toolkit for its interface. |
|---|
| 34 | .SH OPTIONS |
|---|
| 35 | .IP "\-\-help" |
|---|
| 36 | Displays usage information. |
|---|
| 37 | .IP "\-\-quiet" |
|---|
| 38 | Suppresses warning messages which are displayed if the program fails to open a file. |
|---|
| 39 | .IP "\-\-search text" |
|---|
| 40 | Initiates a search for |
|---|
| 41 | .I text |
|---|
| 42 | in the current tab. |
|---|
| 43 | .IP \-\-unique |
|---|
| 44 | If an instance of murrupuy is started with this option, any files that are opened using this option afterwards, are opened as tabs in the original window. If a file is already opened in a tab of the original window, it is merely reloaded. |
|---|
| 45 | .IP "\-\-instance name" |
|---|
| 46 | Uses |
|---|
| 47 | .I name |
|---|
| 48 | as the name of the instance contacted or created using the "\-\-unique" option. This allows one to run multiple instances and remotely open and refresh tabs in any of them by passing the instance name. The argument must only contain the characters "[A-Z][a-z][0-9]_" and must not begin with a digit. |
|---|
| 49 | .IP "\-\-choose-instance" |
|---|
| 50 | Can be combined with the "\-\-unique" option to display a dialog at start-up where the instance name can be chosen with all instances that have tabs stored as suggestions. |
|---|
| 51 | .IP [file[#page]] |
|---|
| 52 | .I file |
|---|
| 53 | specifies the file to open. The optional parameter |
|---|
| 54 | .I page |
|---|
| 55 | opens the file at the given page. Multiple files will be opened in separate tabs. |
|---|
| 56 | .IP [file[#src:name:line:column]] |
|---|
| 57 | Forward search using SyncTeX is performed using the optional parameters |
|---|
| 58 | .I name |
|---|
| 59 | which is the name of the source file, |
|---|
| 60 | .I line |
|---|
| 61 | which is the line number in the source file and |
|---|
| 62 | .I column |
|---|
| 63 | which is the column number in the source file where the number 0 matches all lines respectively columns. |
|---|
| 64 | .SH INTER-PROCESS COMMUNICATION |
|---|
| 65 | If the program is invoked using the "\-\-unique" option, it registers an introspectable D-Bus interface at "local.qpdfview/MainWindow" which can be used to communicate with the application. If the "\-\-instance" option is used, the D-Bus interface is registered at "local.qpdfview.name/MainWindow". |
|---|
| 66 | .SH CONFIGURATION FILES |
|---|
| 67 | murrupuy uses configuration files usually located at |
|---|
| 68 | .RS |
|---|
| 69 | "~/.config/qpdfview" |
|---|
| 70 | .RE |
|---|
| 71 | with the majority of settings contained in "qpdfview.conf". |
|---|
| 72 | |
|---|
| 73 | Persitent state like per-file settings, bookmarks and tabs is stored in an SQLite database usually located at |
|---|
| 74 | .RS |
|---|
| 75 | "~/.local/share/data/qpdfview/qpdfview". |
|---|
| 76 | .RE |
|---|
| 77 | |
|---|
| 78 | The icon theme used by Qt can be changed by setting the key "iconTheme" in the section "mainWindow". The application-wide Qt style sheet can be changed by setting the key "styleSheet" in the section "mainWindow". |
|---|
| 79 | |
|---|
| 80 | The tile size in pixels used for tiled rendering can be adjusted by setting the key "tileSize" in the section "pageItem". The default value is 1024 pixels. |
|---|
| 81 | |
|---|
| 82 | The mimimum resp. maximum scale factor can be modified by changing the keys "minimumScaleFactor" resp. "maximumScaleFactor" in the section "documentView". The default values are 0.1 resp. 10.0. |
|---|
| 83 | |
|---|
| 84 | The timeout for auto-refresh resp. prefetch can be changed by setting the keys "autoRefreshTimeout" resp. "prefetchTimeout" in the section "documentView". The defaults are 750 resp. 250 milliseconds. |
|---|
| 85 | |
|---|
| 86 | The maximum number of per-file settings can be modified by changing the key "perFileSettingsLimit" in the section "mainWindow". The default value is 1000. |
|---|
| 87 | .SH EXAMPLES |
|---|
| 88 | .RS |
|---|
| 89 | The command |
|---|
| 90 | .RE |
|---|
| 91 | .B murrupuy foo.pdf#3 bar.pdf |
|---|
| 92 | .RS |
|---|
| 93 | opens "foo.pdf" in the first tab displaying the third page of the document and "bar.pdf" in the second tab displaying the beginning of the document. |
|---|
| 94 | |
|---|
| 95 | The command |
|---|
| 96 | .RE |
|---|
| 97 | .B murrupuy \-\-quiet foobar/* |
|---|
| 98 | .RS |
|---|
| 99 | opens all files that can be opened in the directory "foobar", suppressing warning messages for files that cannot be opened. |
|---|
| 100 | |
|---|
| 101 | The command |
|---|
| 102 | .RE |
|---|
| 103 | .B murrupuy \-\-search foo bar.pdf |
|---|
| 104 | .RS |
|---|
| 105 | opens "bar.pdf" in the first tab and starts a search for "foo". |
|---|
| 106 | |
|---|
| 107 | Subsequent execution of the commands |
|---|
| 108 | .RE |
|---|
| 109 | .B murrupuy \-\-unique foo.pdf bar.pdf |
|---|
| 110 | .RS |
|---|
| 111 | and |
|---|
| 112 | .RE |
|---|
| 113 | .B murrupuy \-\-unique foo.pdf#5 |
|---|
| 114 | .RS |
|---|
| 115 | opens "foo.pdf" and "bar.pdf", then reloads "foo.pdf" and displays its fifth page. |
|---|
| 116 | |
|---|
| 117 | Subsequent execution of the commands |
|---|
| 118 | .RE |
|---|
| 119 | .B murrupuy \-\-unique foo.pdf |
|---|
| 120 | .RS |
|---|
| 121 | and |
|---|
| 122 | .RE |
|---|
| 123 | .B murrupuy bar.pdf |
|---|
| 124 | .RS |
|---|
| 125 | and |
|---|
| 126 | .RE |
|---|
| 127 | .B murrupuy \-\-unique foo1.pdf bar1.pdf |
|---|
| 128 | .RS |
|---|
| 129 | opens "foo.pdf" in the first window, "bar.pdf" in a second window and then "foo1.pdf" and "bar1.pdf" in additional tabs in the first window. |
|---|
| 130 | |
|---|
| 131 | Subsequent execution of the commands |
|---|
| 132 | .RE |
|---|
| 133 | .B murrupuy \-\-unique \-\-instance a foo1.pdf bar1.pdf |
|---|
| 134 | .RS |
|---|
| 135 | and |
|---|
| 136 | .RE |
|---|
| 137 | .B murrupuy \-\-unique \-\-instance b foo2.pdf bar2.pdf |
|---|
| 138 | .RS |
|---|
| 139 | and |
|---|
| 140 | .RE |
|---|
| 141 | .B murrupuy \-\-unique foo3.pdf bar3.pdf |
|---|
| 142 | .RS |
|---|
| 143 | and |
|---|
| 144 | .RE |
|---|
| 145 | .B murrupuy \-\-unique \-\-instance a foo1.pdf#4 bar4.pdf |
|---|
| 146 | .RS |
|---|
| 147 | opens "foo1.pdf" and "bar1.pdf" in the first window, "foo2.pdf" and "bar2.pdf" in the second window, "foo3.pdf" and "bar3.pdf" in the third window and then reloads "foo1.pdf" and displays its fourth page and opens "bar4.pdf" in an additional tab in the first window. |
|---|
| 148 | |
|---|
| 149 | Subsequent execution of the commands |
|---|
| 150 | .RE |
|---|
| 151 | .B murrupuy \-\-unique \-\-instance a foo.pdf bar.pdf |
|---|
| 152 | .RS |
|---|
| 153 | and |
|---|
| 154 | .RE |
|---|
| 155 | .B murrupuy \-\-unique \-\-instance a \-\-search "foobar" |
|---|
| 156 | .RS |
|---|
| 157 | opens "foo.pdf" and "bar.pdf" in a window and then starts a search for the term "foobar" in the document in the active tab (which is the last opened "bar.pdf"). |
|---|
| 158 | |
|---|
| 159 | The command |
|---|
| 160 | .RE |
|---|
| 161 | .B murrupuy \-\-unique foobar.pdf#src:foobar.tex:42:0 |
|---|
| 162 | .RS |
|---|
| 163 | opens or refreshes "foobar.pdf" jumping to and highlighting the position that corresponds to line 42 of the source file "foobar.tex". |
|---|
| 164 | |
|---|
| 165 | The lines |
|---|
| 166 | .RE |
|---|
| 167 | .B [documentView] |
|---|
| 168 | .RS |
|---|
| 169 | .RE |
|---|
| 170 | .B autoRefreshTimeout=1250 |
|---|
| 171 | .RS |
|---|
| 172 | .RE |
|---|
| 173 | .B [mainWindow] |
|---|
| 174 | .RS |
|---|
| 175 | .RE |
|---|
| 176 | .B styleSheet="QTabBar::tab { max-width: 150px; }" |
|---|
| 177 | .RS |
|---|
| 178 | will configure the auto-refresh timeout to 1250 milliseconds and the change the maximum tab width to 150 pixel. |
|---|
| 179 | |
|---|
| 180 | .SH BUGS |
|---|
| 181 | If you find a bug, please report it at |
|---|
| 182 | .RS |
|---|
| 183 | "https://launchpad.net/qpdfview". |
|---|
| 184 | .RE |
|---|
