imip-agent

Annotated docs/preferences.txt

669:d98222e97d5e
2015-08-31 Paul Boddie Renamed the scheduling_resolution setting to permitted_times, adding some documentation for the setting. Renamed various names in the code to reflect the renamed setting.
paul@667 1
Preferences and Settings
paul@667 2
========================
paul@667 3
paul@667 4
LANG
paul@667 5
----
paul@463 6
paul@667 7
Default: en (English)
paul@667 8
Alternatives: (any recognised and supported locale)
paul@667 9
paul@667 10
The language for messages and user interface text.
paul@667 11
paul@667 12
TZID
paul@667 13
----
paul@667 14
paul@667 15
Default: system timezone (see /etc/timezone)
paul@667 16
Alternatives: (any recognised Olson time zone identifier)
paul@463 17
paul@667 18
The default time zone/regime for calendars, new events and local times.
paul@667 19
paul@667 20
freebusy_bundling
paul@667 21
-----------------
paul@667 22
paul@667 23
Default: never
paul@667 24
Alternative: always
paul@463 25
paul@667 26
Indicate whether to bundle free/busy details with other payloads such as
paul@667 27
event and free/busy objects.
paul@667 28
paul@667 29
freebusy_messages
paul@667 30
-----------------
paul@667 31
paul@667 32
Default: none
paul@667 33
Alternative: notify
paul@667 34
paul@667 35
Indicate whether recipients are notified about received free/busy payloads.
paul@463 36
paul@667 37
freebusy_sharing
paul@667 38
----------------
paul@667 39
paul@667 40
Default: no
paul@667 41
Alternative: share
paul@667 42
paul@667 43
Share free/busy details generally:
paul@667 44
paul@667 45
  * bundling in e-mail messages if bundling is configured
paul@667 46
  * responding to free/busy requests via e-mail
paul@667 47
  * publishing as Web resources if a static Web resource is configured
paul@667 48
paul@667 49
incoming
paul@667 50
--------
paul@667 51
paul@667 52
Default: summary-wraps-message
paul@667 53
Alternatives: (see below)
paul@463 54
paul@667 55
Define how incoming event messages are delivered to recipients:
paul@667 56
paul@669 57
  message-only          deliver only the incoming message as it was received
paul@669 58
paul@669 59
  message-then-summary  deliver the message first followed by a summary
paul@669 60
                        message
paul@669 61
paul@669 62
  summary-then-message  deliver a summary first followed by the message
paul@669 63
paul@669 64
  summary-only          deliver only a summary of the message
paul@667 65
paul@667 66
participating
paul@667 67
-------------
paul@667 68
paul@667 69
Default: participate
paul@667 70
Alternative: no
paul@667 71
paul@667 72
Indicate whether a recipient participates in the calendar system. Note that
paul@667 73
participation by default occurs because the handler programs will be defined
paul@667 74
in the mail system for recipients fulfilling certain criteria; other
paul@667 75
recipients will be handled in other ways. Thus, initial non-participation must
paul@667 76
be defined by initialising this setting to "no" for all eligible users, if
paul@667 77
this is the general policy on initial calendar system participation.
paul@669 78
paul@669 79
permitted_times
paul@669 80
---------------
paul@669 81
paul@669 82
Default: (none)
paul@669 83
Alternatives: (see below)
paul@669 84
paul@669 85
Define the time values at which events can be scheduled. In its simplest form,
paul@669 86
this indicates the resolution of a calendar for a participant supporting this
paul@669 87
setting, with the given minute values being those allowed for the start and
paul@669 88
end of an event. This setting requires a value of one of the following forms:
paul@669 89
paul@669 90
  <minute values>
paul@669 91
  <hour values>:<minute values>
paul@669 92
  <hour values>:<minute values>:<second values>
paul@669 93
paul@669 94
Each list of values is a comma-separated collection of permissible values for
paul@669 95
the unit of time being constrained. Any unspecified list is taken to permit
paul@669 96
all normally permissible values for that unit of time. For example:
paul@669 97
paul@669 98
  0,15,30,45            every 15 minutes from the start of each hour
paul@669 99
  10,12,14,16:0,20,40   every 20 minutes from 10:00 until 16:40 inclusive
paul@669 100
  12::0,30              every 30 seconds from the start of each minute during
paul@669 101
                        the period from 12:00:00 until 12:59:30 inclusive
paul@669 102
paul@669 103
The purpose of this setting is not necessarily to impose availability
paul@669 104
constraints but instead to impose a "grid" to which event start and end points
paul@669 105
shall be "locked".