From 65adb79fb6e6d5d5d9c3978e2ce6bd26fe89f36b Mon Sep 17 00:00:00 2001 From: Eitan Adler Date: Mon, 15 Oct 2012 21:45:56 -0400 Subject: Fix mandoc nits --- youtube-dl.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'youtube-dl.1') diff --git a/youtube-dl.1 b/youtube-dl.1 index a3100e9e4..c7315a4f9 100644 --- a/youtube-dl.1 +++ b/youtube-dl.1 @@ -1,4 +1,4 @@ -.TH youtube-dl 1 "" +.TH YOUTUBE-DL 1 "" .SH NAME .PP youtube-dl -- cgit v1.2.3 From 02531431f2e4fcf7e9888299a4e6a56fd7a672d5 Mon Sep 17 00:00:00 2001 From: Philipp Hagemeister Date: Tue, 27 Nov 2012 16:27:35 +0100 Subject: Extended documentation for output format in README (Closes #268) --- youtube-dl.1 | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) (limited to 'youtube-dl.1') diff --git a/youtube-dl.1 b/youtube-dl.1 index ae303b672..b94b9d419 100644 --- a/youtube-dl.1 +++ b/youtube-dl.1 @@ -139,6 +139,54 @@ You can configure youtube-dl by placing default arguments (such as \f[C]--extract-audio\ --no-mtime\f[] to always extract the audio and not copy the mtime) into \f[C]/etc/youtube-dl.conf\f[] and/or \f[C]~/.local/config/youtube-dl.conf\f[]. +.SH OUTPUT TEMPLATE +.PP +The \f[C]-o\f[] option allows users to indicate a template for the +output file names. +The basic usage is not to set any template arguments when downloading a +single file, like in +\f[C]youtube-dl\ -o\ funny_video.flv\ "http://some/video"\f[]. +However, it may contain special sequences that will be replaced when +downloading each video. +The special sequences have the format \f[C]%(NAME)s\f[]. +To clarify, that is a percent symbol followed by a name in parenthesis, +followed by a lowercase S. +Allowed names are: +.IP \[bu] 2 +\f[C]id\f[]: The sequence will be replaced by the video identifier. +.IP \[bu] 2 +\f[C]url\f[]: The sequence will be replaced by the video URL. +.IP \[bu] 2 +\f[C]uploader\f[]: The sequence will be replaced by the nickname of the +person who uploaded the video. +.IP \[bu] 2 +\f[C]upload_date\f[]: The sequence will be replaced by the upload date +in YYYYMMDD format. +.IP \[bu] 2 +\f[C]title\f[]: The sequence will be replaced by the video title. +ext\f[C]:\ The\ sequence\ will\ be\ replaced\ by\ the\ appropriate\ extension\ (like\ flv\ or\ mp4).\ epoch\f[]: +The sequence will be replaced by the Unix epoch when creating the file. +autonumber`: The sequence will be replaced by a five-digit number that +will be increased with each download, starting at zero. +.PP +The current default template is \f[C]%(id)s.%(ext)s\f[], but that will +be switchted to \f[C]%(title)s-%(id)s.%(ext)s\f[] (which can be +requested with \f[C]-t\f[] at the moment). +.PP +In some cases, you don\[aq]t want special characters such as 中, spaces, +or &, such as when transferring the downloaded filename to a Windows +system or the filename through an 8bit-unsafe channel. +In these cases, add the \f[C]--restrict-filenames\f[] flag to get a +shorter title: +.IP +.nf +\f[C] +$\ youtube-dl\ --get-filename\ -o\ "%(title)s.%(ext)s"\ BaW_jenozKc +youtube-dl\ test\ video\ \[aq]\[aq]_ä↭𝕐.mp4\ \ \ \ #\ All\ kinds\ of\ weird\ characters +$\ youtube-dl\ --get-filename\ -o\ "%(title)s.%(ext)s"\ BaW_jenozKc\ --restrict-filenames +youtube-dl_test_video_.mp4\ \ \ \ \ \ \ \ \ \ #\ A\ simple\ file\ name +\f[] +.fi .SH FAQ .SS Can you please put the -b option back? .PP -- cgit v1.2.3 From 877f4c45d3c42045cca9295a92f336e551c7eab8 Mon Sep 17 00:00:00 2001 From: Philipp Hagemeister Date: Tue, 27 Nov 2012 16:28:21 +0100 Subject: Fix output format doc --- youtube-dl.1 | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'youtube-dl.1') diff --git a/youtube-dl.1 b/youtube-dl.1 index b94b9d419..2f7f25f31 100644 --- a/youtube-dl.1 +++ b/youtube-dl.1 @@ -164,10 +164,15 @@ person who uploaded the video. in YYYYMMDD format. .IP \[bu] 2 \f[C]title\f[]: The sequence will be replaced by the video title. -ext\f[C]:\ The\ sequence\ will\ be\ replaced\ by\ the\ appropriate\ extension\ (like\ flv\ or\ mp4).\ epoch\f[]: -The sequence will be replaced by the Unix epoch when creating the file. -autonumber`: The sequence will be replaced by a five-digit number that -will be increased with each download, starting at zero. +.IP \[bu] 2 +\f[C]ext\f[]: The sequence will be replaced by the appropriate extension +(like flv or mp4). +.IP \[bu] 2 +\f[C]epoch\f[]: The sequence will be replaced by the Unix epoch when +creating the file. +.IP \[bu] 2 +\f[C]autonumber\f[]: The sequence will be replaced by a five-digit +number that will be increased with each download, starting at zero. .PP The current default template is \f[C]%(id)s.%(ext)s\f[], but that will be switchted to \f[C]%(title)s-%(id)s.%(ext)s\f[] (which can be -- cgit v1.2.3 From cc872b68a895bae05bd266cc59d53f6e3c638f6c Mon Sep 17 00:00:00 2001 From: Philipp Hagemeister Date: Tue, 27 Nov 2012 16:42:50 +0100 Subject: Actually merge #379 --- youtube-dl.1 | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'youtube-dl.1') diff --git a/youtube-dl.1 b/youtube-dl.1 index 2f7f25f31..17455136f 100644 --- a/youtube-dl.1 +++ b/youtube-dl.1 @@ -24,6 +24,11 @@ redistribute it or use it however you like. -i,\ --ignore-errors\ \ \ \ \ \ continue\ on\ download\ errors -r,\ --rate-limit\ LIMIT\ \ \ download\ rate\ limit\ (e.g.\ 50k\ or\ 44.6m) -R,\ --retries\ RETRIES\ \ \ \ number\ of\ retries\ (default\ is\ 10) +--buffer-size\ SIZE\ \ \ \ \ \ \ size\ of\ download\ buffer\ (e.g.\ 1024\ or\ 16k)\ (default +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ is\ 1024) +--no-resize-buffer\ \ \ \ \ \ \ do\ not\ automatically\ adjust\ the\ buffer\ size.\ By +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ default,\ the\ buffer\ size\ is\ automatically\ resized +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ from\ an\ initial\ value\ of\ SIZE. --dump-user-agent\ \ \ \ \ \ \ \ display\ the\ current\ browser\ identification --user-agent\ UA\ \ \ \ \ \ \ \ \ \ specify\ a\ custom\ user\ agent --list-extractors\ \ \ \ \ \ \ \ List\ all\ supported\ extractors\ and\ the\ URLs\ they -- cgit v1.2.3 From d94adc26383050aea502e1707fb015598398b4ae Mon Sep 17 00:00:00 2001 From: Philipp Hagemeister Date: Tue, 27 Nov 2012 16:58:50 +0100 Subject: Actually fix manpage (#473) --- youtube-dl.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'youtube-dl.1') diff --git a/youtube-dl.1 b/youtube-dl.1 index c66374a56..4508622d2 100644 --- a/youtube-dl.1 +++ b/youtube-dl.1 @@ -1,4 +1,4 @@ -.TH YOUTUBE-DL 1 "" +.TH YOUTUBE-DL 1 "" .SH NAME .PP youtube-dl -- cgit v1.2.3