.TH BURROW 1 "17 Mar 2018" "version 1.4.0"
.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. By default it will provide you a template, but you can override this
by including a 
.I .template
file in your phlog directory.
.TP
.B recipe
Prompt for the name of your recipe, then open it in your default
$EDITOR. By default it will provide you a template, but you can override this
by including a
.I .template
file in your recipe box directory.
.TP
.B topic
Prompt for the name of the topic, then open it in your default
$EDITOR. By default it will provide you a template, but you can override this
by including a
.I .template
file in your topics directory.
.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 create-config
Auto-generate a configuration file at
.I $HOME/.config/burrow/config.
It will be populated by the default parameters
listed below and provide an easy way to customize your configuration. At a
minimum you should update your 
.I config_dir_gopher
to point to the folder on your local computer where your gopher hole resides.
.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.
.TP
.B update-burrow
Burrow will attempt to auto-update. If the local folder where burrow is
installed is a git repository, burrow will pull the latest commit from the
remote branch. If the local directory is not a git remote, burrow will attempt
to update local files with their counterpart on the Github remote repository.
The local directory will only attempt to update files in this way which are
named
.I burrow
or some variation of that name.
.SH OPTIONS
.TP
.B -v
Display current version information.
.TP
.B -d
Debug mode.
.TP 
.B -h
Show the help.
.SH FILES
.I ~/.config/burrow/config
, 
.I ~/.config/burrow
, 
.I ~/.burrow
: 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) sdf (dot) org>