From e32159428b5d4da93ea924583b1deb2160ca4b95 Mon Sep 17 00:00:00 2001 From: gramanas Date: Sat, 26 Dec 2020 13:41:50 +0200 Subject: Organize repo and fix man path mistakes --- man/quart.1.scd | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 man/quart.1.scd (limited to 'man/quart.1.scd') diff --git a/man/quart.1.scd b/man/quart.1.scd new file mode 100644 index 0000000..38508cc --- /dev/null +++ b/man/quart.1.scd @@ -0,0 +1,86 @@ +quart(1) + +; Tabs are required for indentation ( 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. + +*-r* + Print the remaining tasks for the day, if any. This is the default, if no + other flags are given. + +*-s* + Print the whole schedule. + +*-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 -- cgit v1.2.3