1PDFPCRC(5) File Formats Manual PDFPCRC(5)
2
6 pdfpcrc - pdfpc configuration file
7
10 pdfpc(1) first reads its system-wide configuration file, followed by
11 the user-specific one if it exists.
12 Keybindings
15 The following commands are accepted:
16 bind <key> <action> [<arg>]
18 Bind a key to an action, passing a specified argument for ac‐
19 tions that require one
20 unbind <key>
22 Unbind the given key
23 unbind_all
25 Clear all the key bindings
26 mouse <button> <action>
28 Bind a mouse button to an action
29 unmouse <button>
31 Unbind a mouse button
32 unmouse_all
34 Clear all the mouse bindings
35 Key names can be obtained with the help of the xev(1) utility. Note
38 that names are case sensitive. Key combinations with modifiers can be
39 specified in the form <mod>+<key>, where <mod> is one of S (for shift),
40 C (for control) and A/M (for Alt/Meta).
41 A shorthand for specifying key combinations constituting shift and an
44 alphabetic character is to simply give the uppercase version of the al‐
45 phabetic character. For example, S+r and R are equivalent.
46 A list of all possible actions can be obtained via the -L command line
49 option of pdfpc(1). Use the -B command line option to list the action
50 bindings defined.
51 Options
54 Some permanent changes can be configured via the config file. The syn‐
55 tax is:
56 option <option_name> <option_value>
58 The following option_name's are recognized:
61 black-on-end
64 Add an additional black slide at the end of the presentation
65 (bool, Default is false).
66 cache-clean-period
68 Period (in units of s) to check for expired cached content (int,
69 Default is 60).
70 cache-expiration
72 Time (in units of s) to keep (pre)rendered slides in the cache
73 (int, Default is 600). Set to a negative value to keep cached
74 slides permanently.
75 cache-max-rtime
77 Maximal time (in units of ms) it takes to render a slide for its
78 cache to be protected from expiration (int, Default is 1000).
79 cache-min-rtime
81 Minimal time (in units of ms) it takes to render a slide for it
82 to be cached (int, Default is 10).
83 cache-max-usize
85 Maximal size (in units of kB) of a slide image to store it un‐
86 compressed in the cache (int, Default is 256).
87 current-height
89 Percentage of the height of the presenter screen to be used for
90 the current slide (int, Default is 80).
91 current-size
93 Percentage of the presenter screen to be used for the current
94 slide (int, Default is 60).
95 disable-input-autodetection
97 Do not automatically detect type (pen or eraser) of tablet input
98 devices (bool, Default is false).
99 disable-input-pressure
101 Ignore pressure sensitivity of tablet input devices (pen or
102 eraser) even when it is supported by the hardware (bool, Default
103 is false).
104 disable-scrolling
106 Disable scrolling events on the presenter window (bool, Default
107 is false).
108 disable-tooltips
110 Disable tooltips for the toolbox (bool, Default is false).
111 enable-auto-srt-load
113 Try loading video subtitle files automatically. For each video
114 media, pdfpc will append ".srt" to the media URI and attempt to
115 load a subtitle file (in the SRT format) from that location
116 (bool, Default is false).
117 final-slide
119 Show the final slide of an overlay group instead of the next
120 slide. If the user reaches the last slide of the overlay group
121 the next slide will be shown again.
122 move-on-mapped
124 Dual-monitor full-screen window placement is a tricky business.
125 Some window managers (e.g., FVWM) ignore the placement if made
126 before the window is shown. This option enables a workaround
127 (bool, Default is false).
128 next-height
130 Percentage of the height of the presenter screen to be used for
131 the next slide (int, Default is 70).
132 next-slide-first-overlay
134 If the next slide is an overlay group, show the first slide of
135 that group in the next slide view instead of the last slide of
136 that group (bool, Default is false).
137 overview-min-size
139 Minimum width for the overview miniatures, in pixels (int, De‐
140 fault is 150).
141 pointer-color
143 Set the pointer color. Can be a literal color name or a #rrggbb
144 representation (default is red).
145 pointer-opacity
147 Set the pointer opacity in percent (int, default is 50).
148 pointer-size
150 Set the initial pointer size, in pixels (int, default is 10).
151 prerender-delay
153 Delay (in seconds) to launch the pre-rendering process after a
154 slide change (int, default is 4).
155 prerender-slides
157 Number of slides ahead of the current one to pre-render (int,
158 default is 2). Set to 0 to disable the pre-rendering; set to a
159 negative number to pre-render all at once.
160 presentation-screen
162 Screen to be used for the presentation (output name, see e.g.
163 "xrandr --listmonitors").
164 presenter-screen
166 Screen to be used for the presenter (output name).
167 rest-https
169 Run the REST server in the TLS mode (bool, Default is false).
170 rest-port
172 Port of the REST server (int, Default is 8088).
173 rest-passwd
175 Password to authenticate against the REST server (string, if not
176 set, a randomly generated one is used).
177 rest-static-root
179 Root path to serve static HTML content. If begins with "/", it
180 is interpreted as the absolute path; otherwise, relative to
181 /usr/share/pdfpc (string, Default is "www").
182 spotlight-opacity
184 Set opacity of the area outside of the spotlight, in percent
185 (int, default is 50).
186 spotlight-size
188 Set the initial spotlight size, in pixels (int, default is 100).
189 switch-screens
191 Switch the presentation and the presenter screen (bool, Default
192 is false).
193 time-of-day
195 Display the current time instead of the timer
196 timer-pace-color
198 Enable color hints of the timer, continuously indicating whether
199 the presentation is progressing according to the expected pace
200 (bool, Default is true). See the timer operation description in
201 pdfpc(1).
202 toolbox
204 Show the toolbox on startup (bool, Default is false).
205 toolbox-direction
207 Set the toolbox direction. LtoR, RtoL, TtoB, or BtoT for the
208 left-to-right, right-to-left, top-to-bottom, or botton-to-top,
209 respectively (Default is LtoR).
210 toolbox-minimized
212 Set the initial toolbox state minimized (bool, Default is
213 false).
214 transition-fps
216 Frames-per-second for slide transitions (int, Default is 25).
217 Set to 0 to disable all transitions.
218 windowed-mode
220 Set the initial windowed mode: none, presenter, presentation, or
221 both (Default is presenter).
222
225 To change the drawing pen color using the numerical pad keys:
226 bind S+KP_1 setPenColor red
228 bind S+KP_2 setPenColor green
229 bind S+KP_3 setPenColor blue
230 To always activate the black-on-end option, one could add the following
233 to the config file
234 option black-on-end true
236
239 /etc/pdfpcrc
240 System-wide configuration file
241 $XDG_CONFIG_HOME/pdfpc/pdfpcrc
243 User configuration file (if $XDG_CONFIG_HOME is not set,
244 $HOME/.config will be used).
245
249 pdfpc(1)
250 PDFPCRC(5)