diff options
Diffstat (limited to 'man/quart.1')
-rw-r--r-- | man/quart.1 | 126 |
1 files changed, 126 insertions, 0 deletions
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 |