Browse code

Updating documentation. Since that's important, or whatever.

Jenga Phoenix authored on 2019-03-16 16:31:19
Showing 1 changed files
... ...
@@ -14,7 +14,7 @@ Your terminal should accept ANSI color-codes, and be >79chars wide,
14 14
 for best experience~
15 15
 
16 16
 shelltube isn't for downloading videos-- it's for *browsing* for them.
17
-Use youtube-dl or something for that, that's not my job. :P
17
+Use youtube-dl or something for that. That's not my job! :P
18 18
 
19 19
 
20 20
 ----------------------------------------
... ...
@@ -24,7 +24,7 @@ Just place "ytlib.sh" in either the CWD, ./lib/ytlib.sh, /usr/lib/, or
24 24
 /usr/local/lib/
25 25
 
26 26
 Then put `gendl` and `yt` in your $PATH. /usr/local/bin/ is nice (IMO),
27
-or ~/bin/.
27
+or ~/bin/, or /usr/bin. Whatever floats your boat, lad.
28 28
 
29 29
 Profit!
30 30
 
... ...
@@ -85,24 +85,25 @@ Here are the actions:
85 85
 
86 86
 	SHORT	LONG      	ARGUMENTS
87 87
 	----------------------------------------------
88
-	-s	--search	[-csmb] search_query
89
-	-t	--title  	url/id
90
-	-d	--desc  	url/id
91
-	-v	--views  	url/id
92
-	-a	--author  	[-nu] url/id
93
-	-D	--date  	url/id
88
+	s	search  	[-UIcsmb] search_query
89
+	t	title    	url/id
90
+	d	desc    	url/id
91
+	v	views    	url/id
92
+	a	author   	[-nU] url/id
93
+	D	date    	url/id
94 94
 
95 95
 The only actions with weird arguments are --search and --author:
96
-	* normally, --author returns the channel URL and name on two
97
-	  seperate lines
98
-	* "--author -n" returns only the name
99
-	* "--author -u" returns only the URL
96
+	* normally, author returns the channel URL and name on one line
97
+	* "author -n" returns only the name
98
+	* "author -U" returns only the URL
100 99
 
101
-	* normally, --search prints results in the "big" format (title on
100
+	* normally, `search` prints results in the "big" format (title on
102 101
 	  one line, other metadata on second line)
103
-	* "--search -c" for "compact" format, etc.
102
+	* "search -c" for "compact" format, etc.
104 103
 	* "-c", "-s", "-m", "-b", for "compact", "small", "medium", and "big",
105 104
 	  respectively
105
+	* "-U" and "-I" are special-- they print the URL and the ID *only*,
106
+	  respectively. Good for making playlist files.
106 107
 
107 108
 
108 109
 YT PLAYLIST
... ...
@@ -115,40 +116,19 @@ Here are the actions:
115 116
 
116 117
 	SHORT	LONG      	ARGUMENTS
117 118
 	----------------------------------------------
118
-	-s	--search	[-csmb] search_query
119
-	-l	--list  	[-csmb] url/id
120
-	-t	--title  	url/id
121
-	-v	--views  	url/id
122
-	-a	--author  	[-nu] url/id
123
-	-D	--date   	url/id
119
+	s	search  	[-csmb] search_query
120
+	l	list    	[-csmb] url/id
121
+	t	title    	url/id
122
+	v	views    	url/id
123
+	a	author    	[-nu] url/id
124
+	D	date    	url/id
124 125
 
125
-The only actions with weird arguments are --search, --list and --author:
126
-	* --author acts just like "video --author"
127
-	* --search acts just like "video --search"
128
-	* --list acts just like --search, with [-csmb]
126
+The only actions with weird arguments are search, list and author:
127
+	* author acts just like "video author"
128
+	* search acts just like "video search"
129
+	* list acts just like search, with [-UIcsmb]
129 130
 
130 131
 
131
-YT CHANNEL
132
-`yt channel` is for anything related to channels-- here it is:
133
-
134
-	USAGE: yt (c)hannel [action]
135
-
136
-Here are the actions:
137
-
138
-	SHORT	LONG      	ARGUMENTS
139
-	----------------------------------------------
140
-	-s	--search	[-csmb] search_query
141
-	-l	--list  	[-csmb] url/id
142
-	-t	--title  	url/id
143
-	-d	--desc  	url/id
144
-	-v	--subscribers  	url/id
145
-	-D	--date   	url/id
146
-
147
-The only actions with weird arguments are --search, --list and --author:
148
-	* --search acts just like "video --search"
149
-	* --list acts just like "playlist --search"
150
-
151 132
 
152 133
 GENDL
153 134
 --------------------
... ...
@@ -162,9 +142,8 @@ gendl can download files on a system that has at least one of these:
162 142
 
163 143
 ... to stdout or to a file.
164 144
 
165
-yt-search and yt-desc use gendl--
166
-so make sure they're both in the same directory (or, at least, that
167
-gendl is in your $PATH)
145
+Both yt and ytlib.sh require gendl-- so make sure they're both in the same
146
+directory (or, at least, that gendl is in your $PATH)
168 147
 
169 148
 
170 149