.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "rt-email-dashboards 8"
.TH rt-email-dashboards 8 2024-05-31 "perl v5.38.2" "Request Tracker Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
rt\-email\-dashboards \- Send email dashboards
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    rt\-email\-dashboards [options]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This tool will send users email based on how they have subscribed to
dashboards. A dashboard is a set of saved searches, the subscription controls
how often that dashboard is sent and how it's displayed.
.PP
Each subscription has an hour, and possibly day of week or day of month. These
are taken to be in the user's timezone if available, UTC otherwise.
.SH SETUP
.IX Header "SETUP"
You'll need to have cron run this script every hour. Here's an example crontab
entry to do this.
.PP
.Vb 1
\&    0 * * * * /usr/sbin/rt\-email\-dashboards
.Ve
.PP
This will run the script every hour on the hour. This may need some further
tweaking to be run as the correct user.
.SH OPTIONS
.IX Header "OPTIONS"
This tool supports a few options. Most are for debugging.
.IP \-h 8
.IX Item "-h"
.PD 0
.IP \-\-help 8
.IX Item "--help"
.PD
Display this documentation
.IP \-\-dryrun 8
.IX Item "--dryrun"
Figure out which dashboards would be sent, but don't actually generate or email
any of them
.IP "\-\-time SECONDS" 8
.IX Item "--time SECONDS"
Instead of using the current time to figure out which dashboards should be
sent, use SECONDS (usually since midnight Jan 1st, 1970, so \f(CW1192216018\fR would
be Oct 12 19:06:58 GMT 2007).
.IP "\-\-epoch SECONDS" 8
.IX Item "--epoch SECONDS"
Back-compat for \-\-time SECONDS.
.IP \-\-all 8
.IX Item "--all"
Ignore subscription frequency when considering each dashboard (should only be
used with \-\-dryrun for testing and debugging)
.IP "\-\-user User NAME or ID" 8
.IX Item "--user User NAME or ID"
Only check the specified user's subscriptions
.IP "\-\-log LEVEL" 8
.IX Item "--log LEVEL"
Adjust LogToSTDERR config option