1DJVIEW4(1) DjVuLibre DJVIEW4(1)
2
3
4
6 djview4 - Standalone DjVu viewer
7
8
10 djview4 [options] [argument]
11
12
14 Standalone viewer for DjVu files. Features include navigating docu‐
15 ments, zooming and panning page images, producing and displaying thumb‐
16 nails, displaying document outlines, searching documents for particular
17 words in the hidden text layer, copying hidden text to the clipboard,
18 saving pages and documents as bundled or indirect multi-page files, and
19 printing page and documents. The viewer can simultaneously display
20 several pages using a side-by-side or a continuous layout.
21
22
24 This program can run as a standalone program or as a slave process for
25 the DjVu browser plugin nsdejavu. When running as a standalone pro‐
26 gram, the command line argument argument can be:
27
28 * The filename of a valid DjVu document.
29
30 * A local DjVu document URL of the form:
31
32 file:///path/name.djvu[?djvuopts&keyword=value&...]
33
34 The square brackets delimit the optional components of the URL.
35 Various options can be specified using a syntax similar to that of
36 CGI arguments. Specifying options in this manner is very useful for
37 a browser plugin because there are no command line arguments. In
38 the case of a standalone viewer, all options can be specified as
39 command line arguments.
40
41 * An remote DjVu document URL of the form:
42
43 http://host/path/name.djvu[?djvuopts&keyword=value&...]
44
45 https://host/path/name.djvu[?djvuopts&keyword=value&...]
46
47 Browsing remote DjVu documents with the standalone viewer is less
48 efficient than using the browser plugin. The standalone viewer does
49 not benefit from the browser caching strategies and proxy settings.
50 Proxy settings for the standalone viewer can be set independently
51 with the preferences dialog.
52
53 An extensive list of options are recognized. Most options can be spec‐
54 ified as command line argument starting with the customary dash charac‐
55 ter (-) or using the syntax of CGI arguments in the document URL. Some
56 options however are only meaningful as command line arguments. Other
57 options are only recognized when running the X11 version of the djview4
58 program.
59
60
62 The following options are only meaningful when specified on the command
63 line.
64
65
66 -help Display a brief help message.
67
68
69 -verbose
70 Prints informational messages on the console. This option is
71 very useful because it displays messages about the unrecognized
72 constructs in the DjVu annotation and hyperlink layers.
73
74
75 -fullscreen, -fs
76 Start djview4 in full screen mode. Use the key ESC to exit the
77 full screen mode.
78
79
80 -slideshow[=arg]
81 Start djview4 in slide show mode. The optional numerical argu‐
82 ment arg specifies the number of seconds before turning each
83 page. Use the key ESC to exit the slide show mode.
84
85
86
87 -style=stylename
88 Specify the graphical user interface style. The recognized val‐
89 ues for stylename depend on the installed version of the Qt
90 toolkit. Common style names include cde, motif, plastique,
91 platinum, and windows.
92
93
94
96 The following command line options are recognized by the X11 version of
97 the djview4 program. Unlike most djview4 options, X11 options that
98 demand an argument do not use the equal character to introduce their
99 argument.
100
101 -display displayname
102 Specify that the djview4 windows should appear on the X11 dis‐
103 play displayname.
104
105
106 -geometry WxH+X+Y
107 Specify the initial size and position of the first window using
108 the traditional X11 geometry specification syntax. The numeri‐
109 cal arguments W and H represent the initial window width and
110 height. The numerical arguments X and Y indicate the window
111 position relative to the top left corner of the screen.
112
113
114 -name name
115 Set the application name.
116
117
118 -title title
119 Set the title of the first window.
120
121
122 -fn fontname, -font fontname
123 Specify the name of the default font used for buttons and menus.
124 The font should be specified using a X logical font description
125 string.
126
127 -bg color, -background color
128 Specify the default background color for graphical user inter‐
129 face elements. The color should be given as a standard X11
130 color name.
131
132
133 -fg color, -foreground color
134 Specify the default foreground color for graphical user inter‐
135 face elements. The color should be given as a standard X11
136 color name.
137
138
139 -btn color
140 Specify the default button color. The color should be given as
141 a standard X11 color name.
142
143
144 -ncols count
145 Limit the number of colors allocated on a 8 bit display. The
146 default color cube contains 216 distinct colors.
147
148 -cmap Force the allocation of a private color map on a 8-bit display.
149 This might increase the color quality but cause flashing when
150 the viewer window gets activated.
151
152
154 The following options can be specified as command line options or can
155 be passed by augmenting the document URL using a syntax similar to that
156 of CGI arguments
157
158 http://.../file.djvu?djvuopts&key=value&key=value&...
159
160 In order to separate real CGI arguments from these options, the viewer
161 only recognizes keywords that appear after the word djvuopts. The key‐
162 words key are derived from the option names by removing the initial
163 dashes.
164
165
166 -page=pagename
167 Display a specific document page. The viewer first searches a
168 page whose identifier matches the argument pagename. Otherwise,
169 if pagename is a number preceded by character + or -, the viewer
170 performs a displacement relative to the current page. Other‐
171 wise, starting from the current page and wrapping around, it
172 searches for a page whose title matches the argument pagename.
173 Otherwise, if pagename is numerical, it is interpreted as an
174 ordinal page number. Otherwise, and finally, the viewer
175 searches a page whose name matches pagename.
176
177 -pageno=pagenumber
178 The page searching algorithm for option page can cause ambigui‐
179 ties when page titles can be interpreted as numbers. The argu‐
180 ment of option pageno is always interpreted as an ordinal page
181 number. This option is less portable than page because it is
182 not recognized by earlier versions of the djvu plugin. When
183 using this option is necessary, it is advisable to use both the
184 page and pageno options.
185
186 -zoom=zoomfactor
187 Specify the initial zoom factor. Unless the toolbar, pop-up
188 menu and keyboard are disabled, the user will be able to change
189 the zoom factor. Legal values for zoomfactor are shown in the
190 below:
191
192 ┌───────────────────────────────────────────────────────┐
193 │number Magnification factor in range 10% to 999%. │
194 │one2one Select the "one-to-one" mode. │
195 │width Select the "fit width" mode. │
196 │page Select the "fit page" mode. │
197 │stretch Stretch the image to the plugin window size. │
198 └───────────────────────────────────────────────────────┘
199 -showposition=px,py
200 Specify a point in the current page that should be as close as
201 possible to the center of the window. The horizontal and verti‐
202 cal positions px,py in the current page are given as fractions
203 in range 0 to 1. For instance, 0,0 designates the upper left
204 corner of the page, 0.5,0.5 is the center, and 1,1 is the lower
205 right corner.
206
207
208 -mode=modespec
209 Specify the initial display mode. Unless the toolbar and pop-up
210 menu are disabled, the user will be able to change it. Legal
211 values for modespec are shown in the below:
212
213 ┌──────────────────────────────────────────────────────┐
214 │color Display the color image. │
215 │bw Display the foreground mask only. │
216 │fore Display the foreground only. │
217 │back Display the background only. │
218 │text Overlay the hidden text over the color image. │
219 └──────────────────────────────────────────────────────┘
220 -hor_align=keyword, -halign=keyword
221 Specify the horizontal position of the page in the viewer win‐
222 dow. (This does not specify what part of the page will be
223 shown, but rather how margins will be laid out around the page
224 in the plugin window.) Argument keyword must be left, center,
225 or right.
226
227
228 -ver_align=keyword, -valign=keyword
229 Specify the vertical position of the page in the viewer window.
230 (This does not specify what part of the page will be shown, but
231 rather how margins will be laid out around the page in the plug‐
232 in window.) Argument keyword must be top, center, or bottom.
233
234
235 -cache=(yes|no)
236 Enable or disable the caching of fully decoded pages of the doc‐
237 ument. Caching is on by default. Caching of documents whose
238 URL does not contain an extension .djvu or .djv is off by
239 default.
240
241
242 -continuous=(yes|no)
243 Enable or disable the continuous layout of multipage documents.
244
245
246 -sidebyside=(yes|no), -side_by_side=(yes|no)
247 Enable or disable the side-by-side layout of multipage docu‐
248 ments.
249
250
251 -coverpage=(yes|no)
252 Specify whether the cover page must be displayed alone when mul‐
253 tipage documents are shown in side-by-side layout.
254
255
256 -righttoleft=(yes|no)
257 Specify whether pages should be arranged right-to-left when mul‐
258 tipage documents are shown in side-by-side layout.
259
260
261 -layout=keyword{,keyword}
262 Specify the layout settings using a single list of comma-sepa‐
263 rated keywords. The following keywords are recognized:
264
265 ┌───────────────────────────────────────────────────────────────┐
266 │single Disable the side-by-side and continuous modes. │
267 │double Enable the side-by-side mode. │
268 │continuous Enable the continuous mode. │
269 │cover,nocover First page treatment in side-by-side mode. │
270 │ltor,rtol Layout direction for side-by-side mode. │
271 │gap,nogap Specify whether there is a gap between pages. │
272 └───────────────────────────────────────────────────────────────┘
273
274 -scrollbars=(yes|no)
275 Enable or disable the presence of scroll bars when the full
276 image size exceeds the plugin window size. The default is yes.
277
278
279 -frame=(yes|no)
280 Enable or disable the display of a thin frame and shadow around
281 the DjVu images. Frames are enabled by default.
282
283
284 -background=color
285 Specify the color of the background border displayed around the
286 document. The color color must be given in hexadecimal RRGGBB or
287 #RRGGBB format.
288
289
290 -toolbar=keyword{(,|+|-)keyword}
291 Controls the appearance and the contents of the toolbar. The
292 argument of option toolbar is composed of a number of keywords
293 separated by characters comma, plus or minus. The appearance of
294 the toolbar is controlled by keywords placed before the first
295 occurrence of a character plus or minus. The following keywords
296 are recognized in this context:
297
298 ┌───────────────────────────────────────────────────────────┐
299 │no Disable toolbar. │
300 │always Displays the toolbar. │
301 │auto Enable toolbar "autohide" mode (not implemented). │
302 │top Place toolbar along the top edge. │
303 │bottom Place toolbar along the bottom edge. │
304 └───────────────────────────────────────────────────────────┘
305 The contents of the toolbar is controlled by keywords placed
306 after the first occurrence of a character plus or minus. Each
307 keyword adds (after a plus) or removes (after a minus) a partic‐
308 ular toolbar button or group of buttons. The initial content of
309 the toolbar is determined by the first occurrence of a character
310 plus or minus. When this is a plus, the toolbar is initially
311 empty. When this is a minus, the toolbar initially contains the
312 default selection of buttons.
313
314 The following keywords are recognized:
315
316 ┌───────────────────────────────────────────────────────┐
317 │modecombo for the display mode selection tool. │
318 │zoomcombo for the zoom selection tool. │
319 │zoom for the zoom buttons. │
320 │select for the selection button. │
321 │rotate for the image rotation buttons. │
322 │find for the text search button. │
323 │new for the new window button. │
324 │open for the open new document button. │
325 │save for the save button. │
326 │print for the print button. │
327 │layout for the page layout buttons. │
328 │pagecombo for the page selection tool. │
329 │firstlast for the first-page and last-page buttons. │
330 │prevnext for the previous- and next-page buttons. │
331 │backforw reserved for the back and forward buttons. │
332 │help for the contextual help button. │
333 └───────────────────────────────────────────────────────┘
334 For the sake of backward compatibility, the keywords fore, fore_button,
335 back, back_button, bw, bw_button, color, and color_button are inter‐
336 preted like keyword modecombo; the keyword rescombo is a synonym of
337 zoomcombo; the keywords pan, zoomsel, and textsel are interpreted like
338 keyword select; and the keyword doublepage is interpreted like keyword
339 layout. All other keywords are ignored.
340
341 -menubar=(yes|no)
342 Enable or disable the presence of the menu bar located on top of
343 the window.
344
345
346 -statusbar=(yes|no)
347 Enable or disable the presence of the status bar located at the
348 bottom of the window.
349
350
351 -sidebar=keyword{,keyword}
352 Control the dockable panels. The argument is a comma separated
353 list of keywords. A first group of keywords selects which pan‐
354 els are affected. Omitting these keywords selects all panels.
355 A second group of keywords then controls the visibility and the
356 position of the selected panels.
357
358 ┌──────────────────────────────────────────────────────────────┐
359 │thumbnails specify the thumbnail panel. │
360 │outline,bookmarks specify the outline panel. │
361 │search,find specify the search panel. │
362 ├──────────────────────────────────────────────────────────────┤
363 │yes,true show the specified panels (default). │
364 │no,false hide the specified panels. │
365 │left dock specified panels on the left side. │
366 │right dock specified panels on the right side. │
367 │top dock specified panels on the top side. │
368 │bottom dock specified panels on the bottom side. │
369 └──────────────────────────────────────────────────────────────┘
370 -thumbnails=keyword{,keyword}
371 Compatibility alias for -sidebar=keyword{,keyword},thumbnails.
372
373 -outline=keyword{,keyword}
374 Compatibility alias for -sidebar=keyword{,keyword},outline.
375
376 -menu=(yes|no)
377 Enable or disable the pop-up menu.
378
379
380 -keyboard=(yes|no)
381 Enable or disable the DjVu plugin keyboard shortcuts. The
382 default is yes (enabled). Note that disabling the keyboard han‐
383 dling does not disable the shortcuts associated with active
384 menus (see options -menu and -menubar), visible toolbars and
385 sidebars (see options -toolbar and -sidebar).
386
387
388 -mouse=(yes|no)
389 Enable or disable mouse interaction for panning and selecting.
390 The default is yes (enabled).
391
392
393 -links=(yes|no)
394 Enable or disable hyper-links in the DjVu image. Hyper-links
395 are enabled by default.
396
397
398 -highlight=x,y,w,h[,color]
399 Display a highlighted rectangle at the specified coordinates in
400 the current page and with the specified color. Coordinates x,
401 y, w, and h are measured in document image coordinates (not
402 screen coordinates). The origin is set at the bottom left cor‐
403 ner of the image. The color color must be given in hexadecimal
404 RRGGBB or #RRGGBB format. Multiple highlighted zone can be
405 specified and can be interspersed with multiple -page=pagename
406 options.
407
408 -find=text
409 Highlight occurrences of the given string text. This option
410 works when the document contains a hidden text layer. It can be
411 used in conjunction with -sidebar=find to display the text
412 searching interface.
413
414 String text can be terminated by slash (/) followed by letters
415 specifying search options. The following letters are recognized
416
417 ┌────────────────────────────────────────────────────┐
418 │c Case-sensitive search. │
419 │C Case-insensitive search (default). │
420 │w Search hits start on word boundaries (default). │
421 │W Ignore word boundaries. │
422 │r Regular expression search. │
423 │R String search (default). │
424 └────────────────────────────────────────────────────┘
425 -rotate=(0|90|180|270)
426 Rotate the djvu image by the specified angle expressed in
427 degrees counter-clockwise.
428
429
430 -print=(yes|no)
431 Enable or disable printing the DjVu document. Printing is
432 enabled by default.
433
434
435 -save=(yes|no)
436 Enable or disable saving the DjVu document. Saving is enabled
437 by default.
438
439
440 -passive
441 Cause the DjVu image to be displayed in a manner similar to an
442 ordinary web image. The default zoom factor is changed to page.
443 The toolbar, the status bar, the scrollbars, the menus, and the
444 keyboard shortcuts are disabled.
445
446
447 -passivestretch
448 Cause the DjVu image to be displayed in a manner similar to an
449 ordinary web image. The default zoom factor is changed to
450 stretch. The toolbar, the status bar, the scrollbars, the
451 menus, and the keyboard shortcuts are disabled.
452
453
454 -nomenu, -notoolbar, -noscrollbars
455 These options were recognized by some versions of the DjVu view‐
456 ers and are honored for the sake of backward compatibility. A
457 warning message is printed when option -verbose is active.
458
459
460 -logo, -textsel, -search
461 These options were recognized by some versions of the DjVu view‐
462 ers but are currently not implemented by djview4. A warning
463 message is printed when option -verbose is active.
464
465
466
468 Most features can be accessed using the menus, the toolbar, the side
469 bar or the pop-up menu shown when the right mouse button is depressed
470 over a DjVu image. Detailled help can be accessed by clicking the con‐
471 textual help icon from the toolbar and then clicking on various section
472 of the djview user interface.
473
474 The following table lists some useful key combinations recognized when
475 the djvu document is active:
476
477 ┌────────────────────────────────────────────────────────────────────┐
478 │Key Action │
479 ├────────────────────────────────────────────────────────────────────┤
480 │SHIFT+F1 Activate the contextual help. │
481 │1,2, and 3 Change zoom to to 100%, 200% and 300%. │
482 │Up, Down, Left, Right Scroll the image in the given direction. │
483 │Home Display top left corner of the image. │
484 │End Display bottom right corner of the image. │
485 │Control+Home Go to the beginning of the document. │
486 │Control+End Go to the end of the document. │
487 │Space, Return Scroll down or go to next page. │
488 │Backspace Scroll up or go to previous page. │
489 │Page Down Go to the next page. │
490 │Page Up Go to the previous page. │
491 │+, - Zoom in and out. │
492 │[, ] Rotate image. │
493 │W Select the "Fit Width" zooming mode. │
494 │P Select the "Fit Page" zooming mode. │
495 │CTRL+F, F3 Search the hidden text layer. │
496 │CTRL+G Go to a specific page by name or by number. │
497 └────────────────────────────────────────────────────────────────────┘
498 Handy effects can be achieved by holding modifier keys. Although these
499 keys are configurable from the preference dialog, the following table
500 lists the default assignments
501
502 ┌─────────────────────────────────────────────────────────────┐
503 │Key Action │
504 ├─────────────────────────────────────────────────────────────┤
505 │CTRL+SHIFT Hold these keys to show the magnification lens. │
506 │CTRL Hold this key to select an area with the mouse. │
507 │SHIFT Hold this key to display all hyperlinks. │
508 └─────────────────────────────────────────────────────────────┘
510 Setting environment variable DJVIEW_VERBOSE to a nonzero value is
511 equivalent to calling djview with option -verbose. Setting environment
512 variable DJVIEW_OPENGL to values 0 or 1 overrides the preference set‐
513 tings regarding OpenGL rendering.
514
515 When the user clicks on a djvu hyperlink pointing to a web page, the
516 program first tries to execute the web browser programs whose names are
517 listed in the colon separated environment variable BROWSER, then tries
518 sensible platform dependent defaults.
519
520 The user interface language is determined by first trying to find a
521 complete set of translation files for the language specified in the
522 preference dialog, then for the ISO 639 languages specified in the
523 colon separated environment variable LANGUAGE, and finally the language
524 specified by the system locale. If all these searches fail, the user
525 interface language reverts to the english default.
526
527
529 This program was written by Léon Bottou <leonb@users.sf.net> and is
530 distributed under the GNU General Public License. This program
531 includes code derived from program tiff2pdf, written by Ross Finlayson
532 and released under a BSD license.
533
534
535
537 djvu(1), ddjvu(1), nsdejavu(1), tiff2pdf(1)
538
539
540
541DjVuLibre 10/11/2001 DJVIEW4(1)