navopher

Small utility that generates a gophermap for a phlog (gopher log - analogous to blog) based on the contents of a directory.

Build

Dependencies

To install glib run:

$ sudo apt install libglib2.0-dev

$ brew install glib

Or use the package manager of your platform.

Compile

To compile run:

$ make

(or gmake depending on the platform)

Use

$ navopher DIRECTORY FILE

navopher must be invoked with two command line arguments.

DIRECTORY is a path to the directory containing the phlog text files making up your phlog. Only *.txt and *.md files are used to create the file list for the resulting gophermap. The files should have names using the following format:

YYYY-MM-DD__Phlog_Title.txt

navopher converts this to the following gophermap line:

0[YYYY-MM-DD] Phlog Title    YYYY-MM-DD__Phlog_Title.txt

Directory names within DIRECTORY are converted similarly.

*.glink files contain selectors pointing to files on another server. The name of a glink file is similar to that of a regular phlog entry:

YYYY-MM-DD__Phlog_on_Server_X.glink

The glink's content is the following:

dir/Phlog_on_Server_X.txt   serverx.org   70

The selector simply gets copied to the resulting gophermap with the type 0.

The gophermap file in DIRECTORY will always be overwritten with the newly generated one!

Template directives

FILE is the name of the template file within DIRECTORY. This is the template for the generated gophermap.

Currently two directives are recognized:

{{ FILE_LIST }} - the line containing this directive in the template will be replaced by the converted file list
{{ ARCHIVE_LIST }} - the line containing this directive in the template will be replaced by the list if archive directories having names like AR_YYYY
{{ DATE_TIME }} - this will be substituted with the machine's current local date/time.

Example

Contents of gophermap.template:

 ____  _   _ _     ___   ____
|  _ \| | | | |   / _ \ / ___|
| |_) | |_| | |  | | | | |  _
|  __/|  _  | |__| |_| | |_| |
|_|   |_| |_|_____\___/ \____|

Last updated: {{ DATE_TIME }}

{{ FILE_LIST }}

The contents of directory phlog:

2019-02-01__First.md
2019-02-02__Managing_the_hole.md
2019-12-23__Homemade_tools.md
gophermap.template

After running

$ navopher phlog gophermap.template

the resulting gophermap looks like this:

  ____  _   _ _     ___   ____
 |  _ \| | | | |   / _ \ / ___|
 | |_) | |_| | |  | | | | |  _
 |  __/|  _  | |__| |_| | |_| |
 |_|   |_| |_|_____\___/ \____|

 Last updated: 2020-01-06 11:27:19 UTC

0[2019-12-23] Homemade tools    2019-12-23__Homemade_tools.md
0[2019-02-02] Managing the hole 2019-02-02__Managing_the_hole.md
0[2019-02-01] First     2019-02-01__First.md

In lynx the resulting gopher menu might look like this one:

         ____  _   _ _     ___   ____
        |  _ \| | | | |   / _ \ / ___|
        | |_) | |_| | |  | | | | |  _
        |  __/|  _  | |__| |_| | |_| |
        |_|   |_| |_|_____\___/ \____|

        Last updated: 2020-01-06 11:27:19 UTC

(FILE) [2019-12-23] Homemade tools
(FILE) [2019-02-02] Managing the hole
(FILE) [2019-02-01] First

       ______________________________________________________________________
                      Gophered by Gophernicus/1.6 on NetBSD/amd64 8.0_STABLE

lacerto / navopher