Got rid of the final FIXMEs \o/

This commit is contained in:
Darren 'Tadgy' Austin 2020-12-21 22:41:01 +00:00
commit 183a4f83a8

View file

@ -530,7 +530,7 @@ display_help() {
This must be given as a single argument, enclosed in single (') or double This must be given as a single argument, enclosed in single (') or double
(") quotes if it contains spaces, and must be a valid date accepted by (") quotes if it contains spaces, and must be a valid date accepted by
'date --date'. Note: by default UTC is expected, but a specifically given 'date --date'. Note: by default UTC is expected, but a specifically given
date/time + TZ will be converted to UTC. date/time + TZ will be converted to UTC.
-q, --quiet -q, --quiet
Normally, when the scheduler spec> indicates the job should be run, the Normally, when the scheduler spec> indicates the job should be run, the
name of the <job ID> is output to stdout. With this option, ${0##*/} name of the <job ID> is output to stdout. With this option, ${0##*/}
@ -539,7 +539,7 @@ display_help() {
-s <filename>, --statefile <filename> -s <filename>, --statefile <filename>
Use the given <filename> as the state file for maintaining a record of Use the given <filename> as the state file for maintaining a record of
the last execution time of the job IDs. the last execution time of the job IDs.
The default statefile is $FIXME. The default statefile is \$HOME/.config/${0##*/}.state.
Using this option allows non-root users to use the scheduler's job Using this option allows non-root users to use the scheduler's job
tracking functionallity. If the file provided does not exist, it will tracking functionallity. If the file provided does not exist, it will
be created if possible, or an error will be emitted if the <filename> be created if possible, or an error will be emitted if the <filename>
@ -557,15 +557,16 @@ display_help() {
<scheduler spec> <scheduler spec>
This is the 'crontab' style specification of the schedule on which the This is the 'crontab' style specification of the schedule on which the
given <job ID> should be executed. This schedule is compared against the given <job ID> should be executed. This schedule is compared against the
current (or provided by option --date/-d) date/time. current (or that provided by option --date/-d) date/time.
The schedule is given as a single argument enclosed in single (') or The schedule is given as a single argument enclosed in single (') or
double (") quotes, with each component separated by spaces. Be mindful of double (") quotes, with each component separated by spaces. Be mindful of
shell globbing while using a '*' on the command line. shell globbing while using a '*' on the command line.
See documentation for a full rundown of the <scheduler spec> accepted. See documentation for a full rundown of the <scheduler spec> accepted.
<job ID> <job ID>
FIXME A free form identifier used for state tracking between runs.
<job ID> may not contain the character ':'. This is only restriction on This is also output to stdout if the schedule is matched against the
job identifications. date/time. <job ID> may not contain the character ':'. This is only
restriction on job identifications.
EOF EOF
} }