Updated documentation.

[ci skip]
This commit is contained in:
Bastian Kleineidam 2013-03-26 17:35:26 +01:00
parent 92150ddbda
commit 30e76470e3
4 changed files with 39 additions and 30 deletions

View file

@ -145,11 +145,11 @@ for example using up to 4 processes:
.RE .RE
.SH ENVIRONMENT .SH ENVIRONMENT
.IP HTTP_PROXY .IP HTTP_PROXY
.B mainline .B dosage
will use the specified HTTP proxy when downloading URL contents. will use the specified HTTP proxy when downloading URL contents.
.SH NOTES .SH NOTES
Should retrieval fail on any given strip Should retrieval fail on any given strip
.B mainline .B dosage
will attempt to retry. However the retry information is only outputted will attempt to retry. However the retry information is only outputted
in the in the
.B second .B second
@ -172,11 +172,7 @@ Else the return value is zero.
Users can report or view bugs, patches or feature suggestions at Users can report or view bugs, patches or feature suggestions at
.I https://github.com/wummel/dosage/issues .I https://github.com/wummel/dosage/issues
.SH AUTHORS .SH AUTHORS
Jonathan Jacobs <korpse@slipgate.za.net> Jonathan Jacobs, Tristan Seligmann, Bastian Kleineidam <bastian.kleineidam@web.de>
.br
Tristan Seligmann <mithrandi@slipgate.za.net>
.br
Bastian Kleineidam <bastian.kleineidam@web.de>
.SH COPYRIGHT .SH COPYRIGHT
Copyright \(co 2004-2005 Tristan Seligmann and Jonathan Jacobs Copyright \(co 2004-2005 Tristan Seligmann and Jonathan Jacobs
.br .br

View file

@ -77,6 +77,15 @@ 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>json </B>-
Write a JSON file with all download infos (URLs, images). Can be used with
other scripts, eg. order-symlinks.py to add symbolic links.
</DL>
This option can be given multiple times. This option can be given multiple times.
<DL COMPACT> <DL COMPACT>
<DT><B>-t</B>, <B>--timestamps</B><DD> <DT><B>-t</B>, <B>--timestamps</B><DD>
@ -181,7 +190,7 @@ the beginning.
<P> <P>
On Unix, <B><A HREF="../man1/xargs.1.html">xargs</A>(1)</B> can download several comic strips in parallel, On Unix, <B>xargs(1)</B> can download several comic strips in parallel,
for example using up to 4 processes: for example using up to 4 processes:
<DL COMPACT><DT><DD> <DL COMPACT><DT><DD>
<B>cd Comics &amp;&amp; find . -type d | xargs -n1 -P4 dosage -b . -v</B> <B>cd Comics &amp;&amp; find . -type d | xargs -n1 -P4 dosage -b . -v</B>
@ -193,7 +202,7 @@ for example using up to 4 processes:
<DL COMPACT> <DL COMPACT>
<DT>HTTP_PROXY<DD> <DT>HTTP_PROXY<DD>
<B>mainline</B> <B>dosage</B>
will use the specified HTTP proxy when downloading URL contents. will use the specified HTTP proxy when downloading URL contents.
</DL> </DL>
@ -201,7 +210,7 @@ will use the specified HTTP proxy when downloading URL contents.
<H2>NOTES</H2> <H2>NOTES</H2>
Should retrieval fail on any given strip Should retrieval fail on any given strip
<B>mainline</B> <B>dosage</B>
will attempt to retry. However the retry information is only outputted will attempt to retry. However the retry information is only outputted
in the in the
@ -238,13 +247,7 @@ Users can report or view bugs, patches or feature suggestions at
<A NAME="lbAM">&nbsp;</A> <A NAME="lbAM">&nbsp;</A>
<H2>AUTHORS</H2> <H2>AUTHORS</H2>
Jonathan Jacobs &lt;<A HREF="mailto:korpse@slipgate.za.net">korpse@slipgate.za.net</A>&gt; Jonathan Jacobs, Tristan Seligmann, Bastian Kleineidam &lt;<A HREF="mailto:bastian.kleineidam@web.de">bastian.kleineidam@web.de</A>&gt;
<BR>
Tristan Seligmann &lt;<A HREF="mailto:mithrandi@slipgate.za.net">mithrandi@slipgate.za.net</A>&gt;
<BR>
Bastian Kleineidam &lt;<A HREF="mailto:bastian.kleineidam@web.de">bastian.kleineidam@web.de</A>&gt;
<A NAME="lbAN">&nbsp;</A> <A NAME="lbAN">&nbsp;</A>
<H2>COPYRIGHT</H2> <H2>COPYRIGHT</H2>

View file

@ -1,7 +1,5 @@
diff --git i/doc/dosage.1.html w/doc/dosage.1.html --- dosage.1.html.orig 2013-03-26 19:02:14.690504207 +0100
index e4f07f0..b8110eb 100644 +++ dosage.1.html 2013-03-26 19:04:24.808185171 +0100
--- i/doc/dosage.1.html
+++ w/doc/dosage.1.html
@@ -4,7 +4,7 @@ @@ -4,7 +4,7 @@
</HEAD><BODY> </HEAD><BODY>
<H1>DOSAGE</H1> <H1>DOSAGE</H1>
@ -11,7 +9,16 @@ index e4f07f0..b8110eb 100644
<A NAME="lbAB">&nbsp;</A> <A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2> <H2>NAME</H2>
@@ -269,7 +269,7 @@ Copyright &#169; 2012-2013 Bastian Kleineidam @@ -190,7 +190,7 @@
<P>
-On Unix, <B><A HREF="../man1/xargs.1.html">xargs</A>(1)</B> can download several comic strips in parallel,
+On Unix, <B>xargs(1)</B> can download several comic strips in parallel,
for example using up to 4 processes:
<DL COMPACT><DT><DD>
<B>cd Comics &amp;&amp; find . -type d | xargs -n1 -P4 dosage -b . -v</B>
@@ -282,7 +282,7 @@
</DL> </DL>
<HR> <HR>
This document was created by This document was created by

View file

@ -61,6 +61,10 @@ OPTIONS
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.
json - Write a JSON file with all download infos (URLs,
images). Can be used with other scripts, eg. order-sym
links.py to add symbolic links.
This option can be given multiple times. This option can be given multiple times.
-t, --timestamps -t, --timestamps
@ -126,13 +130,13 @@ EXAMPLES
ENVIRONMENT ENVIRONMENT
HTTP_PROXY HTTP_PROXY
mainline will use the specified HTTP proxy when down dosage will use the specified HTTP proxy when download
loading URL contents. ing URL contents.
NOTES NOTES
Should retrieval fail on any given strip mainline will attempt Should retrieval fail on any given strip dosage will attempt to
to retry. However the retry information is only outputted in retry. However the retry information is only outputted in the
the second and successive output levels. 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.
@ -153,9 +157,8 @@ BUGS
at https://github.com/wummel/dosage/issues at https://github.com/wummel/dosage/issues
AUTHORS AUTHORS
Jonathan Jacobs <korpse@slipgate.za.net> Jonathan Jacobs, Tristan Seligmann, Bastian Kleineidam <bas
Tristan Seligmann <mithrandi@slipgate.za.net> tian.kleineidam@web.de>
Bastian Kleineidam <bastian.kleineidam@web.de>
COPYRIGHT COPYRIGHT
Copyright © 2004-2005 Tristan Seligmann and Jonathan Jacobs Copyright © 2004-2005 Tristan Seligmann and Jonathan Jacobs