1MHICAL(1) General Commands Manual MHICAL(1)
2
3
4
6 mhical - nmh's manipulator of iCalendar event requests
7
9 mhical [-help] [-version] [-form formatfile] [-format formatstring]
10 [[-reply accept | decline | tentative] | -cancel] [-contenttype]
11 [-infile infile] [-outfile outfile] [-unfold] [-debug]
12
14 mhical manipulates an iCalendar (.ics) event request, to display it,
15 generate a reply to it, or cancel it. iCalendar event requests and
16 replies are defined by RFC 5545.
17
18 The default operation is to display the iCalendar event request in a
19 human-readable format.
20
21 For the display operation, the -format string and -form formatfile
22 switches may be used to specify a format string or a format file to
23 read. If given a format string, it must be specified as a single argu‐
24 ment to the -format switch. If given a format file name with -form,
25 the file is searched for using the normal nmh rules: absolute pathnames
26 are accessed directly, tilde expansion is done on usernames, and files
27 are searched for in the user's Mail directory as specified in their
28 profile. If not found there, the directory “/etc/nmh” is checked.
29 mhical defaults to using a format file named mhical.24hour, and will
30 use the one installed in the “/etc/nmh” directory if not found else‐
31 where.
32
33 The following format components are supported:
34
35 method
36 organizer
37 summary
38 description
39 location
40 dtstart
41 dtend
42 attendees
43
44 Those format names are case-sensitive. Each corresponds to the iCalen‐
45 dar property of the same name as defined in RFC 5545, with the excep‐
46 tion of attendees. That is a comma-delimited list of the common name
47 (CN), if available, or email address of Attendee properties. A maximum
48 of 20 will be displayed.
49
50 Timezone
51 mhical will display the event with times converted to the timezone
52 specified by the TZ environment variable, if it is set, see tzset(3).
53 If not set, its behavior is implementation defined, but may use the
54 user's local timezone.
55
56 Reply
57 The -reply switch generates a reply from the event request. The
58 required action parameter must be one of accept, decline, or tentative.
59 Delegation is not supported.
60
61 Cancel
62 The -cancel switch generates an iCalendar event that can be used to
63 cancel the event request.
64
65 Input/Output
66 By default, mhical reads from standard input and writes to standard
67 output. The -infile and -outfile, respectively, switches can be used
68 to override these defaults.
69
70 Miscellaneous Switches
71 The -contenttype switch instructs mhical to insert a Content-Type
72 header at the beginning of its output, for use by mhbuild. It can only
73 be used with -reply and -cancel.
74
75 The -unfold switch echoes the event request, but with all lines
76 unfolded.
77
78 The -debug switch reveals minute details of the parse process.
79
81 mhical looks for format files in multiple locations: absolute path‐
82 names are accessed directly, tilde expansion is done on usernames, and
83 files are searched for in the user's Mail directory as specified in
84 their profile. If not found there, the directory “/etc/nmh” is
85 checked.
86
87 /etc/nmh/mhical.24hour The default display template
88 /etc/nmh/mhical.12hour Display template that uses 12-hour clock
89
91 mhbuild(1), mh-format(5), tzset(3), repl(1)
92
94 `-form' defaults to mhical.24hour
95 `-infile' defaults to standard input
96 `-outfile' defaults to standard output
97
99 mhical supports only a very limited subset of RRULE formats. Specifi‐
100 cally, only a frequency of YEARLY and an interval of 1 are supported.
101
102
103
104nmh-1.7.1 2015-01-04 MHICAL(1)