]> git.sthu.org Git - oe1archive.git/commitdiff
Rephrasing help and README.markdown
authorStefan Huber <shuber@sthu.org>
Fri, 2 Jan 2026 21:52:40 +0000 (22:52 +0100)
committerStefan Huber <shuber@sthu.org>
Fri, 2 Jan 2026 21:52:40 +0000 (22:52 +0100)
README.markdown
oe1archive

index 4d76d779424d4232065d99d13ba4df1c35b6f443..2bd52f3309a2187f0357e048c5840c497d2ee622 100644 (file)
@@ -32,22 +32,26 @@ Browse all 30 days and download shows directly.
 
 ### Search Shows by Title and Subtitle
 ```bash
-./oe1archive -s "Show Name"
+./oe1archive -s "Show Name" -r 30
 ```
-Fast search across title and subtitle fields. **Takes approximately 10 seconds.** Use this for most searches.
+Fast search across title and subtitle fields. **Takes approximately 10
+seconds.**
 
 ### Extended Search (including descriptions)
 ```bash
-./oe1archive -s "Show Name" -e
+./oe1archive -s "Show Name" -e -r 30
 ```
-Search all available broadcasts including full description text. **Takes approximately 5 minutes.** Use this if the regular search doesn't find what you're looking for.
+Search all available broadcasts including full description text. **Takes
+approximately 5 minutes.** Use this if the regular search doesn't find what
+you're looking for.
 
 ### Batch Download
 ```bash
 ./oe1archive -d "Show Name" -p "prefix"
 ```
-Download all matching broadcasts with metadata and audio. Use `-e` flag for extended search:
-`./oe1archive -d "Show Name" -p "prefix" -e`
+Download all matching broadcasts with metadata and audio. Use `-e` flag for
+extended search:
+`./oe1archive -d "Show Name" -p "prefix" -e -r 30`
 
 ### Command Examples
 
@@ -59,18 +63,20 @@ Download all matching broadcasts with metadata and audio. Use `-e` flag for exte
 ./oe1archive -s "Show Name"
 
 # Deep search including descriptions
-./oe1archive -s "Some Keyword" -e
+./oe1archive -s "Some Keyword" -e -r 30
 
 # Batch download all matches (fast search)
-./oe1archive -d "Show Name" -p "prefix"
+./oe1archive -d "Show Name" -p "prefix" -r 30
 
 # Batch download all matches (deep search)
-./oe1archive -d "Some Keyword" -p "prefix" -e
+./oe1archive -d "Some Keyword" -p "prefix" -e -r 30
 ```
 
 ## How It Works
 
-The OE1 API provides a rolling weekly window of current broadcasts. Streams remain accessible via loopstream for ~30 days, enabling full month archive access through direct download without search requirements.
+The OE1 API provides a rolling weekly window of current broadcasts. Streams
+remain accessible via loopstream for ~30 days, enabling full month archive
+access through direct download without search requirements.
 
 ## Technical Details
 
index 5a311b07e69309e10bd5cead7b4970fb65b44eb4..78b8885ed6f02d345bfea4ccf2885d0b8fc295dc 100755 (executable)
@@ -473,24 +473,33 @@ def screen_help():
     """Display help information."""
     print("""OE1 Archive - Extended 30-day downloader
 
-Usage:
-    {0} -h, --help              Show this help message
-    {0} -c, --choose            Interactive mode - choose and download
-    {0} -s, --search TITLE      Search by title and subtitle (fast)
-    {0} -s TITLE -e             Extended search including description (slow)
-    {0} -d, --download TITLE    Auto-download all matching broadcasts
-                                 (requires directory prefix via -p)
-    {0} -p, --prefix PREFIX     Directory prefix for downloads
-    {0} -e, --extended-search   Extended search (use with -s or -d)
-    {0} -r, --range DAYS        Extended range from 8 days to given number
-                                    (max 30 days)
+OPTIONS:
+    -c, --choose            Interactive mode - choose and download
+    -d, --download TITLE    Auto-download all matching broadcasts
+                            (requires directory prefix via -p)
+    -e, --extended-search   Extended search (use with -s or -d)
+    -h, --help              Show this help message
+    -p, --prefix PREFIX     Directory prefix for downloads
+    -r, --range DAYS        Extended range from 8 days to given number
+                            (max 30 days)
+    -s, --search TITLE      Search by title and subtitle (fast)
 
 Examples:
-    {0} -c                      Choose broadcast interactively
-    {0} -s "Music"              Search title/subtitle for "Music" (fast)
-    {0} -s "Music" -e           Extended search including description (slow)
-    {0} -d "Brunch" -p "Brunch" Download all "Brunch" broadcasts
-    {0} -d "Brunch" -p "B" -e   Download using extended search
+
+  Search title/subtitle for "Music":
+    {0} -s "Music"
+
+  Choose broadcast interactively within past 14 days:
+    {0} -c -r 14
+
+  Extended search including description (very slow)
+    {0} -e -s "Music" -r 30
+
+  Download all "Brunch" broadcasts:
+    {0} -d "Brunch" -p "Brunch"
+
+   Download using extended search:
+    {0} -e -r 30 -d "Brunch" -p "Brunch"
 """.format(sys.argv[0]))