github/gallery-dl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update configuration.rst

Browse Source
This commit is contained in:
Mike Fährmann
2017-06-27 18:56:24 +02:00
parent 86561d7c8b
commit 598e3a8d88
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/configuration.rst
View File

@@ -67,7 +67,7 @@ output.shorten
-------------- --------------
=========== ===== =========== =====
Type ``bool`` Type ``bool``
Default ``"true"`` Default ``true``
Description Controls whether the output strings should be shortened to fit Description Controls whether the output strings should be shortened to fit
on one console line. on one console line.
=========== ===== =========== =====
@@ -121,9 +121,10 @@ Extractor Options
| The ``category`` is the lowercase site name without any spaces or special | The ``category`` is the lowercase site name without any spaces or special
characters, which is usually just the module name characters, which is usually just the module name
(``pixiv``, ``batoto``, ...). (``pixiv``, ``batoto``, ...).
| The ``subcategory`` is a lowercase word describing the general functionality The ``subcategory`` is a lowercase word describing the general functionality
of that extractor (``user``, ``favorite``, ``manga``, ...). of that extractor (``user``, ``favorite``, ``manga``, ...).
Each one of the following options can be specified on multiple levels of the Each one of the following options can be specified on multiple levels of the
configuration tree: configuration tree:
@@ -142,6 +143,11 @@ general pattern specifically for ``PixivUserExtractor`` instances.
The ``category`` and ``subcategory`` of an extractor used for a specific URL The ``category`` and ``subcategory`` of an extractor used for a specific URL
can be determined by using the ``--list-keywords`` command-line option can be determined by using the ``--list-keywords`` command-line option
(see the example below). (see the example below).
If that does not work, then the extractor names, which can be obtained from
``gallery-dl --list-extractors``, provide an alternativ:
Each extractor name is structured as ``CategorySubcategoryExtractor``.
An extractor called ``PixivUserExtractor`` has therefore the category ``pixiv``
and the subcategory ``user``.
extractor.*.filename extractor.*.filename
-------------------- --------------------
@@ -325,8 +331,8 @@ Description Sets the maximum allowed size for downloaded images.
* If this is an ``integer``, it specifies the maximum image dimension * If this is an ``integer``, it specifies the maximum image dimension
(width and height) in pixels. (width and height) in pixels.
* If this is a ``string``, it should be one of Flickr's format specifiers * If this is a ``string``, it should be one of Flickr's format specifiers
(``"Original"``, ``"Large"``, ... or ``o``, ``k``, ``h``, ``l``, ...) (``"Original"``, ``"Large"``, ... or ``"o"``, ``"k"``, ``"h"``,
to use these as an upper limit. ``"l"``, ...) to use these as an upper limit.
=========== ===== =========== =====
@@ -363,7 +369,7 @@ extractor.oauth.browser
=========== ===== =========== =====
Type ``bool`` Type ``bool``
Default ``true`` Default ``true``
Description Controls how a user is directed to a OAuth authorization site. Description Controls how a user is directed to an OAuth authorization site.
* ``true``: Use Python's |webbrowser.open()|_ method to automatically * ``true``: Use Python's |webbrowser.open()|_ method to automatically
open the URL in the user's browser. open the URL in the user's browser.