aboutsummaryrefslogtreecommitdiff
path: root/doc/metube.1.scd
diff options
context:
space:
mode:
Diffstat (limited to 'doc/metube.1.scd')
-rw-r--r--doc/metube.1.scd42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/metube.1.scd b/doc/metube.1.scd
new file mode 100644
index 0000000..114807a
--- /dev/null
+++ b/doc/metube.1.scd
@@ -0,0 +1,42 @@
+metube(1)
+
+# NAME
+
+metube - A youtube searching program
+
+# DESCRIPTION
+
+metube is a program for searching youtube and extracting video information such
+as the title, channel, url, length...
+
+It uses ytparser under the hood.
+
+# OPTIONS
+
+*-h*
+ Display a help message.
+
+*-f string*
+ The format to print items in. Follows go template syntax. See metube(5)
+ for more info. (default "channel: {{.ChannelTitle}}, title: {{.Title}}, url:
+ {{.Url}}")
+
+*-l string*
+ The language to search in (follows youtube's language codes: en, fr, de,
+ jp...) (default "en")
+
+*-o string*
+ The criterion to use for the search order (relevance, date, views, rating)
+ (default "relevance")
+
+*-p int*
+ The page to get
+
+# SEE ALSO
+
+*metube*(5)
+
+# AUTHORS
+
+Maintained by Julian Hurst <julian.hurst92@gmail.com>. For more information
+about metube, see https://git.sr.ht/~ark/metube.