summaryrefslogtreecommitdiffstats
path: root/files/manual.chunked/ar01s05.html
blob: b9090caadd53dd9e827f31094adbb73d7fac3455 (plain) (blame)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>5. Options</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="CALCURSE - text-based organizer" /><link rel="up" href="index.html" title="CALCURSE - text-based organizer" /><link rel="prev" href="ar01s04.html" title="4. calcurse basics" /><link rel="next" href="ar01s06.html" title="6. Known bugs" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ar01s04.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s06.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" title="5. Options"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_options"></a>5. Options</h2></div></div></div><p>All of the <code class="literal">calcurse</code> parameters are configurable from the Configuration menu
available when pressing <code class="literal">C</code>. You are then driven to a submenu with five
possible choices : pressing <code class="literal">C</code> again will lead you to the Color scheme
configuration, pressing <code class="literal">L</code> allows you to choose the layout of the main
<code class="literal">calcurse</code> screen (in other words, where to put the three different panels on
screen), pressing <code class="literal">G</code> permits you to choose between different general options,
pressing <code class="literal">K</code> opens the key bindings configuration menu, and last you can modify
the notify-bar settings by pressing <code class="literal">N</code>.</p><div class="section" title="5.1. General options"><div class="titlepage"><div><div><h3 class="title"><a id="options_general"></a>5.1. General options</h3></div></div></div><p>These options control <code class="literal">calcurse</code> general behavior, as described below:</p><div class="variablelist"><dl><dt><span class="term">
<code class="literal">auto_save</code> (default: <span class="strong"><strong>yes</strong></span>)
</span></dt><dd>
  This option allows to automatically save the user’s data (if set to <span class="strong"><strong>yes</strong></span>)
  when quitting.  &lt;p class="rq"&gt;&lt;span class="valorise"&gt;warning:&lt;/span&gt; No data
  will be automatically saved if <code class="literal">auto_save</code> is set to <span class="strong"><strong>no</strong></span>.  This means the
  user must press <code class="literal">S</code> (for saving) in order to retrieve its modifications.
</dd><dt><span class="term">
<code class="literal">periodic_save</code> (default: <span class="strong"><strong>0</strong></span>)
</span></dt><dd>
  If different from <code class="literal">0</code>, user’s data will be automatically saved every
  <span class="strong"><strong>periodic_save</strong></span> minutes.  When an automatic save is performed, two asterisks
  (i.e. <code class="literal">**</code>) will appear on the top right-hand side of the screen).
</dd><dt><span class="term">
<code class="literal">confirm_quit</code> (default: <span class="strong"><strong>yes</strong></span>)
</span></dt><dd>
  If set to <span class="strong"><strong>yes</strong></span>, confirmation is required before quitting, otherwise pressing
  <code class="literal">Q</code> will cause <code class="literal">calcurse</code> to quit without prompting for user confirmation.
</dd><dt><span class="term">
<code class="literal">confirm_delete</code> (default: <span class="strong"><strong>yes</strong></span>)
</span></dt><dd>
  If this option is set to <span class="strong"><strong>yes</strong></span>, pressing <code class="literal">D</code> for deleting an item (either a
  <span class="strong"><strong>todo</strong></span>, <span class="strong"><strong>appointment</strong></span>, or <span class="strong"><strong>event</strong></span>), will lead to a prompt asking for user
  confirmation before removing the selected item from the list.  Otherwise, no
  confirmation will be needed before deleting the item.
</dd><dt><span class="term">
<code class="literal">skip_system_dialogs</code> (default: <span class="strong"><strong>no</strong></span>)
</span></dt><dd>
  Setting this option to <span class="strong"><strong>yes</strong></span> will result in skipping the system dialogs
  related to the saving and loading of data.  This can be useful to speed up
  the input/output processes.
</dd><dt><span class="term">
<code class="literal">skip_progress_bar</code> (default: <span class="strong"><strong>no</strong></span>)
</span></dt><dd>
  If set to <span class="strong"><strong>yes</strong></span>, this will cause the disappearing of the progress bar which
  is usually shown when saving data to file.  If set to <span class="strong"><strong>no</strong></span>, this bar will be
  displayed, together with the name of the file being saved (see section
  <a class="link" href="ar01s04.html#basics_files" title="4.4. calcurse files">calcurse files</a>).
</dd><dt><span class="term">
<code class="literal">calendar_default_view</code> (default: <span class="strong"><strong>0</strong></span>)
</span></dt><dd>
  If set to <code class="literal">0</code>, the monthly calendar view will be displayed by default
  otherwise it is the weekly view that will be displayed.
