taskjuggler 3.6.0 → 3.7.1

data/man/tj3ss_receiver.1

@@ -0,0 +1,86 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3SS_RECEIVER "1" "March 2020" "tj3ss_receiver (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3ss_receiver \- receive filled-out status sheets via email
+.SH SYNOPSIS
+.B tj3ss_receiver
+[\fI\,options\/\fR]
+.SH DESCRIPTION
+This program can be used to receive filled\-out status sheets via email.
+It reads the emails from STDIN and extracts the status sheet from the
+attached files. The status sheet is checked for correctness. Good status
+sheets are filed away. The sender be informed by email that the status
+sheets was accepted or rejected.
+.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\-\-directory\fR <DIR>
+Use the specified directory as working directory
+.TP
+\fB\-\-dryrun\fR
+Don't send out any emails or do SCM commits
+.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 configure an e-mail delivery method and sender e-mail e.g.:
+
+_global:
+   emailDeliveryMethod: smtp
+   smtpServer: smtp.your_company.com
+.br
+_statussheets:
+   senderEmail: 'TaskJuggler <statussheets@taskjuggler.amd.com>'
+
+An alternative config file location may be specified using the -c, --config FILE option.
+
+.TP
+\fBstatussheets.log\fR
+The statussheets log file, created in the working directory.
+
+.TP
+\fBStatusSheets/FailedMails/\fR
+Directory created in the working directory to store the failed emails.
+
+.TP
+\fBStatusSheets/FailedSheets/\fR
+Directory created in the working directory to store the failed status sheets.
+.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"
+tj3ss_sender(1)
+
+The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.

data/man/tj3ss_sender.1

