summaryrefslogtreecommitdiff
path: root/gosher.8
blob: a3ae9af19661f695346b9ab5d1ae4c3fb64d6da3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.\" 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
.Nm
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
.Nm
uses
.Xr nc 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).
.Sh SEE ALSO
.Xr clic 1 ,
.Xr gopher 1 ,
.Xr lynx 1 ,
.Xr sacc 1 ,
.Sh AUTHORS
.Nm
is Free Software, distributed under the terms of the GNU
General Public License (GPL), version 3 of the License.
.Pp
.Nm
is copyleft (c) 2018 by
.An Vincenzo (KatolaZ) Nicosia Aq Mt katolaz@freaknet.org
.Sh SECURITY CONSIDERATIONS
It is recommended to run
.Nm
under
.Xr chroot 8 .