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

add manpage

closes #9
This commit is contained in:
fosslinux 2019-10-01 17:33:31 +10:00
parent 5c6f9c37e2
commit 34cbd01ac3
2 changed files with 77 additions and 0 deletions

View File

@ -22,6 +22,8 @@ DESTDIR = /usr
OSXDEST = /usr/local
SBINDIR = $(DESTDIR)/sbin
DOCDIR = $(DESTDIR)/share/doc/$(PACKAGE)
MANPAGE = gophernicus.1.man
MANDEST = $(DESTDIR)/share/man/man1/gophernicus.1
ROOT = /var/gopher
OSXROOT = /Library/GopherServer
@ -167,6 +169,7 @@ install-files: $(BINARY)
install-docs:
mkdir -p $(DOCDIR)
$(INSTALL) -m 644 $(DOCS) $(DOCDIR)
$(INSTALL) -m 644 $(MANPAGE) $(MANDEST)
@echo
install-root:

74
gophernicus.1.man Normal file
View File

@ -0,0 +1,74 @@
.\" Manpage for gophernicus.
.TH man 1 "31 Sep 2019" "3.0.1" "gophernicus man page"
.SH NAME
gophernicus - a modern, full-featured and secure gopher daemon
.SH SYNOPSIS
gophernicus [options]
.SH DESCRIPTION
gophernicus is a daemon that serves the gopher protocol. It serves almost fully
compliant RFC 1436, with a few very small changes to make it more modern.
gophernicus has many useful features, including userdirs, executable gophermaps,
virtual hosting as well as RFC supports it, unveil/pledge support on OpenBSD and
much more. It is fully FOSS, licensed under the BSD 2-Clause license.
.SH OPTIONS
-h hostname Change server hostname (FQDN) [$HOSTNAME]
-p port Change server port [70]
-T port Change TLS/SSL port [0 = disabled]
-r root Change gopher root [/var/gopher]
-t type Change default gopher filetype [0]
-g mapfile Change gophermap file [gophermap]
-a tagfile Change gophertag file [gophertag]
-c cgidir Change CGI script directory [/cgi-bin/]
-u userdir Change users personal gopherspace [public_gopher]
-l logfile Log to Apache-compatible combined format logfile
-w width Change default page width [76]
-o charset Change default output charset [UTF-8]
-s seconds Session timeout in seconds [1800]
-i hits Maximum hits until throttling [4096]
-k kbytes Maximum transfer until throttling [4194304]
-f filterdir Specify directory for output filters
-e ext=type Map file extension to gopher filetype
-R old=new Rewrite the beginning of a selector
-D text|file Set or load server description for caps.txt
-L text|file Set or load server location for caps.txt
-A admin Set admin email for caps.txt
-U paths Specify a colon-separated list of extra unveil(2) paths
(OpenBSD only).
-nv Disable virtual hosting
-nl Disable parent directory links
-nh Disable menu header (title)
-nf Disable menu footer
-nd Disable dates and filesizes in menus
-nc Disable file content detection
-no Disable charset conversion for output
-nq Disable HTTP-style query strings (?query)
-ns Disable logging to syslog
-na Disable autogenerated caps.txt
-nt Disable /server-status
-nm Disable shared memory use (for debugging)
-nr Disable root user checking (for debugging)
-np Disable HAproxy proxy protocol
-nx Disable execution of gophermaps and scripts
-nu Disable personal gopherspaces
-d Debug output in syslog and /server-status
-v Display version number and build date
-b Display the BSD license
-? Display this help
.SH AUTHOR
fosslinux and hb9kns; <gophernicus at gophernicus dot org>
.SH REPORTING BUGS
Please report bugs on our GitHub page: https://github.com/gophernicus/gophernicus.
.SH COPYRIGHT
Copyright (c) Kim Holavia 2009-2018
Copyright (c) Gophernicus Developers 2019
Licensed to you under the terms of the BSD 2-Clause license, please see LICENSE
for the full terms of the license.