Command rtoa
NAME
Command rtoa :: Ref Task Operation add
SYNOPSIS
rtoa RefName TaskName operator type [data]
DESCRIPTION
The rtoa
function is used to add a new rule operation to a task. The
parameters are the referential name, the task name, an operator, a type of
operation and optionaly some datas.
Six operators are available : `add', `add_from', `add_until',
`remove', `remove_from', `remove_until', `shift_before'
and `shift_after'.
The `shift_after' operator is used to move a selection. One or more ranges
of days are selected by the shift_after operation. If a day was selected by
previous operations of the rule and is in a range selected by the shift_after
operation, then the day is moved at the end of the range.
The `shift_before' operator is used to move a selection. One or more ranges
of days are selected by the shift_before operation. If a day was selected by
previous operations of the rule and is in a range selected by the shift_before
operation, then the day is moved at the begining of the range.
The type of operations are : `day_of_week', `day_of_month',
`day_of_year', `week_of_year', `month_of_year', `day',
`date', `always', `rule', `if_equal' and
`if_not_equal'.
- The `day_of_week' operation is used to select a day of a week.
It must be followed by an integer argument (1=Su, 2=Mo, 3=Th, 4=We, 5=Th,
6=Fr, 7=Sa).
- The `day_of_month' is used to select a day in a month. It must be
followed by an integer argument. The value can be in a fork of 1 to 31 or -31
to -1. For negative value, days are counted from the end of the month.
- The `day_of_year' is used to select a day in the year. It must be
followed by an integer argument. The value can be in a fork of 1 to 366
or -366 to -1. For negative value, days are counted from the end of the year.
- The `week_of_year' is used to select a week of the year. It must be
followed by an integer argument. The value can be in a fork of 1 to 52 or -52
to -1. For negative falue, weeks are counted from the end of the year.
- The `month_of_year' is used to select a month of the year. It must be followed by an integer argument. The value can be in a fork of 1 to 12 or -12 to -1.
For negative value, month are counted from the end of the year.
- The `day' operation is used to select a day of the year. It must
be followed by an argument which format is "MM-DD". MM is the month and DD is
the day of the month.
- The `date' operation is used to select a date. It must be followed
by an argument which format is "YYYY-MM-DD". YYYY is the year, MM is the
month and DD is the day of the month.
- The `always' operation is used to select all days. `add' is
the only operator which can be used with this operation. This operations can
be used as first operation to select all days and it will be followed by
`remove' operations.
- The `rule' operation is used to select days with another rule. The
parameter is the name of the rule which will be used.
- The `if_equal' operation is used to select (or unselect) days if
a variable is equal to a value.
- The `if_not_equal' operation is used to select (or unselect) days if
a variable is not equal to a value.
ACCESS CONTROL
This function requires the `admin' privilege for the
`referential' command family.
SEE ALSO
This document was generated
by dom on September, 11 2005
using texi2html