summaryrefslogtreecommitdiffstats
path: root/cras.1
blob: 7a49ed56de973cfd1a1245d49c2abd0696efe4c9 (plain)
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
.TH CRAS 1 cras\-VERSION
.SH NAME
Cras - The Anti-Procrastination Tool
.SH SYNOPSIS
.B cras
.RB [ \-osv ]
.RB [ \-tT 
.IR num  ]
.I 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 
.I file.
.TP
.BI \-t " num"
Mark task 
.I num 
as done.
.TP
.BI \-T " num"
Mark task
.I 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 ENVIRONMENT VARIABLES
Execution of Cras is affected by the following environment variables:
.TP
.B NO_COLOR
Setting it to any value disables ANSI color escapes on output.
.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