burrow.1

.TH BURROW 1 "06 Mar 2020" "version 1.7.9"
.SH NAME
burrow \- a helper for building and managing a gopher hole
.SH SYNOPSIS
burrow [options] [command]
.SH DESRIPTION
burrow is a collection of helper actions designed to assist in the creation,
modification, and maintenance of a gopher hole.
.SH COMMANDS
.TP
.B phlog
Prompt for the title of a new post, then open it in your default
$EDITOR.
.TP
.B gophermap
Open a gophermap file relative to your gopher directory for editing,
automatically stripping some special characters for easier editing of info
lines.
.TP
.B rss
Automatically generate an RSS feed of your most recent phlog
entries and output it to the root of your gopher directory. This can be
automatically generated by using the config option config_phlog_autorss.
.TP
.B quickstart
Creates a new configuration file from interactive user prompts.
.TP
.B edit-config
Opens your burrow configuration file for editing if it exists.
.TP
.B update-git
Silently attempt to update a git repository at the location
of your gopher hole. It is appropriate for use by a cron job.
.TP
.B git-pull
which is useful for crons.
.SH OPTIONS
.TP
.B -v
Display current version information.
.TP
.B -d
Debug mode.
.TP 
.B -h
Show the help.
.SH FILES
.I $XDG_CONFIG_HOME
,
.I ~/.config/burrow/config
, 
.I ~/.config/burrow
, 
.I ~/.burrow
,
.I /etc/burrow/config
: configuration settings for burrow. If none of these are available, the default
configuration is loaded.
.SH BUGS
None known.
.SH AUTHOR
James Tomasino <tomasino (at) lavabit (dot) com>