From 81db2d80400ebefce061fdaf0c7c4fe6e4ee7538 Mon Sep 17 00:00:00 2001 From: Philipp Hagemeister Date: Tue, 27 Nov 2012 16:06:59 +0100 Subject: [PATCH] Document --restrict-filenames, remove stitle --- documentation.html | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/documentation.html b/documentation.html index b2d6eae89..2caee1ff7 100644 --- a/documentation.html +++ b/documentation.html @@ -90,14 +90,20 @@ Unsupported, see https://github.com/rg3/youtube-dl/issues/300
  • url: The sequence will be replaced by the video URL.
  • uploader: The sequence will be replaced by the nickname of the person who uploaded the video.
  • upload_date: The sequence will be replaced by the upload date in YYYYMMDD format.
    • -
  • title: The sequence will be replaced by the literal video title.
    • -
  • stitle: The sequence will be replaced by a simplified video title, restricted to alphanumeric characters and dashes.
    • +
  • title: The sequence will be replaced by the video title.
  • ext: The sequence will be replaced by the appropriate extension (like flv or mp4).
  • epoch: 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.
    • -

    As you may have guessed, the default template is %(id)s.%(ext)s. When some command line options are used, it's replaced by other templates like %(stitle)s-%(id)s.%(ext)s. You can specify your own.

    +

    The current default template is %(id)s.%(ext)s, but that will be switchted to %(title)s-%(id)s.%(ext)s (which can be requested with -t at the moment).

    + +

    In some cases, you don'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 --restrict-filenames flag to get a shorter title:

    + +

    $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc +youtube-dl test video ''_ä↭𝕐.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

    Configuration