Merge pull request #1 from jamestomasino/master

Adds new burrow disambiguity

.drone.yml

@@ -0,0 +1,26 @@
+---
+kind: pipeline
+type: ssh
+name: deploy
+
+server:
+    host:
+      from_secret: host
+    user:
+      from_secret: username
+    ssh_key:
+      from_secret: ssh_key
+
+clone:
+    disable: true
+
+trigger:
+    branch:
+      - master
+
+steps:
+    - name: deploy
+      commands:
+        - cd /opt/services/burrow
+        - sudo -Hu services git pull origin master
+        - sudo -Hu root make

.travis.yml

@@ -0,0 +1,3 @@
+language: shell
+script:
+  - bash -c 'shopt -s globstar && shellcheck burrow'

Makefile

@@ -1,6 +1,6 @@
 PREFIX ?= /usr/local
 BINDIR ?= $(PREFIX)/bin
-MANDIR ?= $(PREFIX)/share/man
+MANDIR ?= $(PREFIX)/share/man/man1
 
 # Attempt to find bash completion dir in order of preference
 ifneq ($(wildcard /etc/bash_completion.d/.),)
@@ -14,23 +14,22 @@ endif
 
 HAS_PKGCONFIG := $(shell command -v pkg-config 2> /dev/null)
 ifdef HAS_PKGCONFIG
-  CPLDIR ?= $$(pkg-config --variable=completionsdir bash-completion 2> /dev/null)
+  CPLDIR ?= $(shell pkg-config --variable=completionsdir bash-completion 2> /dev/null)
 endif
 
 install:
 	@echo Installing the executable to $(BINDIR)
 	@mkdir -p $(BINDIR)
-	@cp -f burrow $(BINDIR)/burrow
-	@chmod 755 $(BINDIR)/burrow
+	@install -m 755 burrow $(BINDIR)
 	@echo Installing the manual page to $(MANDIR)/man1
 	@mkdir -p $(MANDIR)
-	@cp -f burrow.1 $(MANDIR)/man1/burrow.1
-	@chmod 644 $(MANDIR)/man1/burrow.1
+	@install -m 644 burrow.1 $(MANDIR)
 ifdef CPLDIR
+ifneq ($(CPLDIR),)
 	@echo Installing the command completion to $(CPLDIR)
 	@mkdir -p $(CPLDIR)
-	@cp -f burrow.d $(CPLDIR)/burrow
-	@chmod 644 $(CPLDIR)/burrow
+	@install -m 644 burrow.d $(CPLDIR)/burrow
+endif
 endif
 
 uninstall:
@@ -39,8 +38,10 @@ uninstall:
 	@echo Removing the manual page from $(MANDIR)/man1
 	@rm -f $(BINDIR)/man1/burrow.1
 ifdef CPLDIR
+ifneq ($(CPLDIR),)
 	@echo Removing the command completion from $(CPLDIR)
 	@rm -f $(CPLDIR)/burrow
 endif
+endif
 
 .PHONY: install uninstall

README.md

@@ -1,91 +1,75 @@
-# burrow ![status](https://img.shields.io/badge/status-working-green.svg?style=flat-square) ![license](https://img.shields.io/badge/license-GPL3-blue.svg?style=flat-square) ![bash](https://img.shields.io/badge/Bash-4%2B-lightgrey.svg?style=flat-square)
+# burrow ![status](https://travis-ci.com/jamestomasino/burrow.svg?branch=master) ![license](https://img.shields.io/badge/license-GPL3-blue.svg?style=flat-square)
 
 **burrow** is a helper for building and managing a gopher hole.
 
 ## Installation
 
