~ubuntu-branches/debian/sid/qpdfview/sid

1 by Benjamin Eltzner
Import upstream version 0.3~beta2
1
<!--
2
3
Copyright 2012 Benjamin Eltzner
4
Copyright 2012 Adam Reichold
5
6
This file is part of qpdfview.
7
8
qpdfview is free software: you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation, either version 2 of the License, or
11
(at your option) any later version.
12
13
qpdfview is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
GNU General Public License for more details.
17
18
You should have received a copy of the GNU General Public License
19
along with qpdfview.  If not, see <http://www.gnu.org/licenses/>.
20
21
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
22
23
-->
24
25
<html>
26
27
<head>
28
    <title>Help</title>
29
</head>
30
31
<body>
32
33
<h2><a name="top">Help</a></h2>
34
35
<h4>Table of contents</h4>
36
<ol>
37
    <li><a href="#mainmenu">Main menu</a></li>
38
    <ol>
39
        <li><a href="#file">File</a></li>
40
        <li><a href="#edit">Edit</a></li>
41
        <li><a href="#view">View</a></li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
42
        <li><a href="#tabs">Tabs</a></li>
43
        <li><a href="#bookmarks">Bookmarks</a></li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
44
        <li><a href="#help">Help</a></li>
45
    </ol>
46
    <li><a href="#mainview">Main view</a></li>
47
    <li><a href="#auxiliaryviews">Auxiliary views</a></li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
48
    <li><a href="#settings">Settings</a></li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
49
</ol>
50
51
<h4>Introduction</h4>
52
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
53
<p><em>qpdfview</em> 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.</p>
54
55
<p>Refer to the manual page for information on command-line options and configuration files.</p>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
56
57
<h3><a name="mainmenu">Main menu</a> <a href="#top">&uarr;</a></h3>
58
59
<h4><a name="file">File</a> <a href="#top">&uarr;</a></h4>
60
61
<ul>
62
	<li><b>Open...</b> Opens a dialogue to choose a file to open in the current tab. If there is no tab, the file is opened in a new tab.</li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
63
	<li><b>Open in new tab...</b> Opens a dialogue to choose files to open in new tabs.</li>
64
	<li><b>Recently used</b> Contains a list of the ten most recently used files.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
65
	<li><b>Refresh</b> Reloads the file displayed in the current tab.</li>
66
	<li><b>Save copy...</b> Opens a dialogue to save a copy of the file displayed in the current tab.</li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
67
    <li><b>Print...</b> Opens a dialogue to print the file displayed in the current tab.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
68
	<li><b>Exit</b> Closes all tabs and ends the program.</li>
69
</ul>
70
71
<h4><a name="edit">Edit</a> <a href="#top">&uarr;</a></h4>
72
73
<ul>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
74
	<li><b>Next/Previous/First/Last page</b> Skips to the next/previous/first/last page of the document. Without effect if the last/first/first/last page of the document is already displayed.</li>
75
    <li><b>Jump to page...</b> Opens a dialogue to enter a page to display in the current tab.</li>
76
	<li><b>Search...</b> Opens the search tool bar at the bottom of the window. The search automatically starts two seconds after the last change of the search term or is manually started by pressing the return key.</li>
77
	<li><b>Find previous/next</b> Jumps to the previous/next occurrence of the search term in the document.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
78
	<li><b>Cancel search</b> Cancels the currently running search and closes the search tool bar.</li>
1.2.1 by Benjamin Eltzner
Import upstream version 0.3.3
79
	<li><b>Copy to clipboard</b> If checked, the program will wait for a frame to be dragged to copy texts or images.</li>
80
	<li><b>Add annotation</b> If checked, the program will wait for a frame to be dragged to add annotations.</li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
81
	<li><b>Settings...</b> Opens the settings dialogue.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
82
</ul>
83
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
84
<p>The <em>current page</em> can be changed by entering the desired page into the text field in the edit tool bar and pressing the return key.</p>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
85
86
<h4><a name="view">View</a> <a href="#top">&uarr;</a></h4>
87
88
<ul>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
89
	<li><b>Continuous</b> Determines whether all rows of the page layout are visible at once.</li>
90
	<li><b>Two pages</b> Determines whether the page layout uses two columns.</li>
91
	<li><b>Zoom in</b> Increases the scale factor by 10 percent.</li>
92
	<li><b>Zoom out</b> Decreases the scale factor by 10 percent.</li>
93
	<li><b>Original size</b> Resets the scale factor to 100 percent.</li>
94
    	<li><b>Fit to page width</b> Determines the scale factor such that all pages fully fit into the main view horizontally.</li>
