add man(1) generation

1 files changed, 31 insertions, 0 deletions

diff --git a/man/templates/pik.1.man.tmpl b/man/templates/pik.1.man.tmpl
new file mode 100644
index 0000000..53f1cfd
--- /dev/null
+++ b/man/templates/pik.1.man.tmpl
@@ -0,0 +1,31 @@
+{{- /*gotype: github.com/ewy1/pik/man.ManData*/ -}}
+.TH PIK 1 {{.Version}} {{.Runtime}}
+.sh NAME
+pik \- file based task runner
+.SH SYNOPSIS
+.B pik
+[\fIOPTION\fR]... [[\fISOURCE\fR] [\fITARGET\fR]] [\fIARG\fR]...
+.SH DESCRIPTION
+.B pik
+executes scripts from the .pik folder or external runners.
+.SH EXAMPLES
+Given a .pik folder in your current working directory containing "script.sh", calling
+.B pik script
+will start that script.
+.PP To start a script from another location, pass that as the SOURCE before the TARGET.
+Example:
+.B pik project build
+will start ../../.pik/build.py if it exists.
+.SH OPTIONS
+{{ range .Flags -}}
+.TP
+.BR \-\-{{.Name }} {{ if .Shorthand }}, \-{{ .Shorthand }}{{ end }} = {{ .Value.Type }} {{ if .DefValue }} ({{.DefValue}}) {{- end }}
+{{ .Usage }}
+{{ end }}
+.SH EXIT CODES
+If the target runs and returns a non-zero error code, we pass that forward instead.
+{{ range .ExitCodes -}}
+.TP
+.BR {{ .Value }}
+{{ .Message }}
+{{ end }}
\ No newline at end of file