summaryrefslogtreecommitdiff
path: root/getht.1
blob: 06b850c0d1da271f41da51eed51a30d169f04930 (plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
.\" See COPYING file for copyright, license and warranty details
.TH GETHT 1
.SH NAME 
.B GetHT
\- The Free Hinduism Today Digital Edition Downloader
.SH SYNOPSIS
.TP 5
\fBgetht
\fI[-ualmofVvh] [-d issno] [-n medno] [-t tocfile] [-m medtocfile]\fR

.SH DESCRIPTION
.PP
.I GetHT
is a program which downloads pdf files from Hinduism
Today. It has good proxy support, and is small, fast,
and simple.

.I GetHT
is not endorsed by or affiliated with Hinduism Today. 

.SH OPTIONS
.TP
.B \-u, \-\-update
Update the Hinduism Today contents files.
.TP
.B \-a, \-\-download-all
Download all issues of Hinduism Today. 
.TP
.B \-d, \-\-download-issue issno
Download the issue numbered issno (use \fI-l\fR to find
issue numbers).
.TP
.B \-f, \-\-force
Force getht to download files, even if they have
already been downloaded. This is useful if a download
has been corrupted or interrupted.
.TP
.B \-l, \-\-list-issues
List the issues of Hinduism Today, with issue numbers,
sorted by date.
.TP
.B \-t, \-\-tocfile tocfile
Use a different contents file, as specified by tocfile.
.TP
.B \-h, \-\-help
Print a brief usage message.
.TP
.B \-v, \-\-verbose
Make the output from \fI-l\fR and \fI-m\fR more verbose.
May be used twice to make output yet more verbose.
.TP
.B \-V, \-\-version
Display the version number.

.SH CONFIGURATION FILE
All of the settings for GetHT are stored in the 
configuration file, which normally resides in
\fB~/.getht/config.ini\fR.

The format of this file is very simple:
\fB<option> = <setting>\fR
with commented lines starting with a # 

The following options may be set.
.TP
.B savepath
Stores the path in which all issues will be saved
The default setting is \fB~/hinduism_today/\fR
.TP
.B startup_check
Whether to automatically check for new issues each 
time the GetHT is executed. \fB1\fR = yes, \fB0\fR = no
The default setting is \fB0\fR
.TP
.B toc_uri
A uri to the xml file containing the table of contents 
for the publication.
Default: \fBhttp://www.hinduismtoday.com/digital/htde_toc.xml\fR
.TP
.B proxy_type
The type of proxy (if any) through which GetHT is to
pass. GetHT currently supports the following options:
\fBhttp\fR, \fBsocks4\fR, and \fBsocks5\fR.
To not use any proxy, simply leave out this line.
.TP
.B proxy_address
The uri of the proxy to connect through.
.TP
.B proxy_port
The port of the proxy to connect to.
.TP
.B proxy_auth
The method of authentication (if any) with the proxy.
GetHT currently supports the following options:
\fBbadic\fR, \fBdigest\fR, and \fBntlm\fR.
If you don't need proxy authentication, leave out this
line.
.TP
.B proxy_user
The username with which to connect to the proxy server.
.TP
.B proxy_pass
The password with which to connect to to proxy server.

.SH FILES
.TP
.B ~/getht/config.ini
configuration file.

.SH BUGS
.I GetHT
is very new, so there will undoubtedly be some bugs
around, or parts of the program which don't work as
expected.

If you encounter problems, there are several ways to
get help:
.TP
.B Mailing List
.I http://lists.nongnu.org/mailman/listinfo/getht-general
.TP
.B Bug Tracker
.I http://savannah.nongnu.org/bugs/?func=additem&group=getht

.SH LICENSE
Copyright 2008 Nick White

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

.SH AUTHOR
GetHT is at present primarily the work of Nick White, see the AUTHORS
file for full credits and contact details.