dosage/doc/dosage.1

180 lines
5.1 KiB
Groff
Raw Normal View History

2012-10-11 12:17:10 +00:00
.TH DOSAGE 1
2012-06-20 19:58:13 +00:00
.SH NAME
2013-03-25 18:46:48 +00:00
dosage \- a comic strip downloader and archiver
2012-06-20 19:58:13 +00:00
.SH SYNOPSIS
\fBdosage\fP [\fIoptions\fP] \fImodule\fP...
2012-06-20 19:58:13 +00:00
.SH DESCRIPTION
2012-10-11 12:17:10 +00:00
.B dosage
is an application designed to keep a local mirror of specific
2012-10-11 12:17:10 +00:00
web comics and other picture\-based content, such as
\fIPicture Of The Day\fP sites, with a variety of options
2012-06-20 19:58:13 +00:00
for updating and maintaining collections.
.SH OPTIONS
.TP
\fB\-b\fP \fIPATH\fP, \fB\-\-basepath=\fP\fIPATH\fP
Specifies a base path to put comic subdirectories. The default is \fBComics\fP.
2012-06-20 19:58:13 +00:00
.TP
\fB\-\-baseurl=\fP\fIPATH\fP
Specifies the base URL for output handlers. The default is a local file URI.
2012-06-20 19:58:13 +00:00
.TP
\fB\-a\fP, \fB\-\-all\fP
2012-10-11 12:17:10 +00:00
Traverses all available strips backwards from the current one.
This can be useful you want a full collection of a new comic strip,
or update an existing one where files are missing.
.
Catchups can start at a specific strip by using the index syntax, see
2012-06-20 19:58:13 +00:00
the
.B INDEX SYNTAX
and
.B SPECIAL SYNTAX
2012-10-11 12:17:10 +00:00
sections for more information. This is useful when you missed some days
2013-02-07 19:48:21 +00:00
and want only to download the missing files.
.TP
2013-02-04 19:22:54 +00:00
\fB\-c\fP, \fB\-\-continue\fP
Same as \fB\-\-all\fP, but stop at the first existing image file.
Useful for cron jobs that are not executed every day.
2012-06-20 19:58:13 +00:00
.TP
\fB\-h\fP, \fB\-\-help\fP
2012-06-20 19:58:13 +00:00
Output brief help information.
.TP
\fB\-l\fP, \fB\-\-list\fP
2012-06-20 19:58:13 +00:00
List available comic modules in multi\-column fashion.
.TP
\fB\-\-singlelist\fP
2013-01-23 18:54:26 +00:00
List available comic modules in single\-column fashion.
2012-06-20 19:58:13 +00:00
.TP
\fB\-m\fP \fIMODULE\fP, \fB\-\-modulehelp=\fP\fIMODULE\fP
Output module-specific help for \fIMODULE\fP.
2012-06-20 19:58:13 +00:00
.TP
\fB\-o\fP \fIOUTPUT\fP, \fB\-\-output=\fP\fIOUTPUT\fP
\fIOUTPUT\fP may be any one of the following:
2012-06-20 19:58:13 +00:00
.PP
.RS
.BR "html " \-
Writes out an HTML file linking to the strips actually downloaded in the
current run, named by date (ala dailystrips). The files can be found in the
\fBhtml\fP directory of your \fBComics\fP directory.
2012-06-20 19:58:13 +00:00
.RE
.PP
.RS
.BR "rss " \-
Writes out an RSS feed detailing what strips were downloaded in the last 24
hours. The feed can be found in \fBComics/dailydose.xml\fP.
2012-06-20 19:58:13 +00:00
.RE
2013-03-25 18:46:48 +00:00
.PP
.RS
.BR "json " \-
Write a JSON file with all download infos (URLs, images). Can be used with
other scripts, eg. order-symlinks.py to add symbolic links.
.RE
This option can be given multiple times.
2012-06-20 19:58:13 +00:00
.TP
\fB\-t\fP, \fB\-\-timestamps\fP
2012-06-20 19:58:13 +00:00
Print timestamps for all output at any level.
.TP
\fB\-v\fP, \fB\-\-verbose\fP
2012-06-20 19:58:13 +00:00
Increase the output level by one with each occurence.
.TP
\fB\-V\fP, \fB\-\-version\fP
2012-06-20 19:58:13 +00:00
Display the version number.
.I module
At least one valid
.I module
must be specified. A list of valid modules can be found by passing the
.B \-l
option. Multiple
.I module
arguments can be specified on the command line.
2012-10-11 12:17:10 +00:00
Module names are case insensitive, and it is sufficient to specify a
unique substring of the module name.
2012-06-20 19:58:13 +00:00
.SH INDEX SYNTAX
Instead of starting at the latest comic strip, an index lets dosage start
at a certain strip. The index can be specified by appending a colon \fB:\fP
and the index name after the module. Multiple comma-spearated indices can
also be specified.
2012-06-20 19:58:13 +00:00
.PP
The index name itself usually is the part of the comic strip URL that identifiess
a strip, eg. a number or a date. The expected format is documented when using
the \fB\-\-modulehelp\fP option.
2012-06-20 19:58:13 +00:00
.SH SPECIAL SYNTAX
.TP
.B @
This expands to mean all the comics currently in your \fBComics\fP
2012-10-11 12:17:10 +00:00
directory. All other specified comic module names will be ignored.
2012-06-20 19:58:13 +00:00
.TP
.B @@
This expands to mean all the comics available to Dosage.
.PP
\fBINDEX SYNTAX\fP can not be used with \fBSPECIAL SYNTAX\fP.
2012-06-20 19:58:13 +00:00
.SH EXAMPLES
2012-10-11 12:17:10 +00:00
Retrieve all Mega Tokyo comics:
2012-06-20 19:58:13 +00:00
.RS
2012-10-11 12:17:10 +00:00
.B dosage \-a megatokyo
2012-06-20 19:58:13 +00:00
.RE
.PP
2012-10-11 12:17:10 +00:00
Retrieve the current comic of Cyanide and Happiness:
2012-06-20 19:58:13 +00:00
.RS
2012-10-11 12:17:10 +00:00
.B dosage cyanideandhappiness
2012-06-20 19:58:13 +00:00
.RE
.PP
Retrieve the current strip of all comics in your \fBComics\fP directory:
2012-06-20 19:58:13 +00:00
.RS
2012-10-11 12:17:10 +00:00
.B dosage @
.RE
.PP
Retrieve the current strip of every comic that there is a module for:
.RS
.B dosage @@
.RE
.PP
Retrieve the Penny Arcade strip for a given index:
.RS
.B dosage pennyarcade:2004\-07\-22
.RE
.PP
2012-10-11 12:17:10 +00:00
Retrieve Calvin and Hobbes strips from a given index going backwards to
the beginning.
2012-10-11 12:17:10 +00:00
.RS
.B dosage \-a calvinandhobbes:2012/07/22
2012-06-20 19:58:13 +00:00
.RE
.PP
On Unix, \fBxargs(1)\fP can download several comic strips in parallel,
for example using up to 4 processes:
.RS
.B cd Comics && find . -type d | xargs -n1 -P4 dosage -b . -v
.RE
2012-06-20 19:58:13 +00:00
.SH ENVIRONMENT
.IP HTTP_PROXY
2013-03-26 16:35:26 +00:00
.B dosage
will use the specified HTTP proxy when downloading URL contents.
2012-06-20 19:58:13 +00:00
.SH NOTES
Should retrieval fail on any given strip
2013-03-26 16:35:26 +00:00
.B dosage
2012-06-20 19:58:13 +00:00
will attempt to retry. However the retry information is only outputted
in the
.B second
and successive output levels.
.PP
At the time of writing, a
.B complete
Dosage collection weighs in at around 3.0GB.
.SH RETURN VALUE
2012-10-11 12:17:10 +00:00
The return value greater than zero when
2012-06-20 19:58:13 +00:00
.IP \(bu
a program error occurred.
.IP \(bu
comics could not be found or downloaded
.IP \(bu
2013-01-23 18:54:26 +00:00
the program run was aborted with Ctrl\-C
2012-06-20 19:58:13 +00:00
.PP
Else the return value is zero.
.SH BUGS
Users can report or view bugs, patches or feature suggestions at
.I https://github.com/wummel/dosage/issues
2012-06-20 19:58:13 +00:00
.SH AUTHORS
2013-03-26 16:35:26 +00:00
Jonathan Jacobs, Tristan Seligmann, Bastian Kleineidam <bastian.kleineidam@web.de>
2012-10-11 12:17:10 +00:00
.SH COPYRIGHT
Copyright \(co 2004-2005 Tristan Seligmann and Jonathan Jacobs
.br
2013-01-09 21:21:19 +00:00
Copyright \(co 2012-2013 Bastian Kleineidam