Backup command added. fixes #21

Author: iandstanley

docs/RELEASE-NOTES.md

@@ -1,6 +1,10 @@
 #		     STANDARD(?) UNIX NOTES
 #			RELEASE NOTES
 
+2.4 
+	- Added backup sub-command (creates GnuPG encrypted 
+	  tarball in HOME)
+
 2.3
 	- Added GNU shred(1) for file deletion where available
 	- fixed bug #26 (wrong extension for 'edit' -> .asc)

docs/ROADMAP.md

@@ -3,6 +3,8 @@
 				
 				ROADMAP
 
+2.4 Added backup sub command
+
 2.3 Use GNU shred(1) where available
 
 2.2 Migrate to ascii encoded GPG files (see RELEASE-NOTES.md)
@@ -48,6 +50,5 @@ FUTURE FEATURES
 	- zsh completion
 	- FreeBSD .PKG packaging
 	- FreeBSD ports configuration
-    	- encrypted backup/restore
     	- PIV card support
     	- Issue #17 BUG - import truncates filename if spaces in filename

docs/USING_NOTES.md

@@ -51,6 +51,10 @@ $ ykman openpgp set-touch enc cached
 ```
 
 
+## Sub-command backup
+
+Backup your notes and journal entries to a GPG encrypted tar file (in $HOME)
+
 ## Sub-command add | insert
 
 To add a note simply issue the command

docs/journal.1

@@ -78,6 +78,8 @@ the KEYID of the private key you wish to use.
 issues with other keys, then run \fBnotes newkey <keyid>\fP. Notes will 
 replace the keyid automatically in the config file.
 
+Journal entries can be backed up using the backup sub-command of notes(1).
+
 .SH SHELL INTEGRATION
 
 Standard Unix Notes system supports bash completion for notes(1), 

docs/notes.1

@@ -85,6 +85,14 @@ Displays the config file
 ~/.notes/config
 to the terminal. This is a quick way of determining that GPG KeyID is in use.
 
+.SY backup
+.YS
+
+Backup your notes directory to a GPG encrypted tar file placed in your 
+$HOME directory. Backups can be tested using the following command:
+
+    $ gpg -d ~/unix-notes-backup-20210630_1503.tar.asc | tar tv 
+
 .SY help
 .YS
 Displays a quick help page displaying available commands.

notes

@@ -28,7 +28,8 @@ GPG_OPTS=" --quiet --yes --compress-algo=none --no-encrypt-to"
 GPG="gpg"
 EDITOR="${EDITOR:-nano}"
 PAGER="${PAGER:-more}"
-
+TIMESTAMP="`date \"+%Y%m%d_%H%M\"`"
+BACKUPFILE="${HOME}/unix-notes-backup-${TIMESTAMP}.tar.asc"
 # Use shred if available
 SHRED="`which shred`"
 if [ $? = 0 ]; then 
@@ -370,6 +371,7 @@ GPG encrypted notes system for BSD and Linux systems
 
 	notes init          initialise notes system
 	notes config        display config file
+    notes backup        backup $NOTESDIR to GPG encrypted tar file
 	notes newkey email  change GPG key 
 	notes help          show help
 	notes version       show version
@@ -435,6 +437,14 @@ cmd_config () {
 	echo The Journal uses the directory $JOURNALDIR
 }
 
+cmd_backup () {
+
+    get_recipient
+
+    echo running tar backup to $BACKUPFILE
+    tar cv ${NOTESDIR} | gpg -ear ${KEY} ${GPGOPTS} > ${BACKUPFILE}
+}
+
 cmd_tree () {
     tree  -I Journal  ${NOTESDIR}  
 }
@@ -630,6 +640,7 @@ COMMAND="$1"
 case "$1" in
         init) shift;                    cmd_init "$@" ;;
         config) shift;                  cmd_config "$@" ;;
+        backup) shift;                  cmd_backup ;;
         tree) shift;                  	cmd_tree ;;
         licence|license) shift;         cmd_licence "$@" ;;
         default) shift;                 cmd_default "$@" ;;