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