aboutsummaryrefslogtreecommitdiffstats
path: root/data/man
diff options
context:
space:
mode:
authorLibravatarUnit 193 <unit193@ubuntu.com>2019-12-25 19:40:28 -0500
committerLibravatarUnit 193 <unit193@ubuntu.com>2019-12-25 19:40:28 -0500
commitf9a1a9dcb7df977eeac9544786df9c0b93795815 (patch)
tree8cb69cf7685da8d7e4deb7dc1d6b209098e1ddfb /data/man
parent0c73e982fa596da07f23b377621ab894a9e64884 (diff)
New upstream version 1.12.1upstream/1.12.1
Diffstat (limited to 'data/man')
-rw-r--r--data/man/gallery-dl.111
-rw-r--r--data/man/gallery-dl.conf.5157
2 files changed, 119 insertions, 49 deletions
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1
index a775e76..a530760 100644
--- a/data/man/gallery-dl.1
+++ b/data/man/gallery-dl.1
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL" "1" "2019-11-09" "1.11.1" "gallery-dl Manual"
+.TH "GALLERY-DL" "1" "2019-12-22" "1.12.1" "gallery-dl Manual"
.\" disable hyphenation
.nh
@@ -131,9 +131,6 @@ Like '--filter', but applies to manga-chapters and other delegated URLs
.B "\-\-zip"
Store downloaded files in a ZIP archive
.TP
-.B "\-\-exec" \f[I]CMD\f[]
-Execute CMD for each downloaded file. Example: --exec 'magick convert {} {}.png && rm {}'
-.TP
.B "\-\-ugoira\-conv"
Convert Pixiv Ugoira to WebM (requires FFmpeg)
.TP
@@ -148,6 +145,12 @@ Write image tags to separate text files
.TP
.B "\-\-mtime\-from\-date"
Set file modification times according to 'date' metadata
+.TP
+.B "\-\-exec" \f[I]CMD\f[]
+Execute CMD for each downloaded file. Example: --exec 'convert {} {}.png && rm {}'
+.TP
+.B "\-\-exec\-after" \f[I]CMD\f[]
+Execute CMD after all files were downloaded successfully. Example: --exec-after 'cd {} && convert * ../doc.pdf'
.SH EXAMPLES
.TP
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index 8902f51..07f1b88 100644
--- a/data/man/gallery-dl.conf.5
+++ b/data/man/gallery-dl.conf.5
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL.CONF" "5" "2019-11-09" "1.11.1" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2019-12-22" "1.12.1" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -171,7 +171,7 @@ escaped with backslashes, e.g. \f[I]"\\\\[\\\\]"\f[]
\f[I]string\f[]
.IP "Default:" 9
-\f[I]"\\\\u0000-\\\\u001f\\\\u007f"\f[] (ASCII control characters)
+\f[I]"\\u0000-\\u001f\\u007f"\f[] (ASCII control characters)
.IP "Description:" 4
Set of characters to remove from generated path names.
@@ -191,8 +191,6 @@ Controls the behavior when downloading files that have been
downloaded before, i.e. a file with the same filename already
exists or its ID is in a \f[I]download archive\f[].
-__ \f[I]extractor.*.archive\f[]
-
* \f[I]true\f[]: Skip downloads
@@ -211,8 +209,8 @@ after \f[I]N\f[] consecutive skips
after \f[I]N\f[] consecutive skips
-* \f[I]"enumerate"\f[]: Append a numeric suffix to the end of the
-original filename (\f[I]file.ext.1\f[], \f[I]file.ext.2\f[], etc)
+* \f[I]"enumerate"\f[]: Add an enumeration index to the beginning of the
+filename extension (\f[I]file.1.ext\f[], \f[I]file.2.ext\f[], etc.)
.SS extractor.*.sleep
.IP "Type:" 6
@@ -280,7 +278,7 @@ be \f[I]strings\f[], will be used as cookie-names and -values.
\f[I]bool\f[]
.IP "Default:" 9
-\f[I]false\f[]
+\f[I]true\f[]
.IP "Description:" 4
If \f[I]extractor.*.cookies\f[] specifies a cookies.txt file, update its
@@ -623,20 +621,22 @@ Use with caution.
.SS extractor.deviantart.include
.IP "Type:" 6
-\f[I]list\f[] of \f[I]strings\f[] or \f[I]string\f[]
+\f[I]string\f[] or \f[I]list\f[] of \f[I]strings\f[]
.IP "Default:" 9
-\f[I]["gallery"]\f[]
+\f[I]"gallery"\f[]
+
+.IP "Example:" 4
+"favorite,journal,scraps" or ["favorite", "journal", "scraps"]
.IP "Description:" 4
-Selects the subcategories to include when processing a user profile.
+A (comma-separated) list of subcategories to include
+when processing a user profile.
-Possible values are \f[I]"gallery"\f[], \f[I]"scraps"\f[], \f[I]"journal"\f[],
-\f[I]"favorite"\f[].
+Possible values are
+\f[I]"gallery"\f[], \f[I]"scraps"\f[], \f[I]"journal"\f[], \f[I]"favorite"\f[].
-It is also possible to use a string with the initial character of
-each subcategory, i.e. \f[I]"gsj"\f[] for
-\f[I]["gallery", "scraps", "journal"]\f[]
+You can use \f[I]"all"\f[] instead of listing all values separately.
.SS extractor.deviantart.journals
.IP "Type:" 6
@@ -869,6 +869,16 @@ Controls whether to choose the GIF or MP4 version of an animation.
Include *Story Highlights* when downloading a user profile.
(requires authentication)
+.SS extractor.instagram.videos
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]true\f[]
+
+.IP "Description:" 4
+Download video files.
+
.SS extractor.kissmanga.captcha
.IP "Type:" 6
\f[I]string\f[]
@@ -884,6 +894,25 @@ Controls how to handle redirects to CAPTCHA pages.
* \f[I]"wait\f[]: Ask the user to solve the CAPTCHA and wait.
+.SS extractor.newgrounds.include
+.IP "Type:" 6
+\f[I]string\f[] or \f[I]list\f[] of \f[I]strings\f[]
+
+.IP "Default:" 9
+\f[I]"art"\f[]
+
+.IP "Example:" 4
+"movies,audio" or ["movies", "audio"]
+
+.IP "Description:" 4
+A (comma-separated) list of subcategories to include
+when processing a user profile.
+
+Possible values are
+\f[I]"art"\f[], \f[I]"audio"\f[], \f[I]"movies"\f[].
+
+You can use \f[I]"all"\f[] instead of listing all values separately.
+
.SS extractor.oauth.browser
.IP "Type:" 6
\f[I]bool\f[]
@@ -975,7 +1004,7 @@ the \f[I]recursive\f[] extractor.
\f[I]integer\f[]
.IP "Default:" 9
-\f[I]500\f[]
+\f[I]0\f[]
.IP "Description:" 4
The value of the \f[I]limit\f[] parameter when loading
@@ -1197,6 +1226,16 @@ video extraction and download
* \f[I]false\f[]: Skip video Tweets
+.SS extractor.vsco.videos
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]true\f[]
+
+.IP "Description:" 4
+Download video files.
+
.SS extractor.wallhaven.api-key
.IP "Type:" 6
\f[I]string\f[]
@@ -1299,8 +1338,8 @@ alongside the actual output files.
.IP "Default:" 9
\f[I]null\f[]
-.IP "Examples:" 4
-\f[I]"32000"\f[], \f[I]"500k"\f[], \f[I]"2.5M"\f[]
+.IP "Example:" 4
+"32000", "500k", "2.5M"
.IP "Description:" 4
Maximum download rate in bytes per second.
@@ -1571,10 +1610,10 @@ or to let it run asynchronously.
\f[I]string\f[] or \f[I]list\f[] of \f[I]strings\f[]
.IP "Example:" 4
-
-* "convert {} {}.png && rm {}"
-
-* ["echo", "{user[account]}", "{id}"]
+"convert {} {}.png && rm {}",
+.br
+["echo", "{user[account]}", "{id}"]
+.br
.IP "Description:" 4
The command to run.
@@ -1620,8 +1659,8 @@ Select how to write metadata.
* \f[I]"tags"\f[]: \f[I]tags\f[] separated by newlines
-* \f[I]"custom"\f[]: result of applying \f[I]metadata.format\f[] to a file's
-metadata dictionary
+* \f[I]"custom"\f[]: result of applying \f[I]metadata.content-format\f[]
+to a file's metadata dictionary
.SS metadata.extension
.IP "Type:" 6
@@ -1631,9 +1670,26 @@ metadata dictionary
\f[I]"json"\f[] or \f[I]"txt"\f[]
.IP "Description:" 4
-Filename extension for metadata files.
+Filename extension for metadata files that will be appended to the
+original file names.
-.SS metadata.format
+.SS metadata.extension-format
+.IP "Type:" 6
+\f[I]string\f[]
+
+.IP "Example:" 4
+"{extension}.json",
+.br
+"json"
+.br
+
+.IP "Description:" 4
+Custom format string to build filename extensions for metadata
+files with, which will replace the original filename extensions.
+
+Note: \f[I]metadata.extension\f[] is ignored if this option is set.
+
+.SS metadata.content-format
.IP "Type:" 6
\f[I]string\f[]
@@ -1641,7 +1697,7 @@ Filename extension for metadata files.
"tags:\\n\\n{tags:J\\n}\\n"
.IP "Description:" 4
-Custom format string to build content of metadata files.
+Custom format string to build the content of metadata files with.
Note: Only applies for \f[I]"mode": "custom"\f[].
@@ -1845,6 +1901,17 @@ this cache.
(See \f[I]SSLContext.set_ciphers() <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_ciphers>\f[]
for details)
+.SS pyopenssl
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Use \f[I]pyOpenSSL <https://www.pyopenssl.org/en/stable/>\f[]-backed
+SSL-support.
+
.SH API TOKENS & IDS
.SS extractor.deviantart.client-id & .client-secret
.IP "Type:" 6
@@ -1965,19 +2032,19 @@ and put them in your configuration file
.IP "Type:" 6
\f[I]string\f[] or \f[I]integer\f[]
-.IP "Examples:" 4
-
-* \f[I]"2019-01-01T00:00:00"\f[]
-
-* \f[I]"2019"\f[] with \f[I]"%Y"\f[] as \f[I]date-format\f[]
-
-* \f[I]1546297200\f[]
+.IP "Example:" 4
+"2019-01-01T00:00:00",
+.br
+"2019" with "%Y" as \f[I]date-format\f[],
+.br
+1546297200
+.br
.IP "Description:" 4
A \f[I]Date\f[] value represents a specific point in time.
-* If given as \f[I]string\f[], it is parsed according to date-format_.
+* If given as \f[I]string\f[], it is parsed according to \f[I]date-format\f[].
* If given as \f[I]integer\f[], it is interpreted as UTC timestamp.
@@ -1985,15 +2052,15 @@ A \f[I]Date\f[] value represents a specific point in time.
.IP "Type:" 6
\f[I]string\f[] or \f[I]list\f[] of \f[I]strings\f[]
-.IP "Examples:" 4
-
-* \f[I]"file.ext"\f[]
-
-* \f[I]"~/path/to/file.ext"\f[]
-
-* \f[I]"$HOME/path/to/file.ext"\f[]
-
-* \f[I]["$HOME", "path", "to", "file.ext"]\f[]
+.IP "Example:" 4
+"file.ext",
+.br
+"~/path/to/file.ext",
+.br
+"$HOME/path/to/file.ext",
+.br
+["$HOME", "path", "to", "file.ext"]
+.br
.IP "Description:" 4
A \f[I]Path\f[] is a \f[I]string\f[] representing the location of a file
@@ -2015,7 +2082,7 @@ The path \f[I]C:\\path\\to\\file.ext\f[] has therefore to be written as
\f[I]object\f[]
-.IP "Examples:" 4
+.IP "Example:" 4
.. code::
{