2018-09-01 22:55:03 +00:00
|
|
|
.TH BURROW 1 "01 Sep 2018" "version 1.6.1"
|
2018-01-20 06:32:19 +00:00
|
|
|
.SH NAME
|
|
|
|
|
burrow \- a helper for building and managing a gopher hole
|
2018-01-20 20:54:55 +00:00
|
|
|
.SH SYNOPSIS
|
2018-01-21 02:26:33 +00:00
|
|
|
burrow [options] [command]
|
2018-01-20 06:32:19 +00:00
|
|
|
.SH DESRIPTION
|
2018-01-21 02:26:33 +00:00
|
|
|
burrow is a collection of helper actions designed to assist in the creation,
|
2018-01-20 20:54:55 +00:00
|
|
|
modification, and maintenance of a gopher hole.
|
2018-01-21 02:26:33 +00:00
|
|
|
.SH COMMANDS
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
|
|
|
|
.B phlog
|
2018-04-01 02:41:10 +00:00
|
|
|
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.
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
|
|
|
|
.B recipe
|
2018-04-01 02:41:10 +00:00
|
|
|
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
|
2018-03-03 17:03:27 +00:00
|
|
|
.B topic
|
2018-04-01 02:41:10 +00:00
|
|
|
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
|
2018-07-16 00:02:15 +00:00
|
|
|
.B root
|
|
|
|
|
Open your gopher hole's root gophermap for editing. This will remove any
|
|
|
|
|
type 'i' formatting and allow comments to be added in natural text. You will
|
|
|
|
|
still need to create links in the proper gophermap formatting.
|
|
|
|
|
.TP
|
2018-04-01 02:41:10 +00:00
|
|
|
.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.
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
|
|
|
|
.B create-config
|
2018-04-01 02:41:10 +00:00
|
|
|
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.
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
2018-03-06 21:44:31 +00:00
|
|
|
.B edit-config
|
|
|
|
|
Opens your burrow configuration file for editing if it exists.
|
|
|
|
|
.TP
|
2018-01-20 20:54:55 +00:00
|
|
|
.B update-git
|
2018-04-01 02:41:10 +00:00
|
|
|
Silently attempt to update a git repository at the location
|
|
|
|
|
of your gopher hole. It is appropriate for use by a cron job.
|
|
|
|
|
.TP
|
2018-01-20 20:54:55 +00:00
|
|
|
.B git-pull
|
|
|
|
|
which is useful for crons.
|
2018-01-21 02:26:33 +00:00
|
|
|
.SH OPTIONS
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
2018-04-10 02:07:57 +00:00
|
|
|
.B -v
|
2018-01-20 21:41:37 +00:00
|
|
|
Display current version information.
|
|
|
|
|
.TP
|
2018-04-10 02:07:57 +00:00
|
|
|
.B -d
|
2018-01-20 21:41:37 +00:00
|
|
|
Debug mode.
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
2018-04-10 02:07:57 +00:00
|
|
|
.B -h
|
2018-01-20 20:54:55 +00:00
|
|
|
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
|
2018-04-10 02:17:38 +00:00
|
|
|
James Tomasino <tomasino (at) lavabit (dot) com>
|
