Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
DSPDFVIEWER(1)		     General Commands Manual		  DSPDFVIEWER(1)

NAME
     dspdfviewer - Dual-Screen PDF Viewer

SYNOPSIS
     dspdfviewer [options] [filename]

DESCRIPTION
     dspdfviewer  is  intended	for  presentations created with the latex-beamer
     class, specifically  documents  created  with  the  show  notes  on  second
     screen=right option.

     Its  purpose is to display the left half of a page on the audience's screen
     (which will most commonly be a projector) and the right half on your  "pri-
     vate"  screen  (think:  the notebook you carried to the presentation site).
     The basic idea is that you will display personal notes and  information  to
     help you with your presentation on your personal screen, while the audience
     sees only the PDF they are supposed to see.

     On  the secondary screen you will see three clocks: A "wall clock", a "pre-
     sentation" clock and a "slide" clock.

     The wall clock in the bottom left corner that display current time of  day,
     the  presentation	clock  (labeled "Total") counts the time you spent since
     you started the presentation, and the "slide" counter (bottom  right)  dis-
     plays the time you spent on the current slide.

     The  clocks  don't start the second you launch the program, the idea behind
     that behaviour is that many people have a "title" slide active long  before
     the audience even arrives.

     Once  you	use  the  next/previous slide commands, the clock starts. If you
     want to start the clock, but still display  the  title  slide,  just  press
     "previous"  (for  example,  Up  Arrow  or	Right Mouse Button) on the title
     slide.

     If you want to reset the clocks to zero, press the  "Home"  button  on  the
     keybord.

OPTIONS
     The exact behaviour of dspdfviewer is configurable using command-line para-
     meters.

     Unless  otherwise	noted, all command-line options can be written in a con-
     figuration file. See the FILES section for the location.

     For the command-line parameters, this program follows the usual GNU command
     line syntax, with long options starting with two dashes ('-').   A  summary
     of options is included below.

     If  you  specify  those in a configuration file, write one option per line,
     use the long version without the two leading dashes, followed by an  equals
     sign and the desired value.

     For example, bottom-pane-height=20 is a valid configuration line.

     If  an  option is specified in both the configuration file and the command-
     line, the command-line value takes precedence.

     Note for options of type <bool>: They take true, false, 0	or  1  as  argu-
     ments.   For  example, --use-second-screen false can be expressed as --use-
     second-screen 0 or shortened to -u0.

     -h, --help
	    Show summary of options.

     -f, --full-page
	    Use the presentation program with a normal single-screen  PDF,  that
	    is display the full page on both the primary and secondary monitor.

	    The  secondary  screen  still contains timers and thumbnails to help
	    you with your presentation, unless you disable them  using	the  op-
	    tions below.

     -u, --use-second-screen <bool>
	    Controls whether the program actually works as a dual-screen viewer.

	    The default is true.

	    If	you  only  have one screen, but still want to use the cache fea-
	    tures, you can set this option to false. If the window  ends  up  on
	    the wrong display, you can still use the switch command (see below).

	    What  comes out on the primary screen depends on whether you use the
	    -f Option: -u0 -f results in a simple full-screen PDF viewer,  while
	    -u0  without  -f  still splits the page in half and outputs only the
	    left frame.

     -l, --hyperlink-support <bool>
	    Controls whether the program makes PDF Hyperlinks clickable.

	    The default is true.

	    While it is normally desired to have clickable  hyperlinks,  if  you
	    cannot  control the position of your pointer (if your remote control
	    has only left-click and right-click) it might be  safer  to  disable
	    hyperlinks.

     --prerender-previous-pages n
	    When  jumping  to  slide  m, also pre-render the slides (m-n)..(m-1)
	    (default 3)

	    Note: If you set this to zero, you will not get a thumbnail for  the
	    previous page rendered before you have visited it.

     --prerender-next-pages n
	    When  jumping  to  slide  m, also pre-render the slides (m+1)..(m+n)
	    (default 10)

	    Note: If you set this to zero, you will not get a thumbnail for  the
	    next page rendered before you have visited it.

     --cache-size n (in megabytes / MiB)
	    This  controls  how  much  memory  dspdfviewer is allowed to use for
	    caching rendered pages.  The default value is 1024, meaning 1 GiB of
	    RAM.  Note that the memory used for active rendering  processes,  as
	    well  as  the currently displayed images are not included in the ac-
	    counting, so the total memory usage of dspdfviewer	will  be  higher
	    than this.

	    CAVEAT:  It  is currently not verified that this memory is enough to
	    hold all prerendered pages.  If you make the cache too small to hold
	    the prerendered pages, it will start  dropping  the  first	rendered
	    (adjacent  to the current page), resulting in very poor performance.
	    If in doubt, set a larger cache or a lower prerender amount.

     -a, --presenter-area <bool>
	    Show (true, 1) or hide (false, 0) the presenter's area on the second
	    screen.  If this is set to zero, the following options will have  no
	    effect.

     -d, --duplicate <bool>
	    Duplicate (true, 1) or hide (false, 0) the audience's screen next to
	    the notes on the second screen.  The default is false.

     -t, --thumbnails <bool>
	    Show  (true,  1)  or  hide	(false,  0) the thumbnails on the second
	    screen.

     -T, --thumbnail-page-part <pagepart>
	    Show this part of the page for thumbnails, valid values are  "left",
	    "right" or "both".

     -w, --wall-clock <bool>
	    Show  (true,  1)  or  hide	(false,  0) the wall clock on the second
	    screen.

     -p, --presentation-clock <bool>
	    Show (true, 1) or hide (false, 0) the presentation clock on the sec-
	    ond screen.

     -s, --slide-clock <bool>
	    Show (true, 1) or hide (false, 0) the  slide  clock  on  the  second
	    screen.

     -b, --bottom-pane-height n
	    Configure how large the presenter area on the second screen will be,
	    unit is percent of second screen's total height.

	    Default value 20.

     --i3-workaround <bool>
	    This  tries to ask the i3 window manager (by calling the i3-msg com-
	    mand) to move the audience window to "the other screen".

	    This is considered an experimental feature and disabled by	default.
	    Read the runtimeconfiguration.cpp source code for more info.