@@ -0,0 +1,100 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3SS_SENDER "1" "March 2020" "tj3ss_sender (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3ss_sender \- send out status sheets templates via email
+.SH SYNOPSIS
+.B tj3ss_sender
+[\fI\,options\/\fR]
+.SH DESCRIPTION
+This program can be used to out status sheets templates via email. It will
+generate status sheet templates for managers of the project. The project data
+will be accesses via tj3client from a running TaskJuggler server process.
+.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\-\-directory\fR <DIR>
+Use the specified directory as working directory
+.TP
+\fB\-\-dryrun\fR
+Don't send out any emails or do SCM commits
+.TP
+\fB\-r\fR, \fB\-\-resource\fR <ID>
+Only generate template for given resource
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+Send out a new template even if one exists
+already
+.HP
+\fB\-\-hideresource\fR <EXPR> Filter expression to limit the resource list
+.TP
+\fB\-i\fR, \fB\-\-interval\fR <DURATION> The duration of the interval. This is a number
+directly followed by a unit. 1w means one week
+(the default), 5d means 5 days and 72h means 72
+hours.
+.TP
+\fB\-e\fR, \fB\-\-enddate\fR <DAY>
+The end date of the reporting period. Either as
+YYYY\-MM\-DD or day of week. 0: Sunday, 1: Monday
+and so on. The default value is 2020\-03\-18.
+.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
+
+\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 configure an authentication key, an e-mail delivery method and sender e-mail e.g.:
+
+_global:
+   authKey: ********
+   smtpServer: smtp.your_company.com
+.br
+_statussheets:
+   senderEmail: 'TaskJuggler <statussheets@taskjuggler.amd.com>'
+
+(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
+\fBstatussheets.log\fR
+The statussheets log file, created in the working directory.
+
+.TP
+\fBStatusSheetTemplates\fR
+Base directory of the sheet templates, created in the working directory.
+.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"
+
+tj3ss_receiver(1), tj3d(1)
+
+The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.

data/man/tj3ts_receiver.1

@@ -0,0 +1,86 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3TS_RECEIVER "1" "March 2020" "tj3ts_receiver (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3ts_receiver \- receive filled-out time sheets via email
+.SH SYNOPSIS
+.B tj3ts_receiver
+[\fI\,options\/\fR]
+.SH DESCRIPTION
+This program can be used to receive filled\-out time sheets via email.  It
+reads the emails from STDIN and extracts the time sheet from the attached
+files. The time sheet is checked for correctness. Good time sheets are filed
+away. The sender will be informed by email that the time sheets was accepted
+or rejected.
+.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\-\-directory\fR <DIR>
+Use the specified directory as working directory
+.TP
+\fB\-\-dryrun\fR
+Don't send out any emails or do SCM commits
+.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 configure an authentication key, an e-mail delivery method and sender e-mail e.g.:
+
+_global:
+   authKey: ********
+   smtpServer: smtp.your_company.com
+_timesheets:
+   senderEmail: 'TaskJuggler <timesheets@taskjuggler.amd.com>'
+
+(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
+\fBtimesheets.log\fR
+The statussheets log file, created in the working directory.
+
+.TP
+\fBTimeSheets/FailedMails/\fR
+Directory created in the working directory to store the failed emails.
+
+.TP
+\fBTimeSheets/FailedSheets/\fR
+Directory created in the working directory to store the failed status sheets.
+.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"
+
+tj3ts_sender(1)
+
+The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.

data/man/tj3ts_sender.1

@@ -0,0 +1,92 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3TS_SENDER "1" "March 2020" "tj3ts_sender (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3ts_sender \- send out time sheets templates via email
+.SH SYNOPSIS
+.B tj3ts_sender
+[\fI\,options\/\fR]
+.SH DESCRIPTION
+This program can be used to send out time sheets templates via email. It will
+generate time sheet templates for all resources of the project. The project
+data will be accesses via tj3client from a running TaskJuggler server process.
+.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\-\-directory\fR <DIR>
+Use the specified directory as working directory
+.TP
+\fB\-\-dryrun\fR
+Don't send out any emails or do SCM commits
+.TP
+\fB\-r\fR, \fB\-\-resource\fR <ID>
+Only generate template for given resource
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+Send out a new template even if one exists already
+.TP
+\fB\-e\fR, \fB\-\-enddate\fR <DAY>
+The end date of the reporting period. Either as
+YYYY\-MM\-DD or day of week. 0: Sunday, 1: Monday and
+so on. The default value is 2020\-03\-16.
+.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
+
+\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 configure an authentication key, an e-mail delivery method and sender e-mail e.g.:
+
+_global:
+   authKey: ********
+   smtpServer: smtp.your_company.com
+   projectId: acso
+.br
+_timesheets:
+   senderEmail: 'TaskJuggler <statussheets@taskjuggler.amd.com>'
+
+(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
+\fBtimesheets.log\fR
+The timesheets log file, created in the working directory.
+
+.TP
+\fBTimeSheetTemplates\fR
+Base directory of the sheet templates, created in the working directory.
+.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"
+tj3ts_receiver(1)
+
+The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.

data/man/tj3ts_summary.1

@@ -0,0 +1,104 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH TJ3TS_SUMMARY "1" "March 2020" "tj3ts_summary (TaskJuggler) 3.7.1" "TaskJuggler"
+.SH NAME
+tj3ts_summary \- send out individual copies and a summary of accepted time sheets
+.SH SYNOPSIS
+.B tj3ts_summary
+[\fI\,options\/\fR]
+.SH DESCRIPTION
+This program can be used to send out individual copies and a summary of all
+accepted time sheets a list of email addresses. The directory structures for
+templates and submitted time sheets must be present. The project data will be
+accesses via tj3client from a running TaskJuggler server process.
+.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\-\-directory\fR <DIR>
+Use the specified directory as working directory
+.TP
+\fB\-\-dryrun\fR
+Don't send out any emails or do SCM commits
+.TP
+\fB\-r\fR, \fB\-\-resource\fR <ID>
+Only generate summary for given resource
+.TP
+\fB\-t\fR, \fB\-\-to\fR <EMAIL>
+Send all individual reports and a summary report to
+this email address
+.TP
+\fB\-\-sheet\fR <EMAIL>
+Send all reports to this email address
+.TP
+\fB\-\-digest\fR <EMAIL>
+Send a summary report to this email address
+.TP
+\fB\-e\fR, \fB\-\-enddate\fR <DAY>
+The end date of the reporting period. Either as
+YYYY\-MM\-DD or day of week. 0: Sunday, 1: Monday and
+so on. The default value is 2020\-03\-16.
+.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
+
+\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 configure an authentication key, an e-mail delivery method, project id, sender e-mail and receipients e.g.:
+
+_global:
+   authKey: ********
+   smtpServer: smtp.your_company.com
+   projectId: acso
+.br
+_timesheets:
+   senderEmail: 'TaskJuggler <statussheets@taskjuggler.amd.com>'
+  _summary:
+    sheetRecipients:
+      - team@your_company.com
+
+(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
+\fBtimesheets.log\fR
+The timesheets log file, created in the working directory.
+
+.TP
+\fBTimeSheetTemplates\fR
+Base directory of the sheet templates, created in the working directory.
+.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"
+tj3ts_receiver(1)  tj3ts_sender(1)
+
+The full TaskJuggler manual is available online at http://www.taskjuggler.org/tj3/manual/, or via the tj3man command.