Mirrors/gallery-dl
1
0
Fork 0
mirror of https://github.com/mikf/gallery-dl.git synced 2024-11-22 18:53:21 +01:00
Code Issues Releases Wiki Activity

update docs/configuration.rst

Browse Source 
- fix description of "skip": "enumerate"
- use line breaks for lists of multiple examples
- improve formatting of auto-generated man pages
This commit is contained in:
Mike Fährmann 2019-12-05 23:43:57 +01:00
parent e17907ee2a
commit 93b43f74f4
No known key found for this signature in database
GPG Key ID: 5680CA389D365A88
1 changed files with 20 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/configuration.rst
View File

@ -150,8 +150,6 @@ Description Controls the behavior when downloading files that have been
downloaded before, i.e. a file with the same filename already downloaded before, i.e. a file with the same filename already
exists or its ID is in a `download archive`__. exists or its ID is in a `download archive`__.
__ `extractor.*.archive`_
* ``true``: Skip downloads * ``true``: Skip downloads
* ``false``: Overwrite already existing files * ``false``: Overwrite already existing files
@ -163,10 +161,12 @@ Description Controls the behavior when downloading files that have been
* ``"exit:N"``: Skip downloads and exit the program * ``"exit:N"``: Skip downloads and exit the program
after ``N`` consecutive skips after ``N`` consecutive skips
* ``"enumerate"``: Append a numeric suffix to the end of the * ``"enumerate"``: Add an enumeration index to the beginning of the
original filename (``file.ext.1``, ``file.ext.2``, etc) filename extension (``file.1.ext``, ``file.2.ext``, etc.)
=========== ===== =========== =====
__ `extractor.*.archive`_
extractor.*.sleep extractor.*.sleep
----------------- -----------------
@ -553,8 +553,7 @@ extractor.deviantart.include
=========== ===== =========== =====
Type ``string`` or ``list`` of ``strings`` Type ``string`` or ``list`` of ``strings``
Default ``"gallery"`` Default ``"gallery"``
Example * ``"favorite,journal,scraps"`` Example ``"favorite,journal,scraps"`` or ``["favorite", "journal", "scraps"]``
* ``["favorite", "journal", "scraps"]``
Description A (comma-separated) list of subcategories to include Description A (comma-separated) list of subcategories to include
when processing a user profile. when processing a user profile.
@ -788,8 +787,7 @@ extractor.newgrounds.include
=========== ===== =========== =====
Type ``string`` or ``list`` of ``strings`` Type ``string`` or ``list`` of ``strings``
Default ``"art"`` Default ``"art"``
Example * ``"movies,audio"`` Example ``"movies,audio"`` or ``["movies", "audio"]``
* ``["movies", "audio", "scraps"]``
Description A (comma-separated) list of subcategories to include Description A (comma-separated) list of subcategories to include
when processing a user profile. when processing a user profile.
@ -1168,7 +1166,7 @@ downloader.*.rate
=========== ===== =========== =====
Type ``string`` Type ``string``
Default ``null`` Default ``null``
Examples ``"32000"``, ``"500k"``, ``"2.5M"`` Example ``"32000"``, ``"500k"``, ``"2.5M"``
Description Maximum download rate in bytes per second. Description Maximum download rate in bytes per second.
Possible values are valid integer or floating-point numbers Possible values are valid integer or floating-point numbers
@ -1423,8 +1421,8 @@ exec.command
------------ ------------
=========== ===== =========== =====
Type ``string`` or ``list`` of ``strings`` Type ``string`` or ``list`` of ``strings``
Example * ``"convert {} {}.png && rm {}"`` Example | ``"convert {} {}.png && rm {}"``,
* ``["echo", "{user[account]}", "{id}"]`` | ``["echo", "{user[account]}", "{id}"]``
Description The command to run. Description The command to run.
* If this is a ``string``, it will be executed using the system's * If this is a ``string``, it will be executed using the system's
@ -1482,8 +1480,8 @@ metadata.extension-format
------------------------- -------------------------
=========== ===== =========== =====
Type ``string`` Type ``string``
Example * ``"{extension}.json"`` Example | ``"{extension}.json"``,
* ``"json"`` | ``"json"``
Description Custom format string to build filename extensions for metadata Description Custom format string to build filename extensions for metadata
files with, which will replace the original filename extensions. files with, which will replace the original filename extensions.
@ -1798,12 +1796,12 @@ Date
---- ----
=========== ===== =========== =====
Type ``string`` or ``integer`` Type ``string`` or ``integer``
Examples * ``"2019-01-01T00:00:00"`` Example | ``"2019-01-01T00:00:00"``,
* ``"2019"`` with ``"%Y"`` as date-format_ | ``"2019"`` with ``"%Y"`` as `date-format`_,
* ``1546297200`` | ``1546297200``
Description A |Date|_ value represents a specific point in time. Description A |Date|_ value represents a specific point in time.
* If given as ``string``, it is parsed according to date-format_. * If given as ``string``, it is parsed according to `date-format`_.
* If given as ``integer``, it is interpreted as UTC timestamp. * If given as ``integer``, it is interpreted as UTC timestamp.
=========== ===== =========== =====
@ -1812,10 +1810,10 @@ Path
---- ----
=========== ===== =========== =====
Type ``string`` or ``list`` of ``strings`` Type ``string`` or ``list`` of ``strings``
Examples * ``"file.ext"`` Example | ``"file.ext"``,
* ``"~/path/to/file.ext"`` | ``"~/path/to/file.ext"``,
* ``"$HOME/path/to/file.ext"`` | ``"$HOME/path/to/file.ext"``,
* ``["$HOME", "path", "to", "file.ext"]`` | ``["$HOME", "path", "to", "file.ext"]``
Description A |Path|_ is a ``string`` representing the location of a file Description A |Path|_ is a ``string`` representing the location of a file
or directory. or directory.
@ -1837,7 +1835,7 @@ Logging Configuration
=========== ===== =========== =====
Type ``object`` Type ``object``
Examples .. code:: Example .. code::
{ {
"format": "{asctime} {name}: {message}", "format": "{asctime} {name}: {message}",