Updated program description.

This commit is contained in:
Bastian Kleineidam 2013-03-25 19:46:48 +01:00
parent c99827935b
commit 4338afc1a7
5 changed files with 22 additions and 16 deletions

View file

@ -1,7 +1,7 @@
Dosage
=======
Dosage is a commandline comic downloader and archiver.
Dosage is a comic strip downloader and archiver.
Introduction
-------------
@ -31,17 +31,11 @@ User-agent: dosage
Allow: *
```
Adult content
--------------
Some comics contain adult content and require age confirmation.
These comics can only be downloaded by using the --adult option,
which confirms that you are old enough to view them.
Usage
------
List available comics (ca. 3000 at the moment):
`$ dosage -l`
`$ dosage --list`
Get the latest comic of for example CalvinAndHobbes and save it in the "Comics"
directory:
@ -49,18 +43,24 @@ directory:
`$ dosage CalvinAndHobbes`
If you already have downloaded several comics and want to get the latest
strip of all of them:
strips of all of them:
`$ dosage @`
`$ dosage --continue @`
On Unix, ``xargs`` can download several comic strips in parallel,
for example using up to 4 processes:
`$ cd Comics && find . -type d | xargs -n1 -P4 dosage -b . -v`
`$ cd Comics && find . -type d | xargs -n1 -P4 dosage --basedir . --verbose`
For advanced options and features execute `dosage -h` or look at the dosage
For advanced options and features execute `dosage --help` or look at the dosage
manual page.
Adult content
--------------
Some comics contain adult content and require age confirmation.
These comics can only be downloaded by using the --adult option,
which confirms that you are old enough to view them.
Installation
-------------
The most convenient method is to use pip, which installs all dependencies

View file

@ -1,6 +1,6 @@
.TH DOSAGE 1
.SH NAME
dosage \- a commandline comic downloader and archiver
dosage \- a comic strip downloader and archiver
.SH SYNOPSIS
\fBdosage\fP [\fIoptions\fP] \fImodule\fP...
.SH DESCRIPTION
@ -61,6 +61,12 @@ 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
hours. The feed can be found in \fBComics/dailydose.xml\fP.
.RE
.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.
.TP
\fB\-t\fP, \fB\-\-timestamps\fP

View file

@ -9,7 +9,7 @@ Section: User Commands (1)<BR><A HREF="#index">Index</A>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
dosage - a commandline comic downloader and archiver
dosage - a comic strip downloader and archiver
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

View file

@ -3,7 +3,7 @@ DOSAGE(1) DOSAGE(1)
NAME
dosage - a commandline comic downloader and archiver
dosage - a comic strip downloader and archiver
SYNOPSIS
dosage [options] module...

View file

@ -403,7 +403,7 @@ class MyRegister (register, object):
args = dict(
name = AppName,
version = AppVersion,
description = 'a commandline comic downloader and archiver',
description = 'a comic strip downloader and archiver',
keywords = 'comic,webcomic,downloader,archiver',
author = 'Tristan Seligmann, Jonathan Jacobs, Bastian Kleineidam',
author_email = 'bastian.kleineidam@web.de',