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_it.html | 150 +++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 106 insertions(+), 44 deletions(-)

(limited to 'doc/manual_it.html')
diff --git a/doc/manual_it.html b/doc/manual_it.html
index 4cf11b1..8593a6b 100755
--- a/doc/manual_it.html
+++ b/doc/manual_it.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <!--
 /*
- * $calcurse: manual_it.html,v 1.12 2009/07/10 19:49:08 culot Exp $
+ * $calcurse: manual_it.html,v 1.13 2009/08/18 13:08:01 culot Exp $
  *
  * Copyright (c) 2004-2009 Frederic Culot <frederic@culot.org>
  * All rights reserved.
@@ -91,13 +91,14 @@ partecipare allo sviluppo di calcurse.
 	    <li><a href="#basics_interface_noninteractive">4.2.1 Modo non interattivo</a></li>
 	    <li><a href="#basics_interface_interactive">4.2.2 Modo interattivo</a></li>
 	</ul></li>
-	<li><a href="#basics_files">4.3 Files di <code>calcurse</code></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 Files di <code>calcurse</code></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 Aiuto in linea</a></li>
+	<li><a href="#basics_help">4.6 Aiuto in linea</a></li>
     </ul></li>
     <li><a href="#options">5. Opzioni</a>
     <ul>
@@ -201,6 +202,8 @@ caratteristiche<a name="overview_features"></a></h2>
 <span class="todo">Key bindings are also configurable, to fit everyone's needs.</span>
   Infine un sistema configurabile di allarmi ricorda all'utente
   l'avvicinarsi degli appuntamenti.
+<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. Installazione<a name="install"></a></h1>
@@ -268,7 +271,7 @@ caratteristiche<a name="overview_features"></a></h2>
   Innanzitutto è necessario scompattare l'archivio contenente i
   sorgenti:
 </p>
-	<pre>tar zxvf calcurse-2.6.tar.gz</pre>
+	<pre>tar zxvf calcurse-2.7.tar.gz</pre>
 <p>
   Una volta verificati i requisiti e scompattato l'archivio la
   procedura d'installazione è piuttosto semplice visto che segue i tre
@@ -319,7 +322,7 @@ caratteristiche<a name="overview_features"></a></h2>
       dell'argomento. Sono possibili due formati:
 
       <ul>
-	<li>una data <span class="todo">(possible formats described below).</li>
+	<li>una data <span class="todo">(possible formats described below).</span></li>
 	<li>un numero 'n'.</li>
       </ul>
       Nel primo caso viene mostrata la lista degli appuntamenti per la
@@ -403,6 +406,15 @@ caratteristiche<a name="overview_features"></a></h2>
             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>
@@ -633,7 +645,38 @@ d'ambiente<a name="basics_invocation_environment"></a></h3>
   </dl> 
 </p>
 
-<h2>4.3 File di <code>calcurse</code><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 File di <code>calcurse</code><a name="basics_files"></a></h2>
 <p>
   Al primo avvio di <code>calcurse</code> viene creata nella vostra
   directory <code>$HOME</code> 
@@ -673,13 +716,22 @@ d'ambiente<a name="basics_invocation_environment"></a></h3>
 </dl>
 
 <div class="todo">
-<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>
+</div>
+
+<div class="todo">
+<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
@@ -718,7 +770,7 @@ d'ambiente<a name="basics_invocation_environment"></a></h3>
         </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
@@ -726,7 +778,7 @@ d'ambiente<a name="basics_invocation_environment"></a></h3>
 </p>
 </div>
 
-<h2>4.5 Aiuto in linea<a name="basics_help"></a></h2>
+<h2>4.6 Aiuto in linea<a name="basics_help"></a></h2>
 <p>
   In ogni momento è possibile richiedere il sistema dell'aiuto in
   linea premendo il tasto '?': una volta avviato si possono richiedere
@@ -766,16 +818,14 @@ d'ambiente<a name="basics_invocation_environment"></a></h3>
 	      modificati.
 	  </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
-            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>
-            </dd>
-            </div>
+    <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).</span>
+    </dd>
 
 	  <dt><code>confirm_quit</code> 
 	    (default: <span class="emp">yes</span>)</dt>
@@ -823,26 +873,25 @@ d'ambiente<a name="basics_invocation_environment"></a></h3>
 	    finestra del calendario.
 	  </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
-                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>
-                <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:
-                <ol>
-                  <li>mm/dd/yyyy</li>
-                  <li>dd/mm/yyyy</li>
-                  <li>yyyy/mm/dd</li>
-                  <li>yyyy-mm-dd</li>
-                  </ol>
-                </dd>
-                </div>
+    <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.</span></dd>
+
+    <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>
+      <li>yyyy/mm/dd</li>
+      <li>yyyy-mm-dd</li>
+    </ol>
+    </dd>
 
 	</dl>
 
@@ -989,6 +1038,19 @@ d'ambiente<a name="basics_invocation_environment"></a></h3>
       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. Bachi conosciuti<a name="known_bugs"></a></h1>
@@ -1445,7 +1507,7 @@ d'ambiente<a name="basics_invocation_environment"></a></h3>
 
 <div class="footer">
   Copyright &copy; 2004-2009 Fr&eacute;d&eacute;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>
 
-- 
cgit v1.2.3-54-g00ecf

