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 | 126 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ man/quart.1.scd | 86 +++++++++++++++++++++++++++++++++++++ man/quart.5 | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ man/quart.5.scd | 90 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 431 insertions(+) create mode 100644 man/quart.1 create mode 100644 man/quart.1.scd create mode 100644 man/quart.5 create mode 100644 man/quart.5.scd (limited to 'man') diff --git a/man/quart.1 b/man/quart.1 new file mode 100644 index 0000000..9dd5103 --- /dev/null +++ b/man/quart.1 @@ -0,0 +1,126 @@ +.\" Generated by scdoc 1.11.1 +.\" Complete documentation for this program is not available as a GNU info page +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.nh +.ad l +.\" Begin generated content: +.TH "quart" "1" "2020-12-26" +.P +.P +.SH NAME +.P +quart - plan your day, a quarter at a time +.P +.SH SYNOPSIS +.P +\fBquart\fR [\fIfile\fR] [\fB-schrn\fR] [\fB-l\fR \fINUM\fR] +.br +\fBqc\fR [\fICOMMAND\fR] +.br +\fBqc\fR [\fB-\fR \fIARGS\fR] +.P +.SH OPTIONS +.P +\fBquart\fR has the following options: +.P +\fIfile\fR +.RS 4 +File containing the schedule to parse.\& +.P +.RE +\fB-r\fR +.RS 4 +Print the remaining tasks for the day, if any.\& This is the default, if no +other flags are given +.P +.RE +\fB-s\fR +.RS 4 +Print the whole schedule.\& +.P +.RE +\fB-c\fR +.RS 4 +Print \fIcurrent\fR task.\& +.P +.RE +\fB-n\fR +.RS 4 +Print \fInext\fR task.\& +.P +.RE +\fB-l\fR \fIquarters\fR +.RS 4 +Print the task that you should do \fIquarters\fR quarters \fIlater\fR.\& +.P +.RE +\fBqc\fR has the following options: +.P +Without any arguments it pretty prints the current schedule.\& +.P +\fB-\fR +.RS 4 +Pass any argument that follows the `-` symbol to \fBquart\fR, along with +the current schedule.\& +.P +.RE +\fBinit, i\fR +.RS 4 +Create the required directory structure under \fI$QUART_HOME\fR.\& +.P +.RE +\fBnew, n\fR +.RS 4 +Create a new schedule and archive the current one.\& +.P +.RE +\fBremove, rm\fR +.RS 4 +Remove current schedule while also archiving it.\& +.P +.RE +\fBedit, e\fR +.RS 4 +Run \fI$EDITOR\fR on the current schedule.\& +.P +.RE +\fBcat, c\fR +.RS 4 +Print current schedule file in \fIstdout\fR.\& +.P +.RE +\fBhelp, h, -h\fR +.RS 4 +Show help.\& +.P +.RE +.SH DESCRIPTION +.P +\fBquart\fR parses a file in \fBquart\fR(5) format and prints the schedule according to +the given options.\& \fBqc\fR is a bash wrapper around \fBquart\fR 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 \fB-h\fR flag.\& +.P +.SH FILES/ENVIRONMENT +.P +\fIQUART_HOME\fR +.RS 4 +\fBqc\fR uses this location for storing current and archived schedules.\& +\fI~/.\&quart.\&d\fR by default.\& +.P +.RE +\fIQUART_HOME/archive\fR +.RS 4 +All the archived schedules end up here and are renamed.\& +.P +.RE +\fIEDITOR\fR +.RS 4 +Used when invoking the edit command.\& +.P +.RE +.SH AUTHOR +.P +Anastasis Grammenos \ No newline at end of file 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 diff --git a/man/quart.5 b/man/quart.5 new file mode 100644 index 0000000..a24578a --- /dev/null +++ b/man/quart.5 @@ -0,0 +1,129 @@ +.\" Generated by scdoc 1.11.1 +.\" Complete documentation for this program is not available as a GNU info page +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.nh +.ad l +.\" Begin generated content: +.TH "quart" "5" "2020-12-26" +.P +.P +.SH NAME +.P +quart - document format for \fBquart\fR(1) schedules +.P +.SH SYNTAX +.P +\fBquart\fR files are inspired by emacs' org-mode.\& The header contains the time +that the schedule begins and each line represents a quarter of time, or 15 +minures.\& +.P +.SS HEADER +.P +Before any task, every \fBquart\fR file must contain a header with the starting +time of the schedule.\& It looks like this: +.P +.nf +.RS 4 +#+START: 9:15 +.fi +.RE +.P +It is case insenstive.\& +.P +.SS COMMENTS +.P +Every line beginning with `#` is ignored.\& Comments must start at the beginning +of the line.\& +.P +.SS BODY +.P +The body of the document contains the tasks.\& Each task is a line starting with `* ` +(asterisk and space).\& The full definition of a task looks like this: +.P +.RS 4 +* [\fIREPETITION\fR] [\fIFLAG\fR] <\fBDESCRIPTION\fR> +.P +.RE +\fIFLAG\fR and \fIREPETION\fR are optional.\& See the respective sections below.\& +.P +The description can be any arbitrary string.\& +.P +.SS FLAGS +.P +Each task can have a \fIflag\fR set to make it pop out.\& There are three flags avaliable: +.P +.TS +c r l +c r l +c r l +c r l. +T{ +\fBChar\fR +T} T{ +\fBFlag\fR +T} T{ +\fBDescription\fR +T} +T{ +! +T} T{ +\fIUrgent\fR +T} T{ +Mark task as important.\& +T} +T{ +?\& +T} T{ +\fIMaybe\fR +T} T{ +Mark task as mayhap.\& +T} +T{ +@ +T} T{ +\fIDepends\fR +T} T{ +Task that depends on someone else.\& +T} +.TE +.sp 1 +Use them by adding the required \fIchar\fR after the `* ` in a task: +.P +.nf +.RS 4 +#+start: 9:30 +* ! Meet with Knuth\&. +.fi +.RE +.P +If used with \fIrepetition\fR it must go \fBafter\fR it.\& +.P +.SS REPETITION +.P +Allows repetition of a task for as many quarters as needed in succession.\& +.P +Use them by adding a number right after the `* ` in a task: +.P +.nf +.RS 4 +#+start: 11:30 +* 8 Boring 2h meeting\&. +.fi +.RE +.P +If used with \fIflags\fR it must go \fBbefore\fR any.\& +.P +.SS SPECIAL +.P +There are two special symbols the \fIDESCRIPTION\fR can contain: +.P +\fB=\fR +.RS 4 +Repeat the previous task.\& It will only carry over the description +so it can contain a different \fIflag\fR or \fIrepetition\fR number.\& +.P +.RE +\fB-\fR +.RS 4 +None, blank, empty, the most important thing.\& 15 minutes of doing nothing.\& \ No newline at end of file diff --git a/man/quart.5.scd b/man/quart.5.scd new file mode 100644 index 0000000..3133185 --- /dev/null +++ b/man/quart.5.scd @@ -0,0 +1,90 @@ +quart(5) + +; Tabs are required for indentation ( in emacs) + +# NAME + +quart - document format for *quart*(1) schedules + +# SYNTAX + +*quart* files are inspired by emacs' org-mode. The header contains the time +that the schedule begins and each line represents a quarter of time, or 15 +minures. + +## HEADER + +Before any task, every *quart* file must contain a header with the starting +time of the schedule. It looks like this: + +``` +#+start: 9:15 +``` + +Use capital letters, or lowercase ones. No mixing. + +## COMMENTS + +Every line beginning with `#` is ignored. Comments must start at the beginning +of the line. + +## BODY + +The body of the document contains the tasks. Each task is a line starting with `\* ` +(asterisk and space). The full definition of a task looks like this: + + \* [_REPETITION_] [_FLAG_] <*DESCRIPTION*> + +_FLAG_ and _REPETION_ are optional. See the respective sections below. + +The description can be any arbitrary string. + +## FLAGS + +Each task can have a _flag_ set to make it pop out. There are three flags avaliable: + +|- *Char* +:] *Flag* +:[ *Description* +|- \! +: _Urgent_ +:[ Mark task as important. +|- ? +: _Maybe_ +:[ Mark task as mayhap. +|- @ +: _Depends_ +:[ Task that depends on someone else. + +Use them by adding the required _char_ after the `\* ` in a task: + +``` +#+start: 9:30 +\* ! Meet with Knuth. +``` + +If used with _repetition_ it must go *after* it. + +## REPETITION + +Allows repetition of a task for as many quarters as needed in succession. + +Use them by adding a number right after the `\* ` in a task: + +``` +#+start: 11:30 +* 8 Boring 2h meeting. +``` + +If used with _flags_ it must go *before* any. + +## SPECIAL + +There are two special symbols the _DESCRIPTION_ can contain: + +*=* + Repeat the previous task. It will only carry over the description + so it can contain a different _flag_ or _repetition_ number. + +*-* + None, blank, empty, the most important thing. 15 minutes of doing nothing. \ No newline at end of file -- cgit v1.2.3