X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fanno.man;h=6107cd0aafbe05a656a96906886bd28cef4e0935;hp=5cf583139c88898e6375804822fca9e3139c64fd;hb=f90104a1c52886ee18a4af23b67535530b59f920;hpb=869cc73c5455f13b7adf07575373b4e68c32ed48 diff --git a/man/anno.man b/man/anno.man index 5cf5831..6107cd0 100644 --- a/man/anno.man +++ b/man/anno.man @@ -2,72 +2,92 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" -.TH ANNO %manext1% MH.6.8 [%nmhversion%] +.TH ANNO %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME anno \- annotate messages .SH SYNOPSIS -.in +.5i -.ti -.5i -anno -\%[+folder] \%[msgs] -\%[\-component\ field] -\%[\-inplace] -.br -\%[\-noinplace] -\%[\-date] \%[\-nodate] -\%[\-text\ body] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B anno +.RI [ +folder ] +.RI [ msgs ] +.RB [ \-component +.IR field ] +.RB [ \-inplace " | " \-noinplace ] +.RB [ \-date " | " \-nodate ] +.RB [ \-version ] +.RB [ \-help ] +.RB [ \-text +.IR body ] .SH DESCRIPTION -\fIAnno\fR annotates the specified messages in the named folder using +.B Anno +annotates the specified messages in the named folder using the field and body. - -Usually, annotation is performed by the commands \fIdist\fR, \fIforw\fR, -and \fIrepl\fR, if they are given the `\-anno' switch. This allows you -to keep track of your distribution of, forwarding of, and replies to -a message. - -By using \fIanno\fR, you can perform arbitrary annotations of your own. +.PP +Usually, annotation is performed by the commands +.BR dist , +.BR forw , +.RB "and " repl , +if they are given the +.B \-anno +switch. This allows you to keep track of your distribution of, +forwarding of, and replies to a message. +.PP +By using +.BR anno , +you can perform arbitrary annotations of your own. Each message selected will be annotated with the lines - +.PP field:\ date field:\ body - -The `\-nodate' switch inhibits the date annotation, leaving only the +.PP +The +.B \-nodate +switch inhibits the date annotation, leaving only the body annotation. -If a `\-component\ field' is not specified when \fIanno\fR is invoked, -\fIanno\fR will prompt the user for the name of field for the annotation. - +If a +.BI \-component " field" +is not specified when +.B anno +is invoked, +.B anno +will prompt the user for the name of field for the annotation. +.PP The field specified should be a valid 822-style message field name, which means that it should consist of alphanumerics (or dashes) only. The body specified is arbitrary text. - -Normally \fIanno\fR does the annotation inplace in order to preserve -any links to the message. You may change this by using the `\-noinplace' +.PP +Normally +.B anno +does the annotation inplace in order to preserve +any links to the message. You may change this by using the +.B \-noinplace switch. -.Fi + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Current\-Folder:~^To find the default current folder -.Sa -dist (1), forw (1), repl (1) -.De -`+folder' defaults to the current folder -.Ds -`msgs' defaults to cur -.Ds -`\-inplace' -.Ds -`\-date' -.Co + +.SH "SEE ALSO" +dist(1), forw(1), repl(1) + +.SH "DEFAULTS" +.nf +.RI ` +folder "' defaults to the current folder" +.RI ` msgs "' defaults to cur" +.RB ` \-inplace ' +.RB ` \-date ' + +.SH CONTEXT If a folder is given, it will become the current folder. The first message annotated will become the current message. -.En