stv0g/tvheadend
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs: update timeshift documentation.

Browse source
This commit is contained in:
Adam Sutton 2013-01-13 22:11:13 +00:00
parent cb7a879d6a
commit d08c0b665a
1 changed files with 24 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs/html/config_timeshift.html
View file

@ -10,28 +10,42 @@
<dd>Turn on and off timeshift.
<dt>On-Demand
<dd>Turn this on to only begin timeshift recording when pause is pressed.
Leave unchecked for always timeshifting. (Rewinding even if you haven't pressed
pause.)
<dd>Turn this on to start timeshift buffer on pause. In this mode
you cannot rewind the buffer (it always begins on the currently playing
frame).
Without this option there will be a permanent, cicular, buffer upto
the limits defined below.
<dt>Storage Path:
<dd>Where should the timeshift data be stored.
<dd>Where the timeshift data will be stored. If nothing is specified this
will default to CONF_DIR/timeshift/buffer
<dt>Max. Period (mins):
<dd>Specify the number of minutes to put into the timeshift.
<dd>Specify the maximum time period that will be buffered for any given
(client) subscription.
<dt>Unlimited:
<dd>If checked, this overrides Max Period (mins) and will continue to timeshift until your
hard drive or other storage medium fills up.
<dd>If checked, this allows the timeshift buffer to grow unbounded until
your storage media runs out of space (WARNING: this could be dangerous!).
<!--
<dt>Max. Size (MB)
<dd>Specifies in Megabytes how big the timeshift file should get.
<dd>Specifies the maximum combined size of all timeshift buffers. If you
specify an unlimited period its highly recommended you specifying a value
here.
<dt>Unlimited:
<dd>If checked, this overrides Max Size (MB) and will continue to timeshift until your
hard drive or other storage medium fills up
<dd>If checked, this allows the combined size of all timeshift buffers to
potentially grow unbounded until your storage media runs out of space
(WARNING: this could be dangerous!).
-->
</dl>
Changes to any of these settings must be confirmed by pressing the
'Save configuration' button before taking effect.
NOTE: These settings represent server side maximums, however the clients can
request smaller buffers or even not to create a buffer at all (for example
should they not support timeshifting).
</div>