</dd><dt><span class="term">
<code class="literal">week_begins_on_monday</code> (default: <span class="strong"><strong>yes</strong></span>)
</span></dt><dd>
  One can choose between Monday and Sunday as the first day of the week. If the
  option <code class="literal">week_begins_on_monday</code> is set to <span class="strong"><strong>yes</strong></span>, Monday will be first in the
  calendar view. Else if the option is set to <span class="strong"><strong>no</strong></span>, then Sunday will be the
  first day of the week.
</dd><dt><span class="term">
<code class="literal">output_datefmt</code> (default: <span class="strong"><strong>%D</strong></span>)
</span></dt><dd>
  This option indicates the format to be used when displaying dates in
  non-interactive mode. Using the default values, dates are displayed the
  following way: <span class="strong"><strong>mm/dd/aa</strong></span>.  You can see all of the possible formats by typing
  <code class="literal">man 3 strftime</code> inside a terminal.
</dd><dt><span class="term">
<code class="literal">input_datefmt</code> (default: <span class="strong"><strong>1</strong></span>)
</span></dt><dd><p class="simpara">
  This option indicates the format that will be used to enter dates in
  <span class="strong"><strong>calcurse</strong></span>. Four choices are available:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
mm/dd/yyyy
</li><li class="listitem">
dd/mm/yyyy
</li><li class="listitem">
yyyy/mm/dd
</li><li class="listitem">
yyyy-mm-dd
</li></ol></div></dd></dl></div></div><div class="section" title="5.2. Key bindings"><div class="titlepage"><div><div><h3 class="title"><a id="options_keys"></a>5.2. Key bindings</h3></div></div></div><p>One can define it’s own keybindings within the <code class="literal">Keys</code> configuration menu. The
default keys look like the one used by the <code class="literal">vim</code> editor, especially the
displacement keys. Anyway, within this configuration menu, users can redefine
all of the keys available from within calcurse’s user interface.</p><p>To define new keybindings, first highlight the action to which it will apply.
Then, delete the actual key binding if necessary, and add a new one. You will
then be asked to press the key corresponding to the new binding. It is possible
to define more than one key binding for a single action.</p><p>An automatic check is performed to see if the new key binding is not already
set for another action. In that case, you will be asked to choose a different
one. Another check is done when exiting from this menu, to make sure all
possible actions have a key associated with it.</p><p>The following keys can be used to define bindings:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
lower-case, upper-case letters and numbers, such as <code class="literal">a</code>, <code class="literal">Z</code>, <code class="literal">0</code>
</li><li class="listitem">
CONTROL-key followed by one of the above letters
</li><li class="listitem">
escape, horizontal tab, and space keys
</li><li class="listitem">
arrow keys (up, down, left, and right)
</li><li class="listitem">
<code class="literal">HOME</code> and <code class="literal">END</code> keys
</li></ul></div><p>While inside the key configuration menu, an online help is available for each
one of the available actions. This help briefly describes what the highlighted
action is used for.</p></div><div class="section" title="5.3. Color themes"><div class="titlepage"><div><div><h3 class="title"><a id="_color_themes"></a>5.3. Color themes</h3></div></div></div><p><code class="literal">calcurse</code> color theme can be customized to suit user’s needs. To change the
default theme, the configuration page displays possible choices for foreground
and background colors.  Using arrows or calcurse displacement keys to move, and
<code class="literal">X</code> or space to select a color, user can preview the theme which will be
applied.  It is possible to keep the terminal’s default colors by selecting the
corresponding choice in the list.</p><p>The chosen color theme will then be applied to the panel borders, to the
titles, to the keystrokes, and to general informations displayed inside status
bar. A black and white theme is also available, in order to support non-color
terminals.</p><div class="note" title="Note" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/icons/note.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>Depending on your terminal type and on the value of the <code class="literal">$TERM</code>
      environnement variable, color could or could not be supported. An error
      message will appear if you try to change colors whereas your terminal
      does not support this feature.  If you do know your terminal supports
      colors but could not get <code class="literal">calcurse</code> to display them, try to set your
      <code class="literal">$TERM</code> variable to another value (such as <span class="strong"><strong>xterm-xfree86</strong></span> for instance).</p></td></tr></table></div></div><div class="section" title="5.4. Layout configuration"><div class="titlepage"><div><div><h3 class="title"><a id="_layout_configuration"></a>5.4. Layout configuration</h3></div></div></div><p>The layout corresponds to the position of the panels inside <code class="literal">calcurse</code> screen.
