DIR go back
Burrow is very easy to install.
Preferred installation:
1. Download the latest build from Github:
HTML Latest Build
2. Install system-wide:
$ sudo make install
If you don't have administrative rights, you can add the burrow
executable to your path. Note: You will not have man support or
bash command-completion if you don't install.
3. Generate a default configuration file:
$ burrow create-config
4. Edit the default configuration file:
$ burrow edit-config
=== Config ===
The following locations are available for configuration:
1) $HOME/.config/burrow/config
2) $HOME/.config/burrow
3) $HOME/.burrow
These files are processed in the order listed. Variables defined in
multiple locations will use the last assigned value.
The following options are available (defaults shown):
config_dir_gopher="$HOME/gopher" # local path to gopher site
config_gopher_server="sdf.org" # server of gopher host
config_gopher_port="70" # port of gopher host
config_gopher_root="/users/username/" # path on gopher host to gopher site
config_dir_phlog="phlog" # relative path to phlog
config_phlog_gophermap=true # phlogs use gophermap format by default
config_phlog_usedate=true # use a date-stamp on phlog posts
config_dir_recipebox="recipebox" # relative path to recipe box
config_recipebox_gophermap=false # recipes use plain text by default
config_recipebox_usedate=false # do not use a date-stamp on recipe filenames
config_dir_topics="topics" # relative path to topics directory
config_topics_gophermap=true # topic notes use gophermap format by default
config_topics_usedate=false # do not use a date-stamp on topic filenames
config_git_commit=false # automatically commit changes if git repo
config_git_push=false # automatically push changes if git repo
config_autoindent=true # automatically reformat gophermaps with leading "i"
# types and parse links at the end of file
config_file_rss="rss.xml" # filename of RSS feed
config_gopher_name="My Gopher Hole" # used in RSS feed output
config_gopher_desc="Description" # used in RSS feed output
config_rss_num_entries="10" # number of entries to inclued in RSS feed
config_phlog_autorss=false # automatically generate RSS feed
Note: This file is a valid Bash script and will be sourced upon load.