diff options
Diffstat (limited to 'cras.1')
| -rw-r--r-- | cras.1 | 44 |
1 files changed, 44 insertions, 0 deletions
@@ -0,0 +1,44 @@ +.TH CRAS 1 cras\-VERSION +.SH NAME +Cras - The Anti-Procrastination Tool +.SH SYNOPSIS +.B cras +.RB [ \-osv ] +.RB [ \-tT\ num ] +.RB file +.SH DESCRIPTION +Cras is an unapologetic daily task planner and manager for your terminal and WM +status bar. It holds your tasks only for a limited amount of time (24 hours, by +default) and doesn't allow you to edit the task list after set up, except for +marking a task as done. +.SH OPTIONS +.TP +.B \-o +Switch to short-form output. +.TP +.B \-s +Save from standard input into file. +.TP +.B \-t\ num +Mark task num as done. +.TP +.B \-T\ num +Mark task num as pending. +.TP +.B \-v +Show version information and exit. +.SH USAGE +To set up a new task list, call Cras using the -s option. Cras will read each +new line from standard input as a new task, until EOF is reached. + +The newly created task list will be readable by Cras only up to the expiry +date, which under the default configuration is 24 hours after originally saving +it. Use -t to mark a task as done and -T to mark it back as pending. + +Running Cras with no options outputs the task list. For a summary, use the -o +flag; this short-form output is suitable for printing to WM status bars. +.SH CONFIGURATION +Cras is configured by creating a custom config.h and recompiling the source +code. +.SH BUGS +Report bugs to https://todo.sr.ht/~emvigo/cras
\ No newline at end of file |