atscap_conf.5

   1 .TH atscap_conf 5 "2007-Aug-21" "atscap_conf" "(C) 2004-2007 inkling@nop.org"
   2 .NAME
   3 .B atscap_conf
   4 \- Configuration file for atscap instances
   5
   6 .SH DESCRIPTION
   7 This document describes the format of the atscap
   8 configuration file.
   9 .SH LOCATION
  10 atscap.n.conf is usually located in the /etc/atscap/ directory.
  11 It may also be found other places depending on the
  12 .B "atscap -c"
  13 option.
  14
  15 .SH WARNING
  16 This file is modified during operation.  Expired volatile timers are
  17 not kept.  Comments are not kept.  Lines not starting with with the
  18 following letters are not kept:
  19 .IP
  20 .B "A F S I C T W V"
  21 or
  22 .B "Z"
  23
  24 .SH AUTOMATIC EVENT TIMER CONFIGURATION
  25 .TP
  26  AEventName[.n][:CH[:DAYS]]
  27 .IP
  28 Searches for EventName in EPG and adds a timer for it.  Auto events will not
  29 work on stations without an EPG.  For auto events to work properly, you also
  30 needs the AUTO field non-zero on the C configuration line.
  31 .IP
  32 EventName will match truncated event name and may have optional [.n], CH or
  33 DAYS bitmask to limit search to program n on channel CH and DAYS bits.
  34 .IP
  35 CH and DAYS are optional to limit searches beyond the event name. These are
  36 used when EventName search collides, i.e. 27:House.3 and 09:HouseFix.1. can
  37 be fixed with AHouse:27 to only look on channel 27 for match to House.
  38 If HouseFix moves to channel 27 then you'll wind up getting both. You can
  39 further limit the matching by setting the weekday bits for the day you want.
  40 .TP
  41 NOTE: Put A-lines before C-lines to search current EPG for events. If you
  42 get it out of order, atscap will save it in the correct order.
  43
  44 .SH Automatic Event Timer Configuration Example
  45 These only work if the station sends updated Program Guides. Matches will
  46 be added as volatile timers.
  47 .TP
  48 NOTE: Your channel numbers will obviously be different.
  49 .IP
  50 ACSI
  51 .IP
  52 Search Program Guides for CSI. If any matches found, add them to the timer list
  53 as volatile timers. This only works if Program Guide Time Out is non-zero for
  54 the channels which you wish to search.
  55 .IP
  56 ACSIMiami
  57 .IP
  58 If that's the only CSI you want, let search find it. This is an example of the
  59 event name truncation. It reduces the event name to two unique words, no space.
  60 .IP
  61 ACSI:31:0111110
  62 .IP
  63 Search CBS Program Guides for CSI, only for Mon-Friday. This prevents CBS 4:3
  64 self-syndications from showing up, but it is possible to miss weekend episodes.
  65 .IP
  66 A24:27
  67 .IP
  68 Search FOX Channel 27 Program Guide for 24. This prevents
  69 the syndication non-HD re-runs on NBC from showing up.
  70 If you want the non-HD re-runs, remove the :27
  71 .IP
  72 ANova.1:9
  73 .IP
  74 Search PBS Channel 9 Program guide for Nova. The Program
  75 filter .1 limits it to only HD broadcasts on Program 1.
  76
  77 .SH CHANNEL CONFIGURATION
  78 CCH:SIGN:NET:AUTO:PGM:PA[:RPGN:REPG]
  79 .TP
  80 Configure the channel with the following settings:
  81 .IP
  82 CH 2 digits; SIGN 1-5 chars, NET 1-3 chars
  83 .br
  84 AUTO nz is Program Guide Time Out every 3hrs, 0 stops auto EPG
  85 .br
  86 PGM Program select, 3 is usual, -1 for raw capture
  87 .br
  88 PA Program Audio select, -1 or 0 is first audio in Program
  89 .br
  90 RPGN [Optional] remote EPG program number to import as current program.
  91 .br
  92 REPG [Optional] remote EPG guide # to import as current program.
  93 .TP
  94
  95 The order of C lines in this file sets the order of the channel
  96 list and the channel hotkeys. Hotkey [1] is first channel loaded.
  97
  98 .TP
  99 The [optional] parameters can be used to get broadcast EPGs into an atscap
 100 session running on cable, which has no EPG that I can find yet. You will
 101 need to co-ordinate the EPG program [RPGN] and file numbers [REPG] with
 102 the atscap server that is receiving broadcast EPGs, since the channel order
 103 is most likely quite a bit different between broadcast and cable. You also
 104 will need to set the S configuration line for the remote atscap address:port
 105 and possibly poke a hole in the firewall(s) in case your EPG is not being
 106 served by a locally network connected atscap session running on broadcast.
 107
 108
 109 .SH Channel Configuration Examples
 110 .IP
 111 C27:KRIV:FOX:1:3:0
 112 .IP
 113 Sets Channel 27 callsign to KRIV and station ID to FOX with EPG refresh every
 114 3 hours and default capture on Program 3 with Audio 0 as default selection.
 115 .IP
 116 C31:KHOU:CBS:180:-1:-1
 117 .IP
 118 Sets Channel 31 callsign to KHOU and station ID to CBS with EPG refresh every
 119 3 hours and full capture as default for manual captures.
 120
 121 .SH Cable With Remote EPG Configuration Example
 122 .IP
 123 C27:KRIV:FOX:180:1:0:3:3
 124 .IP
 125 Sets Channel 27 callsign to KRIV and station ID to FOX with auto EPG and
 126 loads remote data from S-line defined server on program 3 and EPG 03.epg.
 127 The remote EPG is imported and changed to the channel and program number
 128 given earlier on this C-line.
 129
 130 .SH VOLATILE TIMER CONFIGURATION
 131 .TP
 132 VCH:YYYYMMDD:HH:MM:LM:NameX
 133 .IP
 134 Automatic Events or User EPG adds these to timer list. A-line, see above,
 135 is automatic event search to add these.  You shouldn't have to edit these,
 136 unless it's wrong or you want to add some future exact event start time.
 137
 138   YYYYMMDD is 4 digit year, 2 digit month(1-12), 2 digit day of month(1-31)
 139   HH is hours 0-23, MM is minutes 0-59,  LM is length in minutes
 140 .TP
 141 NOTE: These are sorted above W-lines in timer precedence.
 142
 143 .SH Volatile Timer Configuration Example (changed to LCN not PTC)
 144 .IP
 145 V31:20070204:17:00:300:SuperBowlXLI@.3
 146 .IP
 147 V27:20080203:17:00:300:SuperBowlXLII@.3
 148 .IP
 149 You can manually set timers years in advance.  If the EPG stops working on
 150 game day, no problem. 300 minutes will use close to 40MB of storage space.
 151
 152 .SH WEEKDAY TIMER CONFIGURATION (changed to LCN not PTC)
 153 .TP
 154 WCH:HH:MM:LM:DAYS:NameX
 155 .IP
 156 Weekday timers can be in any order. Save sorts by channel.
 157 This kind of timer can be used when the station has no EPG.
 158
 159  Weekday bits format: 1111111 in place of SMTWTFS
 160  X is optional flags for capture control:
 161  X can be can be any of the following:
 162    $ adds -Sun -Mon -Tue, etc., to Name, or
 163    @ adds -MmDd-HhMm unique to Name
 164  .p selects v ( 1 ... n) for Program number
 165     no .p will select full capture
 166  ,a selects a (0 ... 7) for Audio channel
 167     no ,a will auto-select main audio 0 for capture
 168     ,a requires .p: Audio number is within Program
 169
 170 .SH Weekday Timer Configuration Example
 171 .IP
 172 W35:20:00:060:0000010:LasVegas@.3
 173 .IP
 174 Capture LasVegas-mmdd-hhmm.ts on NBC Channel 35 Program 3.
 175 Without ,[1...n] given, it defaults to main audio 0.
 176 This timer runs every Friday at 8pm for 60 minutes.
 177 .IP
 178 W27:16:00:270:0000001:NASCAR$.3,1
 179 .IP
 180 This captures NASCAR-Sat.ts on FOX Channel 27 Program 3. With ,a given as ,1 it
 181 captures mono audio channel 1. Usually the secondary audio has no announcer.
 182 The capture time will be 4 hours and 30 minutes and use about 36GB of storage.
 183 .IP
 184 W31:22:35:062:0111110:LateShow.3
 185 .IP
 186 It's the Late Show with Dave Bucktooth. Without any # or $, it will overwrite
 187 itself to save disk space. The .3 will make it capture only Program 3, Audio 0.
 188 .IP
 189 W31:17:00:060:111111:News11
 190 .IP
 191 This one will capture 1 hour of full stream from Channel 31 at 5pm every day
 192 of the week. If your station bothers to send the Doppler radar on the other
 193 Virtual Channel, you can have both news and radar. It will use about 8.8GB
 194 per hour of capture.
 195
 196 .SH ATSC REMOTE EPG SERVER SELECT
 197 .TP
 198 Saddress:port
 199 .IP
 200 If you're using cable, this will be the IP address (or name) and port to
 201 use for retrieving the EPG data from the remote atscap session that is
 202 connected to broadcast. See optional parameters on C-line configuration.
 203
 204 .SH ATSC SYSTEM TIME SOURCE SELECT
 205 .TP
 206 ZPTC[:Offset]
 207 .IP
 208 ATSC stream time select. Station STT generators are notoriously unreliable.
 209 It is recommended this you leave this at Z0 or it will drift unacceptably.
 210 You can try it if you want to get a good laugh at the lack of timekeeping.
 211 .TP
 212 NOTE: Local system time change requires running as root.
 213
 214  Z sets local time from Channel's ATSC stream time
 215  Z0 will disable setting local time from ATSC stream time
 216  Offset is optional number of seconds of correction
 217
 218 .SH System Time Configuration Example
 219 .IP
 220 Z27:3
 221 .IP
 222 Sets local time from Channel 27 ATSC STT minus 3 seconds. It can only update
 223 local time during a capture, so you need to set C config line for this channel
 224 to have AUTO non-zero, if you want it to update your system time automatically.
 225 .TP
 226 NOTE: It will conflict with ntpd.  NTP works better and is recommended.
 227
 228 .SH SEE ALSO
 229 .PP
 230 atscap(1)
 231
 232 .SH AUTHOR
 233 .TP
 234 The author of this manual page is <inkling@nop.org>.
 235 .SH COPYRIGHT
 236 .PP
 237 This manual page is part of the atscap-1.1 distribution software.
 238 .PP
 239 This software is Copyright (C) 2004, 2005, 2006, 2007
 240 .IP
 241 by
 242 .B <inkling@nop.org>
 243 .SH LICENSE
 244 .PP
 245 Permission is granted to copy, distribute and/or modify this document
 246 under the terms of the GNU General Public License, Version 2.
 247 .PP
 248 A copy of the license with the file name COPYING or LICENSE should have been
 249 included in this distribution. If it was not included, please contact me,
 250 .B <inkling@nop.org>,
 251 or write to:
 252 .IP
 253  The Free Software Foundation, Inc.
 254  51 Franklin Street, Fifth Floor
 255  Boston, MA 02110-1301, USA