dmoonfire/dosage
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Activity

Updated manpage.

Browse source
This commit is contained in:
Bastian Kleineidam 2013-02-07 20:48:21 +01:00
parent 419ae5fbcf
commit 8117c5b132
3 changed files with 35 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/dosage.1
View file

@ -28,9 +28,8 @@ the
and and
.B SPECIAL SYNTAX .B SPECIAL SYNTAX
sections for more information. This is useful when you missed some days sections for more information. This is useful when you missed some days
and want only to download the missing files. To make this task easy, and want only to download the missing files.
the traversal ends at the first existing image file when starting from .TP
an index (excluding the index itself).
\fB\-c\fP, \fB\-\-continue\fP \fB\-c\fP, \fB\-\-continue\fP
Same as \fB\-\-all\fP, but stop at the first existing image file. Same as \fB\-\-all\fP, but stop at the first existing image file.
Useful for cron jobs that are not executed every day. Useful for cron jobs that are not executed every day.
@ -62,12 +61,6 @@ current run, named by date (ala dailystrips). The files can be found in the
Writes out an RSS feed detailing what strips were downloaded in the last 24 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. hours. The feed can be found in \fBComics/dailydose.xml\fP.
.RE .RE
.PP
.RS
.BR "rss " \-
Writes an RSS feed with all of the strips downloaded during the run, for use
with your favourite RSS aggregator.
.RE
.TP .TP
\fB\-t\fP, \fB\-\-timestamps\fP \fB\-t\fP, \fB\-\-timestamps\fP
Print timestamps for all output at any level. Print timestamps for all output at any level.

15
doc/dosage.1.html
View file

@ -43,10 +43,8 @@ and
<B>SPECIAL SYNTAX</B> <B>SPECIAL SYNTAX</B>
sections for more information. This is useful when you missed some days sections for more information. This is useful when you missed some days
and want only to download the missing files. To make this task easy, and want only to download the missing files.
the traversal ends at the first existing image file when starting from <DT><B>-c</B>, <B>--continue</B><DD>
an index (excluding the index itself).
<B>-c</B>, <B>--continue</B>
Same as <B>--all</B>, but stop at the first existing image file. Same as <B>--all</B>, but stop at the first existing image file.
Useful for cron jobs that are not executed every day. Useful for cron jobs that are not executed every day.
<DT><B>-h</B>, <B>--help</B><DD> <DT><B>-h</B>, <B>--help</B><DD>
@ -79,15 +77,6 @@ Writes out an RSS feed detailing what strips were downloaded in the last 24
hours. The feed can be found in <B>Comics/dailydose.xml</B>. hours. The feed can be found in <B>Comics/dailydose.xml</B>.
</DL> </DL>
<P>
<DL COMPACT><DT><DD>
<B>rss </B>-
Writes an RSS feed with all of the strips downloaded during the run, for use
with your favourite RSS aggregator.
</DL>
<DL COMPACT> <DL COMPACT>
<DT><B>-t</B>, <B>--timestamps</B><DD> <DT><B>-t</B>, <B>--timestamps</B><DD>
Print timestamps for all output at any level. Print timestamps for all output at any level.

66
doc/dosage.txt
View file

