summaryrefslogtreecommitdiffstats
path: root/man/quart.1
blob: 9dd5103c7e33d65c105a5a09a42471cfcd21fa32 (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
.\" 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