95
	<li><b>Fit to page size</b> Determines the scale factor such that all pages fully fit into the main view horizontally and vertically.</li>
96
	<li><b>Rotate left</b> Rotates the pages left/counterclockwise by 90 degrees.</li>
97
	<li><b>Rotate right</b> Rotates the pages right/clockwise by 90 degrees.</li>
98
	<li><b>Tool bars</b> This menu contains a list of available tool bars for accessing often used actions.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
99
	<li><b>Docks</b> This menu contains a list of available docks for displaying supplementary information.</li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
100
	<li><b>Fonts...</b> Opens a dialogue listing the fonts used in the document.</li>
101
	<li><b>Fullscreen</b> Toggles the fullscreen mode, i.e. the window is shown maximized and without decoration.</li>
102
	<li><b>Presentation...</b> Enters presentation mode which can be left by pressing F12 or escape. The home/end key is used to display the first/last page. Arrow keys right and down, space and the page down key jump to the next page. Arrow keys left and up, backspace and the page up key jump to the previous page. The return key returns to the page before the last jump.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
103
</ul>
104
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
105
<p>The <em>scale factor</em> can be changed by entering the desired percentage into the text field in the view tool bar and pressing the return key.</p>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
106
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
107
<h4><a name="tabs">Tabs</a> <a href="#top">&uarr;</a></h4>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
108
109
<ul>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
110
    <li><b>Previous/Next tab</b> Makes the previous/next tab the current tab. Cycles to the last/first tab if the first/last tab is the current tab.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
111
    <li><b>Close tab</b> Closes the current tab.</li>
112
    <li><b>Close all tabs</b> Closes all tabs.</li>
113
    <li><b>Close all tabs but current tab</b> Closes all tabs except for the current tab.</li>
114
</ul>
115
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
116
<p>This menu contains a list of all tabs which can be made the current tab by clicking on them. Tabs can be closed by middle-clicking on them.</p>
117
118
<h4><a name="bookmarks">Bookmarks</a> <a href="#top">&uarr;</a></h4>
119
120
<ul>
1.2.1 by Benjamin Eltzner
Import upstream version 0.3.3
121
    <li><b>Previous bookmark</b> Jumps to the closest bookmark before the current page.</li>
122
    <li><b>Next bookmark</b> Jumps to the closest bookmark after the current page.</li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
123
    <li><b>Add bookmark</b> Adds a bookmark for the current file and page.</li>
1.2.1 by Benjamin Eltzner
Import upstream version 0.3.3
124
    <li><b>Remove bookmark</b> Removes the bookmark for the current file and page.</li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
125
    <li><b>Remove all bookmarks</b> Removes all bookmarks.</li>
126
    <li><b>Open</b> Opens the corresponding file in the current tab. If there is no tab, the file is opened in a new tab.</li>
127
    <li><b>Open in new tab</b> Opens the corresponding file in a new tab.</li>
1.2.1 by Benjamin Eltzner
Import upstream version 0.3.3
128
    <li><b>Jump to page</b> Jumps to the corresponding page if the corresponding file is open and opens the corresponding file in a new tab otherwise.</li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
129
</ul>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
130
131
<h4><a name="help">Help</a> <a href="#top">&uarr;</a></h4>
132
133
<ul>
134
	<li><b>Contents</b> Displays this document.</li>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
135
	<li><b>About</b> Displays the program version.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
136
</ul>
137
138
<h3><a name="mainview">Main view</a> <a href="#top">&uarr;</a></h3>
139
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
140
<p>The backspace/space key skips to the previous/next page. The home/end key skips to the first/last page. The arrow, page up and page down keys scroll the viewport. The return key returns to the page before the last jump.</p>
141
142
<p>Using the mouse wheel scrolls up and down. Holding <b>ALT</b> while using the mouse wheel scrolls left and right. Holding <b>CTRL</b> while using the mouse wheel scales the document. Holding <b>SHIFT</b> while using the mouse wheel rotates the document.</p>
143
144
<p>Links are highlighted by red frames (if enabled in the settings). Left-click on a link to show the linked page or open the linked URL in the default browser (if enabled in the settings). Hovering over a link displays its destination as a tool tip.</p>
145
146
<p>To <em>copy texts or images</em>, hold <b>SHIFT</b>, click and hold the left mouse button to drag a frame around the area to copy. Once the mouse button is released, a pop-up menu is displayed to select whether to copy texts or images into the clipboard.</p>
147
148
<p>To <em>add annotations</em>, hold <b>CTRL</b>, click and hold the left mouse button to drag a frame around the region of interest. Once the mouse button is released, a pop-up menu is displayed to select whether to add text or highlight annotations. Left-click to <em>edit annotations</em>. Right-click to <em>remove annotations</em>. (Adding and removing annotations requires version 0.20 or higher of the Poppler library.) Hovering over an annotation displays its contents as a tool tip.</p>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
149
150
<h3><a name="auxiliaryviews">Auxiliary views</a> <a href="#top">&uarr;</a></h3>
151
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
152
<p>The <em>outline</em> dock displays an overview of the contents of the document. A left click on an entry jumps to the respective page in the main view.</p>
153
154
<p>The <em>properties</em> dock displays further information supplied by the document.</p>
155
156
<p>The <em>thumbnails</em> dock displays small versions of the pages. A left click on an entry jumps to the respective page in the main view.</p>
157
158
<h3><a name="settings">Settings</a> <a href="#top">&uarr;</a></h3>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
159
1.2.1 by Benjamin Eltzner
Import upstream version 0.3.3
160
<p>Interface settings</p>
161
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
162
<ul>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
163
    <li><b>Open URL</b> Determines whether links to URL are opened in the default browser.</li>
