Gophernicus documentation
DIR ..
DIR examples 2025-Aug-28 17:22 --------
TEXT ChangeLog 2016-Nov-04 12:56 13.4 KB
TEXT INSTALL 2016-Nov-04 12:56 4.5 KB
TEXT LICENSE 2016-Nov-04 12:56 1.3 KB
TEXT README 2016-Nov-04 12:56 9.6 KB
TEXT README.Debian 2021-May-28 16:39 1.2 KB
TEXT README.Gophermap 2016-Nov-04 12:56 3.4 KB
Sample gophermap for Gophernicus
Creating a file called "gophermap" into a directory disables the
normal resource listing and replaces it with the contents of the map
file. You can also have inline gophermaps - files with a ".gophermap"
extension are parsed as gophermaps and displayed in between normal
resources in alphabetical order.
In a gophermap any line that doesn't contain a <TAB> character is
automatically converted to an type "i" gopher resource which are
displayed as plain text in the client. Lines which contain tabs are
intepreted as gopher resource lines which the client will render as
links. The first line of a gophermap should be a !Title line
describing the menu.
Dynamic gophermaps are possible by making the gophermap a script and
marking it as executable. All script output is parsed just like a
static gophermap, for example lines without tabs are converted to "i"
resources. Executable gophermaps are always ran through the default
shell (/bin/sh) so depending on your operating system that's either
slow, or really unbearably slow...
The format of a gophermap resource line is simple:
Xname<TAB>selector<TAB>host<TAB>port
Where:
X is the gopher filetype
name is an explanation of the resource
selector is the path to resource
host:port are the hostname and port number to go to
Type and name are mandatory. If you don't specify a selector, the
name field will be also used as the selector. If you don't specify
host or port the host:port of the current server are used instead.
Also make sure to use ONLY ONE TAB between the fields.
Valid filetypes include:
0 text file
1 directory
3 error message
5 archive file (zip, tar etc)
7 search query
8 telnet session
9 binary file
g GIF image
h HTML file
i info text
I generic image file (other than GIF)
d document file (ps, pdf, doc etc)
s sound file
; video file
c calendar file
M MIME file (mbox, emails etc)
Additional type characters supported by Gophernicus:
# comment - rest of the line is ignored
!title menu title (use on the first line)
-file hide file from listings
:ext=type change filetype (for this directory only)
~ include a list of users with valid ~/public_gopher
% include a list of available virtual hosts
=mapfile include or execute other gophermap
* stop processing gophermap, include file listing
. stop processing gophermap (default)
Examples of valid resource lines:
1subdir
DIR Relative internal link
DIR Absolute internal link
DIR External link
DIR External relative link (which shouldn't work)
TEXT Finger-to-gopher link
HTML Link to a website
HTML Link to a local html page
DOS Link to an tar archive
BIN Link to a binary file
TELNET Telnet session
Include links to users own gopherspaces:
List all available virtual hosts:
Include sub-gophermap:
Gophernicus - Copyright (c) 2009-2016 Kim Holviala <kim@holviala.com>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Execute script and parse output as subgophermap:
02:53:29 up 30 days, 4:50, 1 user, load average: 1.38, 1.41, 1.19
Here we stop processing the gophermap and include the regular menu:
DOS README.md.gz 2024-Jul-08 00:30 5.6 KB
TEXT TODO 2016-Nov-04 12:56 0.3 KB
DOS changelog.Debian.gz 2024-Jul-08 00:30 0.8 KB
DOS changelog.gz 2021-Jan-03 02:44 1.3 KB
TEXT copyright 2021-May-28 16:39 2.6 KB
____________________________________________________________________________________________________
Gophered by Gophernicus/3.1.1 on Debian/13 x86_64