From 5a3f1009c9cc317948b3d9fa7a336e2adac0983f Mon Sep 17 00:00:00 2001 From: Ricter Z Date: Mon, 2 May 2022 18:48:02 +0800 Subject: [PATCH] update README for issue #237 --- README.rst | 56 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 34 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 6e62bbc..bd5b6d0 100644 --- a/README.rst +++ b/README.rst @@ -138,24 +138,27 @@ Other options: .. code-block:: + Usage: + nhentai --search [keyword] --download + NHENTAI=http://h.loli.club nhentai --id [ID ...] + nhentai --file [filename] + + Environment Variable: + NHENTAI nhentai mirror url + Options: - # Operation options -h, --help show this help message and exit -D, --download download doujinshi (for search results) -S, --show just show the doujinshi information - - # Doujinshi options --id=ID doujinshi ids set, e.g. 1,2,3 -s KEYWORD, --search=KEYWORD search doujinshi by keyword - --tag=TAG download doujinshi by tag -F, --favorites list or download your favorites. - - # Multi-page options - --page=PAGE page number of search results - --max-page=MAX_PAGE The max page when recursive download tagged doujinshi - - # Download options + --page-all all search results + --page=PAGE, --page-range=PAGE + page number of search results. e.g. 1,2-5,14 + --sorting=SORTING sorting of doujinshi (recent / popular / + popular-[today|week]) -o OUTPUT_DIR, --output=OUTPUT_DIR output dir -t THREADS, --threads=THREADS @@ -164,23 +167,32 @@ Other options: timeout for downloading doujinshi -d DELAY, --delay=DELAY slow down between downloading every doujinshi - -p PROXY, --proxy=PROXY - uses a proxy, for example: http://127.0.0.1:1080 + --proxy=PROXY store a proxy, for example: -p 'http://127.0.0.1:1080' -f FILE, --file=FILE read gallery IDs from file. --format=NAME_FORMAT format the saved folder name - - # Generating options + -r, --dry-run Dry run, skip file download. --html generate a html viewer at current directory --no-html don't generate HTML after downloading - --gen-main generate a main viewer contain all the doujin in the folder + --gen-main generate a main viewer contain all the doujin in the + folder -C, --cbz generate Comic Book CBZ File - -P --pdf generate PDF file - --rm-origin-dir remove downloaded doujinshi dir when generated CBZ - or PDF file. - - # nHentai options - --cookie=COOKIE set cookie of nhentai to bypass Google recaptcha - + -P, --pdf generate PDF file + --rm-origin-dir remove downloaded doujinshi dir when generated CBZ or + PDF file. + --meta generate a metadata file in doujinshi format + --regenerate-cbz regenerate the cbz file if exists + --cookie=COOKIE set cookie of nhentai to bypass Cloudflare captcha + --useragent=USERAGENT + set useragent to bypass Cloudflare captcha + --language=LANGUAGE set default language to parse doujinshis + --clean-language set DEFAULT as language to parse doujinshis + --save-download-history + save downloaded doujinshis, whose will be skipped if + you re-download them + --clean-download-history + clean download history + --template=VIEWER_TEMPLATE + set viewer template ============== nHentai Mirror -- 2.44.0