164
    <li><b>Auto-refresh</b> Determines whether files are automatically reloaded if changed on disk.</li>
165
    <li><b>Track recently used</b> If enabled, a recently used menu is available and lists the ten most recently used documents. (Effective after restart.)</li>
166
    <li><b>Restore tabs</b> If enabled, tabs and their properties are saved on ending the program and restored on restart.</li>
167
    <li><b>Restore bookmarks</b> If enabled, bookmarks are saved on ending the program and restored on restart.</li>
1.2.1 by Benjamin Eltzner
Import upstream version 0.3.3
168
    <li><b>Tab position</b> Defines at which edge of the main view tabs will be displayed.</li>
169
    <li><b>Tab visibility</b> Determines whether tabs will be displayed if less than two documents are opened.</li>
170
    <li><b>File tool bar</b> Defines which actions are visible in the file tool bar. Available actions are openInNewTab, open, refresh, saveCopy and print. (Effective after restart.)</li>
171
    <li><b>Edit tool bar</b> Defines which actions are visible in the edit tool bar. Available actions are currentPage, previousPage, nextPage, firstPage, lastPage, jumpToPage, search, copyToClipboard and addAnnotation. (Effective after restart.)</li>
172
    <li><b>View tool bar</b> Defines which actions are visible in the view tool bar. Available action are scaleFactor, zoomIn, zoomOut, continuousMode, twoPagesMode, originalSize, fitToPageWidth, fitToPageSize, rotateLeft, rotateRight, fullscreen and presentation. (Effective after restart.)</li>
173
    <li><b>Zoom modifiers</b> The keyboard modifiers to zoom using the mouse wheel in the main view.</li>
174
    <li><b>Rotate modifiers</b> The keyboard modifiers to rotate using the mouse wheel in the main view.</li>
175
    <li><b>Horizontal modifiers</b> The keyboard modifiers to scroll horizontally using the mouse wheel in the main view.</li>
176
    <li><b>Copy modifiers</b> The keyboard modifiers to copy texts or images from a page.</li>
177
    <li><b>Annotate modifiers</b> The keyboard modifiers to add annotations to a page.</li>
178
</ul>
179
180
<p>Graphics settings</p>
181
182
<ul>
1.1.3 by Benjamin Eltzner
Import upstream version 0.3.2
183
    <li><b>Decorate pages</b> Determines whether pages are set apart from the background.</li>
184
    <li><b>Decorate links</b> Determines whether links are highlighted by red frames.</li>
185
    <li><b>Invert colors</b> Determines whether pages are rendered with inverted colors.</li>
186
    <li><b>Page spacing</b> Determines both vertical and horizontal space displayed between pages.</li>
187
    <li><b>Thumbnail spacing</b> Determines both vertical and horizontal space displayed between thumbnails.</li>
188
    <li><b>Thumbnail size</b> Determines the size of the thumbnails.</li>
189
    <li><b>Antialiasing</b> Improves display quality at the cost of performance</li>
190
    <li><b>Text antialiasing</b> Improves text display quality at the cost of performance</li>
191
    <li><b>Text hinting</b> May improve text display quality for certain fonts.</li>
192
    <li><b>Cache size</b> The program will try to cache rendered pages within this limit increasing rendering speed at the cost of increased memory usage.</li>
193
    <li><b>Prefetch</b> The program will try to render pages that are not yet visible increasing rendering speed at the cost of increased cache usage.</li>
1 by Benjamin Eltzner
Import upstream version 0.3~beta2
194
</ul>
195
196
</body>
197
198
</html>