summaryrefslogtreecommitdiffstats
path: root/quart.5
blob: b8bb2e21e3dc215eaab1605df41345fc943df72e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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-25"
.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, the most important thing.\& 15 minutes of doing nothing.\&