-### Dependencies
-
-#### Required
-
-* bash 4+
-
-  * Install on OSX: `brew install bash`
-
-#### Recommended
-
-* GNU sed
-
-  * Avoids creation of `.bak` files in strange places on OSX
-  * Install on OSX: `brew install gnu-sed --with-default-names`
-
-* GNU getopt
-
-  * Required to use long named switches, like --version or --help instead of -v and -h.
-  * Install on OSX: `brew install gnu-getopt --with-default-names`
-
-### Install
-
-`sudo make install`
-
 _Note: On systems without admin access the binary can be run directly from the
 git repo, but will lack `man` support and command completion._
 
 See the [Getting Started](https://github.com/jamestomasino/burrow/wiki/Getting-Started) guide.
 
+### Install on Linux / MacOS
+
+`sudo make install`
+
+### Install on BSD systems
+
+#### FreeBSD
+
+- Installing bash-completion via either `pkg install bash-completion` or via the `shells/bash-completion` port.
+- Installing the GNU version of make via either `pkg install gmake` or the `port devel/gmake`.
+- Rather than using `sudo make install`, run `sudo gmake install`.
+
+#### OpenBSD
+
+- Install the GNU version of make via either `pkg_add gmake` or the port `devel/gmake`.
+- There is no bash-completion package or port in OpenBSD. However the source code can be found at https://github.com/scop/bash-completion
+- Burrow appears to install and run without the presence of bash-completion. Exercise caution.
+- As root (or via `doas`), run `gmake install`.
+
+
 ### Uninstall
 
-`sudo make uninstall`
+`sudo make uninstall` # or gmake uninstall on BSD
 
 ## Usage
 
 ```bash
 burrow phlog          # create new phlog post
-burrow recipe         # add or update a recipe to box
-burrow topic          # add or update a topic file
-burrow create-config  # generate a default config file
+burrow gophermap      # edit a gophermap
+burrow rss            # generate a RSS feed of phlog entries
 burrow edit-config    # open your config file for editing
 burrow update-git     # pull latest git repo for gopher dir, if exists
-burrow update-burrow  # update git repo or pull latest version from github
 ```
 
-- `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.
+`$EDITOR`.
 
-- `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.
+- `gophermap` will open a gophermap file 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.
 
-- `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.
 
-- `update-burrow` will attempt to pull the latest version of burrow from git if
-your local folder is a git repository. If not, it will attempt to update each
-file in the burrow directory with the same named file in the master branch of
-the git repository for burrow on Github.
-
 _`man burrow` or `burrow -h` for more information._
 
 ## Config
 
 The following locations are available for configuration:
 
-1) `$HOME/.config/burrow/config`
-2) `$HOME/.config/burrow`
-3) `$HOME/.burrow`
+1) `/etc/burrow/config`
+2) `$XDG_CONFIG_HOME`
+3) `$HOME/.config/burrow/config`
+4) `$HOME/.config/burrow`
+5) `$HOME/.burrow`
 
 These files are processed in the order listed. Variables defined in multiple
 locations will use the last assigned value.
@@ -102,25 +86,33 @@ 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_autofold=false                  # automatically break lines at specific width
-config_foldwidth=66                    # width of line used for autofold
-config_autoindent=true                 # automatically reformat gophermaps with leading spaces
-                                       # and parse links at the end of file
+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._
 
+## Disambiguity
+
+There is [another burrow project](https://github.com/sloumdrone/burrow) created
+by _sloumdrone_. His burrow project is a GUI gopher client. Please check it out!
+
+There is also another project called "Burrow the Burrows" which can be found on gopher at: `gopher://kalos.mine.nu/1/burrow/index.gph`. It aims to construct and maintain a graph of the whole Gopherspace.
+
+There is another [static site generator for gopher](https://github.com/hyperrealgopher/burrow) written in Haskell by @hyperrealgopher. It has similar features to my burrow.
+
+_Armen_ now has a [gemini & spartan server](https://gitlab.com/armen138/burrow) named burrow.
+
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to
 discuss what you would like to change.

burrow.1

@@ -1,4 +1,4 @@
-.TH BURROW 1 "06 Mar 2018" "version 1.2.6"
+.TH BURROW 1 "06 Mar 2020" "version 1.7.9"
 .SH NAME
 burrow \- a helper for building and managing a gopher hole
 .SH SYNOPSIS
@@ -9,56 +9,54 @@ modification, and maintenance of a gopher hole.
 .SH COMMANDS
 .TP
 .B phlog
-Create a new phlog entry.
+Prompt for the title of a new post, then open it in your default
+$EDITOR.
 .TP
-.B recipe
-Add or update a recipe to the recipe box.
-.B topic
-Add or update a topic in your topics directory.
+.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
-.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.
+.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.
+.TP
+.B quickstart
+Creates a new configuration file from interactive user prompts.
 .TP
 .B edit-config
 Opens your burrow configuration file for editing if it exists.
 .TP
 .B update-git
-If the gopher directory resides within a git repository, this action will do a
-silent
+Silently attempt to update a git repository at the location
+of your gopher hole. It is appropriate for use by a cron job.
+.TP
 .B git-pull
 which is useful for crons.
-.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.
 .SH OPTIONS
 .TP
-.B -v, --version
+.B -v
 Display current version information.
 .TP
-.B -d, --debug
+.B -d
 Debug mode.
-.TP 
-.B -h, --help
+.TP
+.B -h
 Show the help.
 .SH FILES
+.I $XDG_CONFIG_HOME
+,
 .I ~/.config/burrow/config
-, 
+,
 .I ~/.config/burrow
-, 
+,
 .I ~/.burrow
+,
+.I /etc/burrow/config
 : 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>
+James Tomasino <tomasino (at) lavabit (dot) com>

burrow.d

@@ -1,22 +1,46 @@
 #!/usr/bin/env bash
 
-_burrow()
-{
-  # Get basic autocomplete commands from the function itself
-  local helplist
-  helplist=$(burrow shortlist)
-
-  # Combine all the lists for autocomplete
+_burrow() {
   local cur
   cur=${COMP_WORDS[COMP_CWORD]}
-  COMPREPLY=( $( compgen -W "$helplist" -- "$cur" ) )
+  if [ "${COMP_WORDS[1]}" == "gophermap" ]; then
+    local gopher_dir
+    local gophermaps
+    local directories
+    gopher_dir=$(burrow gopherdir)
+    search_dir=${gopher_dir}
+    if [ -n "${COMP_WORDS[2]}" ]; then
+      partial_search_dir="${gopher_dir}${COMP_WORDS[2]}"
+      if [ -d "$partial_search_dir" ]; then
+        search_dir="$partial_search_dir"
+      else
+        partial_search_dir=$(dirname "$partial_search_dir")
+        if [ -d "$partial_search_dir" ]; then
+          search_dir="$partial_search_dir"
+        fi
+      fi
+    fi
+    gophermaps=$(find "$search_dir" -mindepth 1 -maxdepth 1 -type f -name "gophermap" -print | sed "s|$gopher_dir||" | sed "s|gophermap$||" )
+    directories=$(find "$search_dir" -mindepth 1 -maxdepth 1 -type d -print | sed "s|$gopher_dir||" )
+    local suggestions=( $( compgen -W "$gophermaps $directories" -- "$cur" ) )
+    if [ "${#suggestions[@]}" == "1" ]; then
+      local resp=$(echo ${suggestions[0]/%\ */})
+      COMPREPLY=("$resp")
+    else
+      COMPREPLY=("${suggestions[@]}")
+    fi
+  else
+    local helplist
+    helplist=$(burrow shortlist)
+    COMPREPLY=( $( compgen -W "$helplist" -- "$cur" ) )
+  fi
 }
 
 # Detect if current shell is ZSH, and if so, load this file in bash
 # compatibility mode.
 if [ -n "$ZSH_VERSION" ]; then
-	autoload bashcompinit
-	bashcompinit
+  autoload bashcompinit
+  bashcompinit
 fi
 
 complete -o default -o nospace -F _burrow burrow
@@ -25,5 +49,5 @@ complete -o default -o nospace -F _burrow burrow
 # when the user has tab-completed the executable name and consequently
 # included the '.exe' suffix.
 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
-complete -o default -o nospace -F _burrow burrow.exe
+  complete -o default -o nospace -F _burrow burrow.exe
 fi