-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathINSTALL.txt
81 lines (57 loc) · 3.41 KB
/
INSTALL.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
===============================================================================
"tv" UTILITY INSTALLATION NOTES
===============================================================================
This file describes the installation of "tv" on your machine.
===============================================================================
1. Requirements
===============================================================================
* This application was written in Java. To run the application, a Java virtual
machine has to be installed. This can be provided via Oracle's Java Runtime
Environment (JRE). The minimum JRE version that this application supports is
1.7. See: http://java.com/en/download/index.jsp
* Apache Maven is used to build from source.
===============================================================================
2. Build
===============================================================================
To build the application, run the following command:
mvn install
This will create tv.jar file in the "target" directory
===============================================================================
3. Configuration
===============================================================================
There is a sample configuration file (sample.tv.conf) that should also be
copied if you wish to use the program with alternative defaults. You will have
to edit the configuration file before use. The program, by default, looks for
the configuration file in the following place:
Linux default: $HOME/.tv/tv.conf
Mac default: $HOME/.tv/tv.conf
Windows default: C:\ProgramData\$USER\tv\tv.conf
You can change the path to the config file via arguments given to the program.
For more information see the --config argument in README.txt
[ BASH Completion ]
If you are using BASH shell and the bash-completion package, it may be helpful
to use the /etc/bash_completion.d/tv file as a base for completion. By
default, the _gen_show() function loads show names from a flat file, one show
per line. If you want to use this method to get show names then just change
the path to the file. Alternatively, you may wish to populate the list of shows
dynamically via an array of directory names from some filesystems.
===============================================================================
4. Installation
===============================================================================
You can move the target/tv.jar file to any directory you wish to
store and run the program.
===============================================================================
5. Running the Program
===============================================================================
Assuming the java executable is in your $PATH variable, you run the program as
follows:
java -jar /path/to/tv.jar TVARGS
Where TVARGS are the arguments to be given to the program. For more
information about the arguments, program usage, and examples, see README.txt.
It is recommended to create an alias to the program to avoid having to type
repeated arguments. For example, when using BASH, add a line similar to one of
the following examples, to ~/.bash_aliases
alias tv='java -jar /path/to/tv.jar'
alias tv='java -jar /path/to/tv.jar --source /path/to/tv/folder/'
This allows you to run the program by its alias e.g.
tv Scrubs pilot