The default layout makes the calendar panel to be displayed on the top-right
corner of the terminal, the todo panel on the bottom-right corner, while the
appointment panel is displayed on the left hand-side of the screen (see the
figure in section <a class="link" href="ar01s04.html#basics_interface_interactive" title="Interactive mode">Interactive mode</a> for an
exemple of the default layout).  By choosing another layout in the
configuration screen, user can customize <code class="literal">calcurse</code> appearence to best suit his
needs by placing the different panels where needed.</p><p>The following option is used to modify the layout configuration:</p><div class="variablelist"><dl><dt><span class="term">
<code class="literal">layout</code> (default: <span class="strong"><strong>0</strong></span>)
</span></dt><dd>
  Eight different layouts are to be chosen from (see layout configuration
  screen for the description of the available layouts).
</dd></dl></div></div><div class="section" title="5.5. Sidebar configuration"><div class="titlepage"><div><div><h3 class="title"><a id="_sidebar_configuration"></a>5.5. Sidebar configuration</h3></div></div></div><p>The sidebar is the part of the screen which contains two panels: the calendar
and, depending on the chosen layout, either the todo list or the appointment
list.</p><p>The following option is used to change the width of the sidebar:</p><div class="variablelist"><dl><dt><span class="term">
<code class="literal">side-bar_width</code> (default: <span class="strong"><strong>0</strong></span>)
</span></dt><dd>
  Width (in percentage, 0 being the minimum width) of the side bar.
</dd></dl></div></div><div class="section" title="5.6. Notify-bar settings"><div class="titlepage"><div><div><h3 class="title"><a id="options_notify"></a>5.6. Notify-bar settings</h3></div></div></div><p>The following options are used to modify the notify-bar behavior:</p><div class="variablelist"><dl><dt><span class="term">
<code class="literal">notify-bar_show</code> (default: <span class="strong"><strong>yes</strong></span>)
</span></dt><dd>
  This option indicates if you want the notify-bar to be displayed or not.
</dd><dt><span class="term">
<code class="literal">notify-bar_date</code> (default: <span class="strong"><strong>%a %F</strong></span>)
</span></dt><dd>
  With this option, you can specify the format to be used to display the
  current date inside the notification bar. You can see all of the possible
  formats by typing <code class="literal">man 3 strftime</code> inside a terminal.
</dd><dt><span class="term">
<code class="literal">notify-bar_time</code> (default: <span class="strong"><strong>%T</strong></span>)
</span></dt><dd>
  With this option, you can specify the format to be used to display the
  current time inside the notification bar. You can see all of the possible
  formats by typing <code class="literal">man 3 strftime</code> inside a terminal.
</dd><dt><span class="term">
<code class="literal">notify-bar_warning</code> (default: <span class="strong"><strong>300</strong></span>)
</span></dt><dd>
  When there is an appointment which is flagged as <code class="literal">important</code> within the next
  <code class="literal">notify-bar_warning</code> seconds, the display of that appointment inside the
  notify-bar starts to blink.  Moreover, the command defined by the
  <code class="literal">notify-bar_command</code> option will be launched.  That way, the user is warned
  and knows there will be soon an upcoming appointment.
</dd><dt><span class="term">
<code class="literal">notify-bar_command</code> (default: <span class="strong"><strong>printf <span class="emphasis"><em>\a</em></span></strong></span>)
</span></dt><dd><p class="simpara">
  This option indicates which command is to be launched when there is an
  upcoming appointment flagged as <code class="literal">important</code>. This command will be passed to
  the user’s shell which will interpret it. To know what shell must be used,
  the content of the <code class="literal">$SHELL</code> environment variable is used. If this variable is
  not set, <code class="literal">/bin/sh</code> is used instead.
</p><div class="informalexample"><p>Say the <code class="literal">mail</code> command is available on the user’s system, one can use the
following command to get notified by mail of an upcoming appointment (the
appointment description will also be mentioned in the mail body):</p><pre class="screen">$ calcurse --next | mail -s "[calcurse] upcoming appointment!" user@host.com</pre></div></dd><dt><span class="term">
<code class="literal">notify-daemon_enable</code> (default: <span class="strong"><strong>no</strong></span>)
</span></dt><dd>
  If set to yes, daemon mode will be enabled, meaning <code class="literal">calcurse</code> will run into
  background when the user’s interface is exited. This will allow the
  notifications to be launched even when the interface is not running. More
  details can be found in section <a class="link" href="ar01s04.html#basics_daemon" title="4.3. Background mode">Background mode</a>.
</dd><dt><span class="term">
<code class="literal">notify-daemon_log</code> (default: <span class="strong"><strong>no</strong></span>)
</span></dt><dd>
  If set to yes, <code class="literal">calcurse</code> daemon activity will be logged (see section
  <a class="link" href="ar01s04.html#basics_files" title="4.4. calcurse files">files</a>).
</dd></dl></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s04.html"><img src="images/icons/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s06.html"><img src="images/icons/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/icons/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>