summaryrefslogtreecommitdiff
path: root/gosher.8
diff options
context:
space:
mode:
Diffstat (limited to 'gosher.8')
-rw-r--r--gosher.862
1 files changed, 62 insertions, 0 deletions
diff --git a/gosher.8 b/gosher.8
new file mode 100644
index 0000000..138fa45
--- /dev/null
+++ b/gosher.8
@@ -0,0 +1,62 @@
+.\" The following requests are required for all man pages.
+.Dd July 23, 2018
+.Dt GOSHER 8 SMM
+.Os Linux
+.Sh NAME
+.Nm gosher
+.Nd a Gopher server in a shell script
+.Sh SYNOPSIS
+.Nm gosher
+.Op Ar PORT Op Ar GOPHERDIR
+.Sh DESCRIPTION
+.Pp
+.Ic gosher
+is a server for the Gopher protocol (RFC 1436) in a POSIX shell
+script.
+
+.Pp
+Gopher is a textual protocol for information exchange over the Internet,
+that provides a unified hierarchical menu-based interface. The Gopher
+protocol has assigned port 70 by IANA.
+
+.Pp
+.Ic gosher
+uses
+.Em netcat(1)
+to listen for incoming connections on the specified
+.Ar PORT
+(defaults to 70 if
+.Ar PORT
+is not specified) and makes available all the files under the folder
+.Ar GOPHERDIR
+(defaults to the current directory if not specified).
+
+
+
+.\" This next request is for sections 1, 6, 7 & 8 only
+.\".Sh ENVIRONMENT
+
+
+.\".Sh EXAMPLES
+.\" This next request is for sections 1, 6, 7 & 8 only
+.\" (command return values (to shell) and
+.\" fprintf/stderr type diagnostics)
+
+.\" .Sh DIAGNOSTICS
+.Sh SEE ALSO
+lynx(1), gopher(1), sacc(1), clic(1)
+.\" .Sh CONFORMING TO
+.\" .Sh HISTORY
+.Sh AUTHORS
+.Ic gosher
+is Free Software, distributed under the terms of the GNU
+General Public License (GPL), version 3 of the License.
+.Pp
+.Ic gosher
+is copyleft (c) 2018 by
+.An Vincenzo (KatolaZ) Nicosia <katolaz@freaknet.org>
+
+.Sh SECURITY CONSIDERATIONS
+It is recommended to run
+.Ic gosher
+under chroot(8).