aboutsummaryrefslogtreecommitdiffstats
path: root/data
diff options
context:
space:
mode:
authorLibravatarUnit 193 <unit193@ubuntu.com>2020-03-16 23:20:15 -0400
committerLibravatarUnit 193 <unit193@ubuntu.com>2020-03-16 23:20:15 -0400
commite8cc000750de972384f2f34d02d42222b4018ae9 (patch)
tree26eb0bacedff7480d29bafcf184ca529cf9f1d9f /data
parent4366125d2580982abb57bc65a26fc1fb8ef2a5df (diff)
New upstream version 1.13.2upstream/1.13.2
Diffstat (limited to 'data')
-rw-r--r--data/man/gallery-dl.12
-rw-r--r--data/man/gallery-dl.conf.5417
2 files changed, 280 insertions, 139 deletions
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1
index a2cd77d..304c345 100644
--- a/data/man/gallery-dl.1
+++ b/data/man/gallery-dl.1
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL" "1" "2020-01-19" "1.12.3" "gallery-dl Manual"
+.TH "GALLERY-DL" "1" "2020-03-14" "1.13.2" "gallery-dl Manual"
.\" disable hyphenation
.nh
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index d7bb941..4ad93f8 100644
--- a/data/man/gallery-dl.conf.5
+++ b/data/man/gallery-dl.conf.5
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL.CONF" "5" "2020-01-19" "1.12.3" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2020-03-14" "1.13.2" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -139,6 +139,18 @@ segment, which will be joined together and appended to the
.IP "Description:" 4
Directory path used as the base for all download destinations.
+.SS extractor.*.parent-directory
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Use an extractor's current target directory as
+\f[I]base-directory <extractor.*.base-directory_>\f[]
+for any spawned child extractors.
+
.SS extractor.*.path-restrict
.IP "Type:" 6
\f[I]string\f[]
@@ -155,12 +167,12 @@ in generated path segment names.
Special values:
-
+.br
* \f[I]"auto"\f[]: Use characters from \f[I]"unix"\f[] or \f[I]"windows"\f[]
depending on the local operating system
-
+.br
* \f[I]"unix"\f[]: \f[I]"/"\f[]
-
+.br
* \f[I]"windows"\f[]: \f[I]"\\\\\\\\|/<>:\\"?*"\f[]
Note: In a set with 2 or more characters, \f[I][]^-\\\f[] need to be
@@ -191,24 +203,24 @@ 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[].
-
+.br
* \f[I]true\f[]: Skip downloads
-
+.br
* \f[I]false\f[]: Overwrite already existing files
-
+.br
* \f[I]"abort"\f[]: Abort the current extractor run
-
+.br
* \f[I]"abort:N"\f[]: Skip downloads and abort extractor run
after \f[I]N\f[] consecutive skips
-
+.br
* \f[I]"exit"\f[]: Exit the program altogether
-
+.br
* \f[I]"exit:N"\f[]: Skip downloads and exit the program
after \f[I]N\f[] consecutive skips
-
+.br
* \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.)
@@ -233,18 +245,43 @@ Number of seconds to sleep before each download.
The username and password to use when attempting to log in to
another site.
-Specifying username and password is required for the
-\f[I]pixiv\f[], \f[I]nijie\f[], and \f[I]seiga\f[]
-modules and optional (but strongly recommended) for
-\f[I]danbooru\f[], \f[I]exhentai\f[], \f[I]idolcomplex\f[], \f[I]instagram\f[],
-\f[I]luscious\f[], \f[I]sankaku\f[], \f[I]tsumino\f[], and \f[I]twitter\f[].
+Specifying a username and password is required for
+
+.br
+* \f[I]pixiv\f[]
+.br
+* \f[I]nijie\f[]
+.br
+* \f[I]seiga\f[]
+
+and optional for
+
+.br
+* \f[I]danbooru\f[]
+.br
+* \f[I]e621\f[]
+.br
+* \f[I]exhentai\f[]
+.br
+* \f[I]idolcomplex\f[]
+.br
+* \f[I]instagram\f[]
+.br
+* \f[I]luscious\f[]
+.br
+* \f[I]sankaku\f[]
+.br
+* \f[I]tsumino\f[]
+.br
+* \f[I]twitter\f[]
These values can also be set via the \f[I]-u/--username\f[] and
\f[I]-p/--password\f[] command-line options or by using a \f[I].netrc\f[] file.
(see Authentication_)
-Note: The password for \f[I]danbooru\f[] is the API key found in your
-user profile, not the password for your account.
+Note: The password values for \f[I]danbooru\f[] and \f[I]e621\f[] should be
+the API keys found in your user profile, not your actual account
+password.
.SS extractor.*.netrc
.IP "Type:" 6
@@ -264,14 +301,23 @@ Enable the use of \f[I].netrc\f[] authentication data.
\f[I]null\f[]
.IP "Description:" 4
-Source to read additional cookies from.
+Source to read additional cookies from. Either as
+.br
+* the \f[I]Path\f[] to a Mozilla/Netscape format cookies.txt file or
+.br
+* a JSON \f[I]object\f[] specifying cookies as a name-to-value mapping
-* If this is a \f[I]Path\f[], it specifies a
-Mozilla/Netscape format cookies.txt file.
+Example:
+
+.. code::
+
+{
+"cookie-name": "cookie-value",
+"sessionid" : "14313336321%3AsabDFvuASDnlpb%3A31",
+"isAdult" : "1"
+}
-* If this is an \f[I]object\f[], its key-value pairs, which should both
-be \f[I]strings\f[], will be used as cookie-names and -values.
.SS extractor.*.cookies-update
.IP "Type:" 6
@@ -281,8 +327,9 @@ be \f[I]strings\f[], will be used as cookie-names and -values.
\f[I]true\f[]
.IP "Description:" 4
-If \f[I]extractor.*.cookies\f[] specifies a cookies.txt file, update its
-contents with cookies received during data extraction.
+If \f[I]extractor.*.cookies\f[] specifies the \f[I]Path\f[] to a cookies.txt
+file and it can be opened and parsed without errors,
+update its contents with cookies received during data extraction.
.SS extractor.*.proxy
.IP "Type:" 6
@@ -294,10 +341,10 @@ contents with cookies received during data extraction.
.IP "Description:" 4
Proxy (or proxies) to be used for remote connections.
-
+.br
* If this is a \f[I]string\f[], it is the proxy URL for all
outgoing requests.
-
+.br
* If this is an \f[I]object\f[], it is a scheme-to-proxy mapping to
specify different proxy URLs for each scheme.
It is also possible to set a proxy for a specific host by using
@@ -482,8 +529,8 @@ Note: The index of the first image is \f[I]1\f[].
\f[I]string\f[]
.IP "Description:" 4
-Like \f[I]image-range\f[], but applies to delegated URLs
-like manga-chapters, etc.
+Like \f[I]image-range <extractor.*.image-range_>\f[],
+but applies to delegated URLs like manga-chapters, etc.
.SS extractor.*.image-filter
.IP "Type:" 6
@@ -509,9 +556,15 @@ by \f[I]-K\f[] or \f[I]-j\f[].
.IP "Type:" 6
\f[I]string\f[]
+.IP "Example:" 4
+"lang == 'en'"
+.br
+"language == 'French' and 10 <= chapter < 20"
+.br
+
.IP "Description:" 4
-Like \f[I]image-filter\f[], but applies to delegated URLs
-like manga-chapters, etc.
+Like \f[I]image-filter <extractor.*.image-filter_>\f[],
+but applies to delegated URLs like manga-chapters, etc.
.SS extractor.*.image-unique
.IP "Type:" 6
@@ -559,6 +612,16 @@ See \f[I]strptime\f[] for a list of formatting directives.
.IP "Description:" 4
Try to follow external URLs of embedded players.
+.SS extractor.blogger.videos
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]true\f[]
+
+.IP "Description:" 4
+Download embedded videos hosted on https://www.blogger.com/
+
.SS extractor.danbooru.ugoira
.IP "Type:" 6
\f[I]bool\f[]
@@ -569,9 +632,9 @@ Try to follow external URLs of embedded players.
.IP "Description:" 4
Controls the download target for Ugoira posts.
-
+.br
* \f[I]true\f[]: Original ZIP archives
-
+.br
* \f[I]false\f[]: Converted video files
.SS extractor.deviantart.extra
@@ -597,9 +660,9 @@ Note: Enabling this option also enables deviantart.metadata_.
Select the directory structure created by the Gallery- and
Favorite-Extractors.
-
+.br
* \f[I]true\f[]: Use a flat directory structure.
-
+.br
* \f[I]false\f[]: Collect a list of all gallery-folders or
favorites-collections and transfer any further work to other
extractors (\f[I]folder\f[] or \f[I]collection\f[]), which will then
@@ -648,11 +711,11 @@ You can use \f[I]"all"\f[] instead of listing all values separately.
.IP "Description:" 4
Selects the output format of journal entries.
-
+.br
* \f[I]"html"\f[]: HTML with (roughly) the same layout as on DeviantArt.
-
+.br
* \f[I]"text"\f[]: Plain text with image references and HTML tags removed.
-
+.br
* \f[I]"none"\f[]: Don't download journals.
.SS extractor.deviantart.mature
@@ -720,9 +783,9 @@ The \f[I]refresh-token\f[] value you get from
Using a \f[I]refresh-token\f[] allows you to access private or otherwise
not publicly available deviations.
-Note: Authenticating with a \f[I]refresh-token\f[] requires persistent
-storage in a \f[I]cache file <cache.file_>\f[].
-Otherwise the token will become invalid after its first use.
+Note: The \f[I]refresh-token\f[] becomes invalid
+\f[I]after 3 months <https://www.deviantart.com/developers/authentication#refresh>\f[]
+or whenever your \f[I]cache file <cache.file_>\f[] is deleted or cleared.
.SS extractor.deviantart.wait-min
.IP "Type:" 6
@@ -804,14 +867,33 @@ Extract and download videos.
.IP "Description:" 4
Sets the maximum allowed size for downloaded images.
-
+.br
* If this is an \f[I]integer\f[], it specifies the maximum image dimension
(width and height) in pixels.
-
+.br
* If this is a \f[I]string\f[], it should be one of Flickr's format specifiers
(\f[I]"Original"\f[], \f[I]"Large"\f[], ... or \f[I]"o"\f[], \f[I]"k"\f[], \f[I]"h"\f[],
\f[I]"l"\f[], ...) to use as an upper limit.
+.SS extractor.furaffinity.include
+.IP "Type:" 6
+\f[I]string\f[] or \f[I]list\f[] of \f[I]strings\f[]
+
+.IP "Default:" 9
+\f[I]"gallery"\f[]
+
+.IP "Example:" 4
+"scraps,favorite" or ["scraps", "favorite"]
+
+.IP "Description:" 4
+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]"favorite"\f[].
+
+You can use \f[I]"all"\f[] instead of listing all values separately.
+
.SS extractor.gelbooru.api
.IP "Type:" 6
\f[I]bool\f[]
@@ -840,6 +922,18 @@ If the selected format is not available, \f[I]"mp4"\f[], \f[I]"webm"\f[]
and \f[I]"gif"\f[] (in that order) will be tried instead, until an
available format is found.
+.SS extractor.hitomi.metadata
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]true\f[]
+
+.IP "Description:" 4
+Try to extract
+\f[I]artist\f[], \f[I]group\f[], \f[I]parody\f[], and \f[I]characters\f[]
+metadata.
+
.SS extractor.imgur.mp4
.IP "Type:" 6
\f[I]bool\f[] or \f[I]string\f[]
@@ -850,12 +944,12 @@ available format is found.
.IP "Description:" 4
Controls whether to choose the GIF or MP4 version of an animation.
-
+.br
* \f[I]true\f[]: Follow Imgur's advice and choose MP4 if the
\f[I]prefer_video\f[] flag in an image's metadata is set.
-
+.br
* \f[I]false\f[]: Always choose GIF.
-
+.br
* \f[I]"always"\f[]: Always choose MP4.
.SS extractor.instagram.highlights
@@ -889,9 +983,9 @@ Download video files.
.IP "Description:" 4
Controls how to handle redirects to CAPTCHA pages.
-
+.br
* \f[I]"stop\f[]: Stop the current extractor run.
-
+.br
* \f[I]"wait\f[]: Ask the user to solve the CAPTCHA and wait.
.SS extractor.newgrounds.include
@@ -923,12 +1017,27 @@ You can use \f[I]"all"\f[] instead of listing all values separately.
.IP "Description:" 4
Controls how a user is directed to an OAuth authorization site.
-
+.br
* \f[I]true\f[]: Use Python's \f[I]webbrowser.open()\f[] method to automatically
open the URL in the user's browser.
-
+.br
* \f[I]false\f[]: Ask the user to copy & paste an URL from the terminal.
+.SS extractor.oauth.port
+.IP "Type:" 6
+\f[I]integer\f[]
+
+.IP "Default:" 9
+\f[I]6414\f[]
+
+.IP "Description:" 4
+Port number to listen on during OAuth authorization.
+
+Note: All redirects will go to http://localhost:6414/, regardless
+of the port specified here. You'll have to manually adjust the
+port number in your browser's address bar when using a different
+port than the default.
+
.SS extractor.photobucket.subalbums
.IP "Type:" 6
\f[I]bool\f[]
@@ -939,6 +1048,16 @@ open the URL in the user's browser.
.IP "Description:" 4
Download subalbums.
+.SS extractor.pixiv.user.avatar
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Download user avatars.
+
.SS extractor.pixiv.ugoira
.IP "Type:" 6
\f[I]bool\f[]
@@ -949,9 +1068,12 @@ Download subalbums.
.IP "Description:" 4
Download Pixiv's Ugoira animations or ignore them.
-These animations come as a \f[I].zip\f[] file containing all the single
+These animations come as a \f[I].zip\f[] file containing all
animation frames in JPEG format.
+Use an \f[I]ugoira\f[] post processor to convert them
+to watchable videos. (Example__)
+
.SS extractor.plurk.comments
.IP "Type:" 6
\f[I]bool\f[]
@@ -983,9 +1105,9 @@ during the extraction process.
.IP "Description:" 4
Controls how to handle redirects to CAPTCHA pages.
-
+.br
* \f[I]"stop\f[]: Stop the current extractor run.
-
+.br
* \f[I]"wait\f[]: Ask the user to solve the CAPTCHA and wait.
.SS extractor.recursive.blacklist
@@ -1066,9 +1188,9 @@ This value sets the maximum recursion depth.
Special values:
-
+.br
* \f[I]0\f[]: Recursion is disabled
-
+.br
* \f[I]-1\f[]: Infinite recursion (don't do this)
.SS extractor.reddit.refresh-token
@@ -1088,6 +1210,25 @@ authorized to do so,
but requests to the reddit API are going to be rate limited
at 600 requests every 10 minutes/600 seconds.
+.SS extractor.reddit.videos
+.IP "Type:" 6
+\f[I]bool\f[] or \f[I]string\f[]
+
+.IP "Default:" 9
+\f[I]true\f[]
+
+.IP "Description:" 4
+Control video download behavior.
+
+.br
+* \f[I]true\f[]: Download videos and use \f[I]youtube-dl\f[] to handle
+HLS and DASH manifests
+.br
+* \f[I]"ytdl"\f[]: Download videos and let \f[I]youtube-dl\f[] handle all of
+video extraction and download
+.br
+* \f[I]false\f[]: Ignore videos
+
.SS extractor.sankaku.wait-min & .wait-max
.IP "Type:" 6
\f[I]float\f[]
@@ -1161,11 +1302,11 @@ Search posts for inline images and videos.
\f[I]true\f[]
.IP "Description:" 4
-
+.br
* \f[I]true\f[]: Extract media from reblogged posts
-
+.br
* \f[I]false\f[]: Skip reblogged posts
-
+.br
* \f[I]"same-blog"\f[]: Skip reblogged posts unless the original post
is from the same blog
@@ -1222,18 +1363,18 @@ Extract \f[I]TwitPic <https://twitpic.com/>\f[] embeds.
\f[I]bool\f[] or \f[I]string\f[]
.IP "Default:" 9
-\f[I]false\f[]
+\f[I]true\f[]
.IP "Description:" 4
Control video download behavior.
-
+.br
* \f[I]true\f[]: Download videos and use \f[I]youtube-dl\f[] to handle
HLS \f[I].m3u8\f[] manifests
-
+.br
* \f[I]"ytdl"\f[]: Download videos and let \f[I]youtube-dl\f[] handle all of
video extraction and download
-
+.br
* \f[I]false\f[]: Skip video Tweets
.SS extractor.vsco.videos
@@ -1282,9 +1423,9 @@ Note: This requires 1 additional HTTP request for each post.
.IP "Description:" 4
Reverse the order of chapter URLs extracted from manga pages.
-
+.br
* \f[I]true\f[]: Start with the latest chapter
-
+.br
* \f[I]false\f[]: Start with the first chapter
.SH DOWNLOADER OPTIONS
@@ -1319,11 +1460,11 @@ to set file modification times.
.IP "Description:" 4
Controls the use of \f[I].part\f[] files during file downloads.
-
+.br
* \f[I]true\f[]: Write downloaded data into \f[I].part\f[] files and rename
them upon download completion. This mode additionally supports
resuming incomplete downloads.
-
+.br
* \f[I]false\f[]: Do not use \f[I].part\f[] files and write data directly
into the actual output files.
@@ -1451,9 +1592,9 @@ used to generate filenames for files downloaded with youtube-dl.
Special values:
-
+.br
* \f[I]null\f[]: generate filenames with \f[I]extractor.*.filename\f[]
-
+.br
* \f[I]"default"\f[]: use youtube-dl's default, currently \f[I]"%(title)s-%(id)s.%(ext)s"\f[]
Note: An output template other than \f[I]null\f[] might
@@ -1492,15 +1633,15 @@ All available options can be found in \f[I]youtube-dl's docstrings
.IP "Description:" 4
Controls the output string format and status indicators.
-
+.br
* \f[I]"null"\f[]: No output
-
+.br
* \f[I]"pipe"\f[]: Suitable for piping to other processes or files
-
+.br
* \f[I]"terminal"\f[]: Suitable for the standard Windows console
-
+.br
* \f[I]"color"\f[]: Suitable for terminals that understand ANSI escape codes and colors
-
+.br
* \f[I]"auto"\f[]: Automatically choose the best suitable output mode
.SS output.shorten
@@ -1525,12 +1666,12 @@ on one console line.
Controls the progress indicator when *gallery-dl* is run with
multiple URLs as arguments.
-
+.br
* \f[I]true\f[]: Show the default progress indicator
(\f[I]"[{current}/{total}] {url}"\f[])
-
+.br
* \f[I]false\f[]: Do not show any progress indicator
-
+.br
* Any \f[I]string\f[]: Show the progress indicator using this
as a custom \f[I]format string\f[]. Possible replacement keys are
\f[I]current\f[], \f[I]total\f[] and \f[I]url\f[].
@@ -1614,9 +1755,9 @@ in their default location.
.IP "Description:" 4
The action to take when files do not compare as equal.
-
+.br
* \f[I]"replace"\f[]: Replace/Overwrite the old version with the new one
-
+.br
* \f[I]"enumerate"\f[]: Add an enumeration index to the filename of the new
version like \f[I]skip = "enumerate" <extractor.*.skip_>\f[]
@@ -1654,13 +1795,13 @@ or to let it run asynchronously.
.IP "Description:" 4
The command to run.
-
+.br
* If this is a \f[I]string\f[], it will be executed using the system's
shell, e.g. \f[I]/bin/sh\f[]. Any \f[I]{}\f[] will be replaced
with the full path of a file or target directory, depending on
\f[I]exec.final\f[]
-
+.br
* If this is a \f[I]list\f[], the first element specifies the program
name and any further elements its arguments.
Each element of this list is treated as a \f[I]format string\f[] using
@@ -1689,12 +1830,12 @@ have been downloaded successfully.
.IP "Description:" 4
Select how to write metadata.
-
+.br
* \f[I]"json"\f[]: all metadata using \f[I]json.dump()
<https://docs.python.org/3/library/json.html#json.dump>\f[]
-
+.br
* \f[I]"tags"\f[]: \f[I]tags\f[] separated by newlines
-
+.br
* \f[I]"custom"\f[]: result of applying \f[I]metadata.content-format\f[]
to a file's metadata dictionary
@@ -1827,12 +1968,12 @@ Enable Two-Pass encoding.
.IP "Description:" 4
Controls the frame rate argument (\f[I]-r\f[]) for FFmpeg
-
+.br
* \f[I]"auto"\f[]: Automatically assign a fitting frame rate
based on delays between frames.
-
+.br
* any other \f[I]string\f[]: Use this value as argument for \f[I]-r\f[].
-
+.br
* \f[I]null\f[] or an empty \f[I]string\f[]: Don't set an explicit frame rate.
.SS ugoira.keep-files
@@ -1904,11 +2045,11 @@ Keep the actual files after writing them to a ZIP archive.
\f[I]"default"\f[]
.IP "Description:" 4
-
+.br
* \f[I]"default"\f[]: Write the central directory file header
once after everything is done or an exception is raised.
-
+.br
* \f[I]"safe"\f[]: Update the central directory file header
each time a file is stored in a ZIP archive.
@@ -1922,9 +2063,9 @@ case the Python interpreter gets shut down unexpectedly
\f[I]Path\f[]
.IP "Default:" 9
-
+.br
* \f[I]tempfile.gettempdir()\f[] + \f[I]".gallery-dl.cache"\f[] on Windows
-
+.br
* (\f[I]$XDG_CACHE_HOME\f[] or \f[I]"~/.cache"\f[]) + \f[I]"/gallery-dl/cache.sqlite3"\f[] on all other platforms
.IP "Description:" 4
@@ -1942,11 +2083,11 @@ this cache.
\f[I]true\f[]
.IP "Description:" 4
-
+.br
* \f[I]true\f[]: Update urllib3's default cipher list
-
+.br
* \f[I]false\f[]: Leave the default cipher list as is
-
+.br
* Any \f[I]string\f[]: Replace urllib3's default ciphers with these
(See \f[I]SSLContext.set_ciphers() <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_ciphers>\f[]
for details)
@@ -1968,25 +2109,25 @@ SSL-support.
\f[I]string\f[]
.IP "How To:" 4
-
+.br
* login and visit DeviantArt's
\f[I]Applications & Keys <https://www.deviantart.com/developers/apps>\f[]
section
-
+.br
* click "Register Application"
-
+.br
* scroll to "OAuth2 Redirect URI Whitelist (Required)"
and enter "https://mikf.github.io/gallery-dl/oauth-redirect.html"
-
+.br
* scroll to the bottom and agree to the API License Agreement.
Submission Policy, and Terms of Service.
-
+.br
* click "Save"
-
+.br
* copy \f[I]client_id\f[] and \f[I]client_secret\f[] of your new
application and put them in your configuration file
as \f[I]"client-id"\f[] and \f[I]"client-secret"\f[]
-
+.br
* get a new \f[I]refresh-token <extractor.deviantart.refresh-token_>\f[]
if necessary
@@ -1995,15 +2136,15 @@ if necessary
\f[I]string\f[]
.IP "How To:" 4
-
+.br
* login and \f[I]Create an App <https://www.flickr.com/services/apps/create/apply/>\f[]
in Flickr's \f[I]App Garden <https://www.flickr.com/services/>\f[]
-
+.br
* click "APPLY FOR A NON-COMMERCIAL KEY"
-
+.br
* fill out the form with a random name and description
and click "SUBMIT"
-
+.br
* copy \f[I]Key\f[] and \f[I]Secret\f[] and put them in your configuration
file
@@ -2020,19 +2161,19 @@ file
\f[I]string\f[]
.IP "How To:" 4
-
+.br
* login and visit the \f[I]apps <https://www.reddit.com/prefs/apps/>\f[]
section of your account's preferences
-
+.br
* click the "are you a developer? create an app..." button
-
+.br
* fill out the form, choose "installed app", preferably set
"http://localhost:6414/" as "redirect uri" and finally click
"create app"
-
+.br
* copy the client id (third line, under your application's name and
"installed app") and put it in your configuration file
-
+.br
* use "\f[I]Python:<application name>:v1.0 (by /u/<username>)\f[]" as
user-agent and replace \f[I]<application name>\f[] and \f[I]<username>\f[]
accordingly (see Reddit's
@@ -2043,15 +2184,15 @@ accordingly (see Reddit's
\f[I]string\f[]
.IP "How To:" 4
-
+.br
* login and \f[I]Apply for an API Key <https://api.smugmug.com/api/developer/apply>\f[]
-
+.br
* use a random name and description,
set "Type" to "Application", "Platform" to "All",
and "Use" to "Non-Commercial"
-
+.br
* fill out the two checkboxes at the bottom and click "Apply"
-
+.br
* copy \f[I]API Key\f[] and \f[I]API Secret\f[]
and put them in your configuration file
@@ -2060,20 +2201,20 @@ and put them in your configuration file
\f[I]string\f[]
.IP "How To:" 4
-
+.br
* login and visit Tumblr's
\f[I]Applications <https://www.tumblr.com/oauth/apps>\f[] section
-
+.br
* click "Register application"
-
+.br
* fill out the form: use a random name and description, set
https://example.org/ as "Application Website" and "Default
callback URL"
-
+.br
* solve Google's "I'm not a robot" challenge and click "Register"
-
+.br
* click "Show secret key" (below "OAuth Consumer Key")
-
+.br
* copy your \f[I]OAuth Consumer Key\f[] and \f[I]Secret Key\f[]
and put them in your configuration file
@@ -2093,9 +2234,9 @@ and put them in your configuration file
.IP "Description:" 4
A \f[I]Date\f[] value represents a specific point in time.
-
+.br
* If given as \f[I]string\f[], it is parsed according to \f[I]date-format\f[].
-
+.br
* If given as \f[I]integer\f[], it is interpreted as UTC timestamp.
.SS Path
@@ -2156,9 +2297,9 @@ The path \f[I]C:\\path\\to\\file.ext\f[] has therefore to be written as
.IP "Description:" 4
Extended logging output configuration.
-
+.br
* format
-
+.br
* General format string for logging messages
or a dictionary with format strings for each loglevel.
@@ -2169,39 +2310,39 @@ it is also possible to access the current
and \f[I]job <https://github.com/mikf/gallery-dl/blob/2e516a1e3e09cb8a9e36a8f6f7e41ce8d4402f5a/gallery_dl/job.py#L19>\f[]
objects as well as their attributes
(e.g. \f[I]"{extractor.url}"\f[])
-
+.br
* Default: \f[I]"[{name}][{levelname}] {message}"\f[]
-
+.br
* format-date
-
+.br
* Format string for \f[I]{asctime}\f[] fields in logging messages
(see \f[I]strftime() directives <https://docs.python.org/3/library/time.html#time.strftime>\f[])
-
+.br
* Default: \f[I]"%Y-%m-%d %H:%M:%S"\f[]
-
+.br
* level
-
+.br
* Minimum logging message level
(one of \f[I]"debug"\f[], \f[I]"info"\f[], \f[I]"warning"\f[], \f[I]"error"\f[], \f[I]"exception"\f[])
-
+.br
* Default: \f[I]"info"\f[]
-
+.br
* path
-
+.br
* \f[I]Path\f[] to the output file
-
+.br
* mode
-
+.br
* Mode in which the file is opened;
use \f[I]"w"\f[] to truncate or \f[I]"a"\f[] to append
(see \f[I]open() <https://docs.python.org/3/library/functions.html#open>\f[])
-
+.br
* Default: \f[I]"w"\f[]
-
+.br
* encoding
-
+.br
* File encoding
-
+.br
* Default: \f[I]"utf-8"\f[]
Note: path, mode and encoding are only applied when configuring