calcurse(1)

1CALCURSE(1)                     Calcurse Manual                    CALCURSE(1)
2
3
4

NAME

6       Calcurse - text-based organizer
7

SYNOPSIS

9       calcurse [-h|-v] [-x] [-an] [-t[num]] [-d date|num] [-c file]
10

DESCRIPTION

12       Calcurse  is a text-based calendar and scheduling application. It helps
13       keeping track of events, appointments and everyday  tasks.   A  config‐
14       urable  notification system reminds user of upcoming deadlines, and the
15       curses based interface can be customized to suit user  needs.   All  of
16       the commands are documented within an online help system.
17

OPTIONS

19       The following options are supported:
20
21       -a, --appointment
22              Print the appointments and events for the current day and exit.
23              Note:  the  calendar  from which to read the appointments can be
24              specified using the '-c' flag.
25
26       -c <file>, --calendar <file>
27              Specify the calendar  file  to  use.  The  default  calendar  is
28              '~/.calcurse/apts' (see section FILES below).
29
30       -d <date|num>, --day <date|num>
31              Print  the appointments and events for the given date or for the
32              given number of upcoming days, depending on the argument format.
33              Two possible formats are supported:
34
35                ·  a date of the form 'mm/dd/yyyy'.
36
37                ·  a number 'n'.
38
39              In  the  first  case,  the  appointments and events list for the
40              specified date will be returned, while in the  second  case  the
41              appointments  and  events list for the 'n' upcoming days will be
42              returned.
43              As an example, typing 'calcurse -d 3' will display your appoint‐
44              ments  and  events for today, tomorrow, and the day after tomor‐
45              row.
46              Note: as for the '-a' flag, the calendar from which to read  the
47              appointments can be specified using the '-c' flag.
48
49       -h, --help
50              Print  a  short  help text describing the supported command-line
51              options, and then exit.
52
53       -n, --next
54              Print the next appointment within upcoming 24  hours  and  exit.
55              The  indicated  time  is  the  number  of hours and minutes left
56              before this appointment.
57              Note: the calendar from which to read the  appointments  can  be
58              specified using the '-c' flag.
59
60       -t[num], --todo[=num]
61              Print  the  'todo'  list and exit. If the optional number num is
62              given, then only todos having a priority equal to  num  will  be
63              returned.
64              Note:  priority  number  must be between 1 (highest) and 9 (low‐
65              est).
66
67       -v, --version
68              Display calcurse version and exit.
69
70       -x, --export
71              Export user data to iCalendar format. Events,  appointments  and
72              todos are converted and echoed to stdout.
73              Note:  redirect  standard  output  to  export data to a file, by
74              issuing a command such as:
75              $ calcurse --export > my_data.ics
76

NOTES

78       Calcurse interface contains three different panels (calendar,  appoint‐
79       ment  list,  and todo list) on which you can perform different actions.
80       All the possible actions, together with  their  associated  keystrokes,
81       are listed on the status bar. This status bar takes place at the bottom
82       of the screen.
83
84       At any time, the built-in help system can be invoked  by  pressing  the
85       '?'   key.  Once  viewing  the help screens, informations on a specific
86       command can be accessed by pressing the keystroke corresponding to that
87       command.
88

CONFIGURATION

90       The  calcurse options can be changed from the configuration menu (shown
91       when 'C' is hit). Four possible categories are to be chosen from :  the
92       color  scheme,  the  layout  (the  location  of the three panels on the
93       screen), notification options, and more general options (such as  auto‐
94       matic  save before quitting).  All of these options are detailed in the
95       configuration menu.
96

FILES

98       The following structure is created in your $HOME  directory  the  first
99       time calcurse is run :
100
101       $HOME/.calcurse/
102                 |___conf
103                 |___apts
104                 |___todo
105
106       The  conf  file contains the user configuration. The apts file contains
107       all of the user's appointments, and the todo  file  contains  the  todo
108       list.
109

LICENCE

111       Copyright (c) 2004-2007 by Frederic Culot.
112       This  software is released under the GNU General Public License. Please
113       read the COPYING file for more information.
114

BUGS

116       Incorrect highlighting of items appear when using  calcurse  black  and
117       white  theme together with a $TERM variable set to xterm-color.  To fix
118       this bug, and as advised by Thomas E. Dickey (xterm maintainer), xterm-
119       xfree86  should  be  used instead of xterm-color to set the $TERM vari‐
120       able:
121           "The xterm-color value for $TERM is a bad choice for
122            XFree86 xterm because it is commonly used for a
123            terminfo entry which happens to not support bce.
124            Use the xterm-xfree86 entry which is distributed
125            with XFree86 xterm (or the similar one distributed
126            with ncurses)."
127
128       If you find other bugs, please send a report to  calcurse@culot.org  or
129       to the author, below.
130

AUTHOR

132       Frederic Culot <frederic@culot.org>.
133