taskjuggler 3.6.0 → 3.7.1

data/man/tj3webd.1

@@ -0,0 +1,86 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3WEBD "1" "March 2020" "tj3webd (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3webd \- TaskJuggler reports web server
+.SH SYNOPSIS
+.B tj3webd
+[\fI\,options\/\fR]
+.SH DESCRIPTION
+The TaskJuggler web server can be used to serve the HTTP reports of
+TaskJuggler projects to be viewed by any HTML5 compliant web browser. It uses
+the TaskJuggler daemon (tj3d) for data hosting and report generation.
+.SH OPTIONS
+.TP
+\fB\-c\fR, \fB\-\-config\fR <FILE>
+Use the specified YAML configuration file
+.TP
+\fB\-\-silent\fR
+Don't show program and progress information
+.TP
+\fB\-\-no\-color\fR
+Don't use ANSI contol sequences to color the
+terminal output. Colors should only be used when
+spooling to an ANSI terminal. In case the detection
+fails, you can use this option to force colors to
+be off.
+.TP
+\fB\-\-debug\fR
+Enable Ruby debug mode
+.TP
+\fB\-d\fR, \fB\-\-dont\-daemonize\fR
+Don't put program into daemon mode. Keep it
+connected to the terminal and show debug output.
+.TP
+\fB\-p\fR, \fB\-\-port\fR <NUMBER>
+Use the specified TCP/IP port to connect to the
+TaskJuggler daemon (Default: 8474).
+.TP
+\fB\-\-pidfile\fR <FILE NAME>
+Write the process ID of the daemon to the specified
+file.
+.TP
+\fB\-\-logfile\fR <FILE NAME>
+Log daemon messages to the specified file.
+.TP
+\fB\-\-urifile\fR <FILE NAME>
+If the port is 0, use this file to read the URI of
+the TaskJuggler daemon.
+.TP
+\fB\-\-webserver\-port\fR <NUMBER>
+Use the specified TCP/IP port to serve web browser
+requests (Default: 8080).
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show this message
+.TP
+\fB\-\-version\fR
+Show version info
+.SH ENVIRONMENT
+
+.TP
+\fBHOME\fR
+The user's home folder. Used to search for configuration file if not specified.
+.SH FILES
+
+.TP
+\fB.taskjugglerrc\fR or \fBtaskjuggler.rc\fR
+tj3d searches for a config file named .taskjugglerrc or taskjuggler.rc in the current path, the user's home path as specified by the HOME environment variable or /etc/. At a minimum the file must contain:
+
+_global:
+  authKey: ********
+
+(the user should specify their own auth key and set file permissions accordingly). An alternative config file location may be specified using the -c, --config FILE option.
+.SH COPYRIGHT
+Copyright \(co 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020
+.IP
+by Chris Schlaeger <cs@taskjuggler.org>
+.PP
+This program is free software; you can redistribute it and/or modify it under
+the terms of version 2 of the GNU General Public License as published by the
+Free Software Foundation.
+.PP
+For more info about TaskJuggler see http://www.taskjuggler.org
+.SH "SEE ALSO"
+tj3d(1)
+
+The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.

data/manual/Day_To_Day_Juggling

@@ -4,7 +4,7 @@
 
 To analyze the impact that a small variation can have on a project,
 TaskJuggler supports an unlimited amount of scenarios. Each
-additional scenario is a slight derivation of the it's parent. The
+additional scenario is a slight derivation of it's parent. The
 task tree structure needs to be the same for all scenarios, but most
 attributes can vary from one scenario to another. Several report
 types support comparative listing of multiple [[scenarios]].
@@ -223,12 +223,12 @@ missing time sheets and will send out a reminder to those
 contributors that have not submitted their report.
 
 # On Monday the project managers need to review the time sheets and
-update the plan accordingly. TaskJuggler can compile a list changes
+update the plan accordingly. TaskJuggler can compile a list of changes
 compared to the plan. This makes it easy to update the plan according
 to the actual progress that was made. The closer the actuals match the
 plan the less work this is. The project managers now generate
 bookings for the last week and add them to the database with previous
-bookings. Doing so, will prevent changes to the plan to affect the
+bookings. Doing so will prevent changes to the plan to affect the
 past. Only the future will be modified.
 
 # Once the plan has been updated, managers will receive their status
@@ -696,7 +696,7 @@ by the scheduler according to your provided constraints.
 
 When you run ''''tj3 --freeze'''' again, it will update the header
 and booking files. Since you have included your booking file, any
-modifications you have made, will be preserved. That is, the actual
+modifications you have made will be preserved. That is, the actual
 data will be preserved, not the formatting since the file will be
 completely re-generated again.
 
@@ -722,11 +722,11 @@ is generated by the ''''tj3ss_sender'''' program and is called a status
 report template. Each manager will get one template that includes the
 status reports for the tasks they are responsible for.
 
-It's not the managers task to prepare the report for the next level
+It's the managers task to prepare the report for the next level
 of management. To do this, the manager has 3 options:
 
 * Forward the status report of a task directly to the next level. The
-original authorship can be keep or removed. The content can also be
+original authorship can be kept or removed. The content can also be
 edited if needed.
 
 * Similar reports for a task or a whole task sub-tree can be combined
@@ -747,7 +747,7 @@ created.
 ==== The Status Sheet Template Sender ====
 
 To send out the time sheets, the command ''''tj3ts_sender'''' must be
-used. It will use the ''''tj3client'''' program to do retrieve the
+used. It will use the ''''tj3client'''' program to retrieve the
 necessary data from the TaskJuggler server.
 
 Before the program can be used, a new section must be added to the
@@ -813,7 +813,7 @@ the resource selection and end date.
 
 ==== The Status Sheet Receiver ====
 
-Similarly to the time sheets a the completed status sheets must be
+Similarly to the time sheets, the completed status sheets must be
 send back by email. We already described how the necessary email
 aliases should be configured. For status sheets the address
 ''''statussheets@taskjuggler.your_company.com'''' can be used.

data/manual/Installation

@@ -88,7 +88,7 @@ If you don't want to install TaskJuggler for all users on the system,
 you can also install it into your home or data directory. This does
 not require root or admin permissions.
 
-The following steps are describe the installation on a Linux system
+The following steps describe the installation on a Linux system
 with the bash shell. You may have to use slightly different commands
 on a different operating system.
 
@@ -119,7 +119,7 @@ Configure gem to find the installed files.
 The last two settings should also be added to your .profile file to
 make them permanent.
 
-That's it. You now should be run TaskJuggler.
+That's it. You now should run TaskJuggler.
 
   tj3 --version
 
@@ -187,7 +187,7 @@ Then checkout the source code with the following command
 
  git clone git@github.com/taskjuggler/TaskJuggler.git
 
-Make sure, you have removed all previously installed instances of
+Make sure you have removed all previously installed instances of
 TaskJuggler from your system before doing so. It is a common mistake
 to have an old version of the TaskJuggler installed and then use parts
 of the old and new version together.
@@ -323,7 +323,7 @@ Log out and back in again. Now
 
   which ruby
 
-should show return the path to the link to your
+should return the path to the link to your
 ''''${HOME}/bin/ruby''''. You now have the latest Ruby installed and
 are ready to use TaskJuggler.
 
@@ -343,7 +343,7 @@ TaskJuggler can be used with any text editor that supports UTF-8 text
 file editing. If you don't have a preference yet, we recommend to try
 the [http://www.vim.org Vim] text editor. It's a very powerful editor
 and it has been customized for better integration with TaskJuggler.
-This section describes, how to activate and use the Vim integration.
+This section describes how to activate and use the Vim integration.
 Vim is provided by pretty much any Linux distribution and also works
 well on MacOX and Windows. See the web page for how to install it if
 you don't have it yet.
@@ -366,7 +366,7 @@ you may have to modify it accordingly.
 
   cp `gem contents taskjuggler | fgrep tjp.vim` .vim/syntax
 
-Now we have to make sure, Vim detects the file. Edit the
+Now we have to make sure Vim detects the file. Edit the
 ''''.vim/filetype.vim'''' file to contain the following section.
 
  augroup filetypedetect

data/manual/List_Attributes

@@ -29,7 +29,7 @@ In this example, task ''''T3'''' has the flags ''''f1'''' and
 ''''f2'''' assigned.
 
 The same works for scenarios as well. Even though the syntax may not
-look like inheritance is at play the scenario ''''s2'''' inherits all
+look like inheritance is at play, the scenario ''''s2'''' inherits all
 values from ''''s1''''.
 
 <[example file="ListAttributes" tag="scenario"]>

data/manual/Rich_Text_Attributes

@@ -126,7 +126,7 @@ in nowiki tags.
 You can also insert raw HTML code by enclosing it in
 '''<nowiki><html>...</html></nowiki>''' tags. For all other output
 formats, this content will be ignored. There is also no error checking
-if the code is valid! Use this feature very carefully.
+whether the code is valid! Use this feature very carefully.
 
 ==== Block and Inline Generators ====
 
@@ -179,12 +179,13 @@ Parameters:
 
 * ''''attributes'''': A set of attributes that override the original
 attributes of the referenced report. All report attributes
-are supported. Since the value of attributes already must be enclosed
+are supported. Since the values of attributes already must be enclosed
 by single or double quotes, all single or double quotes contained in
 the string must be escaped with backslashes. This feature enables
 reports with content that is customized based on where they have been
 referenced from. It requires the reports to be dynamically generated
-and is only available when used with the ''''tj3d'''' web server.
+and is only available when used with the ''''tj3d'''' web server
+''''tj3webd''''.
 The ''''tj3'''' application will ignore the attributes setting.
 
  taskreport "All" {
@@ -254,8 +255,8 @@ is used, certain or all of the above parameters have already
 predefined values. When used in the header section of a report, the
 context does not provide a property or scope property. Start and end
 dates as well the formatting options are taken from the report
-context. But when used e. g. in [[celltext.column]] the cell
-provides, that property and the attribute and possibly even the scope
+context. But when used e. g. in [[celltext.column]], the cell
+provides that property and the attribute and possibly even the scope
 property.
 
 

data/manual/Software

@@ -1,6 +1,6 @@
 == The TaskJuggler Software ==
 
-After the installation of a software package the first questions that
+After the installation of a software package the first question that
 most users have is ''"How do I run it?"''. Many users expect to find
 an icon on their desktop or an entry in the start menu hierarchy.
 Don't bother looking for them, you won't find any for TaskJuggler. As
@@ -80,7 +80,7 @@ in your web browser.
 
 The latter defaults to using the
 [http://www.mozilla.com/en-US/firefox/new/ Mozilla Firefox] web
-browser . Please see
+browser. Please see
 
  tj3man --help
 
@@ -102,12 +102,12 @@ Linux lingo. The program is called ''''tj3d''''. 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
+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
+ID 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.
@@ -147,7 +147,7 @@ configuration option controls the amount of details to be printed out.
 * 3: Like 2, but additionally with information messages
 * 4: Like 3, but additionally with debug messages
 
-The configuration file will be searched in the current directory,
+The configuration file will be searched for in the current directory,
 the current user's home directory or ''''/etc''''. You can also
 explicitly tell the server where to find the configuration file with
 the ''''-c'''' option. See
@@ -210,7 +210,7 @@ changed in the ''''_global'''' section of the config file.
    authKey: topsecret
    webServerPort: 8080
 
-To access the HTML reports point your web browser to
+To access the HTML reports, point your web browser to
 ''''http://localhost:8080/taskjuggler''''. 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

data/manual/TaskJuggler_Internals

@@ -26,7 +26,7 @@ github].
 The scheduler needs to determine the start and end date for all tasks
 that don't have such dates yet. To deal with multiple concurrent time
 zones, all time related events are stored internally as UTC
-time.Additionally, it allocates resources to tasks.  All events such
+time. Additionally, it allocates resources to tasks.  All events such
 as start or end of a task, or allocation of a resource can only happen
 aligned with the [[timingresolution|timing resolution]]. This
 determines the smallest possible allocation period that we call a time
@@ -57,7 +57,7 @@ are scheduled from end to start.
 resources have been assigned for all time slots.
 
 The goal of the scheduler is to transfer all tasks in the completed
-state. Until this goal has been reached, at least one tasks needs to
+state. Until this goal has been reached, at least one task needs to
 be in the ready state. If that's not the case, the project schedule
 cannot be determined and an error is raised. In case there are more
 than one task in the ready state, we need to have a well defined
@@ -103,7 +103,7 @@ that is going through a task, the sum of the criticalness values of
 the tasks of the path is computed. The largest sum is the path
 criticalness of that task.
 
-This heuristic will favor allocations to task with critical resources
+This heuristic will favor allocations to tasks with critical resources
 and long dependency chains. As a result, the critical paths of the
 project are tried to be kept short. The user can use the
 '''criticalness''' and '''pathcriticalness''' [[columnid|columns]] to
@@ -111,7 +111,7 @@ review the respective values for he project's tasks and resources.
 
 When the criticalness and pathcriticalness for all leaf resources and
 tasks has been determined, the leaf tasks are sorted by priority
-(hight to low), then by pathcricialness (high to low) and then by the
+(high to low), then by pathcricialness (high to low) and then by the
 index (low to high). In a loop that is terminated when all tasks have
 been scheduled or an error condition has been detected, the first
 task that is ready for scheduling is completely scheduled. This means

data/manual/The_TaskJuggler_Syntax

@@ -34,7 +34,7 @@ options separated by a vertical bar.
  keyword ( foo | bar | foobar )
 
 Some keywords take one or more arguments. These are known as list
-attributes. The arguments are comma separated. The tree dots in the
+attributes. The arguments are comma separated. The three dots in the
 syntax description mean that the sequence before the dots can be
 repeated if needed. Inheritable list attributes will append the new
 list values to the inherited list. Use can use the [[purge]]
@@ -73,7 +73,7 @@ An integer is any natural number, e. g. ''''0'''', ''''1'''',
 
 Strings are character sequences that are enclosed by special
 character marks. There are three different marks supported. For
-short strings that fit on one lines, you can either use single or
+short strings that fit on one line, you can either use single or
 double quotes.
 
  'This is a single quoted string.'
@@ -112,7 +112,7 @@ exact same combination of tabs and spaces.
 === Predefined Macros ===
 
 TaskJuggler supports a few predefined macros. These are available
-after the project header. They values correspond to the values
+after the project header. Their values correspond to the values
 provided in the project header.
 
 * ''''projectstart'''' The start date of the project.
@@ -128,6 +128,6 @@ the [[timeformat]] setting of the current context.
 === Environment Variable Expansions ===
 
 By using the $(VAR) syntax, you can insert the value of the
-environment variable name VAR. The name of the variable must consists
-only of uppercase ASCII letters, underscore or decimal digits.
+environment variable name VAR. The name of the variable must consist
+only of uppercase ASCII letters, underscores or decimal digits.
 

data/manual/Tutorial

@@ -13,7 +13,7 @@ grow larger. The complete tutorial example comes with your
 TaskJuggler software installation. You can use the following command
 to find the base directory of the example projects.
 
-  ruby19 -e "puts Gem::Specification.find_by_name('taskjuggler').gem_dir"
+  ruby -e "puts Gem::Specification.find_by_name('taskjuggler').gem_dir"
 
 The file for the tutorial project is called
 ''''examples/Tutorial/tutorial.tjp''''. You can use any plain text
@@ -31,7 +31,7 @@ will result in longer scheduling times and higher memory consumption.
 
 <[example file="tutorial" tag="header1"]>
 
-All TaskJuggler properties have a unique ID ,a name, and a set of
+All TaskJuggler properties have a unique ID, a name, and a set of
 optional attributes. The name must always be specified. The ID can be
 omitted if you never have to reference the property from another
 context. If you omit the ID, TaskJuggler will automatically generate a
@@ -75,7 +75,7 @@ The [[currency]] attribute specifies the unit of all currency values.
 <[example file="tutorial" tag="currency"]>
 
 Because each culture has its own way of specifying dates and numbers,
-the format for these are configurable.  Use the [[timeformat]]
+the format for these is configurable.  Use the [[timeformat]]
 attribute to specify the default format for dates. This format is used
 for reports, it does not affect the way you specify dates in the
 project files. Here you always need to use the [[date|TaskJuggler date
@@ -148,7 +148,7 @@ does not do any resource assignments to tasks.
 
 Use the [[leaves]] attribute to define a global holiday. Global
 holidays may have a name and must have a date or date range. Other leaves for
-individual resources or groups of resources can be defines similarly.
+individual resources or groups of resources can be defined similarly.
 
 === Macros ===
 
@@ -189,6 +189,8 @@ In order not to get lost with all the various amounts, we declare 3
 [[account|accounts]] to credit the amounts to. We create one account
 for the development costs, one for the documentation costs, and one
 for the customer payments.
+Actually, there is a fourth account consisting of two accounts nested
+into it.
 
 <[example file="tutorial" tag="accounts"]>
 
@@ -308,7 +310,7 @@ should be allocated to the task. The task won't finish before the
 resources could be allocated long enough to reach the specified
 effort. Tasks with ''''length'''' or ''''duration'''' criteria and
 allocated resources will last exactly as long as requested. Resources
-will be allocated only if available. It's possible that such a tasks
+will be allocated only if available. It's possible that such a task
 ends up with no allocations at all if the resources are always
 assigned to other tasks for that period. Each task can only have one
 of the three duration criteria. Container tasks may never have a
@@ -331,7 +333,7 @@ and end criteria of a task, or one of them and a duration
 specification. The start and end criteria can either be fixed dates or
 relative dates. Relative dates are specifications of the type ''task B
 starts after task A has finished''. Or in other words, task B depends
-on task A. In this example the spec task depends on a subtasks of the
+on task A. In this example the spec task depends on a subtask of the
 deliveries task. We have not specified it yet, but it has the local ID
 ''''start''''.
 
@@ -347,7 +349,7 @@ specification task would be ''''AcSo.spec''''.
 Relative IDs always start with one or more exclamation marks. Each
 exclamation mark moves the scope to the next enclosing task. So
 ''''!deliveries.start'''' is expanded to ''''AcSo.deliveries.start''''
-since ''''AcSo'''' is the enclosing task of deliveries. Relative task
+since ''''AcSo'''' is the enclosing task of ''''deliveries''''. Relative task
 IDs are a little bit confusing at first, but have a real advantage
 over absolute IDs.  Sooner or later you want to move tasks around in
 your project and then it's a lot less likely that you have to fix
@@ -362,7 +364,7 @@ We use the [[priority]] attribute to mark the importance of
 the tasks. 500 is the default priority of top-level tasks. Setting the
 priority to 1000 marks the task as most important task, since the
 possible range is 1 (not important at all) to 1000 (ultimately
-important). priority is an attribute that is passed down to subtasks
+important). ''''priority'''' is an attribute that is passed down to subtasks
 if specified before the subtasks' declaration. So all subtasks of
 software have a priority of 1000 as well, unless they have their own
 priority definition.
@@ -486,7 +488,7 @@ scheduled. But no reports would be generated to visualize the results.
 
 === Visualizing the Project ===
 
-To see and share the project data you reports can be generated. You
+To see and share the project data, reports can be generated. You
 can generate any number of reports and you can select from a variety
 of report types and output formats. To have a report generated after
 the project scheduling has been completed, you need include a report
@@ -645,7 +647,7 @@ For HTML output, the reference is a click-able link to the referenced
 report file.
 
 For the [[footer]] we can proceed accordingly. We just add a few more
-paragraphs of text the describe certain aspects of the project. By
+paragraphs of text to describe certain aspects of the project. By
 putting it all together, we end up with the following report
 definition.
 
@@ -653,7 +655,7 @@ definition.
 
 The generated report can be found
 [http://www.taskjuggler.org/tj3/examples/Tutorial/Overview.html
-here]. It servers as an entry page for the other reports. While it
+here]. It serves as an entry page for the other reports. While it
 already contains some references, a navigator bar would be handy as
 well. Fortunately, there is a block generator called 'navigator' to
 take care of this. But before we can include the navigator in the