Quick Start Guide of vrs

2002/5/18


----------------------------------------------
gtk user interface now does not work.
----------------------------------------------

1. Requirement

Linux video caputure environment
NVrec <http://www.ee.up.ac.za/~justin/v4l2/>
XviD <http://www.xvid.org/> (default codec)
ruby 1.6.6 or later <http://www.ruby-lang.org/>
ruby-gtk (in case using gtk user interface)


2. Installation

untar tarball

[first time only]
$ cd vrs-0.0.? (cd vrs_v1; if you get from cvs)
$ ./prepare.sh ... making directories and config files


3. directory structure

vrs_v1 -+- bin/
        |    +- controller.rb					reservation daemon(alwasy running)
        |    +- makeConf.rb						script to make config files
        |    +- recgtk.rb    					gtk user interface
        |    +- timer.rb							timer(controller.rb uses it)
        +- conf/
        |    +- channel_all.conf			channel frequency definition
        |    +- channel_iepg.conf			channle definition for iEPG
        |    +- quality.conf.in       recording quatity configuration
        +- docs/											documentation
        +- lib/												library
        |    +- repeat_mode_plugins/	repeat mode plugins
        |- logs/                      log
        +- samples/										sample files
        +- var/
        |    +- program_list					reservation list
       	+- video_files/								recorded file folder


4. configuration

conf/quality.conf.in is recording quality definition. First column is 
"recording quality name."
You can change any fields values except recoring quality name as you like.
You can specify xvid or divx in codec column.

Excecuting bin/makeConf.rb makes "recording_quality_name.conf" like 
conf/HiQ.conf from conf/quality.conf.in. It makes also conf/channel.conf
from conf/channel_table.conf.

conf/channel_table.conf is channel frequency definition file. In Japan,
you don't have to change it.

conf/channel.conf contains information of frequency etc in the form of 
DIVX4rec options. You can edit or add any DIVX4rec options.


[in case using gtk user interface]
conf/channel_iepg.conf is channel definition file for iEPG.
Adjust according to your local channel. TV station name must be "Zenkaku",
be careful.


5. making reservation

var/program_list is reservation list file.
one reservation in one line, text file.


Repeat Mode       := ONE|EVERYWEEK
start date        := YYYY/MM/DD
start time        := HH:MM[:SS]
end time          := HH:MM[:SS]
day of week       := Sun|Mon|Tue|Wed|Thu|Fri|Sat

channel           := 1-63
recording quality := VeryHiQHighQ|NormalQ|LowQ|VeryLowQ
file name         := file_name

* ONE 
ONE start_date start_time end_time channel recording_quality file_name
eg,
ONE 2002/04/13 11:00:00 11:45:00 9 LowQ mirai-eno-kyoshitsu.avi

* EVERYWEEK
EVERYWEEK wday start_time end_time channel file_name
eg,
EVERYWEEK Tue 01:25 01:55 12 NormalQ azumanga.avi


6. starting daemon

$ bin/controller.rb &


