improving table of contents

2024-11-16 06:15:46 +00:00 · 2021-06-29 11:21:37 -07:00 · 2021-06-29 11:21:37 -07:00 · f297981f09
commit f297981f09
parent 7fb9564420
1 changed files with 78 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -3,17 +3,94 @@

 youtube-dl - download videos from youtube.com or other video platforms

+
 - [INSTALLATION](#installation)
 - [DESCRIPTION](#description)
 - [OPTIONS](#options)
+  - [Network Options:](#network-options)
+  - [Geo Restriction:](#geo-restriction)
+  - [Video Selection:](#video-selection)
+  - [Download Options:](#download-options)
+  - [Filesystem Options:](#filesystem-options)
+  - [Thumbnail Options:](#thumbnail-options)
+  - [Verbosity / Simulation Options:](#verbosity--simulation-options)
+  - [Workarounds:](#workarounds)
+  - [Video Format Options:](#video-format-options)
+  - [Subtitle Options:](#subtitle-options)
+  - [Authentication Options:](#authentication-options)
+  - [Adobe Pass Options:](#adobe-pass-options)
+  - [Post-processing Options:](#post-processing-options)
 - [CONFIGURATION](#configuration)
+    - [Authentication with `.netrc` file](#authentication-with-netrc-file)
 - [OUTPUT TEMPLATE](#output-template)
+      - [Output template and Windows batch files](#output-template-and-windows-batch-files)
+      - [Output template examples](#output-template-examples)
 - [FORMAT SELECTION](#format-selection)
- [VIDEO SELECTION](#video-selection)
+      - [Format selection examples](#format-selection-examples)
+- [VIDEO SELECTION](#video-selection-1)
 - [FAQ](#faq)
+    - [How do I update youtube-dl?](#how-do-i-update-youtube-dl)
+    - [youtube-dl is extremely slow to start on Windows](#youtube-dl-is-extremely-slow-to-start-on-windows)
+    - [I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists](#im-getting-an-error-unable-to-extract-opengraph-title-on-youtube-playlists)
+    - [I'm getting an error when trying to use output template: `error: using output template conflicts with using title, video ID or auto number`](#im-getting-an-error-when-trying-to-use-output-template-error-using-output-template-conflicts-with-using-title-video-id-or-auto-number)
+    - [Do I always have to pass `-citw`?](#do-i-always-have-to-pass--citw)
+    - [Can you please put the `-b` option back?](#can-you-please-put-the--b-option-back)
+    - [I get HTTP error 402 when trying to download a video. What's this?](#i-get-http-error-402-when-trying-to-download-a-video-whats-this)
+    - [Do I need any other programs?](#do-i-need-any-other-programs)
+    - [I have downloaded a video but how can I play it?](#i-have-downloaded-a-video-but-how-can-i-play-it)
+    - [I extracted a video URL with `-g`, but it does not play on another machine / in my web browser.](#i-extracted-a-video-url-with--g-but-it-does-not-play-on-another-machine--in-my-web-browser)
+    - [ERROR: no fmt_url_map or conn information found in video info](#error-no-fmt_url_map-or-conn-information-found-in-video-info)
+    - [ERROR: unable to download video](#error-unable-to-download-video)
+    - [Video URL contains an ampersand and I'm getting some strange output `[1] 2839` or `'v' is not recognized as an internal or external command`](#video-url-contains-an-ampersand-and-im-getting-some-strange-output-1-2839-or-v-is-not-recognized-as-an-internal-or-external-command)
+    - [ExtractorError: Could not find JS function u'OF'](#extractorerror-could-not-find-js-function-uof)
+    - [HTTP Error 429: Too Many Requests or 402: Payment Required](#http-error-429-too-many-requests-or-402-payment-required)
+    - [SyntaxError: Non-ASCII character](#syntaxerror-non-ascii-character)
+    - [What is this binary file? Where has the code gone?](#what-is-this-binary-file-where-has-the-code-gone)
+    - [The exe throws an error due to missing `MSVCR100.dll`](#the-exe-throws-an-error-due-to-missing-msvcr100dll)
+    - [On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?](#on-windows-how-should-i-set-up-ffmpeg-and-youtube-dl-where-should-i-put-the-exe-files)
+    - [How do I put downloads into a specific folder?](#how-do-i-put-downloads-into-a-specific-folder)
+    - [How do I download a video starting with a `-`?](#how-do-i-download-a-video-starting-with-a--)
+    - [How do I pass cookies to youtube-dl?](#how-do-i-pass-cookies-to-youtube-dl)
+    - [How do I stream directly to media player?](#how-do-i-stream-directly-to-media-player)
+    - [How do I download only new videos from a playlist?](#how-do-i-download-only-new-videos-from-a-playlist)
+    - [Should I add `--hls-prefer-native` into my config?](#should-i-add---hls-prefer-native-into-my-config)
+    - [Can you add support for this anime video site, or site which shows current movies for free?](#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free)
+    - [How can I speed up work on my issue?](#how-can-i-speed-up-work-on-my-issue)
+    - [How can I detect whether a given URL is supported by youtube-dl?](#how-can-i-detect-whether-a-given-url-is-supported-by-youtube-dl)
+- [Why do I need to go through that much red tape when filing bugs?](#why-do-i-need-to-go-through-that-much-red-tape-when-filing-bugs)
 - [DEVELOPER INSTRUCTIONS](#developer-instructions)
+    - [Adding support for a new site](#adding-support-for-a-new-site)
+  - [youtube-dl coding conventions](#youtube-dl-coding-conventions)
+    - [Mandatory and optional metafields](#mandatory-and-optional-metafields)
+      - [Example](#example)
+    - [Provide fallbacks](#provide-fallbacks)
+      - [Example](#example-1)
+    - [Regular expressions](#regular-expressions)
+      - [Don't capture groups you don't use](#dont-capture-groups-you-dont-use)
+        - [Example](#example-2)
+      - [Make regular expressions relaxed and flexible](#make-regular-expressions-relaxed-and-flexible)
+        - [Example](#example-3)
+    - [Long lines policy](#long-lines-policy)
+    - [Inline values](#inline-values)
+      - [Example](#example-4)
+    - [Collapse fallbacks](#collapse-fallbacks)
+      - [Example](#example-5)
+    - [Trailing parentheses](#trailing-parentheses)
+      - [Example](#example-6)
+    - [Use convenience conversion and parsing functions](#use-convenience-conversion-and-parsing-functions)
+      - [More examples](#more-examples)
+        - [Safely extract optional description from parsed JSON](#safely-extract-optional-description-from-parsed-json)
+        - [Safely extract more optional metadata](#safely-extract-more-optional-metadata)
 - [EMBEDDING YOUTUBE-DL](#embedding-youtube-dl)
 - [BUGS](#bugs)
+    - [Is the description of the issue itself sufficient?](#is-the-description-of-the-issue-itself-sufficient)
+    - [Are you using the latest version?](#are-you-using-the-latest-version)
+    - [Is the issue already documented?](#is-the-issue-already-documented)
+    - [Why are existing options not enough?](#why-are-existing-options-not-enough)
+    - [Is there enough context in your bug report?](#is-there-enough-context-in-your-bug-report)
+    - [Does the issue involve one problem, and one problem only?](#does-the-issue-involve-one-problem-and-one-problem-only)
+    - [Is anyone going to need the feature?](#is-anyone-going-to-need-the-feature)
+    - [Is your question about youtube-dl?](#is-your-question-about-youtube-dl)
 - [COPYRIGHT](#copyright)

 # INSTALLATION