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 [ \-inplace " | " \-noinplace ]
  16 .RB [ \-date " | " \-nodate ]
  17 .RB [ \-append ]
  18 .RB [ \-list ]
  19 .RB [ \-delete ]
  20 .RB [ \-number
  21 .IR [ num|all ]]
  22 .RB [ \-preserve " | " \-nopreserve ]
  23 .RB [ \-version ]
  24 .RB [ \-help ]
  25 .RB [ \-text
  26 .IR body ]
  27 .ad
  28 .SH DESCRIPTION
  29 .B Anno
  30 manipulates header fields or
  31 .I annotations
  32 in messages.
  33 Header fields consist of a field name and an optional field body
  34 as defined by RFC-2822.
  35 The
  36 .B -component
  37 option specifies the field name, and the
  38 .B -text
  39 option specifies the field body.
  40 .PP
  41 The messages are the
  42 .I msgs
  43 in the named folder.
  44 .PP
  45 Usually, annotation is performed by the commands
  46 .BR dist ,
  47 .BR forw ,
  48 and
  49 .BR repl ,
  50 if they are given the
  51 .B \-anno
  52 switch.  This allows you to keep track of your distribution of,
  53 forwarding of, and replies to a message.
  54 .PP
  55 By using
  56 .BR anno ,
  57 you can perform arbitrary annotations of your own.
  58 Each message selected will be annotated with the lines
  59 .PP
  60     field:\ date
  61     field:\ body
  62 .PP
  63 The
  64 .B \-nodate
  65 switch inhibits the date annotation, leaving only the
  66 body annotation.
  67 .PP
  68 By default,
  69 .B anno
  70 prepends the annotations to the message.
  71 Annotations are instead appended if the
  72 .B -append
  73 option is specified.
  74 .PP
  75 If a
  76 .B \-component
  77 .I field
  78 is not specified when
  79 .B anno
  80 is invoked,
  81 .B anno
  82 will prompt the user for the name of field for the annotation.
  83 .PP
  84 The field specified must be a valid 2822-style message field name,
  85 which means that it may only consist of alphanumerics and dashes,
  86 The body specified is arbitrary text.
  87 .PP
  88 Normally
  89 .B anno
  90 does the annotation inplace in order to preserve
  91 any links to the message.  You may change this by using the
  92 .B \-noinplace
  93 switch.
  94 .PP
  95 The
  96 .B -list
  97 option produces a listing of the field bodies for header fields with
  98 names matching the specified component, one per line.
  99 The listing is numbered, starting at 1, if the
 100 .B -number
 101 option is also used.
 102 A tab character separates the number and the field body.
 103 The field body is treated as if it is a file name, and only the final
 104 path name component is listed.
 105 The complete field body is listed if the
 106 .B -text
 107 option is used, the contents of the text are ignored.
 108 .PP
 109 The
 110 .B -delete
 111 option removes header fields from messages.
 112 The first header field whose name matches the component is deleted if
 113 no other options are specified.
 114 If the
 115 .B -text
 116 option is used in conjunction with the
 117 .B -delete
 118 option, the first header field whose name matches the component and
 119 whose body matches the text is deleted.
 120 The text is treated as if it was a file name; if it begins with a
 121 slash, the entire field body must match the text, otherwise just the
 122 last path name component of the field body must match.
 123 If the
 124 .B -number
 125 option is used in conjuction with the
 126 .B -delete
 127 option, header field
 128 .I num
 129 whose name matches the component is deleted.
 130 The number matches that which is produced by the
 131 .B -list
 132 option.
 133 The special value
 134 .B all
 135 can be used for the number, and causes all components that match the
 136 name to be deleted.
 137 .PP
 138 By default,
 139 .B anno
 140 changes the last-accessed and last-modified times on annotate messages
 141 to the time at which the annotation occurs.
 142 .B Anno
 143 preserves the original times if the
 144 .B -preserve
 145 option is used.
 146 A matching
 147 .B -nopreserve
 148 option exists that allows time preservation to be turned off if enabled
 149 in the profile.
 150 .SH FILES
 151 .fc ^ ~
 152 .nf
 153 .ta \w'%etcdir%/ExtraBigFileName  'u
 154 ^$HOME/.mmh/profile~^The user profile
 155 .fi
 156
 157 .SH "PROFILE COMPONENTS"
 158 .fc ^ ~
 159 .nf
 160 .ta 2.4i
 161 .ta \w'ExtraBigProfileName  'u
 162 ^Path:~^To determine the user's mail storage
 163 ^Current\-Folder:~^To find the default current folder
 164 .fi
 165
 166 .SH "SEE ALSO"
 167 dist(1), forw(1), repl(1)
 168
 169 .SH DEFAULTS
 170 .nf
 171 .RI ` +folder "' defaults to the current folder"
 172 .RI ` msgs "' defaults to cur"
 173 .RB ` \-inplace '
 174 .RB ` \-date '
 175 .fi
 176
 177 .SH CONTEXT
 178 If a folder is given, it will become the current folder.  The first
 179 message annotated will become the current message.