Sponskrub integration

[yt-dlp.git] / README.md

diff --git a/README.md b/README.md
index d9470eb18d28ee787a5669fe4c7394506ca79614..20d801555529da2b9c810a3c3a50d4aa7c6b6e9c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -321,6 +321,15 @@ ## Thumbnail images:
     --list-thumbnails                Simulate and list all available thumbnail
                                      formats
 
+## Internet Shortcut Options:
+    --write-link                     Write an internet shortcut file, depending on 
+                                     the current platform (.url/.webloc/.desktop). 
+                                     The URL may be cached by the OS.
+    --write-url-link                 Write a Windows internet shortcut file (.url). 
+                                     Note that the OS caches the URL based on the file path.
+    --write-webloc-link              Write a macOS internet shortcut file (.webloc)
+    --write-desktop-link             Write a Linux internet shortcut file (.desktop)
+
 ## Verbosity / Simulation Options:
     -q, --quiet                      Activate quiet mode
     --no-warnings                    Ignore warnings
@@ -344,6 +353,10 @@ ## Verbosity / Simulation Options:
                                      playlist information in a single line.
     --print-json                     Be quiet and print the video information as
                                      JSON (video is still being downloaded).
+    --force-write-archive            Force download archive entries to be written 
+                                     as far as no errors occur, even if -s or 
+                                     another simulation switch is used.
+                                     (Same as --force-download-archive)
     --newline                        Output progress bar as new lines
     --no-progress                    Do not print progress bar
     --console-title                  Display progress in console titlebar
@@ -407,6 +420,7 @@ ## Video Format Options:
                                      one is requested
     -F, --list-formats               List all available formats of requested
                                      videos
+    --list-formats-as-table          Present the output of -F in a more tabular form
     --youtube-skip-dash-manifest     Do not download the DASH manifests and
                                      related data on YouTube videos
     --youtube-skip-hls-manifest      Do not download the HLS manifests and
@@ -509,6 +523,19 @@ ## Post-processing Options:
     --convert-subs FORMAT            Convert the subtitles to other format
                                      (currently supported: srt|ass|vtt|lrc)
 
+## SponSkrub Options (SponsorBlock)
+    --sponskrub                      Use sponskrub to mark sponsored sections
+                                     with the data available in SponsorBlock API
+                                     (Youtube only)
+    --sponskrub-cut                  Cut out the sponsor sections instead of
+                                     simply marking them
+    --sponskrub-force                Run sponskrub even if the video was
+                                     already downloaded. Use with caution
+    --sponskrub-location             Location of the sponskrub binary;
+                                     either the path to the binary or its
+                                     containing directory
+    --sponskrub-args                 Give these arguments to sponskrub
+
 ## Extractor Options:
     --ignore-dynamic-mpd             Do not process dynamic DASH manifests
 
@@ -767,7 +794,7 @@ ## Filtering Formats
 
 Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain).
 
-Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the video hoster.
+Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the video hoster. Any other field made available by the extractor can also be used for filtering.
 
 Formats for which the value is not known are excluded unless you put a question mark (`?`) after the operator. You can combine format filters, so `-f "[height <=? 720][tbr>500]"` selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s.