README.rst

   1 nhentai\r
   2 =======\r
   3 \r
   4 .. code-block::\r
   5 \r
   6            _   _            _        _\r
   7      _ __ | | | | ___ _ __ | |_ __ _(_)\r
   8     | '_ \| |_| |/ _ \ '_ \| __/ _` | |\r
   9     | | | |  _  |  __/ | | | || (_| | |\r
  10     |_| |_|_| |_|\___|_| |_|\__\__,_|_|\r
  11 \r
  12 \r
  13 あなたも変態。 いいね?  \r
  14 |travis|\r
  15 |pypi|\r
  16 |license|\r
  17 \r
  18 \r
  19 nHentai is a CLI tool for downloading doujinshi from <http://nhentai.net>\r
  20 \r
  21 ============\r
  22 Installation\r
  23 ============\r
  24 .. code-block::\r
  25 \r
  26     git clone https://github.com/RicterZ/nhentai\r
  27     cd nhentai\r
  28     python setup.py install\r
  29     \r
  30 =====================\r
  31 Installation (Gentoo)\r
  32 =====================\r
  33 .. code-block::\r
  34 \r
  35     layman -fa glicOne\r
  36     sudo emerge net-misc/nhentai\r
  37 \r
  38 =====\r
  39 Usage\r
  40 =====\r
  41 **IMPORTANT**: To bypass the nhentai frequency limit, you should use `--cookie` option to store your cookie.\r
  42 *The default download folder will be the path where you run the command (CLI path).*\r
  43 \r
  44 \r
  45 Set your nhentai cookie against captcha:\r
  46 \r
  47 .. code-block:: bash\r
  48 \r
  49     nhentai --cookie 'YOUR COOKIE FROM nhentai.net'\r
  50 \r
  51 Download specified doujinshi:\r
  52 \r
  53 .. code-block:: bash\r
  54 \r
  55     nhentai --id=123855,123866\r
  56 \r
  57 Download doujinshi with ids specified in a file (doujinshi ids split by line):\r
  58 \r
  59 .. code-block:: bash\r
  60 \r
  61     nhentai --file=doujinshi.txt\r
  62 \r
  63 Search a keyword and download the first page:\r
  64 \r
  65 .. code-block:: bash\r
  66 \r
  67     nhentai --search="tomori" --page=1 --download\r
  68 \r
  69 Download by tag name:\r
  70 \r
  71 .. code-block:: bash\r
  72 \r
  73     nhentai --tag lolicon --download --page=2\r
  74 \r
  75 Download your favorites with delay:\r
  76 \r
  77 .. code-block:: bash\r
  78 \r
  79     nhentai --favorites --download --delay 1\r
  80 \r
  81 \r
  82 .. code-block::\r
  83 \r
  84     Options:\r
  85       # Operation options\r
  86       -h, --help            show this help message and exit\r
  87       -D, --download        download doujinshi (for search results)\r
  88       -S, --show            just show the doujinshi information\r
  89 \r
  90       # Doujinshi options\r
  91       --id=ID               doujinshi ids set, e.g. 1,2,3\r
  92       -s KEYWORD, --search=KEYWORD\r
  93                             search doujinshi by keyword\r
  94       --tag=TAG             download doujinshi by tag\r
  95       -F, --favorites       list or download your favorites.\r
  96 \r
  97       # Multi-page options\r
  98       --page=PAGE           page number of search results\r
  99       --max-page=MAX_PAGE   The max page when recursive download tagged doujinshi\r
 100 \r
 101       # Download options\r
 102       -o OUTPUT_DIR, --output=OUTPUT_DIR\r
 103                             output dir\r
 104       -t THREADS, --threads=THREADS\r
 105                             thread count for downloading doujinshi\r
 106       -T TIMEOUT, --timeout=TIMEOUT\r
 107                             timeout for downloading doujinshi\r
 108       -d DELAY, --delay=DELAY\r
 109                             slow down between downloading every doujinshi\r
 110       -p PROXY, --proxy=PROXY\r
 111                             uses a proxy, for example: http://127.0.0.1:1080\r
 112       -f FILE, --file=FILE  read gallery IDs from file.\r
 113       --format=NAME_FORMAT  format the saved folder name\r
 114 \r
 115       # Generating options\r
 116       --html                generate a html viewer at current directory\r
 117       --no-html             don't generate HTML after downloading\r
 118       -C, --cbz             generate Comic Book CBZ File\r
 119       --rm-origin-dir       remove downloaded doujinshi dir when generated CBZ\r
 120                             file.\r
 121 \r
 122       # nHentai options\r
 123       --cookie=COOKIE       set cookie of nhentai to bypass Google recaptcha\r
 124 \r
 125 \r
 126 ==============\r
 127 nHentai Mirror\r
 128 ==============\r
 129 If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.\r
 130 For example:\r
 131 \r
 132 .. code-block:: \r
 133 \r
 134     i.h.loli.club -> i.nhentai.net\r
 135     h.loli.club -> nhentai.net\r
 136 \r
 137 Set `NHENTAI` env var to your nhentai mirror.\r
 138 \r
 139 .. code-block:: bash\r
 140 \r
 141     NHENTAI=http://h.loli.club nhentai --id 123456\r
 142 \r
 143 \r
 144 .. image:: ./images/search.png?raw=true\r
 145     :alt: nhentai\r
 146     :align: center\r
 147 .. image:: ./images/download.png?raw=true\r
 148     :alt: nhentai\r
 149     :align: center\r
 150 .. image:: ./images/viewer.png?raw=true\r
 151     :alt: nhentai\r
 152     :align: center\r
 153 \r
 154 ============\r
 155 あなたも変態\r
 156 ============\r
 157 .. image:: ./images/image.jpg?raw=true\r
 158     :alt: nhentai\r
 159     :align: center\r
 160 \r
 161 \r
 162 \r
 163 .. |travis| image:: https://travis-ci.org/RicterZ/nhentai.svg?branch=master\r
 164    :target: https://travis-ci.org/RicterZ/nhentai\r
 165 \r
 166 .. |pypi| image:: https://img.shields.io/pypi/dm/nhentai.svg\r
 167    :target: https://pypi.org/project/nhentai/\r
 168 \r
 169 .. |license| image:: https://img.shields.io/github/license/ricterz/nhentai.svg\r
 170    :target: https://github.com/RicterZ/nhentai/blob/master/LICENSE\r