burrow/burrow.1

59 lines
1.5 KiB
Groff
Raw Normal View History

2018-09-25 02:26:48 +00:00
.TH BURROW 1 "24 Sep 2018" "version 1.7.2"
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 gophermap
Open a gophermap file relative to your gopher directory for editing,
automatically stripping some special characters for easier editing of info
lines.
.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
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
.B -v
Display current version information.
.TP
.B -d
Debug mode.
2018-01-20 20:54:55 +00:00
.TP
.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>