feat: add a version string and man page

README.md

@@ -61,6 +61,9 @@ OPTIONS:
 -a  <year>
     Year to generate anthology of
 
+-A  <year>
+    Year to view anthology of
+
 -p  <year>
     Compile all entries in this year
 
@@ -81,6 +84,18 @@ OPTIONS:
     search diary for term using
     Please see the documentation of the search tool you use
     to see what search terms/regular expressions are supported.
+
+    Note: only works when encryption is *not* enabled.
+
+-G <file to decrypt>
+    decrypt a file
+
+-g <file to encrypt>
+    encrypt a file
+
+-x
+    clean folder: remove any unencrypted files if encryption is enabled
+
 ```
 
 ## Set up

calliope.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 
+VERSION=1.2.0
 MY_EDITOR="vimx --servername $(pwgen 8 1)"
 MY_VIEWER="xdg-open"
 year=$(date +%G)
@@ -476,6 +477,7 @@ usage ()
     usage: $0 options
 
     Master script file that provides functions to maintain a journal using LaTeX.
+    Version: $VERSION
 
     OPTIONS:
     -h  Show this message and quit

man/man1/calliope.1

@@ -0,0 +1,78 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
+.TH CALLIOPE.SH "1" "April 2022" "calliope.sh 1.2.0" "User Commands"
+.SH NAME
+calliope.sh \- manual page for calliope.sh 1.2.0
+.SH DESCRIPTION
+.IP
+usage: ./calliope.sh options
+.IP
+Master script file that provides functions to maintain a journal using LaTeX.
+Version: 1.2.0
+.IP
+OPTIONS:
+\fB\-h\fR  Show this message and quit
+.TP
+\fB\-t\fR
+Add new entry for today
+.TP
+\fB\-l\fR
+Compile latest entry
+.TP
+\fB\-C\fR
+<commit message>
+Compile latest entry and commit to repository.
+An optional commit message may be given using the commit_message
+variable:
+commit_message="Test" ./calliope.sh \fB\-C\fR
+If one is not given, the default is used: "Add new entry".
+.TP
+\fB\-c\fR
+Compile today's entry
+.TP
+\fB\-a\fR
+<year>
+Year to generate anthology of
+.TP
+\fB\-A\fR
+<year>
+Year to view anthology of
+.TP
+\fB\-p\fR
+<year>
+Compile all entries in this year
+.TP
+\fB\-s\fR
+<entry> (yyyy\-mm\-dd)
+Compile specific entry
+.HP
+\fB\-e\fR edit the latest entry using $MY_EDITOR
+.HP
+\fB\-E\fR <entry> (yyyy\-mm\-dd)
+.IP
+edit specific entry using $MY_EDITOR
+.HP
+\fB\-v\fR view the latest entry using $MY_VIEWER
+.HP
+\fB\-V\fR <entry> (yyyy\-mm\-dd)
+.IP
+view specific entry using $MY_VIEWER
+.HP
+\fB\-k\fR <search term>
+.IP
+search diary for term using
+Please see the documentation of the search tool you use
+to see what search terms/regular expressions are supported.
+.IP
+Note: only works when encryption is *not* enabled.
+.HP
+\fB\-G\fR <file to decrypt>
+.IP
+decrypt a file
+.HP
+\fB\-g\fR <file to encrypt>
+.IP
+encrypt a file
+.HP
+\fB\-x\fR
+.IP
+clean folder: remove any unencrypted files if encryption is enabled