Updated manpage.
This commit is contained in:
Bastian Kleineidam
parent
6319773cb9
commit
87061d1fa6
9
doc/Makefile
Normal file
9
doc/Makefile
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
MANFILES:=dosage.1.html
|
||||
|
||||
man: $(MANFILES)
|
||||
|
||||
dosage.1.html: dosage.1
|
||||
man2html -r $< | tail -n +2 | sed 's/Time:.*//g' | sed 's@/:@/@g' > $@
|
||||
# patch --no-backup-if-mismatch --quiet $@ dosage.1.html.diff
|
||||
|
||||
.PHONY: all man
|
||||
109
doc/dosage.1
109
doc/dosage.1
|
|
@ -1,37 +1,39 @@
|
|||
.TH MAINLINE 1
|
||||
.TH DOSAGE 1
|
||||
.SH NAME
|
||||
mainline \- command line interface to Dosage
|
||||
dosage \- comic strip downloader
|
||||
.SH SYNOPSIS
|
||||
.B mainline
|
||||
.B dosage
|
||||
.RI [ options ]
|
||||
.I module
|
||||
.RI [ module .\|.\|.]
|
||||
.SH DESCRIPTION
|
||||
.B mainline
|
||||
is a command line interface to Dosage. Dosage is a an application designed
|
||||
to keep a local \(oqmirror\(cq of specific web comics and other picture\-based
|
||||
content, such as \(oqPicture Of The Day\(cq sites, with a variety of options
|
||||
.B dosage
|
||||
is an application designed to keep a local \(oqmirror\(cq of specific
|
||||
web comics and other picture\-based content, such as
|
||||
\(oqPicture Of The Day\(cq sites, with a variety of options
|
||||
for updating and maintaining collections.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BI \-b " PATH" "\fR,\fP \-\^\-base\--path=" PATH
|
||||
.BI \-b " PATH" "\fR,\fP \-\^\-basepath=" PATH
|
||||
Specifies a base path to put comic subdirectories. The default is \(oqComics\(cq.
|
||||
.TP
|
||||
.BI \-\^\-base\-url= PATH
|
||||
.BI \-\^\-baseurl= PATH
|
||||
Specifies the base URL for output events. The default is a local file URI.
|
||||
.TP
|
||||
.BR \-c ", " \-\^\-catch-up
|
||||
Traverses all available strips until an (identical) existing one is found.
|
||||
This can be useful if your collection was previously up to date,
|
||||
but you've missed a few days worth of strips. Alternatively you can specify
|
||||
.B \-c
|
||||
twice for a \(oqfull catchup\(cq, which will not stop until all comics
|
||||
have been traversed. Catchups can \(oqresumed\(cq by using the index syntax, see
|
||||
.BR \-a ", " \-\^\-all
|
||||
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 image by using the index syntax, see
|
||||
the
|
||||
.B INDEX SYNTAX
|
||||
and
|
||||
.B SPECIAL SYNTAX
|
||||
sections for more information.
|
||||
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,
|
||||
the traversal ends at the first existing image file when starting from
|
||||
an index (excluding the index itself).
|
||||
.TP
|
||||
.BR \-h ", " \-\^\-help
|
||||
Output brief help information.
|
||||
|
|
@ -39,10 +41,10 @@ Output brief help information.
|
|||
.BR \-l ", " \-\^\-list
|
||||
List available comic modules in multi\-column fashion.
|
||||
.TP
|
||||
.BR \-\^\-single\-list
|
||||
.BR \-\^\-singlelist
|
||||
List available comic modules in single-column fashion.
|
||||
.TP
|
||||
.BI \-m " MODULE" "\fR,\fP \-\^\-module-help=" MODULE
|
||||
.BI \-m " MODULE" "\fR,\fP \-\^\-modulehelp=" MODULE
|
||||
Output module-specific help for
|
||||
.IR MODULE .
|
||||
.TP
|
||||
|
|
@ -51,11 +53,6 @@ Output module-specific help for
|
|||
may be any one of the following:
|
||||
.PP
|
||||
.RS
|
||||
.BR "text " \-
|
||||
Provides no additional output and is the default value.
|
||||
.RE
|
||||
.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
|
||||
|
|
@ -93,20 +90,17 @@ must be specified. A list of valid modules can be found by passing the
|
|||
option. Multiple
|
||||
.I module
|
||||
arguments can be specified on the command line.
|
||||
Module names are case insensitive, and it is sufficient to specify a
|
||||
unique substring of the module name.
|
||||
.SH INDEX SYNTAX
|
||||
One can indicate the start of a list of
|
||||
.B comma seperated
|
||||
indices using a
|
||||
.RB \(oq : "\(cq."
|
||||
.PP
|
||||
If
|
||||
.I \-c
|
||||
is specified with index syntax then \(oqresume\(cq mode is activated,
|
||||
where a \(oqcatchup\(cq will start at the given index.
|
||||
.PP
|
||||
Refer to
|
||||
.B EXAMPLES
|
||||
for samples.
|
||||
The index format is documented when using the \fB\-\-modulehelp\fP option.
|
||||
An alternative method is to use an existing filename as index, since images
|
||||
are always stored in index format.
|
||||
.SH OFFENSIVE COMICS
|
||||
Some users may find certain comics offensive and wish to disable them.
|
||||
Modules listed in
|
||||
|
|
@ -118,30 +112,44 @@ will be disabled. These files should contain only one module name per line.
|
|||
.TP
|
||||
.B @
|
||||
This expands to mean all the comics currently in your \(oqComics\(cq
|
||||
directory.
|
||||
directory. All other specified comic module names will be ignored.
|
||||
.TP
|
||||
.B @@
|
||||
This expands to mean all the comics available to Dosage.
|
||||
.PP
|
||||
.B INDEX SYNTAX
|
||||
can be used with
|
||||
can not be used with
|
||||
.B SPECIAL SYNTAX
|
||||
but this is unlikely to be useful.
|
||||
.
|
||||
.SH EXAMPLES
|
||||
Retrieve the latest Mega Tokyo comic:
|
||||
Retrieve all Mega Tokyo comics:
|
||||
.RS
|
||||
.B mainline MegaTokyo
|
||||
.B dosage \-a megatokyo
|
||||
.RE
|
||||
.PP
|
||||
Retrieve every strip from every comic that there is a module for:
|
||||
Retrieve the current comic of Cyanide and Happiness:
|
||||
.RS
|
||||
.B mainline \-c @@
|
||||
.B dosage cyanideandhappiness
|
||||
.RE
|
||||
.PP
|
||||
Retrieve all Penny Arcade strips from (and including) a given index to
|
||||
the beginning regardless of whether they already exist or not:
|
||||
Retrieve the current strip of all comics in your \(oqComics\(cq directory:
|
||||
.RS
|
||||
.B mainline \-c PennyArcade:2004\-07\-22
|
||||
.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
|
||||
Retrieve Calvin and Hobbes strips from a given index going backwards to
|
||||
the beginning until an existing file is found:
|
||||
.RS
|
||||
.B dosage \-c calvinandhobbes:20120722
|
||||
.RE
|
||||
.SH ENVIRONMENT
|
||||
.IP HTTP_PROXY
|
||||
|
|
@ -159,11 +167,9 @@ At the time of writing, a
|
|||
.B complete
|
||||
Dosage collection weighs in at around 3.0GB.
|
||||
.SH RETURN VALUE
|
||||
The return value is 2 when
|
||||
The return value greater than zero when
|
||||
.IP \(bu
|
||||
a program error occurred.
|
||||
.PP
|
||||
The return value is 1 when
|
||||
.IP \(bu
|
||||
comics could not be found or downloaded
|
||||
.IP \(bu
|
||||
|
|
@ -174,12 +180,19 @@ Else the return value is zero.
|
|||
See
|
||||
.I http://trac.slipgate.za.net/dosage
|
||||
for a list of current development tasks and suggestions.
|
||||
|
||||
.SH FILES
|
||||
.IP "\fB/etc/dosage/disabled\fR"
|
||||
Disables comic modules on a global scale.
|
||||
.IP "\fB~/.dosage/disabled\fR"
|
||||
Disables comic modules on a local scale.
|
||||
.SH AUTHORS
|
||||
.BR mainline " and " Dosage
|
||||
were written by Jonathan Jacobs <korpse@slipgate.za.net> and Tristan Seligmann
|
||||
<mithrandi@slipgate.za.net>. This manual page was written by Jonathan Jacobs.
|
||||
Jonathan Jacobs <korpse@slipgate.za.net>
|
||||
.br
|
||||
Tristan Seligmann <mithrandi@slipgate.za.net>
|
||||
.br
|
||||
Bastian Kleineidam <calvin@users.sourceforge.net>
|
||||
.SH COPYRIGHT
|
||||
Copyright \(co 2004-2005 Tristan Seligmann and Jonathan Jacobs
|
||||
.br
|
||||
Copyright \(co 2012 Bastian Kleineidam
|
||||
|
|
|
|||
|
|
@ -1,19 +1,19 @@
|
|||
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<HTML><HEAD><TITLE>Man page of MAINLINE</TITLE>
|
||||
<HTML><HEAD><TITLE>Man page of DOSAGE</TITLE>
|
||||
</HEAD><BODY>
|
||||
<H1>MAINLINE</H1>
|
||||
<H1>DOSAGE</H1>
|
||||
Section: User Commands (1)<BR><A HREF="#index">Index</A>
|
||||
<A HREF="../index.html">Return to Main Contents</A><HR>
|
||||
|
||||
<A NAME="lbAB"> </A>
|
||||
<H2>NAME</H2>
|
||||
|
||||
mainline - command line interface to Dosage
|
||||
dosage - comic strip downloader
|
||||
<A NAME="lbAC"> </A>
|
||||
<H2>SYNOPSIS</H2>
|
||||
|
||||
<B>mainline</B>
|
||||
<B>dosage</B>
|
||||
|
||||
[<I>options</I>]
|
||||
|
||||
|
|
@ -24,41 +24,41 @@ mainline - command line interface to Dosage
|
|||
<A NAME="lbAD"> </A>
|
||||
<H2>DESCRIPTION</H2>
|
||||
|
||||
<B>mainline</B>
|
||||
<B>dosage</B>
|
||||
|
||||
is a command line interface to Dosage. Dosage is a an application designed
|
||||
to keep a local 'mirror' of specific web comics and other picture-based
|
||||
content, such as 'Picture Of The Day' sites, with a variety of options
|
||||
is an application designed to keep a local 'mirror' of specific
|
||||
web comics and other picture-based content, such as
|
||||
'Picture Of The Day' sites, with a variety of options
|
||||
for updating and maintaining collections.
|
||||
<A NAME="lbAE"> </A>
|
||||
<H2>OPTIONS</H2>
|
||||
|
||||
<DL COMPACT>
|
||||
<DT><B>-b</B><I> PATH</I><B></B>, --base--path=<I>PATH</I>
|
||||
<DT><B>-b</B><I> PATH</I><B></B>, --basepath=<I>PATH</I>
|
||||
|
||||
<DD>
|
||||
Specifies a base path to put comic subdirectories. The default is 'Comics'.
|
||||
<DT><B>--base-url=</B><I>PATH</I>
|
||||
<DT><B>--baseurl=</B><I>PATH</I>
|
||||
|
||||
<DD>
|
||||
Specifies the base URL for output events. The default is a local file URI.
|
||||
<DT><B>-c</B>, <B>--catch-up</B>
|
||||
<DT><B>-a</B>, <B>--all</B>
|
||||
|
||||
<DD>
|
||||
Traverses all available strips until an (identical) existing one is found.
|
||||
This can be useful if your collection was previously up to date,
|
||||
but you've missed a few days worth of strips. Alternatively you can specify
|
||||
<B>-c</B>
|
||||
|
||||
twice for a 'full catchup', which will not stop until all comics
|
||||
have been traversed. Catchups can 'resumed' by using the index syntax, see
|
||||
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 image by using the index syntax, see
|
||||
the
|
||||
<B>INDEX SYNTAX</B>
|
||||
|
||||
and
|
||||
<B>SPECIAL SYNTAX</B>
|
||||
|
||||
sections for more information.
|
||||
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,
|
||||
the traversal ends at the first existing image file when starting from
|
||||
an index (excluding the index itself).
|
||||
<DT><B>-h</B>, <B>--help</B>
|
||||
|
||||
<DD>
|
||||
|
|
@ -67,11 +67,11 @@ Output brief help information.
|
|||
|
||||
<DD>
|
||||
List available comic modules in multi-column fashion.
|
||||
<DT><B>--single-list</B>
|
||||
<DT><B>--singlelist</B>
|
||||
|
||||
<DD>
|
||||
List available comic modules in single-column fashion.
|
||||
<DT><B>-m</B><I> MODULE</I><B></B>, --module-help=<I>MODULE</I>
|
||||
<DT><B>-m</B><I> MODULE</I><B></B>, --modulehelp=<I>MODULE</I>
|
||||
|
||||
<DD>
|
||||
Output module-specific help for
|
||||
|
|
@ -86,14 +86,6 @@ may be any one of the following:
|
|||
</DL>
|
||||
<P>
|
||||
|
||||
<DL COMPACT><DT><DD>
|
||||
<B>text </B>-
|
||||
|
||||
Provides no additional output and is the default value.
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
|
||||
<DL COMPACT><DT><DD>
|
||||
<B>html </B>-
|
||||
|
||||
|
|
@ -149,6 +141,8 @@ option. Multiple
|
|||
<I>module</I>
|
||||
|
||||
arguments can be specified on the command line.
|
||||
Module names are case insensitive, and it is sufficient to specify a
|
||||
unique substring of the module name.
|
||||
</DL>
|
||||
<A NAME="lbAF"> </A>
|
||||
<H2>INDEX SYNTAX</H2>
|
||||
|
|
@ -161,17 +155,9 @@ indices using a
|
|||
|
||||
<P>
|
||||
|
||||
If
|
||||
<I>-c</I>
|
||||
|
||||
is specified with index syntax then 'resume' mode is activated,
|
||||
where a 'catchup' will start at the given index.
|
||||
<P>
|
||||
|
||||
Refer to
|
||||
<B>EXAMPLES</B>
|
||||
|
||||
for samples.
|
||||
The index format is documented when using the <B>--modulehelp</B> option.
|
||||
An alternative method is to use an existing filename as index, since images
|
||||
are always stored in index format.
|
||||
<A NAME="lbAG"> </A>
|
||||
<H2>OFFENSIVE COMICS</H2>
|
||||
|
||||
|
|
@ -191,7 +177,7 @@ will be disabled. These files should contain only one module name per line.
|
|||
|
||||
<DD>
|
||||
This expands to mean all the comics currently in your 'Comics'
|
||||
directory.
|
||||
directory. All other specified comic module names will be ignored.
|
||||
<DT><B>@@</B>
|
||||
|
||||
<DD>
|
||||
|
|
@ -201,33 +187,54 @@ This expands to mean all the comics available to Dosage.
|
|||
|
||||
<B>INDEX SYNTAX</B>
|
||||
|
||||
can be used with
|
||||
can not be used with
|
||||
<B>SPECIAL SYNTAX</B>
|
||||
|
||||
but this is unlikely to be useful.
|
||||
<A NAME="lbAI"> </A>
|
||||
<H2>EXAMPLES</H2>
|
||||
|
||||
Retrieve the latest Mega Tokyo comic:
|
||||
Retrieve all Mega Tokyo comics:
|
||||
<DL COMPACT><DT><DD>
|
||||
<B>mainline MegaTokyo</B>
|
||||
<B>dosage -a megatokyo</B>
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
|
||||
Retrieve every strip from every comic that there is a module for:
|
||||
Retrieve the current comic of Cyanide and Happiness:
|
||||
<DL COMPACT><DT><DD>
|
||||
<B>mainline -c @@</B>
|
||||
<B>dosage cyanideandhappiness</B>
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
|
||||
Retrieve all Penny Arcade strips from (and including) a given index to
|
||||
the beginning regardless of whether they already exist or not:
|
||||
Retrieve the current strip of all comics in your 'Comics' directory:
|
||||
<DL COMPACT><DT><DD>
|
||||
<B>mainline -c PennyArcade:2004-07-22</B>
|
||||
<B>dosage @</B>
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
|
||||
Retrieve the current strip of every comic that there is a module for:
|
||||
<DL COMPACT><DT><DD>
|
||||
<B>dosage @@</B>
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
|
||||
Retrieve the Penny Arcade strip for a given index:
|
||||
<DL COMPACT><DT><DD>
|
||||
<B>dosage pennyarcade:2004-07-22</B>
|
||||
|
||||
</DL>
|
||||
|
||||
Retrieve Calvin and Hobbes strips from a given index going backwards to
|
||||
the beginning until an existing file is found:
|
||||
<DL COMPACT><DT><DD>
|
||||
<B>dosage -c calvinandhobbes:20120722</B>
|
||||
|
||||
</DL>
|
||||
|
||||
|
|
@ -260,15 +267,10 @@ Dosage collection weighs in at around 3.0GB.
|
|||
<A NAME="lbAL"> </A>
|
||||
<H2>RETURN VALUE</H2>
|
||||
|
||||
The return value is 2 when
|
||||
The return value greater than zero when
|
||||
<DL COMPACT>
|
||||
<DT>•<DD>
|
||||
a program error occurred.
|
||||
</DL>
|
||||
<P>
|
||||
|
||||
The return value is 1 when
|
||||
<DL COMPACT>
|
||||
<DT>•<DD>
|
||||
comics could not be found or downloaded
|
||||
<DT>•<DD>
|
||||
|
|
@ -284,6 +286,7 @@ See
|
|||
<I><A HREF="http://trac.slipgate.za.net/dosage">http://trac.slipgate.za.net/dosage</A></I>
|
||||
|
||||
for a list of current development tasks and suggestions.
|
||||
<P>
|
||||
<A NAME="lbAN"> </A>
|
||||
<H2>FILES</H2>
|
||||
|
||||
|
|
@ -296,10 +299,20 @@ Disables comic modules on a local scale.
|
|||
<A NAME="lbAO"> </A>
|
||||
<H2>AUTHORS</H2>
|
||||
|
||||
<B>mainline</B> and <B>Dosage</B>
|
||||
Jonathan Jacobs <<A HREF="mailto:korpse@slipgate.za.net">korpse@slipgate.za.net</A>>
|
||||
<BR>
|
||||
|
||||
were written by Jonathan Jacobs <<A HREF="mailto:korpse@slipgate.za.net">korpse@slipgate.za.net</A>> and Tristan Seligmann
|
||||
<<A HREF="mailto:mithrandi@slipgate.za.net">mithrandi@slipgate.za.net</A>>. This manual page was written by Jonathan Jacobs.
|
||||
Tristan Seligmann <<A HREF="mailto:mithrandi@slipgate.za.net">mithrandi@slipgate.za.net</A>>
|
||||
<BR>
|
||||
|
||||
Bastian Kleineidam <<A HREF="mailto:calvin@users.sourceforge.net">calvin@users.sourceforge.net</A>>
|
||||
<A NAME="lbAP"> </A>
|
||||
<H2>COPYRIGHT</H2>
|
||||
|
||||
Copyright © 2004-2005 Tristan Seligmann and Jonathan Jacobs
|
||||
<BR>
|
||||
|
||||
Copyright © 2012 Bastian Kleineidam
|
||||
<P>
|
||||
|
||||
<HR>
|
||||
|
|
@ -319,6 +332,7 @@ were written by Jonathan Jacobs <<A HREF="mailto:korpse@slipgate.za.net">korp
|
|||
<DT><A HREF="#lbAM">BUGS</A><DD>
|
||||
<DT><A HREF="#lbAN">FILES</A><DD>
|
||||
<DT><A HREF="#lbAO">AUTHORS</A><DD>
|
||||
<DT><A HREF="#lbAP">COPYRIGHT</A><DD>
|
||||
</DL>
|
||||
<HR>
|
||||
This document was created by
|
||||
|
|
|
|||
Loading…
Reference in a new issue