~dosage-dev/dosage/test-mode

« back to all changes in this revision

Viewing changes to doc/mainline.1

  • Committer: ns
  • Date: 2009-12-01 07:07:18 UTC
  • Revision ID: ns@ww1aviationlinks.cjb.net-20091201070718-3xoj70sz52zsq09v
Y plugin added YAFGC

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH MAINLINE 1
 
2
.SH NAME
 
3
mainline \- command line interface to Dosage
 
4
.SH SYNOPSIS
 
5
.B mainline
 
6
.RI [ options ]
 
7
.I module
 
8
.RI [ module .\|.\|.]
 
9
.SH DESCRIPTION
 
10
.B mainline
 
11
is a command line interface to Dosage. Dosage is a an application designed
 
12
to keep a local \(oqmirror\(cq of specific web comics and other picture\-based
 
13
content, such as \(oqPicture Of The Day\(cq sites, with a variety of options
 
14
for updating and maintaining collections.
 
15
.SH OPTIONS
 
16
.TP
 
17
.BI \-b " PATH" "\fR,\fP \-\^\-base\--path=" PATH
 
18
Specifies a base path to put comic subdirectories. The default is \(oqComics\(cq.
 
19
.TP
 
20
.BI \-\^\-base\-url= PATH
 
21
Specifies the base URL for output events. The default is a local file URI.
 
22
.TP
 
23
.BR \-c ", " \-\^\-catch-up
 
24
Traverses all available strips until an (identical) existing one is found.
 
25
This can be useful if your collection was previously up to date,
 
26
but you've missed a few days worth of strips. Alternatively you can specify
 
27
.B \-c
 
28
twice for a \(oqfull catchup\(cq, which will not stop until all comics
 
29
have been traversed. Catchups can \(oqresumed\(cq by using the index syntax, see
 
30
the
 
31
.B INDEX SYNTAX
 
32
and
 
33
.B SPECIAL SYNTAX
 
34
sections for more information.
 
35
.TP
 
36
.BR \-h ", " \-\^\-help
 
37
Output brief help information.
 
38
.TP
 
39
.BR \-l ", " \-\^\-list
 
40
List available comic modules in multi\-column fashion.
 
41
.TP
 
42
.BR \-\^\-single\-list
 
43
List available comic modules in single-column fashion.
 
44
.TP
 
45
.BI \-m " MODULE" "\fR,\fP \-\^\-module-help=" MODULE
 
46
Output module-specific help for
 
47
.IR MODULE .
 
48
.TP
 
49
.BI \-o " OUTPUT" "\fR,\fP \-\^\-output=" OUTPUT
 
50
.I OUTPUT
 
51
may be any one of the following:
 
52
.PP
 
53
.RS
 
54
.BR "text " \-
 
55
Provides no additional output and is the default value.
 
56
.RE
 
57
.PP
 
58
.RS
 
59
.BR "html " \-
 
60
Writes out an HTML file linking to the strips actually downloaded in the
 
61
current run, named by date (ala dailystrips). The files can be found in the
 
62
\'html' directory of your Comics directory.
 
63
.RE
 
64
.PP
 
65
.RS
 
66
.BR "rss " \-
 
67
Writes out an RSS feed detailing what strips were downloaded in the last 24
 
68
hours. The feed can be found in Comics/dailydose.xml.
 
69
.RE
 
70
.PP
 
71
.RS
 
72
.BR "rss " \-
 
73
Writes an RSS feed with all of the strips downloaded during the run, for use
 
74
with your favourite RSS aggregator.
 
75
.RE
 
76
.TP
 
77
.BR \-p ", " \-\^\-progress
 
78
Display a progress bar while downloading comics.
 
79
.TP
 
80
.BR \-q ", " \-\^\-quiet
 
81
Decrease the output level by one with each occurence.
 
82
.TP
 
83
.BR \-t ", " \-\^\-timestamps
 
84
Print timestamps for all output at any level.
 
85
.TP
 
86
.BR \-v ", " \-\^\-verbose
 
87
Increase the output level by one with each occurence.
 
88
.TP
 
89
.BR \-V ", " \-\^\-version
 
90
Display the version number.
 
91
.I module
 
92
At least one valid
 
93
.I module
 
94
must be specified. A list of valid modules can be found by passing the
 
95
.B \-l
 
96
option. Multiple
 
97
.I module
 
98
arguments can be specified on the command line.
 
99
.SH INDEX SYNTAX
 
100
One can indicate the start of a list of
 
101
.B comma seperated
 
102
indices using a
 
103
.RB \(oq : "\(cq."
 
104
.PP
 
105
If
 
106
.I \-c
 
107
is specified with index syntax then \(oqresume\(cq mode is activated,
 
108
where a \(oqcatchup\(cq will start at the given index.
 
109
.PP
 
110
Refer to
 
111
.B EXAMPLES
 
112
for samples.
 
113
.SH OFFENSIVE COMICS
 
114
Some users may find certain comics offensive and wish to disable them.
 
115
Modules listed in
 
116
.B /etc/dosage/disabled
 
117
and
 
118
.B ~/.dosage/disabled
 
119
will be disabled. These files should contain only one module name per line.
 
120
.SH SPECIAL SYNTAX
 
121
.TP
 
122
.B @
 
123
This expands to mean all the comics currently in your \(oqComics\(cq
 
124
directory.
 
125
.TP
 
126
.B @@
 
127
This expands to mean all the comics available to Dosage.
 
128
.PP
 
129
.B INDEX SYNTAX
 
130
can be used with
 
131
.B SPECIAL SYNTAX
 
132
but this is unlikely to be useful.
 
133
.SH EXAMPLES
 
134
Retrieve the latest Mega Tokyo comic:
 
135
.RS
 
136
.B mainline MegaTokyo
 
137
.RE
 
138
.PP
 
139
Retrieve every strip from every comic that there is a module for:
 
140
.RS
 
141
.B mainline \-c @@
 
142
.RE
 
143
.PP
 
144
Retrieve all Penny Arcade strips from (and including) a given index to
 
145
the beginning regardless of whether they already exist or not:
 
146
.RS
 
147
.B mainline \-c PennyArcade:2004\-07\-22
 
148
.RE
 
149
.SH ENVIRONMENT
 
150
.IP HTTP_PROXY
 
151
.B mainline
 
152
will use the specified HTTP proxy whenever possible.
 
153
.SH NOTES
 
154
Should retrieval fail on any given strip
 
155
.B mainline
 
156
will attempt to retry. However the retry information is only outputted
 
157
in the
 
158
.B second
 
159
and successive output levels.
 
160
.PP
 
161
At the time of writing, a
 
162
.B complete
 
163
Dosage collection weighs in at around 3.0GB.
 
164
.SH BUGS
 
165
See
 
166
.I http://trac.slipgate.za.net/dosage
 
167
for a list of current development tasks and suggestions.
 
168
.SH FILES
 
169
.IP "\fB/etc/dosage/disabled\fR"
 
170
Disables comic modules on a global scale.
 
171
.IP "\fB~/.dosage/disabled\fR"
 
172
Disables comic modules on a local scale.
 
173
.SH AUTHORS
 
174
.BR mainline " and " Dosage
 
175
were written by Jonathan Jacobs <korpse@slipgate.za.net> and Tristan Seligmann
 
176
<mithrandi@slipgate.za.net>. This manual page was written by Jonathan Jacobs.