fyb/calcurse-edge
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

manpage updated, long options included

Browse Source
This commit is contained in:
Frederic Culot 2006-12-11 09:37:47 +00:00
parent 2f028c2dec
commit 11e9fc696c
1 changed files with 15 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/calcurse.1
View File

@ -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 .\" Copyright (c) 2004-2006 Frederic Culot
.\" .\"
@ -17,23 +17,14 @@
.\" Foundation, Inc., 59 Temple Place - Suite 330, .\" Foundation, Inc., 59 Temple Place - Suite 330,
.\" Boston, MA 02111-1307, USA. .\" 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 .SH NAME
Calcurse \- text-based organizer Calcurse \- text-based organizer
.PP .PP
.SH SYNOPSIS .SH SYNOPSIS
.B "calcurse " .B "calcurse "
[ [\fB-h\fP|\fB-v\fP] [\fB-an\fP] [\fB-t\fP[\fInum\fP]]
.B "-h " [\fB-d\fP \fIdate\fP|\fInum\fP] [\fB-c\fP \fIfile\fP]
|
.B "-v "
] [
.B "-ant "
] [
.B "-d "
\fIdate\fP|\fInum\fP ] [
.B "-c "
\fIfile\fP ]
.PP .PP
.SH DESCRIPTION .SH DESCRIPTION
Calcurse is a text-based personal organizer which helps keeping track of 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 .SH OPTIONS
The following options are supported: The following options are supported:
.TP .TP
.B \-a .B -a, --appointment
Print the appointments and events for the current day and exit. Print the appointments and events for the current day and exit.
.br .br
\fINote:\fP the calendar from which to read the appointments can be specified using \fINote:\fP the calendar from which to read the appointments can be specified using
the '\-c' flag. the '\-c' flag.
.TP .TP
.B \-c \fB-c\fP <file>, \fB--calendar\fP <file>
Specify the calendar file to use. The default calendar is Specify the calendar file to use. The default calendar is
.B "'~/.calcurse/apts'" .B "'~/.calcurse/apts'"
(see section \fIFILES\fP below). (see section \fIFILES\fP below).
.TP .TP
.B \-d \fB-d\fP <date|num>, \fB--day\fP <date|num>
Print the appointments and events for the given date or for Print the appointments and events for the given date or for
the given number of upcoming days, depending on the argument format. the given number of upcoming days, depending on the argument format.
Two possible formats are supported: 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. appointments can be specified using the '\-c' flag.
.RE .RE
.TP .TP
.B \-h \fB-h\fP, \fB--help\f
Print a short help text describing the supported command-line options, Print a short help text describing the supported command-line options,
and then exit. and then exit.
.TP .TP
.B \-n \fB-n\fP, \fB--next\f
Print the next appointment within upcoming 24 hours and exit. Print the next appointment within upcoming 24 hours and exit.
The indicated time is the number of hours and minutes left before this The indicated time is the number of hours and minutes left before this
appointment. appointment.
@ -91,10 +82,13 @@ appointment.
\fINote:\fP the calendar from which to read the appointments can be specified using \fINote:\fP the calendar from which to read the appointments can be specified using
the '\-c' flag. the '\-c' flag.
.TP .TP
.B \-t \fB-t\fP[num], \fB--todo\fP[=num]
Print the 'todo' list and exit. 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 .TP
.B \-v \fB-v\fP, \fB--version\f
Display calcurse version and exit. Display calcurse version and exit.
.SH NOTES .SH NOTES
Calcurse interface contains three different panels (calendar, Calcurse interface contains three different panels (calendar,