2018-03-17 22:50:46 +00:00
|
|
|
.TH BURROW 1 "17 Mar 2018" "version 1.3.3"
|
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
|
|
|
|
|
Create a new phlog entry.
|
|
|
|
|
.TP
|
|
|
|
|
.B recipe
|
2018-03-03 17:03:27 +00:00
|
|
|
Add or update a recipe to the recipe box.
|
|
|
|
|
.B topic
|
|
|
|
|
Add or update a topic in your topics directory.
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
|
|
|
|
.B create-config
|
|
|
|
|
Generates a default configuration file at
|
|
|
|
|
.I ~/.config/burrow/config
|
|
|
|
|
if no other configuration file exists. It is populated with the default
|
|
|
|
|
settings.
|
|
|
|
|
.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
|
|
|
|
|
If the gopher directory resides within a git repository, this action will do a
|
|
|
|
|
silent
|
|
|
|
|
.B git-pull
|
|
|
|
|
which is useful for crons.
|
2018-03-06 23:27:40 +00:00
|
|
|
.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.
|
2018-01-21 02:26:33 +00:00
|
|
|
.SH OPTIONS
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
2018-01-21 02:26:33 +00:00
|
|
|
.B -v, --version
|
2018-01-20 21:41:37 +00:00
|
|
|
Display current version information.
|
|
|
|
|
.TP
|
2018-01-21 02:26:33 +00:00
|
|
|
.B -d, --debug
|
2018-01-20 21:41:37 +00:00
|
|
|
Debug mode.
|
2018-01-20 20:54:55 +00:00
|
|
|
.TP
|
2018-01-21 02:26:33 +00:00
|
|
|
.B -h, --help
|
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
|
|
|
|
|
James Tomasino <tomasino (at) sdf (dot) org>
|
