summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrederic Culot <calcurse@culot.org>2006-12-11 09:37:47 +0000
committerFrederic Culot <calcurse@culot.org>2006-12-11 09:37:47 +0000
commit11e9fc696cefa3c2fb759f05b79f47f63144d3b3 (patch)
tree8a0910f9ce4144b54ca53406e262dee5a88f0fee
parent2f028c2dec054b1b251497629a5b7a00135604a0 (diff)
downloadcalcurse-11e9fc696cefa3c2fb759f05b79f47f63144d3b3.tar.gz
calcurse-11e9fc696cefa3c2fb759f05b79f47f63144d3b3.zip
manpage updated, long options included
-rwxr-xr-xsrc/calcurse.136
1 files changed, 15 insertions, 21 deletions
diff --git a/src/calcurse.1 b/src/calcurse.1
index aef8611..a9eef12 100755
--- a/src/calcurse.1
+++ b/src/calcurse.1
@@ -1,4 +1,4 @@
-.\" $calcurse: calcurse.1,v 1.3 2006/09/16 09:06:15 culot Exp $
+.\" $calcurse: calcurse.1,v 1.4 2006/12/11 09:37:47 culot Exp $
.\"
.\" Copyright (c) 2004-2006 Frederic Culot
.\"
@@ -17,23 +17,14 @@
.\" Foundation, Inc., 59 Temple Place - Suite 330,
.\" Boston, MA 02111-1307, USA.
.\"
-.TH CALCURSE 1 "September 16, 2006" "Version 1.6" "Calcurse Manual"
+.TH CALCURSE 1 "December 10, 2006" "Version 1.7" "Calcurse Manual"
.SH NAME
Calcurse \- text-based organizer
.PP
.SH SYNOPSIS
.B "calcurse "
-[
-.B "-h "
-|
-.B "-v "
-] [
-.B "-ant "
-] [
-.B "-d "
-\fIdate\fP|\fInum\fP ] [
-.B "-c "
-\fIfile\fP ]
+[\fB-h\fP|\fB-v\fP] [\fB-an\fP] [\fB-t\fP[\fInum\fP]]
+[\fB-d\fP \fIdate\fP|\fInum\fP] [\fB-c\fP \fIfile\fP]
.PP
.SH DESCRIPTION
Calcurse is a text-based personal organizer which helps keeping track of
@@ -45,18 +36,18 @@ All of the commands are documented within an online help system.
.SH OPTIONS
The following options are supported:
.TP
-.B \-a
+.B -a, --appointment
Print the appointments and events for the current day and exit.
.br
\fINote:\fP the calendar from which to read the appointments can be specified using
the '\-c' flag.
.TP
-.B \-c
+\fB-c\fP <file>, \fB--calendar\fP <file>
Specify the calendar file to use. The default calendar is
.B "'~/.calcurse/apts'"
(see section \fIFILES\fP below).
.TP
-.B \-d
+\fB-d\fP <date|num>, \fB--day\fP <date|num>
Print the appointments and events for the given date or for
the given number of upcoming days, depending on the argument format.
Two possible formats are supported:
@@ -79,11 +70,11 @@ and events for today, tomorrow, and the day after tomorrow.
appointments can be specified using the '\-c' flag.
.RE
.TP
-.B \-h
+\fB-h\fP, \fB--help\f
Print a short help text describing the supported command-line options,
and then exit.
.TP
-.B \-n
+\fB-n\fP, \fB--next\f
Print the next appointment within upcoming 24 hours and exit.
The indicated time is the number of hours and minutes left before this
appointment.
@@ -91,10 +82,13 @@ appointment.
\fINote:\fP the calendar from which to read the appointments can be specified using
the '\-c' flag.
.TP
-.B \-t
-Print the 'todo' list and exit.
+\fB-t\fP[num], \fB--todo\fP[=num]
+Print the 'todo' list and exit. If the optional number \fInum\fP is given,
+then only todos having a priority equal to \fInum\fP will be returned.
+.br
+\fINote:\fP priority number must be between 1 (highest) and 9 (lowest).
.TP
-.B \-v
+\fB-v\fP, \fB--version\f
Display calcurse version and exit.
.SH NOTES
Calcurse interface contains three different panels (calendar,