aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristine Dodrill <me@christine.website>2018-12-09 08:57:47 -0800
committerChristine Dodrill <me@christine.website>2018-12-09 08:57:47 -0800
commitee6ceb9e97dec40abd80348dd05db2e45e84eecb (patch)
tree41a0ba810f21165f5b1b778078a8a1a9793f5bce /docs
parent223095c3f5da5ae63cddcecdfc16f0371afa9939 (diff)
downloadx-ee6ceb9e97dec40abd80348dd05db2e45e84eecb.tar.xz
x-ee6ceb9e97dec40abd80348dd05db2e45e84eecb.zip
quickserv manpage
Diffstat (limited to 'docs')
-rw-r--r--docs/man/quickserv.144
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/man/quickserv.1 b/docs/man/quickserv.1
new file mode 100644
index 0000000..5403140
--- /dev/null
+++ b/docs/man/quickserv.1
@@ -0,0 +1,44 @@
+.Dd December 12, 2017
+.Dt QUICKSERV 1 PRM
+
+
+.Sh NAME
+.Nm quickserv
+.Nd quickly and dirtily serve a folder as a HTTP server.
+
+
+.Sh SYNOPSIS
+.Nm
+.Op Fl dir
+.Op Fl port
+
+
+.Sh DESCRIPTION
+.Nm
+serves a local directory of files as an HTTP server.
+
+.Bl -tag -width " " -offset indent -compact
+
+.It Fl dir
+Specifies the local path to be served over HTTP.
+
+.It Fl port
+Specifies the TCP port that quickserv will bind to.
+
+.El
+
+
+.Sh EXAMPLES
+
+.Li quickserv
+
+.Li quickserv -dir ~/public_html -port 9001
+
+
+.Sh SEE ALSO
+
+.Bl -bullet
+
+.It
+.Lk hyperlink: https://godoc.org/net/http#Dir
+