@ -31,12 +31,12 @@ OPTIONS
strip by using the index syntax, see the INDEX SYNTAX strip by using the index syntax, see the INDEX SYNTAX
and SPECIAL SYNTAX sections for more information. This and SPECIAL SYNTAX sections for more information. This
is useful when you missed some days and want only to is useful when you missed some days and want only to
download the missing files. To make this task easy, the download the missing files.
traversal ends at the first existing image file when
starting from an index (excluding the index itself). -c, --continue
-c, --continue Same as --all, but stop at the first Same as --all, but stop at the first existing image
existing image file. Useful for cron jobs that are not file. Useful for cron jobs that are not executed every
executed every day. day.
-h, --help -h, --help
Output brief help information. Output brief help information.
@ -53,19 +53,15 @@ OPTIONS
-o OUTPUT, --output=OUTPUT -o OUTPUT, --output=OUTPUT
OUTPUT may be any one of the following: OUTPUT may be any one of the following:
html - Writes out an HTML file linking to the strips html - Writes out an HTML file linking to the strips
actually downloaded in the current run, named by date actually downloaded in the current run, named by date
(ala dailystrips). The files can be found in the html (ala dailystrips). The files can be found in the html
directory of your Comics directory. directory of your Comics directory.
rss - Writes out an RSS feed detailing what strips were rss - Writes out an RSS feed detailing what strips were
downloaded in the last 24 hours. The feed can be found downloaded in the last 24 hours. The feed can be found
in Comics/dailydose.xml. in Comics/dailydose.xml.
rss - Writes an RSS feed with all of the strips down‐
loaded during the run, for use with your favourite RSS
aggregator.
-t, --timestamps -t, --timestamps
Print timestamps for all output at any level. Print timestamps for all output at any level.
@ -73,26 +69,26 @@ OPTIONS
Increase the output level by one with each occurence. Increase the output level by one with each occurence.
-V, --version -V, --version
Display the version number. module At least one valid Display the version number. module At least one valid
module must be specified. A list of valid modules can be module must be specified. A list of valid modules can be
found by passing the -l option. Multiple module argu‐ found by passing the -l option. Multiple module argu‐
ments can be specified on the command line. Module ments can be specified on the command line. Module
names are case insensitive, and it is sufficient to names are case insensitive, and it is sufficient to
specify a unique substring of the module name. specify a unique substring of the module name.
INDEX SYNTAX INDEX SYNTAX
Instead of starting at the latest comic strip, an index lets Instead of starting at the latest comic strip, an index lets
dosage start at a certain strip. The index can be specified by dosage start at a certain strip. The index can be specified by
appending a colon : and the index name after the module. Multi‐ appending a colon : and the index name after the module. Multi‐
ple comma-spearated indices can also be specified. ple comma-spearated indices can also be specified.
The index name itself usually is the part of the comic strip The index name itself usually is the part of the comic strip
URL that identifiess a strip, eg. a number or a date. The URL that identifiess a strip, eg. a number or a date. The
expected format is documented when using the --modulehelp expected format is documented when using the --modulehelp
option. option.
SPECIAL SYNTAX SPECIAL SYNTAX
@ This expands to mean all the comics currently in your @ This expands to mean all the comics currently in your
Comics directory. All other specified comic module names Comics directory. All other specified comic module names
will be ignored. will be ignored.
@ -107,37 +103,37 @@ EXAMPLES
Retrieve the current comic of Cyanide and Happiness: Retrieve the current comic of Cyanide and Happiness:
dosage cyanideandhappiness dosage cyanideandhappiness
Retrieve the current strip of all comics in your Comics direc‐ Retrieve the current strip of all comics in your Comics direc‐
tory: tory:
dosage @ dosage @
Retrieve the current strip of every comic that there is a mod‐ Retrieve the current strip of every comic that there is a mod‐
ule for: ule for:
dosage @@ dosage @@
Retrieve the Penny Arcade strip for a given index: Retrieve the Penny Arcade strip for a given index:
dosage pennyarcade:2004-07-22 dosage pennyarcade:2004-07-22
Retrieve Calvin and Hobbes strips from a given index going Retrieve Calvin and Hobbes strips from a given index going
backwards to the beginning. backwards to the beginning.
dosage -a calvinandhobbes:20120722 dosage -a calvinandhobbes:20120722
On Unix, xargs(1) can download several comic strips in paral‐ On Unix, xargs(1) can download several comic strips in paral‐
lel, for example using up to 4 processes: lel, for example using up to 4 processes:
cd Comics && find . -type d | xargs -n1 -P4 dosage -b . cd Comics && find . -type d | xargs -n1 -P4 dosage -b .
-v -v
ENVIRONMENT ENVIRONMENT
HTTP_PROXY HTTP_PROXY
mainline will use the specified HTTP proxy when down‐ mainline will use the specified HTTP proxy when down‐
loading URL contents. loading URL contents.
NOTES NOTES
Should retrieval fail on any given strip mainline will attempt Should retrieval fail on any given strip mainline will attempt
to retry. However the retry information is only outputted in to retry. However the retry information is only outputted in
the second and successive output levels. the second and successive output levels.
At the time of writing, a complete Dosage collection weighs in At the time of writing, a complete Dosage collection weighs in
at around 3.0GB. at around 3.0GB.
RETURN VALUE RETURN VALUE
@ -152,7 +148,7 @@ RETURN VALUE
Else the return value is zero. Else the return value is zero.
BUGS BUGS
Users can report or view bugs, patches or feature suggestions Users can report or view bugs, patches or feature suggestions
at https://github.com/wummel/dosage/issues at https://github.com/wummel/dosage/issues
AUTHORS AUTHORS