DIR go back
=== Usage ===
burrow phlog # create new phlog post
burrow recipe # add or update a recipe to box
burrow topic # add or update a topic file
burrow rss # generate a RSS feed of phlog entries
burrow create-config # generate a default config file
burrow edit-config # open your config file for editing
burrow update-git # pull latest git repo for gopher dir, if exists
- create-config will auto-generate a configuration file at
$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
config_dir_gopher to point to the folder on your local computer
where your gopher hole resides.
- edit-config will open your burrow configuration file for easy
editing.
- phlog will 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 .template file in your
phlog directory.
- recipe will 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 .template file in your
recipe box directory.
- topic will 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 .template file in your topics
directory.
- rss will 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.
- update-git will silently attempt to update a git repository at
the location of your gopher hole. It is appropriate for use by a
cron job.
Type "man burrow" or "burrow -h" for more information.
=== License ===
Burrow is released under the GPL3.0 license