Penguin
Recent Changes
Annotated edit history of xpdf(1) version 2, including all changes. View license author blame.
Rev Author # Line
1 perry 1 xpdf
2 !!!xpdf
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 CONFIGURATION FILE
7 OPTIONS
8 CONTROLS
9 WEB BROWSERS
10 REMOTE SERVER MODE
11 BUGS
12 AUTHOR
13 SEE ALSO
14 ----
15 !!NAME
16
17
18 xpdf - Portable Document Format (PDF) file viewer for X (version 1.00)
19 !!SYNOPSIS
20
21
22 __xpdf__ [[options] [[''PDF-file'' [[''page'' |
23 +''dest'']]
24 !!DESCRIPTION
25
26
27 __Xpdf__ is a viewer for Portable Document Format (PDF)
28 files. (These are also sometimes also called Acrobat' files,
29 from the name of Adobe's PDF software.) Xpdf runs under the
30 X Window System on UNIX, VMS, and OS/2.
31
32
33 To run xpdf, simply type:
34
35
36 xpdf file.pdf
37
38
39 where ''file.pdf'' is your PDF file. The file name can be
40 followed by a number specifying the page which should be
41 displayed first, e.g.:
42
43
44 xpdf file.pdf 18
45
46
47 You can also give a named destination, prefixed with +' in
48 place of the page number.
49
50
51 You can also start xpdf without opening any
52 files:
53
54
55 xpdf
56 !!CONFIGURATION FILE
57
58
59 Xpdf reads a configuration file at startup. It first tries
60 to find the user's private config file, ~/.xpdfrc. If that
61 doesn't exist, it looks for a system-wide config file,
62 typically /usr/local/etc/xpdfrc (but this location can be
63 changed when xpdf is built). See the xpdfrc(5) man
64 page for details.
65 !!OPTIONS
66
67
68 Many of the following options can be set with configuration
69 file commands or X resources. These are listed in square
70 brackets with the description of the corresponding command
71 line option.
72
73
74 __-g__ ''geometry''
75
76
77 Set the initial window geometry. (__-geometry__ is
78 equivalent.) [[X resource: __xpdf.geometry__]
79
80
81 __-title__ ''title''
82
83
84 Set the window title. By default, the title will be
85 xpdf.title__]
86
87
88 __-cmap__
89
90
2 perry 91 Install a private colormap. This is ignored on !TrueColor
1 perry 92 visuals. [[X resource: __xpdf.installCmap__]
93
94
95 __-rgb__ ''number''
96
97
98 Set the size of largest RGB cube xpdf will try to allocate.
99 The default is 5 (for a 5x5x5 cube); set to a smaller number
100 to conserve color table entries. This is ignored with
2 perry 101 private colormaps and on !TrueColor visuals. [[X resource:
1 perry 102 __xpdf.rgbCubeSize__]
103
104
105 __-papercolor__ ''color''
106
107
108 Set the
109 xpdf.paperColor__]
110
111
112 __-z__ ''zoom''
113
114
115 Set the initial zoom factor. A number (-5 .. 5) specifies a
116 zoom factor, where 0 means 72 dpi. You may also specify
117 page', to fit the page to the window size, or width', to fit
118 the page width to the window width. [[X resource:
119 __xpdf.initialZoom__]
120
121
122 __-t1lib__ ''font-type''
123
124
125 Set the type of font rendering for t1lib (the Type 1
126 rasterizer) to use. Options are none' (don't use t1lib at
127 all), plain' (use non-anti-aliased fonts), low' or high'
128 (use low-level or high-level anti-aliased fonts). [[config
129 file: __t1libControl__]
130
131
132 __-freetype__ ''font-type''
133
134
2 perry 135 Set the type of font rendering for !FreeType (the !TrueType
136 rasterizer) to use. Options are none' (don't use !FreeType at
1 perry 137 all), plain' (use non-anti-aliased fonts), or aa' (use
138 anti-aliased fonts). [[config file:
139 __freetypeControl__]
140
141
142 __-ps__ ''PS-file''
143
144
2 perry 145 Set the default file name for !PostScript output. This can
146 also be of the form |command' to pipe the !PostScript through
1 perry 147 a command. [[config file: __psFile__]
148
149
150 __-paper__ ''size''
151
152
153 Set the paper size to one of
154 psPaperSize__]
155
156
157 __-paperw__ ''size''
158
159
160 Set the paper width, in points. [[config file:
161 __psPaperSize__]
162
163
164 __-paperh__ ''size''
165
166
167 Set the paper height, in points. [[config file:
168 __psPaperSize__]
169
170
171 __-level1__
172
173
2 perry 174 Generate Level 1 !PostScript. The resulting !PostScript files
1 perry 175 will be significantly larger (if they contain images), but
176 will print on Level 1 printers. This also converts all
177 images to black and white. [[config file:
178 __psLevel__]
179
180
181 __-enc__ ''encoding-name''
182
183
184 Sets the encoding to use for text output. The
185 ''encoding-name'' must be defined with the unicodeMap
186 command (see xpdfrc(5)). This defaults to
187 __textEncoding__]
188
189
190 __-eol__ ''unix | dos | mac''
191
192
193 Sets the end-of-line convention to use for text output.
194 [[config file: __textEOL__]
195
196
197 __-opw__ ''password''
198
199
200 Specify the owner password for the PDF file. Providing this
201 will bypass all security restrictions.
202
203
204 __-upw__ ''password''
205
206
207 Specify the user password for the PDF file.
208
209
210 __-fullscreen__
211
212
213 Open xpdf in a full-screen mode, useful for presentations.
214 You may also want to specify '-bg black' (or similar) with
215 this. (There is currently no way to switch between window
216 and full-screen modes on the fly.)
217
218
219 __-remote__ ''name''
220
221
222 Start/contact xpdf remote server with specified name (see
223 the __REMOTE SERVER MODE__ section below).
224
225
226 __-raise__
227
228
229 Raise xpdf remote server window (with -remote
230 only).
231
232
233 __-quit__
234
235
236 Kill xpdf remote server (with -remote only).
237
238
239 __-cmd__
240
241
242 Print commands as they're executed (useful for
243 debugging).
244
245
246 __-q__
247
248
249 Don't print any messages or errors. [[config file:
250 __errQuiet__]
251
252
253 __-cfg__ ''config-file''
254
255
256 Read ''config-file'' in place of ~/.xpdfrc or the
257 system-wide config file.
258
259
260 __-v__
261
262
263 Print copyright and version information.
264
265
266 __-h__
267
268
269 Print usage information. (__-help__ and __--help__ are
270 equivalent.)
271
272
273 Several other standard X options and resources will work as
274 expected:
275
276
277 __-display__ ''display''
278
279
280 [[X resource: __xpdf.display__]
281
282
283 __-fg__ ''color''
284
285
286 (__-foreground__ is equivalent.) [[X resource:
287 __xpdf.foreground__]
288
289
290 __-bg__ ''color''
291
292
293 (__-background__ is equivalent.) [[X resource:
294 __xpdf.background__]
295
296
297 __-font__ ''font''
298
299
300 (__-fn__ is equivalent.) [[X resource:
301 __xpdf.font__]
302
303
304 The color and font options only affect the user interface
305 elements, not the PDF display (the paper').
306
307
308 The following X resources do not have command line option
309 equivalents:
310
311
312 __xpdf.viKeys__
313
314
315 Enables the h', l', k' and j' keys for left, right, up, and
316 down scrolling.
317 !!CONTROLS
318
319
320 __On-screen controls, at the bottom of the xpdf
321 window__
322
323
324 __left/right arrow buttons__
325
326
327 Move to the previous/next page.
328
329
330 __double left/right arrow buttons__
331
332
333 Move backward or forward by ten pages.
334
335
336 __dashed left/right arrow buttons__
337
338
339 Move backward or forward along the history
340 path.
341
342
343 __Page' entry box__
344
345
346 Move to a specific page number. Click in the box to activate
347 it, type the page number, then hit return.
348
349
350 __zoom popup menu__
351
352
353 Change the zoom factor (see the description of the -z option
354 above).
355
356
357 __binoculars button__
358
359
360 Find a text string.
361
362
363 __print button__
364
365
2 perry 366 Bring up a dialog for generating a !PostScript file. The
1 perry 367 dialog has options to set the pages to be printed and the
2 perry 368 !PostScript file name. The file name can be -' for stdout or
369 |command' to pipe the !PostScript through a command, e.g.,
1 perry 370 |lpr'.
371
372
373 __?' button__
374
375
376 Bring up the about xpdf' window.
377
378
379 __link info__
380
381
382 The space between the ?' and Quit' buttons is used to show
383 the URL or external file name when the mouse is over a
384 link.
385
386
387 __Quit' button__
388
389
390 Quit xpdf.
391
392
393 __Menu__
394
395
396 Pressing the right mouse button will post a popup menu with
397 the following commands:
398
399
400 __Open...__
401
402
403 Open a new PDF file via a file requester.
404
405
406 __Reload__
407
408
409 Reload the current PDF file. Note that Xpdf will reload the
410 file automatically (on a page change or redraw) if it has
411 changed since it was last loaded.
412
413
414 __Save as...__
415
416
417 Save the current file via a file requester.
418
419
420 __Rotate counterclockwise__
421
422
423 Rotate the page 90 degrees counterclockwise.
424
425
426 __Rotate clockwise__
427
428
429 Rotate the page 90 degrees clockwise. The two rotate
430 commands are intended primarily for PDF files where the
431 rotation isn't correctly specified in the file, but they're
432 also useful if your X server doesn't support font
433 rotation.
434
435
436 __Quit__
437
438
439 Quit xpdf.
440
441
442 __Text selection__
443
444
445 Dragging the mouse with the left button held down will
446 highlight an arbitrary rectangle. Any text inside this
447 rectangle will be copied to the X selection
448 buffer.
449
450
451 __Links__
452
453
454 Clicking on a hyperlink will jump to the link's destination.
455 A link to another PDF document will make xpdf load that
456 document. A launch' link to an executable program will
457 display a dialog, and if you click ok', execute the program.
458 URL links call an external command (see the __WEB
459 BROWSERS__ section below).
460
461
462 __Panning__
463
464
465 Dragging the mouse with the middle button held down pans the
466 window.
467
468
469 __Key bindings__
470
471
472 __o__
473
474
475 Open a new PDF file via a file requester.
476
477
478 __r__
479
480
481 Reload the current PDF file. Note that Xpdf will reload the
482 file automatically (on a page change or redraw) if it has
483 changed since it was last loaded.
484
485
486 __f__
487
488
489 Find a text string.
490
491
492 __n__
493
494
495 Move to the next page. Scrolls to the top of the page,
496 unless scroll lock is turned on.
497
498
499 __p__
500
501
502 Move to the previous page. Scrolls to the top of the page,
503 unless scroll lock is turned on.
504
505
506 ____ or ____ or
507 ____
508
509
510 Scroll down on the current page; if already at bottom, move
511 to next page.
512
513
514 ____ or ____ or
515 ____ or
516 ____
517
518
519 Scroll up on the current page; if already at top, move to
520 previous page.
521
522
523 __v__
524
525
526 Move forward along the history path.
527
528
529 __b__
530
531
532 Move backward along the history path.
533
534
535 ____
536
537
538 Scroll to top of current page.
539
540
541 ____
542
543
544 Scroll to bottom of current page.
545
546
547 __arrows__
548
549
550 Scroll the current page.
551
552
553 __0__
554
555
556 Set the zoom factor to zero (72 dpi).
557
558
559 __+__
560
561
562 Zoom in (increment the zoom factor by 1).
563
564
565 __-__
566
567
568 Zoom out (decrement the zoom factor by 1).
569
570
571 __z__
572
573
574 Set the zoom factor to 'page' (fit page to
575 window).
576
577
578 __w__
579
580
581 Set the zoom factor to 'width' (fit page width to
582 window).
583
584
585 __control-L__
586
587
588 Redraw the current page.
589
590
591 __q__
592
593
594 Quit xpdf.
595 !!WEB BROWSERS
596
597
598 If you want to run xpdf automatically from netscape or
599 mosaic (and probably other browsers) when you click on a
600 link to a PDF file, you need to edit (or create) the files
601 ''.mime.types'' and ''.mailcap'' in your home
602 directory. In ''.mime.types'' add the line:
603
604
605 application/pdf pdf
606
607
608 In ''.mailcap'' add the lines:
609
610
611 # Use xpdf to view PDF files.
612
613
614 application/pdf; xpdf -q %s
615
616
617 Make sure that xpdf is on your executable search
618 path.
619
620
621 When you click on a URL link in a PDF file, xpdf will
622 execute the command specified by the urlCommand config file
623 option, replacing an occurrence of %s' with the URL. For
624 example, to call netscape with the URL, add this line to
625 your config file:
626
627
628 urlCommand
629 !!REMOTE SERVER MODE
630
631
632 Xpdf can be started in remote server mode by specifying a
633 server name (in addition to the file name and page number).
634 For example:
635
636
637 xpdf -remote myServer file.pdf
638
639
640 If there is currently no xpdf running in server mode with
641 the name myServer', a new xpdf window will be opened. If
642 another command:
643
644
645 xpdf -remote myServer another.pdf 9
646
647
648 is issued, a new copy of xpdf will not be started. Instead,
649 the first xpdf (the server) will load ''another.pdf'' and
650 display page nine. If the file name is the
651 same:
652
653
654 xpdf -remote myServer another.pdf 4
655
656
657 the xpdf server will simply display the specified
658 page.
659
660
661 The -raise option tells the server to raise its window; it
662 can be specified with or without a file name and page
663 number.
664
665
666 The -quit option tells the server to close its window and
667 exit.
668 !!BUGS
669
670
671 No support for Type 3 fonts.
672 !!AUTHOR
673
674
675 The xpdf software and documentation are copyright 1996-2002
676 Derek B. Noonburg (derekn@foolabs.com).
677 !!SEE ALSO
678
679
680 pdftops(1), pdftotext(1), pdfinfo(1),
681 pdffonts(1), pdftopbm(1), pdfimages(1),
682 xpdfrc(5)__
683 http://www.foolabs.com/xpdf/__
684 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.