~ubuntu-branches/ubuntu/lucid/xpdf/lucid-updates

« back to all changes in this revision

Viewing changes to doc/xpdfrc.hlp

  • Committer: Bazaar Package Importer
  • Author(s): Andy Price
  • Date: 2007-05-17 22:04:33 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517220433-gzcx2lrvllkbl7mr
Tags: 3.02-1ubuntu1
* Merge from Debian unstable (LP: #113365), remaining changes:
  - Added back 09_xpdfrc_manpage.dpatch (LP #71753)
  - Set Ubuntu maintainer

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
1 xpdfrc
3
3
2 NCLUDE_FILE
4
4
 
5
 
       xpdfrc - configuration file for Xpdf tools (version 3.01)
 
5
       xpdfrc - configuration file for Xpdf tools (version 3.02)
6
6
 
7
7
       include config-file
8
8
              Includes  the specified config file.  The effect of
267
267
              Level  3 PostScript, this generates a CID font, for
268
268
              lower levels it generates a non-CID composite font.
269
269
 
 
270
       psPreload yes | no
 
271
              If set to "yes", PDF forms are converted to PS pro-
 
272
              cedures, and image data is  preloaded.   This  uses
 
273
              more memory in the PostScript interpreter, but gen-
 
274
              erates significantly smaller PS files in situations
 
275
              where,  e.g., the same image is drawn on every page
 
276
              of a long document.  This defaults to "no".
 
277
 
270
278
       psOPI yes | no
271
 
              If  set to "yes", generates PostScript OPI comments
272
 
              for all images and forms which  have  OPI  informa-
273
 
              tion.   This  option  is only available if the Xpdf
274
 
              tools  were  compiled  with  OPI   support.    This
 
279
              If set to "yes", generates PostScript OPI  comments
 
280
              for  all  images  and forms which have OPI informa-
 
281
              tion.  This option is only available  if  the  Xpdf
 
282
              tools   were   compiled  with  OPI  support.   This
275
283
              defaults to "no".
276
284
 
277
285
       psASCIIHex yes | no
278
 
              If  set to "yes", the ASCIIHexEncode filter will be
279
 
              used instead  of  ASCII85Encode  for  binary  data.
 
286
              If set to "yes", the ASCIIHexEncode filter will  be
 
287
              used  instead  of  ASCII85Encode  for  binary data.
280
288
              This defaults to "no".
281
289
 
282
290
       psFile file-or-command
283
 
              Sets  the  default PostScript file or print command
284
 
              for xpdf.  Commands start  with  a  '|'  character;
285
 
              anything  else is a file.  If the file name or com-
286
 
              mand contains  spaces  it  must  be  quoted.   This
287
 
              defaults  to  unset, which tells xpdf to generate a
288
 
              name  of  the  form  <file>.ps  for  a   PDF   file
 
291
              Sets the default PostScript file or  print  command
 
292
              for  xpdf.   Commands  start  with a '|' character;
 
293
              anything else is a file.  If the file name or  com-
 
294
              mand  contains  spaces  it  must  be  quoted.  This
 
295
              defaults to unset, which tells xpdf to  generate  a
 
296
              name   of   the  form  <file>.ps  for  a  PDF  file
289
297
              <file>.pdf.
290
298
 
291
299
       fontDir dir
292
 
              See  the  description  above,  in the DISPLAY FONTS
 
300
              See the description above,  in  the  DISPLAY  FONTS
293
301
              section.
294
302
 
295
303
                                                               ()
340
348
              size, or 'width', to fit the page width to the win-
341
349
              dow width.
342
350
 
 
351
       continuousView yes | no
 
352
              If set to "yes", xpdf will start in continuous view
 
353
              mode, i.e., with one vertical screoll bar  for  the
 
354
              whole document.  This defaults to "no".
 
355
 
343
356
       enableT1lib yes | no
344
357
              Enables  or  disables  use  of t1lib (a Type 1 font
345
358
              rasterizer).  This is only  relevant  if  the  Xpdf
361
374
              trol  provided  by  the  old   "t1libControl"   and
362
375
              "freetypeControl" options.)  This default to "yes".
363
376
 
 
377
       vectorAntialias yes | no
 
378
              Enables or disables anti-aliasing of vector  graph-
 
379
              ics in the PDF rasterizer.  This defaults to "yes".
 
380
 
 
381
       strokeAdjust yes | no
 
382
              Enables  or  disables  stroke   adjustment.    This
 
383
              defaults to "yes".
 
384
 
 
385
       screenType dispersed | clustered | stochasticClustered
 
386
              Sets  the  halftone screen type, which will be used
 
387
              when generating a monochrome (1-bit)  bitmap.   The
 
388
              three  options  are  dispersed-dot dithering, clus-
 
389
              tered-dot dithering (with a round dot and 45-degree
 
390
              screen angle), and stochastic clustered-dot dither-
 
391
              ing.  By default, "stochasticClustered" is used for
 
392
              resolutions  of 300 dpi and higher, and "dispersed"
 
393
              is used for resolutions lower then 300 dpi.
 
394
 
 
395
       screenSize integer
 
396
              Sets the  size  of  the  (square)  halftone  screen
 
397
              threshold  matrix.   By default, this is 4 for dis-
 
398
              persed-dot dithering, 10 for clustered-dot  dither-
 
399
              ing,  and  100 for stochastic clustered-dot dither-
 
400
              ing.
 
401
 
 
402
       screenDotRadius integer
 
403
              Sets the halftone screen dot radius.  This is  only
 
404
              used when screenType is set to stochasticClustered,
 
405
              and it defaults to 2.  In clustered-dot  mode,  the
 
406
              dot  radius is half of the screen size.  Dispersed-
 
407
              dot dithering doesn't have a dot radius.
 
408
 
 
409
       screenGamma float
 
410
              Sets the halftone screen gamma  correction  parame-
 
411
              ter.   Gamma  values greater than 1 make the output
 
412
              brighter; gamma values less than 1 make it  darker.
 
413
              The default value is 1.
 
414
 
 
415
       screenBlackThreshold float
 
416
              When  halftoning,  all  values below this threshold
 
417
              are forced to solid black.   This  parameter  is  a
 
418
              floating  point  value  between  0  (black)  and  1
 
419
              (white).  The default value is 0.
 
420
 
 
421
       screenWhiteThreshold float
 
422
              When halftoning, all values  above  this  threshold
 
423
              are  forced  to  solid  white.  This parameter is a
 
424
              floating  point  value  between  0  (black)  and  1
 
425
              (white).  The default value is 1.
 
426
 
364
427
       urlCommand command
365
 
              Sets the command executed when you click on  a  URL
366
 
              link.   The  string  "%s" will be replaced with the
 
428
              Sets  the  command executed when you click on a URL
 
429
              link.  The string "%s" will be  replaced  with  the
367
430
              URL.  (See the example below.)  This has no default
368
431
              value.
369
432
 
370
433
       movieCommand command
371
434
              Sets the command executed when you click on a movie
372
 
              annotation.  The string "%s" will be replaced  with
 
435
              annotation.   The string "%s" will be replaced with
373
436
              the movie file name.  This has no default value.
374
437
 
375
438
       mapNumericCharNames yes | no
376
439
              If set to "yes", the Xpdf tools will attempt to map
377
 
              various numeric character names sometimes  used  in
378
 
              font  subsets.   In some cases this leads to usable
379
 
              text, and in other cases it leads to  gibberish  --
 
440
              various  numeric  character names sometimes used in
 
441
              font subsets.  In some cases this leads  to  usable
 
442
              text,  and  in other cases it leads to gibberish --
380
443
              there is no way for Xpdf to tell.  This defaults to
381
444
              "yes".
382
445
 
 
446
       mapUnknownCharNames yes | no
 
447
              If  set to "yes", and mapNumericCharNames is set to
 
448
              "no", the Xpdf tools  will  apply  a  simple  pass-
 
449
              through  mapping  (Unicode  index = character code)
 
450
              for all unrecognized glyph names.  In  some  cases,
 
451
              this  leads  to  usable text, and in other cases it
 
452
              leads to gibberish -- there is no way for  Xpdf  to
 
453
              tell.  This defaults to "no".
 
454
 
 
455
       bind modifiers-key context command ...
 
456
              Add  a  key or mouse button binding.  Modifiers can
 
457
              be zero or more of:
 
458
 
 
459
                  shift-
 
460
                  ctrl-
 
461
                  alt-
 
462
 
 
463
              Key can be a regular ASCII character,  or  any  one
 
464
              of:
 
465
 
 
466
                  space
 
467
                  tab
 
468
                  return
 
469
                  enter
 
470
                  backspace
 
471
                  insert
 
472
                  delete
 
473
                  home
 
474
                  end
 
475
                  pgup
 
476
                  pgdn
 
477
                  left / right / up / down        (arrow keys)
 
478
                  f1 .. f35                       (function keys)
 
479
                  mousePress1 .. mousePress7      (mouse buttons)
 
480
                  mouseRelease1 .. mouseRelease7  (mouse buttons)
 
481
 
 
482
              Context is either "any" or a comma-separated combi-
 
483
              nation of:
 
484
 
 
485
                  fullScreen / window       (full screen mode on/off)
 
486
                  continuous / singlePage   (continuous mode on/off)
 
487
                  overLink / offLink        (mouse over link or not)
 
488
                  scrLockOn / scrLockOff    (scroll lock on/off)
 
489
 
 
490
              The context string can include  only  one  of  each
 
491
              pair in the above list.
 
492
 
 
493
              Command  is  an Xpdf command (see the COMMANDS sec-
 
494
              tion of the xpdf(1) man page for details).   Multi-
 
495
              ple commands are separated by whitespace.
 
496
 
 
497
              The bind command replaces any existing binding, but
 
498
              only if it was defined for  the  exact  same  modi-
 
499
              fiers,  key,  and  context.  All tokens (modifiers,
 
500
              key, context, commands) are case-sensitive.
 
501
 
 
502
              Example key bindings:
 
503
 
 
504
                  # bind ctrl-a in any context to the nextPage
 
505
                  # command
 
506
                  bind ctrl-a any nextPage
 
507
 
 
508
                  # bind uppercase B, when in continuous mode
 
509
                  # with scroll lock on, to the reload command
 
510
                  # followed by the prevPage command
 
511
                  bind B continuous,scrLockOn reload prevPage
 
512
 
 
513
              See the xpdf(1) man page for more examples.
 
514
 
 
515
       unbind modifiers-key context
 
516
              Removes a key binding  established  with  the  bind
 
517
              command.  This is most useful to remove default key
 
518
              bindings before establishing new ones (e.g., if the
 
519
              default key binding is given for "any" context, and
 
520
              you want to create new key  bindings  for  multiple
 
521
              contexts).
 
522
 
383
523
       printCommands yes | no
384
 
              If set to "yes", drawing commands  are  printed  as
 
524
              If  set  to  "yes", drawing commands are printed as
385
525
              they're  executed  (useful  for  debugging).   This
386
526
              defaults to "no".
387
527
 
388
528
       errQuiet yes | no
389
 
              If set to "yes",  this  suppresses  all  error  and
390
 
              warning  messages from all of the Xpdf tools.  This
 
529
              If  set  to  "yes",  this  suppresses all error and
 
530
              warning messages from all of the Xpdf tools.   This
391
531
              defaults to "no".
392
532
 
393
533
                                                               ()
465
605
2 AUTHOR
466
606
 
467
607
       The   Xpdf   software   and  documentation  are  copyright
468
 
       1996-2005 Glyph & Cog, LLC.
 
608
       1996-2007 Glyph & Cog, LLC.
469
609
 
470
610
                                                               ()
471
611