Initial commit

3 files changed, 123 insertions, 0 deletions

diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..5ac3d05
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,37 @@
+.POSIX:
+
+PREFIX?=/usr/local
+_INSTDIR=$(DESTDIR)$(PREFIX)
+MANDIR?=$(_INSTDIR)/share/man
+
+DOCS := \
+	metube.1 \
+	metube.5
+
+
+RM?=rm -f
+
+all: doc
+
+%.1: %.1.scd
+		scdoc < $< > $@
+
+%.5: %.5.scd
+		scdoc < $< > $@
+
+doc: $(DOCS)
+
+clean:
+		$(RM) $(DOCS)
+			
+install: all
+		install -D -m 644 -t $(MANDIR)/man1 metube.1
+		install -D -m 644 -t $(MANDIR)/man5 metube.5
+
+uninstall:
+		$(RM) $(MANDIR)/man1/metube.1
+		$(RM) $(MANDIR)/man1/metube.5
+
+.DEFAULT_GOAL := doc
+
+.PHONY: all doc clean install uninstall
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.
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.