aniani/gophernicus
1
0
Fork 0
mirror of https://github.com/gophernicus/gophernicus.git synced 2024-06-09 06:20:43 +00:00
Code

Merge pull request #101 from omar-polo/manpage

Browse Source 
some manpage fixes
This commit is contained in:
fosslinux 2022-01-22 11:57:46 +11:00 committed by GitHub
commit d4ed70f218
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
gophernicus.8
View File

@ -1,5 +1,5 @@
.Dd April 13, 2020 .Dd April 13, 2020
.Dt GOPHERNICUS 1 .Dt GOPHERNICUS 8
.Os .Os
.Sh NAME .Sh NAME
.Nm gophernicus .Nm gophernicus
@ -47,11 +47,12 @@
.Op Fl \&? .Op Fl \&?
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
is a gopher server. It serves almost compliant RFC 1436, with small is a gopher server.
changes to make it more modern. It serves almost compliant RFC 1436, with small changes to make it more
modern.
.Nm .Nm
supports userdirs, executable gophermaps, CGI, and virtual hosting (in the supports userdirs, executable gophermaps, CGI, and virtual hosting
limits of the RFC). .Pq in the limits of the RFC .
.Pp .Pp
.Nm .Nm
can log to can log to
@ -65,21 +66,17 @@ Changes the server hostname shown on the output menu.
The default is the fully qualified domain name of the machine. The default is the fully qualified domain name of the machine.
.It Fl p Ar port .It Fl p Ar port
Changes the server port shown on the output menu. Changes the server port shown on the output menu.
The default is The default is 70.
.Pa 70 .
.It Fl T Ar port .It Fl T Ar port
Changes the SSL/TLS port. Changes the SSL/TLS port.
The default is The default is 0 (disabled).
.Pa 0
(disabled).
.It Fl r Ar directory .It Fl r Ar directory
Set the document root of the server. Set the document root of the server.
The default is The default is
.Pa /var/gopher . .Pa /var/gopher .
.It Fl t Ar type .It Fl t Ar type
Set the default gopher filetype. Set the default gopher filetype.
The default is The default is 0.
.Pa 0 .
.It Fl g Ar mapfile .It Fl g Ar mapfile
Set the gophermap file name. Set the gophermap file name.
The default is The default is
@ -94,21 +91,22 @@ The default is
.Pa /cgi-bin/ . .Pa /cgi-bin/ .
.It Fl u Ar directory .It Fl u Ar directory
Set the name of the personal gopherspace directory. Set the name of the personal gopherspace directory.
Each user can deploy a personal gopherspace by creating a directory Each user can deploy a personal gopherspace by creating
.Pa directory .Ar directory
in their home directory. in their home directory.
The default is The default is
.Pa public_gopher . .Pa public_gopher .
.It Fl l Ar file .It Fl l Ar file
Log to Log to
.Pa file .Ar file
in Apache-compatible combined format. Disabled by default. in Apache-compatible combined format.
Disabled by default.
.It Fl w Ar width .It Fl w Ar width
Set default page width. Set default page width.
The default is The default is 67.
.Pa 67 .
.It Fl o Ar charset .It Fl o Ar charset
Select the output charset. It can be Select the output charset.
It can be one of
.Ar UTF-8 , .Ar UTF-8 ,
.Ar US-ASCII , .Ar US-ASCII ,
or or
@ -117,17 +115,13 @@ The default is
.Ar UTF-8 . .Ar UTF-8 .
.It Fl s Ar seconds .It Fl s Ar seconds
Session timeout in seconds. Session timeout in seconds.
The default is The default is 1800.
.Pa 1800 .
.It Fl i Ar hits .It Fl i Ar hits
Maximum hits until throttling. Maximum hits until throttling.
The default is The default is 4069.
.Pa 4069 .
.It Fl k Ar kilobytes .It Fl k Ar kilobytes
Maximum transfer size in KiB until throttling. Maximum transfer size in KiB until throttling.
The default is The default is 4194304 (4 GiB).
.Pa 4194304
(4 GiB).
.It Fl f Ar directory .It Fl f Ar directory
Set directory where output filters are found. Set directory where output filters are found.
Disabled by default. Disabled by default.
@ -156,7 +150,8 @@ Set the email of the administrator to appear in
.It Fl U Ar paths .It Fl U Ar paths
Set a colon-separated list of extra Set a colon-separated list of extra
.Xr unveil 2 .Xr unveil 2
paths (only for OpenBSD). paths
.Pq only for Ox .
.It Fl nv .It Fl nv
Disable virtual hosting. Disable virtual hosting.
.It Fl nl .It Fl nl
@ -193,6 +188,8 @@ By default,
will refuse to run as root. will refuse to run as root.
.It Fl np .It Fl np
Disable HAProxy proxy protocol. Disable HAProxy proxy protocol.
.It Fl nu
Disable personal gopherspaces.
.It Fl nx .It Fl nx
Disable execution of gophermaps and scripts. Disable execution of gophermaps and scripts.
.It Fl nH .It Fl nH
@ -223,7 +220,7 @@ mostly conforms to
.Lk https://tools.ietf.org/html/rfc1436 "RFC 1436" .Lk https://tools.ietf.org/html/rfc1436 "RFC 1436"
.Sh AUTHORS .Sh AUTHORS
.An -nosplit .An -nosplit
.An Kim Holviala. .An Kim Holviala
wrote the original implementation (2009\(en2018). wrote the original implementation (2009\(en2018).
.Pp .Pp
.An fosslinux .An fosslinux
@ -247,7 +244,7 @@ Copyright \(co
2009\(en2018. 2009\(en2018.
.Pp .Pp
Copyright \(co Copyright \(co
.An Nm gophernicus Ns \& developers .An gophernicus developers
2019. 2019.
.Pp .Pp
Licensed to you under the terms of the BSD 2-clause license. Licensed to you under the terms of the BSD 2-clause license.