Makefile to recreate README

2024-12-23 09:48:39 +01:00 · 2011-08-25 00:09:28 +02:00 · 2011-08-25 00:09:28 +02:00 · 4618f3da74
commit 4618f3da74
parent eb0387a848
2 changed files with 59 additions and 55 deletions
--- a/15
+++ b/15
@ -0,0 +1,15 @@
+
+
+update-readme:
+	@options=$$(COLUMNS=80 ./youtube-dl --help | sed -e '1,/.*General Options.*/ d' -e 's/^\W\{2\}\(\w\)/### \1/') && \
+		header=$$(sed -e '/.*## OPTIONS/,$$ d' README.md) && \
+		footer=$$(sed -e '1,/.*## COPYRIGHT/ d' README.md) && \
+		echo "$${header}" > README.md && \
+		echo -e '\n## OPTIONS' >> README.md && \
+		echo "$${options}" >> README.md&& \
+		echo -e '\n## COPYRIGHT' >> README.md && \
+		echo "$${footer}" >> README.md
+
+
+
+.PHONY: update-readme
--- a/README.md
+++ b/README.md
@ -15,31 +15,28 @@ which means you can modify it, redistribute it or use it however you like.
    -v, --version            print program version and exit
    -U, --update             update this program to latest stable version
    -i, --ignore-errors      continue on download errors
-    -r LIMIT, --rate-limit=LIMIT
-                          download rate limit (e.g. 50k or 44.6m)
-    -R RETRIES, --retries=RETRIES
-                          number of retries (default is 10)
-    --playlist-start=NUMBER
-                          playlist video to start at (default is 1)
-    --playlist-end=NUMBER
-                          playlist video to end at (default is last)
+    -r, --rate-limit LIMIT   download rate limit (e.g. 50k or 44.6m)
+    -R, --retries RETRIES    number of retries (default is 10)
+    --playlist-start NUMBER  playlist video to start at (default is 1)
+    --playlist-end NUMBER    playlist video to end at (default is last)
    --dump-user-agent        display the current browser identification

-###  Authentication Options
-    -u USERNAME, --username=USERNAME
-                        account username
-    -p PASSWORD, --password=PASSWORD
-                        account password
-    -n, --netrc         use .netrc authentication data
+### Filesystem Options:
+    -t, --title              use title in file name
+    -l, --literal            use literal title in file name
+    -A, --auto-number        number downloaded files starting from 00000
+    -o, --output TEMPLATE    output filename template
+    -a, --batch-file FILE    file containing URLs to download ('-' for stdin)
+    -w, --no-overwrites      do not overwrite files
+    -c, --continue           resume partially downloaded files
+    --cookies FILE           file to dump cookie jar to
+    --no-part                do not use .part files
+    --no-mtime               do not use the Last-modified header to set the file
+                             modification time
+    --write-description      write video description to a .description file
+    --write-info-json        write video metadata to a .info.json file

-###  Video Format Options
-    -f FORMAT, --format=FORMAT
-                        video format code
-    --all-formats       download all available video formats
-    --max-quality=FORMAT
-                        highest quality format to download
-
-### Verbosity / Simulation Options
+### Verbosity / Simulation Options:
    -q, --quiet              activates quiet mode
    -s, --simulate           do not download video
    -g, --get-url            simulate, quiet but print URL
@ -50,27 +47,20 @@ which means you can modify it, redistribute it or use it however you like.
    --no-progress            do not print progress bar
    --console-title          display progress in console titlebar

-### Filesystem Options
-    -t, --title         use title in file name
-    -l, --literal       use literal title in file name
-    -A, --auto-number   number downloaded files starting from 00000
-    -o TEMPLATE, --output=TEMPLATE
-                        output filename template
-    -a FILE, --batch-file=FILE
-                        file containing URLs to download ('-' for stdin)
-    -w, --no-overwrites
-                        do not overwrite files
-    -c, --continue      resume partially downloaded files
-    --cookies=FILE      file to dump cookie jar to
-    --no-part           do not use .part files
-    --no-mtime          do not use the Last-modified header to set the file
-                        modification time
+### Video Format Options:
+    -f, --format FORMAT      video format code
+    --all-formats            download all available video formats
+    --max-quality FORMAT     highest quality format to download
+
+### Authentication Options:
+    -u, --username USERNAME  account username
+    -p, --password PASSWORD  account password
+    -n, --netrc              use .netrc authentication data

 ### Post-processing Options:
    --extract-audio          convert video files to audio-only files (requires
                             ffmpeg and ffprobe)
-    --audio-format=FORMAT
-                        "best", "aac" or "mp3"; best by default
+    --audio-format FORMAT    "best", "aac" or "mp3"; best by default

 ## COPYRIGHT
 **youtube-dl**: Copyright © 2006-2011 Ricardo Garcia Gonzalez. The program is
@ -80,4 +70,3 @@ likewise released into the public domain.

 ## BUGS
 Bugs should be reported at: <https://github.com/rg3/youtube-dl/issues>
-