summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAriadna Vigo <arivigodr@gmail.com>2020-07-06 23:38:02 +0200
committerAriadna Vigo <arivigodr@gmail.com>2020-07-06 23:38:02 +0200
commitd7aad1e41fb1165303e1b4a8476fd887edc86f4b (patch)
treec6f2a06a804605ce5e011a2eca04059b91dbf8f5
parentf34b43203146e9278a2e8ef34948ed70b1c9a404 (diff)
Improved man page formatting
-rw-r--r--cras.113
1 files changed, 10 insertions, 3 deletions
diff --git a/cras.1 b/cras.1
index 7a49ed5..b866730 100644
--- a/cras.1
+++ b/cras.1
@@ -1,13 +1,16 @@
.TH CRAS 1 cras\-VERSION
.SH NAME
+.PP
Cras - The Anti-Procrastination Tool
.SH SYNOPSIS
+.PP
.B cras
.RB [ \-osv ]
.RB [ \-tT
.IR num ]
.I file
.SH DESCRIPTION
+.PP
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
@@ -34,22 +37,26 @@ as pending.
.B \-v
Show version information and exit.
.SH USAGE
+.PP
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.
-
+.PP
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.
-
+.PP
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
+.PP
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
+.PP
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
+.PP
+Report bugs to https://todo.sr.ht/~emvigo/cras