git.marmaro.de Git - mmh/blob - man/anno.man1

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH ANNO %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 anno \- annotate messages
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B anno
  11 .RI [ +folder ]
  12 .RI [ msgs ]
  13 .RB [ \-component
  14 .IR field ]
  15 .RB [ \-text
  16 .IR body ]
  17 .RB [ \-append ]
  18 .RB [ \-date " | " \-nodate ]
  19 .RB [ \-preserve " | " \-nopreserve ]
  20 .RB [ \-Version ]
  21 .RB [ \-help ]
  22 .HP
  23 .B anno
  24 .B \-delete
  25 .RI [ +folder ]
  26 .RI [ msgs ]
  27 .RB [ \-component
  28 .IR field ]
  29 .RB [ \-text
  30 .IR body ]
  31 .RB [ \-number
  32 .IR num " | all ]
  33 .RB [ \-preserve " | " \-nopreserve ]
  34 .RB [ \-Version ]
  35 .RB [ \-help ]
  36 .HP
  37 .B anno
  38 .B \-list
  39 .RI [ +folder ]
  40 .RI [ msgs ]
  41 .RB [ \-component
  42 .IR field ]
  43 .RB [ \-number ]
  44 .RB [ \-Version ]
  45 .RB [ \-help ]
  46 .ad
  47 .SH DESCRIPTION
  48 .B Anno
  49 manipulates header fields or
  50 .I annotations
  51 in messages.
  52 Header fields consist of a field name and an optional field body
  53 as defined by RFC-2822.
  54 The field name may consist of alphanumerics and dashes only.
  55 The field body may consist of arbitrary text.
  56 .PP
  57 Usually, annotation is performed by the commands
  58 .BR dist ,
  59 .BR forw ,
  60 and
  61 .BR repl ,
  62 if they are given the
  63 .B \-anno
  64 switch.  This allows you to keep track of your redistribution of,
  65 forwarding of, and replies to a message.
  66 The
  67 .B whatnow
  68 shell uses annoations to manage attachments, too.
  69 .PP
  70 By using
  71 .BR anno
  72 manually, you can perform arbitrary annotations of your own.
  73 .PP
  74 .B Anno
  75 has three operation modes: Adding, deleting and listing of header lines.
  76 .SS "Add mode
  77 .PP
  78 This is the default mode.
  79 Historically, it had been the only mode available.
  80 .PP
  81 Each message selected will be annotated with the lines
  82 .PP
  83 .RS 5
  84 .nf
  85 field:\ date
  86 field:\ body
  87 .fi
  88 .RE
  89 .PP
  90 The
  91 .B \-component
  92 switch specifies the field name.
  93 If no
  94 .B \-component
  95 .I field
  96 is specified,
  97 .B anno
  98 will prompt the user for a field name.
  99 .PP
 100 The
 101 .B \-text
 102 switch specifies the field body.
 103 If it is missing, only the date annotation will be added.
 104 The
 105 .B \-nodate
 106 switch inhibits the date annotation, leaving only the
 107 body annotation.
 108 .PP
 109 By default,
 110 .B anno
 111 prepends the annotations to the message.
 112 Annotations are instead appended if the
 113 .B \-append
 114 switch is specified.
 115 .PP
 116 .B Anno
 117 always does the annotation in place in order to preserve
 118 any links to the message.
 119 .PP
 120 By default,
 121 .B anno
 122 changes the last-accessed and last-modified times on annotated messages
 123 to the time of the annotation.
 124 .B Anno
 125 preserves the original times if the
 126 .B \-preserve
 127 switch is used.
 128 .SS "Delete mode
 129 .PP
 130 The
 131 .B \-delete
 132 mode removes header fields from messages.
 133 By default, the first header field whose name matches the component
 134 is deleted.
 135 .PP
 136 The
 137 .B \-component
 138 switch specifies the field name of headers to delete.
 139 If no
 140 .B \-component
 141 .I field
 142 is specified,
 143 .B anno
 144 will prompt the user for the name.
 145 .PP
 146 If the
 147 .B \-text
 148 switch is used,
 149 the first header field whose name matches the component and
 150 whose body matches the text is deleted.
 151 The text is treated as if it was a path name; if it begins with a
 152 slash, the entire field body must match the text, otherwise just the
 153 last path name component of the field body must match.
 154 .PP
 155 If the
 156 .B \-number
 157 switch is used,
 158 the
 159 .IR n th
 160 header field whose name matches the component is deleted.
 161 The numbers are the same as those produced in
 162 .B \-list
 163 mode.
 164 The special value `all' can be used for the number,
 165 and causes all components that match the name to be deleted.
 166 .PP
 167 Either
 168 .B \-text
 169 or
 170 .B \-number
 171 may be specified, but not both at the same time.
 172 .SS "List mode
 173 .PP
 174 The
 175 .B \-list
 176 mode produces a listing of the field bodies for header fields with
 177 matching component names, one per line.
 178 Trailing whitespace in the field body does not get printed.
 179 If the
 180 .B \-number
 181 switch is also used,
 182 the listing is numbered, starting at 1.
 183 .PP
 184 The
 185 .B \-component
 186 switch specifies the field name of headers to list.
 187 If no
 188 .B \-component
 189 .I field
 190 is specified,
 191 .B anno
 192 will prompt the user for the name.
 193 .SH FILES
 194 .fc ^ ~
 195 .nf
 196 .ta \w'%etcdir%/ExtraBigFileName  'u
 197 ^$HOME/.mmh/profile~^The user profile
 198 .fi
 199 .SH "PROFILE COMPONENTS"
 200 .fc ^ ~
 201 .nf
 202 .ta 2.4i
 203 .ta \w'ExtraBigProfileName  'u
 204 ^Path:~^To determine the user's mail storage
 205 ^Current\-Folder:~^To find the default current folder
 206 .fi
 207 .SH "SEE ALSO"
 208 dist(1), forw(1), repl(1)
 209 .SH DEFAULTS
 210 .nf
 211 .RI ` +folder "' defaults to the current folder"
 212 .RI ` msgs "' defaults to the current message"
 213 .RB ` \-date '
 214 .RB ` \-nopreserve '
 215 .fi
 216 .SH CONTEXT
 217 If a folder is given, it will become the current folder.  The first
 218 message annotated will become the current message.
 219 .SH BUGS
 220 .PP
 221 The
 222 .B \-number
 223 switch must appear after either the
 224 .B \-list
 225 or the
 226 .B \-delete
 227 mode switch, on the command line.
 228 Otherwise it is not possible to determine if it takes an argument.