summaryrefslogtreecommitdiffstats
path: root/quart.1.scd
diff options
context:
space:
mode:
authorgramanas <anastasis.gramm2@gmail.com>2019-03-27 19:56:24 +0200
committergramanas <anastasis.gramm2@gmail.com>2020-12-25 21:34:36 +0200
commit5b4a10af81c60c6c4787d95f82004094f358459c (patch)
tree6f7b358288926bd5c501755d1e8f2872fb68d046 /quart.1.scd
downloadquart-5b4a10af81c60c6c4787d95f82004094f358459c.tar.gz
quart-5b4a10af81c60c6c4787d95f82004094f358459c.tar.bz2
quart-5b4a10af81c60c6c4787d95f82004094f358459c.zip
Initial..
Diffstat (limited to 'quart.1.scd')
-rw-r--r--quart.1.scd79
1 files changed, 79 insertions, 0 deletions
diff --git a/quart.1.scd b/quart.1.scd
new file mode 100644
index 0000000..2a9e08e
--- /dev/null
+++ b/quart.1.scd
@@ -0,0 +1,79 @@
+quart(1)
+
+; Tabs are required for indentation (<C-q tab> in emacs)
+
+# NAME
+
+quart - plan your day, a quarter at a time
+
+# SYNOPSIS
+
+*quart* [_file_] [*-schrn*] [*-l* _NUM_] ++
+*qc* [_COMMAND_] ++
+*qc* [*-* _ARGS_]
+
+# OPTIONS
+
+*quart* has the following options:
+
+_file_
+ File containing the schedule to parse.
+
+*-c*
+ Print _current_ task.
+
+*-n*
+ Print _next_ task.
+
+*-l* _quarters_
+ Print the task that you should do _quarters_ quarters _later_.
+
+*qc* has the following options:
+
+Without any arguments it pretty prints the current schedule.
+
+*-*
+ Pass any argument that follows the `-` symbol to *quart*, along with
+ the current schedule.
+
+*init, i*
+ Create the required directory structure under _$QUART_HOME_.
+
+*new, n*
+ Create a new schedule and archive the current one.
+
+*remove, rm*
+ Remove current schedule while also archiving it.
+
+*edit, e*
+ Run _$EDITOR_ on the current schedule.
+
+*cat, c*
+ Print current schedule file in _stdout_.
+
+*help, h, -h*
+ Show help.
+
+# DESCRIPTION
+
+*quart* parses a file in *quart*(5) format and prints the schedule according to
+the given options. *qc* is a bash wrapper around *quart* that automates the
+management of daily schedule files. It cat be customized by editing it. It is
+the recommended way of managing you quart schedules. Both commands provide
+usage information using the *-h* flag.
+
+# FILES/ENVIRONMENT
+
+_QUART_HOME_
+ *qc* uses this location for storing current and archived schedules.
+ _~/.quart.d_ by default.
+
+_QUART_HOME/archive_
+ All the archived schedules end up here and are renamed.
+
+_EDITOR_
+ Used when invoking the edit command.
+
+# AUTHOR
+
+Anastasis Grammenos \ No newline at end of file