Skip to content

Commit f128951

Browse files
committed
Add --cache-size to the manpage
1 parent fcd573c commit f128951

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/dspdfviewer.1

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,21 @@ When jumping to slide m, also pre-render the slides (m+1)..(m+n) (default 10)
145145
Note: If you set this to zero, you will not get a thumbnail for the next page
146146
rendered before you have visited it.
147147

148+
.TP
149+
.B \-\-cache\-size \fIn\fR (in megabytes / MiB)
150+
This controls how much memory dspdfviewer is allowed to use for caching rendered pages.
151+
The default value is 1024, meaning 1 GiB of RAM.
152+
Note that the memory used for active rendering processes, as well as the currently
153+
displayed images are not included in the accounting, so the total memory usage
154+
of dspdfviewer will be higher than this.
155+
156+
CAVEAT: It is currently not verified that this memory is enough to hold all
157+
prerendered pages.
158+
If you make the cache too small to hold the prerendered pages,
159+
it will start dropping the first rendered (adjacent to the current page),
160+
resulting in very poor performance.
161+
If in doubt, set a larger cache or a lower prerender amount.
162+
148163
.TP
149164
.B \-a, \-\-presenter-area \fI<bool>\fR
150165
Show (true, 1) or hide (false, 0) the presenter's area on the second screen.

0 commit comments

Comments
 (0)