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

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