From 20cd296a80d2f3a2b43de4c00fc5ed26ce36221e Mon Sep 17 00:00:00 2001
From: Frederic Culot <calcurse@culot.org>
Date: Tue, 18 Aug 2009 13:07:59 +0000
Subject: Manuals updated with parts related to daemon mode.
---
doc/manual_de.html | 119 ++++++++++++++++++++++++++++++++++++++++-------------
1 file changed, 90 insertions(+), 29 deletions(-)
(limited to 'doc/manual_de.html')
diff --git a/doc/manual_de.html b/doc/manual_de.html
index dd4b79d..b003583 100755
--- a/doc/manual_de.html
+++ b/doc/manual_de.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--
/*
- * $calcurse: manual_de.html,v 1.26 2009/07/10 19:49:07 culot Exp $
+ * $calcurse: manual_de.html,v 1.27 2009/08/18 13:07:59 culot Exp $
*
* Copyright (c) 2004-2009 Frederic Culot <frederic@culot.org>
* All rights reserved.
@@ -91,13 +91,14 @@ well as the way one can contribute to <code>calcurse</code> development.
<li><a href="#basics_interface_noninteractive">4.2.1 Nicht-interaktiver Modus</a></li>
<li><a href="#basics_interface_interactive">4.2.2 Interaktiver Modus</a></li>
</ul></li>
- <li><a href="#basics_files">4.3 <code>calcurse</code> Dateien</a></li>
- <li><a href="#basics_import_export"><span class="todo">4.4 Import/Export capabilities</span></a>
+ <li><a href="#basics_daemon"><span class="todo">4.3 Background mode</span></a></li>
+ <li><a href="#basics_files">4.4 <code>calcurse</code> Dateien</a></li>
+ <li><a href="#basics_import_export"><span class="todo">4.5 Import/Export capabilities</span></a>
<ul>
- <li><a href="#basics_import"><span class="todo">4.4.1 Import</span></a></li>
- <li><a href="#basics_export"><span class="todo">4.4.2 Export</span></a></li>
+ <li><a href="#basics_import"><span class="todo">4.5.1 Import</span></a></li>
+ <li><a href="#basics_export"><span class="todo">4.5.2 Export</span></a></li>
</ul></li>
- <li><a href="#basics_help">4.5 Onlinehilfe</a></li>
+ <li><a href="#basics_help">4.6 Onlinehilfe</a></li>
</ul></li>
<li><a href="#options">5. Optionen</a>
<ul>
@@ -199,6 +200,8 @@ wählen.
<span class="todo">Key bindings are also configurable, to fit everyone's needs.</span>
Ein konfigurierbares Notizsystem erinnert den Benutzer
an bevorstehende Termine.
+<span class="todo">The reminders are sent even if the user's interface
+is not running, as calcurse is able to run in background.</span>
</p>
<h1>3. Installation<a name="install"></a></h1>
@@ -255,7 +258,7 @@ laden:</p>
<h2>3.2 Installationsprozess<a name="install_process"></a></h2>
<p>
Als erstes müssen die Dateien entpackt werden:</p>
-<pre>tar zxvf calcurse-2.6.tar.gz</pre>
+<pre>tar zxvf calcurse-2.7.tar.gz</pre>
<p>
Ist diese Voraussetzung erfüllt und das Archiv entpackt,
sind nur noch die drei üblichen Schritte erforderlich:</p>
@@ -367,6 +370,15 @@ Es werden sowohl kurze als auch lange Optionsangaben unterstützt.</p>
regular expression.
</div>
</dd>
+ <dt><code>--status</code></dt>
+ <dd>
+ <div class="todo">
+ 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.
+ </div>
+ </dd>
<dt><code>-t[num], --todo[=num]</code></dt>
<dd>Gibt die 'todo' Liste aus.
Wird die optionale Angabe <code>num</code> übergeben, werden nur diejenigen
@@ -578,7 +590,38 @@ Hierbei steht '^' für die Taste 'Strg' beziehungsweise 'Ctrl':
</dl>
</p>
-<h2>4.3 <code>calcurse</code> Dateien<a name="basics_files"></a></h2>
+<div class="todo">
+<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>
+</div>
+
+<h2>4.4 <code>calcurse</code> Dateien<a name="basics_files"></a></h2>
<p>
Die folgende Verzeichnisstruktur wird im $HOME-Verzeichnis angelegt,
<div class="todo">(or in the directory you specified with the -D option)</div>
@@ -607,15 +650,24 @@ $HOME/.calcurse/
<dd>Datei enthält die todo-Liste.</dd>
</dl>
+<div class="todo">
+ <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>
+</div>
+
<div class="todo">
-<h2>4.4 Import/Export capabilities<a name="basics_import_export"></a></h2>
+<h2>4.5 Import/Export capabilities<a name="basics_import_export"></a></h2>
<p>
The import and export capabilities offered by <code>calcurse</code>
are described below.
</p>
-<h3>4.4.1 Import<a name="basics_import"></a></h3>
+<h3>4.5.1 Import<a name="basics_import"></a></h3>
<p>
Data in icalendar format as described in the rfc2445 specification
(see <a href="#links_others">links</a> section below) can be imported
@@ -654,7 +706,7 @@ $HOME/.calcurse/
</ul>
</p>
-<h3>4.4.2 Export<a name="basics_export"></a></h3>
+<h3>4.5.2 Export<a name="basics_export"></a></h3>
<p>
Two possible export formats are available: <code>ical</code> and
<code>pcal</code> (see section <a href="#links_others">Links</a> below
@@ -662,7 +714,7 @@ $HOME/.calcurse/
</p>
</div>
-<h2>4.5 Online Hilfe<a name="basics_help"></a></h2>
+<h2>4.6 Online Hilfe<a name="basics_help"></a></h2>
<p>
Das integrierte Hilfe-System kann jederzeit mit '?' aufgerufen
werden. Informationen über bestimmte Befehle können mit der
@@ -700,16 +752,14 @@ allgemeines Verhalten.</p>
betätigen.</p>
</dd>
- <div class="todo">
- <dt><code>periodic_save</code>
- (default: <span class="emp">0</span>)</dt>
- <dd>If different from '0', user's data will be automatically
+ <dt><code><span class="todo">periodic_save</code>
+ (default: <span class="emp">0</span>)</span></dt>
+ <dd><span class="todo">If different from '0', user's data will be automatically
saved every <span class="emp">periodic_save</span> minutes.
When an automatic save is performed, two asterisks
(i.e. '<code>**</code>') will appear on the top right-hand side
- of the screen).</p>
+ of the screen).</span>
</dd>
- </div>
<dt><code>Beenden_bestätigen</code>
(Voreinstellung: <span class="emp">ja</span>)</dt>
@@ -740,19 +790,18 @@ allgemeines Verhalten.</p>
als erster Tag der Woche festgelegt. Ist <span class="emp">nein</span> gewählt,
beginnt die Woche sonntags.</dd>
- <div class="todo">
- <dt><code>output_datefmt</code>
- (default: <span class="emp">%D</span>)</dt>
- <dd>This option indicates the format to be used when displaying dates
+ <dt><code><span class="todo">output_datefmt</code>
+ (default: <span class="emp">%D</span>)</span></dt>
+ <dd><span class="todo">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="emp">mm/dd/aa</span>.
You can see all of the possible formats by typing <code>man 3 strftime</code>
- inside a terminal.</dd>
+ inside a terminal.</span></dd>
- <dt><code>input_datefmt</code>
- (default: <span class="emp">1</span>)</dt>
- <dd>This option indicates the format that will be used to enter dates in
- <span class="emp">calcurse</span>. Four choices are available:
+ <dt><code><span class="todo">input_datefmt</code>
+ (default: <span class="emp">1</span>)</span></dt>
+ <dd><span class="todo">This option indicates the format that will be used to enter dates in
+ <span class="emp">calcurse</span>. Four choices are available:</span>
<ol>
<li>mm/dd/yyyy</li>
<li>dd/mm/yyyy</li>
@@ -760,7 +809,6 @@ allgemeines Verhalten.</p>
<li>yyyy-mm-dd</li>
</ol>
</dd>
- </div>
</dl>
<div class="todo">
@@ -878,6 +926,19 @@ entsprechend anpassen.</p>
calcurse --next | mail -s "[calcurse] upcoming appointment!" user@host.com
</code>
</dd>
+
+ <dt><code><span class="todo">notify-daemon_enable</code>
+ (default: <span class="emp">no</span>)</span></dt>
+ <dd><span class="todo">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>.</span>
+ </dd>
+ <dt><code><span class="todo">notify-daemon_log</code>
+ (default: <span class="emp">no</span>)</span></dt>
+ <dd><span class="todo">If set to yes, <code>calcurse</code> daemon activity will be logged (see section
+ <a href="#basics_files">files</a></span>).
+ </dd>
</dl>
<h1>6. Bekannte Fehler<a name="known_bugs"></a></h1>
@@ -1187,7 +1248,7 @@ Benutzer, die mir Ihr Feedback mitgeteilt haben.</p>
Copyright © 2004-2009 Fr�d�ric Culot<br>
German translation by Michael Schulz
<code><bloodshower .at. web .dot. de></code>, and Chris.<br>
- Calcurse version 2.6 - Last change: July 10, 2009<br>
+ Calcurse version 2.7 - Last change: August 18, 2009<br>
</div>
</div>
--
cgit v1.2.3-70-g09d2