X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/f347dd165f907248db3958f34ec91a73198fbcb3..ec173fd2c:/man/mhical.man?ds=inline diff --git a/man/mhical.man b/man/mhical.man index 209dc269..72ee8999 100644 --- a/man/mhical.man +++ b/man/mhical.man @@ -1,9 +1,9 @@ -.TH MHICAL %manext1% "January 4, 2015" "%nmhversion%" -.\" +.TH MHICAL %manext1% 2015-01-04 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -mhical \- manipulates an iCalendar event request +mhical \- nmh's manipulator of iCalendar event requests .SH SYNOPSIS .HP 5 .na @@ -17,6 +17,8 @@ mhical \- manipulates an iCalendar event request .RB [[ \-reply .IR "accept" " | " "decline" " | " "tentative" "] |" .BR \-cancel ] +.RB [ \-attendee +.IR address ] .RB [ \-contenttype ] .RB [ \-infile .IR infile ] @@ -31,10 +33,9 @@ manipulates an iCalendar (.ics) event request, to display it, generate a reply to it, or cancel it. iCalendar event requests and replies are defined by RFC 5545. .PP -.SH DISPLAY The default operation is to display the iCalendar event request in a human-readable format. -.SS "Format Program Selection" +.PP For the display operation, the .B \-format .I string @@ -68,14 +69,14 @@ The following format components are supported: .fc ^ ~ .nf .ta \w'description 'u -.BR ^method~^ -.BR ^organizer~^ -.BR ^summary~^ -.BR ^description~^ -.BR ^location~^ -.BR ^dtstart~^ -.BR ^dtend~^ -.BR ^attendees~^ +.B ^method~^ +.B ^organizer~^ +.B ^summary~^ +.B ^description~^ +.B ^location~^ +.B ^dtstart~^ +.B ^dtend~^ +.B ^attendees~^ .fi .RE .PP @@ -94,7 +95,7 @@ by the environment variable, if it is set, see tzset(3). If not set, its behavior is implementation defined, but may use the user's local timezone. -.SH REPLY +.SS Reply The .B \-reply switch generates a reply from the event request. The required @@ -103,12 +104,19 @@ action parameter must be one of .IR "decline" ", or" .IR "tentative" . Delegation is not supported. -.SH CANCEL +.PP +If one of your mailboxes matches more than one attendee in the request, the +.B \-attendee +switch must be used to select the one to use in the reply. The +.B \-attendee +switch can also be used to specify the attendee address if no attendees match +any of your mailboxes. +.SS Cancel The .B \-cancel switch generates an iCalendar event that can be used to cancel the event request. -.SH INPUT/OUTPUT +.SS "Input/Output" By default, .B mhical reads from standard input and writes to standard output. The @@ -116,8 +124,7 @@ reads from standard input and writes to standard output. The and .BR \-outfile , respectively, switches can be used to override these defaults. -.PP -.SH MISCELLANEOUS SWITCHES +.SS "Miscellaneous Switches" The .B \-contenttype switch instructs @@ -153,10 +160,10 @@ is checked. ^%nmhetcdir%/mhical.24hour~^The default display template ^%nmhetcdir%/mhical.12hour~^Display template that uses 12-hour clock .fi -.fi .SH "SEE ALSO" .IR mhbuild (1), .IR mh\-format (5), +.IR mh\-profile (5), .IR tzset (3), .IR repl (1) .SH DEFAULTS @@ -169,3 +176,9 @@ is checked. .B mhical supports only a very limited subset of RRULE formats. Specifically, only a frequency of YEARLY and an interval of 1 are supported. +.PP +.B mhical +produces output with just newlines instead of carriage return-newline +combinations. This is intentional, to fit with typical +.B nmh +convention.