]> jfr.im git - yt-dlp.git/commitdiff
[documentation] Clarify which deprecated options still work
authorpukkandan <redacted>
Wed, 21 Apr 2021 22:17:31 +0000 (03:47 +0530)
committerpukkandan <redacted>
Wed, 21 Apr 2021 22:49:33 +0000 (04:19 +0530)
README.md

index 9442c1ba70ced67958478a1100f3da1be2c9f9fc..5474a959cb1cc2699f6cdbbe05dbd235a6bf67d6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1265,41 +1265,57 @@ # DEPRECATED OPTIONS
 
 These are all the deprecated options and the current alternative to achieve the same effect
 
-    --cn-verification-proxy URL      --geo-verification-proxy URL
-    --id                             -o "%(id)s.%(ext)s"
-    -A, --auto-number                -o "%(autonumber)s-%(id)s.%(ext)s"
-    -t, --title                      -o "%(title)s-%(id)s.%(ext)s"
-    -l, --literal                    -o accepts literal names
+#### Not recommended
+While these options still work, their use is not recommended since there are other alternatives to achieve the same effect
+
     --all-formats                    -f all
     --all-subs                       --sub-langs all --write-subs
     --autonumber-size NUMBER         Use string formatting. Eg: %(autonumber)03d
     --autonumber-start NUMBER        Use internal field formatting like %(autonumber+NUMBER)s
     --metadata-from-title FORMAT     --parse-metadata "%(title)s:FORMAT"
-    --prefer-avconv                  avconv is no longer officially supported (Alias: --no-prefer-ffmpeg)
-    --prefer-ffmpeg                  Default (Alias: --no-prefer-avconv)
     --hls-prefer-native              --downloader "m3u8:native"
     --hls-prefer-ffmpeg              --downloader "m3u8:ffmpeg"
-    --avconv-location                avconv is no longer officially supported
-    -C, --call-home                  Not implemented
-    --no-call-home                   Default
-    --include-ads                    Not implemented
-    --no-include-ads                 Default
-    --write-srt                      --write-subs
+    --sponskrub-args ARGS            --ppa "sponskrub:ARGS"
+    --test                           Used by developers for testing extractors. Not intended for the end user
+
+
+#### Old aliases
+These are aliases that are no longer documented for various reasons
+
+    --avconv-location                --ffmpeg-location
+    --cn-verification-proxy URL      --geo-verification-proxy URL
+    --dump-headers                   --print-traffic
+    --dump-intermediate-pages        --dump-pages
+    --force-write-download-archive   --force-write-archive
+    --load-info                      --load-info-json
+    --no-split-tracks                --no-split-chapters
     --no-write-srt                   --no-write-subs
-    --srt-lang LANGS                 --sub-langs LANGS
     --prefer-unsecure                --prefer-insecure
     --rate-limit RATE                --limit-rate RATE
-    --force-write-download-archive   --force-write-archive
-    --dump-intermediate-pages        --dump-pages
-    --dump-headers                   --print-traffic
-    --youtube-print-sig-code         No longer supported
+    --split-tracks                   --split-chapters
+    --srt-lang LANGS                 --sub-langs LANGS
     --trim-file-names LENGTH         --trim-filenames LENGTH
+    --write-srt                      --write-subs
     --yes-overwrites                 --force-overwrites
-    --load-info                      --load-info-json
-    --split-tracks                   --split-chapters
-    --no-split-tracks                --no-split-chapters
-    --sponskrub-args ARGS            --ppa "sponskrub:ARGS"
-    --test                           Only used for testing extractors
+
+#### No longer supported
+These options may no longer work as intended
+
+    --prefer-avconv                  avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
+    --prefer-ffmpeg                  Default (Alias: --no-prefer-avconv)
+    -C, --call-home                  Not implemented
+    --no-call-home                   Default
+    --include-ads                    No longer supported
+    --no-include-ads                 Default
+    --youtube-print-sig-code         No longer supported
+    --id                             -o "%(id)s.%(ext)s"
+    -A, --auto-number                -o "%(autonumber)s-%(id)s.%(ext)s"
+    -t, --title                      -o "%(title)s-%(id)s.%(ext)s"
+    -l, --literal                    -o accepts literal names
+
+#### Removed
+Currently, there are no options that have been completely removed. But there are plans to remove the old output options `-A`,`-t`, `-l`, `--id` (which have been deprecated since 2014) in the near future. If you are still using these, please move to using `--output` instead
+
 
 
 # MORE