A simple Gopher server in a POSIX shell script
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gosher/gosher.8

64 lines
1.5 KiB

.\" 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 GOPHERDIR Op Ar HOSTNAME Op Ar PORT
.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 HOSTNAME
(defaults to 'localhost' if not specified) and
.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).