aboutsummaryrefslogtreecommitdiff
path: root/doc/metube.5.scd
diff options
context:
space:
mode:
Diffstat (limited to 'doc/metube.5.scd')
-rw-r--r--doc/metube.5.scd44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/metube.5.scd b/doc/metube.5.scd
new file mode 100644
index 0000000..22aa9a6
--- /dev/null
+++ b/doc/metube.5.scd
@@ -0,0 +1,44 @@
+metube(5)
+
+# NAME
+
+metube - Video information format for metube(1)
+
+# FORMAT
+
+The format follows go's template format and provides the following variables:
+
+*Id*
+ The id of the video.
+
+*Title*
+ The video's title.
+
+*Url*
+ The youtube url of the video.
+
+*ThumbUrl*
+ The url of the video's thumbnail.
+
+*ChannelId*
+ The id of the video's channel.
+
+*ChannelTitle*
+ The title of the video's channel.
+
+*ChannelUrl*
+ The url of the video's channel.
+
+*Published*
+ The video's published date provided by youtube.
+
+*LengthText*
+ The length of the video.
+
+# SEE ALSO
+
+*metube*(1)
+
+# AUTHOR
+
+Maintained by Julian Hurst <julian.hurst92@gmail.com>. For more information about metube, see https://git.sr.ht/~ark/metube.