CONTROLS
     You can use the following controls while dspdfviewer is running.

     Note  that  mouse-clicks  are  subject to pointer position if the hyperlink
     support is enabled. If your mouse cursor changes to a hand, it will  follow
     the link you are hovering on a click.

     Keyboard: ?, F1
	    Display quick-help (most important key bindings)

     Keyboard: Spacebar, Page Down / Mouse: Left-Click, Wheel Down
	    Go one page forward

	    Additional keyboard aliases: Down, Right, Return, Enter, N, F

     Keyboard: Backspace, Page Up / Mouse: Right-Click, Wheel Up
	    Go one page backward

	    Additional keyboard aliases: Up, Left, P

     Keyboard: B, . (period)
	    Toggle blanking of the audience screen

     Keyboard: G
	    Go to specific page (a number entry window will pop up)

	    Note  that the this counts PDF pages, so a single slide having 6 un-
	    masking steps will be 7 PDF pages long, including the initial  near-
	    blank page.

     Keyboard: Home, H
	    Go to the first page and reset the clocks to zero.

	    Use  this  if  you want the clocks to stop at zero, use the G (goto)
	    function to page 1 if you want to them to keep running.

	    Note that the Home key may be called "Pos 1" on some keyboards.

     Keyboard: Escape, Q
	    Quit dspdfviewer.

     Keyboard: S, F12
	    Switch primary and secondary screens

	    Use this if the audience sees your 'note' side with the  clocks  and
	    you see the actual presentation on your screen.

	    If	you just want to see the main presentation (for example, because
	    the projector is behind you), use T.

     Keyboard: T
	    Switch secondary screen's function

	    Use this if you want to see the audience side on your screen,  with-
	    out  showing  the  notes  to the audience. Pressing the button again
	    will switch back to normal operation.

     Keyboard: D
	    Switch duplication of the audience's screen

	    Use this if you want to see the audience side and the notes on  your
	    screen (so the full presentation), leaving the audience's screen un-
	    touched. Pressing the button again will switch back to split mode.

FILES
     ~/.config/dspdfviewer.ini
	    You  can  specify all long command-line options (without leading --)
	    here, in a "option=value" format, one per line.

PRESENTER REMOTE CONTROLS
     Most (maybe not all) presenter remote controls technically act  as  a  key-
     board sending one of the keystrokes listed either in the main or additional
     keybindings.  If your remote control does not work as intended, please file
     a bug report describing what keystrokes it generates  when  you  press  its
     buttons. If there is no conflict, a keybinding will be included in the next
     release.

BUGS
     None currently known.

     If you find any bugs, the preferred way to report them is at the github is-
     sue tracker at https://github.com/dannyedel/dspdfviewer/issues.

     As  a  fallback,  you  can  send e-mail to mail@danny-edel.de with the word
     "dspdfviewer" in the subject line.

SEE ALSO
     /usr/share/doc/latex-beamer/beameruserguide.pdf.gz
	    from the latex-beamer package on how to create beamer presentations.

	    Note: Use "show notes on second  screen=right"  because  dspdfviewer
	    assumes that the right half of the page is the notes.

     http://dspdfviewer.danny-edel.de
	    for installation instructions and new release announcements.

				  July 30, 2015 		  DSPDFVIEWER(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=dspdfviewer&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help