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

English html manual updated with parts related to daemon mode.

Browse Source
This commit is contained in:
Frederic Culot 2009-08-18 09:55:03 +00:00
parent 4cc75d9a07
commit c8c81d6da2
2 changed files with 79 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
2009-08-18 Frederic Culot <frederic@culot.org>
* doc/manual_*.html: updated
2009-08-17 Frederic Culot <frederic@culot.org> 2009-08-17 Frederic Culot <frederic@culot.org>
* src/notify.c (notify_needs_reminder): do not request for * src/notify.c (notify_needs_reminder): do not request for

89
doc/manual_en.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- <!--
/* /*
* $calcurse: manual_en.html,v 1.26 2009/07/10 19:49:07 culot Exp $ * $calcurse: manual_en.html,v 1.27 2009/08/18 09:55:03 culot Exp $
* *
* Copyright (c) 2004-2009 Frederic Culot <frederic@culot.org> * Copyright (c) 2004-2009 Frederic Culot <frederic@culot.org>
* All rights reserved. * All rights reserved.
@ -88,13 +88,14 @@ well as the way one can contribute to <code>calcurse</code> development.
<li><a href="#basics_interface_noninteractive">4.2.1 Non-interactive mode</a></li> <li><a href="#basics_interface_noninteractive">4.2.1 Non-interactive mode</a></li>
<li><a href="#basics_interface_interactive">4.2.2 Interactive mode</a></li> <li><a href="#basics_interface_interactive">4.2.2 Interactive mode</a></li>
</ul></li> </ul></li>
<li><a href="#basics_files">4.3 <code>calcurse</code> files</a></li> <li><a href="#basics_daemon">4.3 Background mode</a></li>
<li><a href="#basics_import_export">4.4 Import/Export capabilities</a> <li><a href="#basics_files">4.4 <code>calcurse</code> files</a></li>
<li><a href="#basics_import_export">4.5 Import/Export capabilities</a>
<ul> <ul>
<li><a href="#basics_import">4.4.1 Import</a></li> <li><a href="#basics_import">4.5.1 Import</a></li>
<li><a href="#basics_export">4.4.2 Export</a></li> <li><a href="#basics_export">4.5.2 Export</a></li>
</ul></li> </ul></li>
<li><a href="#basics_help">4.5 Online help</a></li> <li><a href="#basics_help">4.6 Online help</a></li>
</ul></li> </ul></li>
<li><a href="#options">5. Options</a> <li><a href="#options">5. Options</a>
<ul> <ul>
@ -191,7 +192,8 @@ All of the commands are documented within an online help system.
between several color and layout combinations. between several color and layout combinations.
Key bindings are also configurable, to fit everyone's needs. Key bindings are also configurable, to fit everyone's needs.
Last, a configurable notification system reminds user of upcoming Last, a configurable notification system reminds user of upcoming
appointments. appointments. The reminders are sent even if the user's interface
is not running, as calcurse is able to run in background.
</p> </p>
<h1>3. Installation<a name="install"></a></h1> <h1>3. Installation<a name="install"></a></h1>
@ -249,7 +251,7 @@ All of the commands are documented within an online help system.
<h2>3.2 Install process<a name="install_process"></a></h2> <h2>3.2 Install process<a name="install_process"></a></h2>
<p> <p>
First you need to gunzip and untar the source archive:</p> First you need to gunzip and untar the source archive:</p>
<pre>tar zxvf calcurse-2.6.tar.gz</pre> <pre>tar zxvf calcurse-2.7.tar.gz</pre>
<p> <p>
Once you meet the requirements and have extracted the archive, Once you meet the requirements and have extracted the archive,
the install process is quite simple, and follows the standard the install process is quite simple, and follows the standard
@ -358,6 +360,13 @@ All of the commands are documented within an online help system.
print only the items having a description that matches the given print only the items having a description that matches the given
regular expression. regular expression.
</dd> </dd>
<dt><code>--status</code></dt>
<dd>
Display the status of running instances of calcurse. If
calcurse is running, this will tell if the interactive
mode was launched or if calcurse is running in background.
The process pid will also be indicated.
</dd>
<dt><code>-t[num], --todo[=num]</code></dt> <dt><code>-t[num], --todo[=num]</code></dt>
<dd> <dd>
Print the 'todo' list and exit. If the optional number Print the 'todo' list and exit. If the optional number
@ -574,7 +583,40 @@ All of the commands are documented within an online help system.
</dl> </dl>
</p> </p>
<h2>4.3 <code>calcurse</code> files<a name="basics_files"></a></h2> <h2>4.3 Background mode<a name="basics_daemon"></a></h2>
<p>When the daemon mode is enabled in the notification configuration menu
(see <a href="#options_notify">Notify-bar settings</a>), <code>calcurse</code> will stay
in background when the user interface is not running. In background mode,
<code>calcurse</code> checks for upcoming appointments and runs the user-defined
notification command when necessary. When the user interface is started again,
the daemon automatically stops.</p>
<p><code>calcurse</code> background activity can be logged (set the
<code>notify-daemon_log</code> variable in the notification configuration
<a href="#options_notify">menu</a>), and in that case, information about the daemon
start and stop time, reminders' command launch time, signals received... will be written
in the <code>daemon.log</code> file (see section <a href="#basics_files">files</a>).</p>
<p>
Using the <code>--status</code> command line option (see section
<a href="#basics_invocation_commandline">Command line arguments</a>),
one can know if <code>calcurse</code> is currently running in background or not.
If the daemon is running, a message like the following one will be displayed (the pid of
the daemon process will be shown):
<pre>calcurse is running in background (pid 14536)</pre>
<p class="rq"><span class="valorise">Note:</span>
To stop the daemon, just send the <code>TERM</code> signal to it, using a command such as:
<code>'kill daemon_pid'</code>, where <span class="emp">daemon_pid</span> is the process id
of the daemon (14536 in the above example).
</p>
</p>
<h2>4.4 <code>calcurse</code> files<a name="basics_files"></a></h2>
<p> <p>
The following structure is created in your <code>$HOME</code> The following structure is created in your <code>$HOME</code>
directory (or in the directory you specified with the -D option) directory (or in the directory you specified with the -D option)
@ -603,13 +645,20 @@ $HOME/.calcurse/
<dd>this file contains the todo list</dd> <dd>this file contains the todo list</dd>
</dl> </dl>
<h2>4.4 Import/Export capabilities<a name="basics_import_export"></a></h2> <p class="rq"><span class="valorise">Note:</span>
If the logging of calcurse daemon activity was set in the notification
configuration menu, the extra file <code>daemon.log</code> will appear
in calcurse data directory. This file contains logs about calcurse activity
when running in background.
</p>
<h2>4.5 Import/Export capabilities<a name="basics_import_export"></a></h2>
<p> <p>
The import and export capabilities offered by <code>calcurse</code> The import and export capabilities offered by <code>calcurse</code>
are described below. are described below.
</p> </p>
<h3>4.4.1 Import<a name="basics_import"></a></h3> <h3>4.5.1 Import<a name="basics_import"></a></h3>
<p> <p>
Data in icalendar format as described in the rfc2445 specification Data in icalendar format as described in the rfc2445 specification
(see <a href="#links_others">links</a> section below) can be imported (see <a href="#links_others">links</a> section below) can be imported
@ -648,14 +697,14 @@ $HOME/.calcurse/
</ul> </ul>
</p> </p>
<h3>4.4.2 Export<a name="basics_export"></a></h3> <h3>4.5.2 Export<a name="basics_export"></a></h3>
<p> <p>
Two possible export formats are available: <code>ical</code> and Two possible export formats are available: <code>ical</code> and
<code>pcal</code> (see section <a href="#links_others">Links</a> below <code>pcal</code> (see section <a href="#links_others">Links</a> below
to find out about those formats). to find out about those formats).
</p> </p>
<h2>4.5 Online help<a name="basics_help"></a></h2> <h2>4.6 Online help<a name="basics_help"></a></h2>
<p> <p>
At any time, the built-in help system can be invoked by At any time, the built-in help system can be invoked by
pressing the '?' key. Once viewing the help screens, pressing the '?' key. Once viewing the help screens,
@ -878,6 +927,18 @@ $HOME/.calcurse/
calcurse --next | mail -s "[calcurse] upcoming appointment!" user@host.com calcurse --next | mail -s "[calcurse] upcoming appointment!" user@host.com
</code> </code>
</dd> </dd>
<dt><code>notify-daemon_enable</code>
(default: <span class="emp">no</span>)</dt>
<dd>If set to yes, daemon mode will be enabled, meaning <code>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 href="#basics_daemon">'Background mode'</a>.
</dd>
<dt><code>notify-daemon_log</code>
(default: <span class="emp">no</span>)</dt>
<dd>If set to yes, <code>calcurse</code> daemon activity will be logged (see section
<a href="#basics_files">files</a>).
</dd>
</dl> </dl>
<h1>6. Known bugs<a name="known_bugs"></a></h1> <h1>6. Known bugs<a name="known_bugs"></a></h1>
@ -1203,7 +1264,7 @@ msgid ""
<div class="footer"> <div class="footer">
Copyright &copy; 2004-2009 Frédéric Culot<br> Copyright &copy; 2004-2009 Frédéric Culot<br>
Calcurse version 2.6 - Last change: July 10, 2009<br> Calcurse version 2.7 - Last change: August 18, 2009<br>
</div> </div>
</div> </div>