epggrab: Update doc
This commit is contained in:
parent
fd8aee4a7f
commit
98350cac5d
1 changed files with 62 additions and 5 deletions
|
@ -48,6 +48,51 @@
|
||||||
<a href='http://github.com/adamsutton/PyEPG'>http://github.com/adamsutton/PyEPG</a>.</li>
|
<a href='http://github.com/adamsutton/PyEPG'>http://github.com/adamsutton/PyEPG</a>.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<h2>Cron multi-line config text areas</h2>
|
||||||
|
<ul>
|
||||||
|
|
||||||
|
<li><p>The cron lines looks like:</p>
|
||||||
|
<pre>
|
||||||
|
# * * * * * command to execute
|
||||||
|
# ┬ ┬ ┬ ┬ ┬
|
||||||
|
# │ │ │ │ │
|
||||||
|
# │ │ │ │ │
|
||||||
|
# │ │ │ │ └───── day of week (0 - 6) (0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the same as 0)
|
||||||
|
# │ │ │ └────────── month (1 - 12)
|
||||||
|
# │ │ └─────────────── day of month (1 - 31)
|
||||||
|
# │ └──────────────────── hour (0 - 23)
|
||||||
|
# └───────────────────────── min (0 - 59)</pre>
|
||||||
|
|
||||||
|
<li><b>Cron special characters</b>
|
||||||
|
<dl>
|
||||||
|
<dt>Asterisk ( * )
|
||||||
|
<dd>The asterisk indicates that the cron expression matches for all values
|
||||||
|
of the field. E.g., using an asterisk in the 4th field (month)
|
||||||
|
indicates every month.
|
||||||
|
|
||||||
|
<dt>Slash ( / )
|
||||||
|
<dd>Slashes describe increments of ranges. For example 3-59/15 in the
|
||||||
|
1st field (minutes) indicate the third minute of the hour and every
|
||||||
|
15 minutes thereafter. The form "*/..." is equivalent to the form
|
||||||
|
"first-last/...", that is, an increment over the largest possible
|
||||||
|
range of the field.
|
||||||
|
|
||||||
|
<dt>Comma ( , )
|
||||||
|
<dd>Commas are used to separate items of a list. For example, using
|
||||||
|
"MON,WED,FRI" in the 5th field (day of week) means Mondays,
|
||||||
|
Wednesdays and Fridays.
|
||||||
|
|
||||||
|
<dt>Hyphen ( - )
|
||||||
|
<dd>Hyphens define ranges. For example, 2000-2010 indicates every year
|
||||||
|
between 2000 and 2010 AD, inclusive.
|
||||||
|
|
||||||
|
<dt>Number-sign ( # )
|
||||||
|
<dd>Number-sign defines a start of a comment. The rest of line is
|
||||||
|
ignored behind this character.
|
||||||
|
</dl>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
<h2>Configuration options</h2>
|
<h2>Configuration options</h2>
|
||||||
|
|
||||||
<h3>General Config</h3>
|
<h3>General Config</h3>
|
||||||
|
@ -74,14 +119,26 @@
|
||||||
<dt>Module:
|
<dt>Module:
|
||||||
<dd>Select which internal grabber to use.
|
<dd>Select which internal grabber to use.
|
||||||
|
|
||||||
<dt>Grab interval
|
<dt>Cron multi-line
|
||||||
<dd>Time period between grabs. Value and unit are independently set.
|
<dd>Multiple lines of the cron time specification.
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
<h3>Over-the-air Grabbers</h3>
|
<h3>Over-the-air Grabbers</h3>
|
||||||
<p>
|
<dl>
|
||||||
Checkbox list to enable/disable available modules.
|
<dt>Force initial EPG scan at startup
|
||||||
By default all grabbers should be enabled.
|
<dd>... no comment
|
||||||
|
|
||||||
|
<dt>Cron multi-line
|
||||||
|
<dd>Multiple lines of the cron time specification.
|
||||||
|
|
||||||
|
<dt>EPG scan timeout in seconds
|
||||||
|
<dd>The multiplex (mux) is tuned for this amount of time at maximum. If EPG data
|
||||||
|
are completed before this limit, the mux is released sooner.
|
||||||
|
|
||||||
|
<dt>Checkbox list
|
||||||
|
<dd>Checkbox list to enable/disable available modules.
|
||||||
|
By default all grabbers should be enabled.
|
||||||
|
</dl>
|
||||||
|
|
||||||
<h3>External interfaces</h3>
|
<h3>External interfaces</h3>
|
||||||
<p>
|
<p>
|
||||||
|
|
Loading…
Add table
Reference in a new issue