Software.html in taskjuggler-3.2.0

- old
+ new

@@ -1,12 +1,12 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<!-- This file has been generated by tj3man v3.1.0 -->
-<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
+<!DOCTYPE>
+<!-- This file has been generated by tj3man v3.2.0 -->
+<html lang="en" xml:lang="en">
  <head>
   <title>Software</title>
   <meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
+  <meta content="IE=9" http-equiv="X-UA-Compatible"/>
  </head>
  <link href="css/tjmanual.css" rel="stylesheet" type="text/css"></link>
  <body>
   <div align="center">
    <h3 align="center">The TaskJuggler User Manual</h3>
@@ -79,11 +79,11 @@
 </pre></div>
     <p class="manual">how to use a different browser. If you omit the keyword, you will get this user manual (browser).</p>
     <h2 class="manual" id="tj3d">6.3 <code class="manual">tj3d</code>
     </h2>
     <p class="manual">
-     <code class="manual">tj3d</code> is the TaskJuggler daemon. It is a program that runs in the background, disconnected from your shell to provide certain services. It can generate reports on demand and serves them as web pages to a web browser. It's also used to process incoming time sheets.</p>
+     <code class="manual">tj3d</code> is the TaskJuggler daemon. It is a program that runs in the background, disconnected from your shell to provide certain services. It can generate reports on demand and processes incoming time sheets or status reports.</p>
     <p class="manual">Depending on the size of your project the scheduling time can take several minutes or more. Since all operations need to be done on the data of a scheduled project, it makes sense to have this data readily available. This is the job of the TaskJuggler server or daemon in Linux lingo. The program is called <code class="manual">tj3d</code>. When started, it automatically disconnects from the terminal and runs in the background. All interactions with the server are done via the TCP/IP protocol. For security reasons, only connections from the same machine (localhost) are accepted. To get access all clients must provide an authentication key. A TaskJuggler server can serve any number of projects. Once a project has been loaded successfully, clients can retrieve the data in form of reports. Projects are identified by their project ID. If a newly added project has the same ID such as an already loaded project, the new project will replace the old project once it was scheduled successfully. Before you start the server, you need to provide a configuration file with some basic settings.</p>
     <p class="manual">All taskjuggler components can use the same TaskJuggler configuration file. The format is a simple plain text format that follows the <a href="http://www.yaml.org/" target="_top">YAML specification</a>. The file should be called <code class="manual">.taskjuglerrc</code> or <code class="manual">taskjuggler.rc</code>. The settings are structured by sections. Section names always start with an underscore.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">_global:
   authKey: topsecret
   _log:
@@ -102,16 +102,10 @@
     </ul>
     <p class="manual">The configuration file will be searched in the current directory, the current user's home directory or <code class="manual">/etc</code>. You can also explicitly tell the server where to find the configuration file with the <code class="manual">-c</code> option. See</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">tj3d --help
 </pre></div>
     <p class="manual">for details.</p>
-    <p class="manual">The daemon can also be turned into a web server that serves the HTML reports of one or more projects. To enable the web server, start the daemon with the <code class="manual">-w</code> option. By default, the web server is listening on port 8080. This can be changed in the <code class="manual">_global</code> section of the config file.</p>
-    <div class="manual" codesection="1"><pre class="manual" codesection="1">_global:
-  authKey: topsecret
-  webServerPort: 8080
-</pre></div>
-    <p class="manual">To access the HTML reports point your web browser to <code class="manual">http://localhost:8080/taskjuggler</code>. This assumes that the server is running on your local machine. You will then see a list of all loaded projects. Click on the project name to get a list of all reports for this project.</p>
     <p class="manual">So far, the daemon has not received any kind of security review. We strongly advise you to only use the daemon in a trusted environment with only trusted users!</p>
     <h2 class="manual" id="tj3client">6.4 <code class="manual">tj3client</code>
     </h2>
     <p class="manual">To control the TaskJuggler server, you need to use the TaskJuggler client. You can use the client to add or remove projects from the server, inquire the status of loaded projects. It can also be used to show the available reports for each project and to generate report or check time or status sheets.</p>
     <p class="manual">The client must provide the correct authentication key to the server. You need to ensure that it can find the proper configuration file with the authentication key.</p>
@@ -130,9 +124,19 @@
     <div class="manual" codesection="1"><pre class="manual" codesection="1">tj3client report &lt;project_id&gt; &lt;report_id&gt;
 </pre></div>
     <p class="manual">A server that is running can be terminated with the following command.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">tj3client terminate
 </pre></div>
+    <h2 class="manual" id="tj3webd">6.5 <code class="manual">tj3webd</code>
+    </h2>
+    <p class="manual">This is a web server to serve the HTML reports of a project to any web browser. The HTML reports are generated on the fly when accessed. <code class="manual">tj3webd</code> requires that <code class="manual">tj3d</code> is already running on the same machine.</p>
+    <p class="manual">By default, the web server is listening on port 8080. This can be changed in the <code class="manual">_global</code> section of the config file.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1">_global:
+  authKey: topsecret
+  webServerPort: 8080
+</pre></div>
+    <p class="manual">To access the HTML reports point your web browser to <code class="manual">http://localhost:8080/taskjuggler</code>. This assumes that the server is running on your local machine. You will then see a list of all loaded projects. Click on the project name to get a list of all reports for this project.</p>
+    <p class="manual"><i>WARNING: Please be aware that the web server when you have started it can be accessed by anybody on your local machine and by anybody that can reach your machine over the network! It will serve all reports of all projects that are hosted by the TaskJuggler daemon.</i></p>
    </div></div>
   <br/>
   <hr/>
   <table style="width:90%; margin-left:5%; margin-right:5%"><tr>
     <td style="text-align:left; width:35%;">&lt;&lt; <a href="Rich_Text_Attributes.html">Rich_Text_Attributes</a> &lt;&lt;</td>