Commits

Vasilij Schneidermann  committed 1a6d108

switched to rst

  • Participants
  • Parent commits 554ebb8

Comments (0)

Files changed (2)

File README.md

-fug
-===
-
-About
------
-fug is a simple cli webcomic downloader that uses plugins for its
-functionality. This basically means that you only need to code a plugin to add
-support for a new webcomic. Once it's done downloading, you can use your
-favorite image viewer to read offline.
-
-Usage
------
-
-    fug.py [-h] [--list] [-o [DIRECTORY]] [-v] [-d DUMP_FILE]
-           [-f FILENAME_FORMAT] [-s START_URL] [-e END_URL] [-i OFFSET]
-           plugin
-
-    a simple webcomic downloader
-
-    positional arguments:
-      plugin              webcomic plugin to use
-
-    optional arguments:
-      -h, --help          show this help message and exit
-      --list              list available plugins
-      -o [DIRECTORY]      output directory (default: ./)
-      -v                  turn verbose mode on
-      -d DUMP_FILE        dump urls to specified file instead of downloading
-                          images
-      -f FILENAME_FORMAT  override filename format
-      -s START_URL        override start url
-      -e END_URL          override end url
-      -i OFFSET           override offset (default: 1), use with -s and -e to
-                          resume
-
-    example usage: fug qc -o images
+fug
+===
+
+About
+-----
+fug is a simple cli webcomic downloader that uses plugins for its
+functionality. This basically means that you only need to code a plugin to add
+support for a new webcomic. Once it's done downloading, you can use your
+favorite image viewer to read offline.
+
+Usage
+-----
+::
+
+    fug.py [-h] [--list] [-o [DIRECTORY]] [-v] [-d DUMP_FILE]
+           [-f FILENAME_FORMAT] [-s START_URL] [-e END_URL] [-i OFFSET]
+           plugin
+
+    a simple webcomic downloader
+
+    positional arguments:
+      plugin              webcomic plugin to use
+
+    optional arguments:
+      -h, --help          show this help message and exit
+      --list              list available plugins
+      -o [DIRECTORY]      output directory (default: ./)
+      -v                  turn verbose mode on
+      -d DUMP_FILE        dump urls to specified file instead of downloading
+                          images
+      -f FILENAME_FORMAT  override filename format
+      -s START_URL        override start url
+      -e END_URL          override end url
+      -i OFFSET           override offset (default: 1), use with -s and -e to
+                          resume
+
+    example usage: fug qc -o images