.TH  PDFPCRC 5
.if !dURL \{\
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.\}
.if \n[.g] .mso www.tmac

.SH NAME
pdfpcrc \- pdfpc configuration file

.SH DESCRIPTION
.PP
\fBpdfpc\fR(1) first reads its system-wide configuration file, followed by the
user-specific one if it exists.

.SS Keybindings
.PP
The following commands are accepted:
.TP
.B bind <key> <action> [<arg>]
Bind a key to an action, passing a specified argument for actions that require
one
.TP
.B unbind <key>
Unbind the given key
.TP
.B unbind_all
Clear all the key bindings
.TP
.B mouse <button> <action>
Bind a mouse button to an action
.TP
.B unmouse <button>
Unbind a mouse button
.TP
.B unmouse_all
Clear all the mouse bindings

.PP
Key names can be obtained with the help of the \fBxev\fR(1) utility. Note that
names are case sensitive. Key combinations with modifiers can be specified in
the form <mod>+<key>, where <mod> is one of S (for shift), C (for control) and
A/M (for Alt/Meta).

.PP
A shorthand for specifying key combinations constituting shift and an
alphabetic character is to simply give the uppercase version of the
alphabetic character. For example, S+r and R are equivalent.

.PP
A list of all possible actions can be obtained via the \fB\-L\fR command line
option of \fBpdfpc\fR(1). Use the \fB\-B\fR command line option to list the
action bindings defined.

.SS Options
.PP
Some permanent changes can be configured via the config file. The syntax is:
.TP
.B option <option_name> <option_value>

.PP
The following option_name's are recognized:

.TP
.B black-on-end
Add an additional black slide at the end of the presentation (bool, Default is false).
.TP
.BI cache-clean-period
Period (in units of s) to check for expired cached content (int, Default is 60).
.TP
.BI cache-expiration
Time (in units of s) to keep (pre)rendered slides in the cache (int, Default is
600). Set to a negative value to keep cached slides permanently.
.TP
.BI cache-max-rtime
Maximal time (in units of ms) it takes to render a slide for its cache to be
protected from expiration (int, Default is 1000).
.TP
.BI cache-min-rtime
Minimal time (in units of ms) it takes to render a slide for it to be cached
(int, Default is 10).
.TP
.BI cache-max-usize
Maximal size (in units of kB) of a slide image to store it uncompressed in the
cache (int, Default is 256).
.TP
.B current-height
Percentage of the height of the presenter screen to be used for the current slide (int, Default is 80).
.TP
.B current-size
Percentage of the presenter screen to be used for the current slide (int, Default is 60).
.TP
.BI disable-input-autodetection
Do not automatically detect type (pen or eraser) of tablet input devices (bool,
Default is false).
.TP
.BI disable-input-pressure
Ignore pressure sensitivity of tablet input devices (pen or eraser) even when
it is supported by the hardware (bool, Default is false).
.TP
.BI disable-scrolling
Disable scrolling events on the presenter window (bool, Default is false).
.TP
.BI disable-tooltips
Disable tooltips for the toolbox (bool, Default is false).
.TP
.BI enable-auto-srt-load
Try loading video subtitle files automatically. For each video media, pdfpc will
append ".srt" to the media URI and attempt to load a subtitle file (in the SRT
format) from that location (bool, Default is false).
.TP
.B final-slide
Show the final slide of an overlay group instead of the next slide. If the
user reaches the last slide of the overlay group the next slide will be shown
again.
.TP
.B move-on-mapped
Dual-monitor full-screen window placement is a tricky business. Some window
managers (e.g., FVWM) ignore the placement if made before the window is
shown. This option enables a workaround (bool, Default is false).
.TP
.B next-height
Percentage of the height of the presenter screen to be used for the next slide (int, Default is 70).
.TP
.B next-slide-first-overlay
If the next slide is an overlay group, show the first slide of that group in the
next slide view instead of the last slide of that group (bool, Default is false).
.TP
.B overview-min-size
Minimum width for the overview miniatures, in pixels (int, Default is 150).
.TP
.B pointer-color
Set the pointer color. Can be a literal color name or a #rrggbb representation
(default is red).
.TP
.B pointer-opacity
Set the pointer opacity in percent (int, default is 50).
.TP
.B pointer-size
Set the initial pointer size, in pixels (int, default is 10).
.TP
.B prerender-delay
Delay (in seconds) to launch the pre-rendering process after a slide change
(int, default is 4).
.TP
.B prerender-slides
Number of slides ahead of the current one to pre-render (int, default is 2). Set
to 0 to disable the pre-rendering; set to a negative number to pre-render all at
once.
.TP
.B presentation-screen
Screen to be used for the presentation (output name, see e.g. "xrandr --listmonitors").
.TP
.B presenter-screen
Screen to be used for the presenter (output name).
.TP
.B rest-https
Run the REST server in the TLS mode (bool, Default is false).
.TP
.B rest-port
Port of the REST server (int, Default is 8088).
.TP
.B rest-passwd
Password to authenticate against the REST server (string, if not set, a randomly
generated one is used).
.TP
.B rest-static-root
Root path to serve static HTML content. If begins with "/", it is interpreted as
the absolute path; otherwise, relative to /usr/share/pdfpc
(string, Default is "www").
.TP
.B spotlight-opacity
Set opacity of the area outside of the spotlight, in percent (int, default is
50).
.TP
.B spotlight-size
Set the initial spotlight size, in pixels (int, default is 100).
.TP
.B switch-screens
Switch the presentation and the presenter screen (bool, Default is false).
.TP
.B time-of-day
Display the current time instead of the timer
.TP
.B timer-pace-color
Enable color hints of the timer, continuously indicating whether the
presentation is progressing according to the expected pace (bool, Default is true).
See the timer operation description in
.B \fBpdfpc\fR(1).
.TP
.B toolbox
Show the toolbox on startup (bool, Default is false).
.TP
.B toolbox-direction
Set the toolbox direction. LtoR, RtoL, TtoB, or BtoT for the left-to-right,
right-to-left, top-to-bottom, or botton-to-top, respectively (Default is LtoR).
.TP
.B toolbox-minimized
Set the initial toolbox state minimized (bool, Default is false).
.TP
.B transition-fps
Frames-per-second for slide transitions (int, Default is 25). Set to 0 to
disable all transitions.
.TP
.B windowed-mode
Set the initial windowed mode: none, presenter, presentation, or both (Default
is presenter).

.SH EXAMPLES

.PP
To change the drawing pen color using the numerical pad keys:

.RS
bind S+KP_1    setPenColor  red
.br
bind S+KP_2    setPenColor  green
.br
bind S+KP_3    setPenColor  blue
.RE

.PP
To always activate the black-on-end option, one could add the following to the
config file

.RS
option black-on-end true
.RE

.SH FILES
.PP
.B /etc/pdfpcrc
.RS 4
System-wide configuration file
.RE
.PP
.B $XDG_CONFIG_HOME/pdfpc/pdfpcrc
.RS 4
User configuration file (if $XDG_CONFIG_HOME is not set, $HOME/.config will be
used).


.SH SEE ALSO
.PP
\fBpdfpc\fR(1)