taskjuggler 3.6.0 → 3.7.1

data/lib/taskjuggler/reports/TjpExportRE.rb

@@ -265,11 +265,7 @@ class TaskJuggler
       if isLeafTask
         a('scenarios').each do |scenarioIdx|
           generateAttribute(task, 'start', indent + 2, scenarioIdx)
-          if task['milestone', scenarioIdx]
-            if task['scheduled', scenarioIdx]
-              generateAttributeText('milestone', indent + 2, scenarioIdx)
-            end
-          else
+          if !task['milestone', scenarioIdx]
             generateAttribute(task, 'end', indent + 2, scenarioIdx)
             generateAttributeText('scheduling ' +
                                   (task['forward', scenarioIdx] ?

data/lib/taskjuggler/version.rb

@@ -0,0 +1 @@
+VERSION = '3.7.1'

data/man/tj3.1

@@ -0,0 +1,130 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3 "1" "March 2020" "tj3 (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3 \- schedules tj3 projects and generates reports
+.SH SYNOPSIS
+.B tj3
+[\fI\,options\/\fR]
+.SH DESCRIPTION
+This is the main application. It reads in your project files, schedules the
+project and generates the reports.
+.SH OPTIONS
+.TP
+\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\-\-debuglevel\fR N
+Verbosity of debug output
+.TP
+\fB\-\-debugmodules\fR x,y,z
+Restrict debug output to a list of modules
+.TP
+\fB\-\-freeze\fR
+Generate or update the booking file for the
+project. The file will have the same base name as
+the project file but has a \fB\-bookings\fR.tji extension.
+.TP
+\fB\-\-freezedate\fR <date>
+Use a different date than the current momentas
+cut\-off date for the booking file
+.TP
+\fB\-\-freezebytask\fR
+Group the bookings in the booking file generated
+during a freeze by task instead of by resource.
+.TP
+\fB\-\-check\-time\-sheet\fR <tji\-file>
+Check the given time sheet
+.TP
+\fB\-\-check\-status\-sheet\fR <tji\-file>
+Check the given status sheet
+.TP
+\fB\-\-warn\-ts\-deltas\fR
+Turn on warnings for requested changes in time
+sheets
+.TP
+\fB\-\-check\-syntax\fR
+Only parse the input files and check the syntax.
+.TP
+\fB\-\-no\-reports\fR
+Just schedule the project, but don't generate any
+reports.
+.TP
+\fB\-\-list\-reports\fR <report ID regular expression>
+List id, formats and file name of all the defined
+reports that have IDs that match the specified
+regular expression.
+.TP
+\fB\-\-report\fR <report ID>
+Only generate the report with the specified ID.
+This option can be used multiple times.
+.TP
+\fB\-\-reports\fR <report ID regular expression>
+Only generate the reports that have IDs that match
+the specified regular expression. This option can
+be used multiple times.
+.TP
+\fB\-f\fR, \fB\-\-force\-reports\fR
+Generate reports despite scheduling errors
+.TP
+\fB\-\-add\-trace\fR
+Append a current data set to all trace reports.
+.TP
+\fB\-\-abort\-on\-warnings\fR
+Abort program on warnings like we do on errors.
+.TP
+\fB\-o\fR <directory>,
+Directory the reports should go into
+.HP
+\fB\-\-output\-dir\fR
+.TP
+\fB\-c\fR N
+Maximum number of CPU cores to use
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show this message
+.TP
+\fB\-\-version\fR
+Show version info
+.SH ENVIRONMENT
+
+.TP
+\fBTASKJUGGLER_DATA_PATH\fR
+Override the path to the TaskJuggler data folder.
+The data folder contains the css, icons and scripts
+for TaskJuggler reports.
+
+.TP
+\fBTZ\fR
+The POSIX Time Zone environment variable.
+
+Any environment variable may be used in a TaskJuggler file using the expression $(VAR_NAME).
+.SH EXAMPLES
+
+tj3 tutorial.tjp
+.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"
+tj3client(1), tj3d(1), tj3man(1), tj3ss_receiver(1), tj3ss_sender(1), tj3ts_receiver(1), tj3ts_sender(1), tj3ts_summary(1), tj3webd(1)
+
+The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.

data/man/tj3client.1

@@ -0,0 +1,145 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3CLIENT "1" "March 2020" "tj3client (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3client \- send commands and data to the TaskJuggler daemon
+.SH SYNOPSIS
+.B tj3client
+[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,arg1 arg2 \/\fR...]
+.SH DESCRIPTION
+The TaskJuggler client is used to send commands and data to the TaskJuggler
+daemon. The communication is done via TCP/IP.
+.PP
+The following commands are supported:
+.IP
+status
+.IP
+Display the status of the available projects
+.IP
+terminate
+.IP
+Terminate the TaskJuggler daemon
+.IP
+add <tjp file> [<tji file> ...]
+.IP
+Add a new project or update and existing one
+.IP
+update
+.IP
+Reload all projects that have modified files and are not being
+reloaded already
+.IP
+remove <project ID> [<project ID> ...]
+.IP
+Remove the project with the specified ID from the daemon
+.TP
+report <project ID> <report ID> [<report ID> ...] [=
+[<tji file> ...]]
+.IP
+Generate the report with the provided ID for the project with the
+given ID
+.IP
+list\-reports <project ID> [report ID ]
+.IP
+List all available reports of the project or those that match the
+provided report ID
+.IP
+check\-ts <project ID> <time sheet>
+.IP
+Check the provided time sheet for correctness against the project
+with the given ID
+.IP
+check\-ss <project ID> <status sheet>
+.IP
+Check the provided status sheet for correctness against the project
+with the given ID
+.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\-p\fR, \fB\-\-port\fR <NUMBER>
+Use the specified TCP/IP port
+.TP
+\fB\-\-urifile\fR <FILE>
+If the port is 0, use this file to get the URI of
+the server.
+.TP
+\fB\-r\fR, \fB\-\-regexp\fR
+The report IDs are not fixed but regular
+expressions that match a set of reports
+.TP
+\fB\-\-unsafe\fR
+Run the program without sandbox protection. This is
+not recommended for normal operation! It may only
+be used for debugging or testing purposes.
+.TP
+\fB\-\-format\fR [FORMAT]
+Request the report to be generated in the
+specifiedformat. Use multiple options to request
+multiple formats. Supported formats are csv, html,
+niku and tjp. By default, the formats specified in
+the report definition are used.
+.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 EXAMPLES
+.TP
+Load a project:
+tj3client add yourproject.tjp
+.PP
+.TP
+List available reports for a project:
+tj3client list-reports <project_id>
+.PP
+.TP
+Generate a report:
+tj3client report <project_id> <report_id>
+.PP
+.TP
+Terminate a running instance of the server:
+tj3client terminate
+.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/man/tj3d.1

@@ -0,0 +1,93 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJD3 "1" "March 2020" "tjd3 (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tjd3 \- the TaskJuggler daemon
+.SH SYNOPSIS
+.B tj3d
+[\fI\,options\/\fR] [\fI\,<tjp file> \/\fR[\fI\,<tji file> \/\fR...] ...]
+.SH DESCRIPTION
+The TaskJuggler daemon can be used to quickly generate reports for a number
+of scheduled projects that are resident in memory. Once the daemon has been
+started tj3client can be used to control it.
+.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 serve tj3client
+requests (Default: 8474).
+.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 store the URI of
+the server.
+.TP
+\fB\-w\fR, \fB\-\-webserver\fR
+Start a web server that serves the reports of the
+loaded projects.
+.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 SECURITY
+The author advises: "the daemon has not received any kind of security review ... only use the daemon in a trusted environment with only trusted users!"
+.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.
+
+.TP
+\fBtj3d.log\fR
+
+The tj3d log file, created in the working directory. Location can be overridden using the --logfile 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"
+tj3client(1)
+
+The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.

data/man/tj3man.1

@@ -0,0 +1,76 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3MAN "1" "March 2020" "tj3man (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3man \- get documentation for TaskJuggler keywords or generate user manual
+.SH SYNOPSIS
+.B tj3man
+[\fI\,options\/\fR]
+.SH DESCRIPTION
+This program can be used to generate the user manual in HTML format or to get
+a textual help for individual keywords.
+.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\-\-dir\fR <directory>
+directory to put the manual
+.TP
+\fB\-\-html\fR
+Show the user manual in your local web browser. By
+default, Firefox is used or the browser specified
+with the $BROWSER environment variable.
+.TP
+\fB\-\-browser\fR <command>
+Specify the command to start your web browser. The
+default is 'firefox'.
+.TP
+\fB\-m\fR, \fB\-\-manual\fR
+Generate the user manual into the current directory
+or the directory specified with the \fB\-d\fR option.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show this message
+.TP
+\fB\-\-version\fR
+Show version info
+.SH ENVIRONMENT
+
+.TP
+\fBBROWSER\fR
+The web browser used to display the user manual as HTML.
+.SH EXAMPLES
+
+tj3man shift
+.br
+tj3man --html shift.timesheet
+.br
+tj3man --html
+.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"
+
+tj3(1)
+
+The TaskJuggler manual is also available online at http://www.taskjuggler.org/tj3/manual/.