path: root/man/quart.5

.\" 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.\&