diff --git a/README.md b/README.md index 431262f..f65fd56 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,9 @@ OPTIONS: -a Year to generate anthology of +-A + Year to view anthology of + -p 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 + decrypt a file + +-g + encrypt a file + +-x + clean folder: remove any unencrypted files if encryption is enabled + ``` ## Set up diff --git a/calliope.sh b/calliope.sh index 948661e..739cce9 100755 --- a/calliope.sh +++ b/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 diff --git a/man/man1/calliope.1 b/man/man1/calliope.1 new file mode 100644 index 0000000..20514dc --- /dev/null +++ b/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 + +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 to generate anthology of +.TP +\fB\-A\fR + +Year to view anthology of +.TP +\fB\-p\fR + +Compile all entries in this year +.TP +\fB\-s\fR + (yyyy\-mm\-dd) +Compile specific entry +.HP +\fB\-e\fR edit the latest entry using $MY_EDITOR +.HP +\fB\-E\fR (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 (yyyy\-mm\-dd) +.IP +view specific entry using $MY_VIEWER +.HP +\fB\-k\fR +.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 +.IP +decrypt a file +.HP +\fB\-g\fR +.IP +encrypt a file +.HP +\fB\-x\fR +.IP +clean folder: remove any unencrypted files if encryption is enabled