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 [ \-version ]
  19 .RB [ \-help ]
  20 .RB [ \-text
  21 .IR body ]
  22 .ad
  23 .SH DESCRIPTION
  24 .B Anno
  25 annotates the specified messages in the named folder using
  26 the field and body.
  27 .PP
  28 Usually, annotation is performed by the commands
  29 .BR dist ,
  30 .BR forw ,
  31 and
  32 .BR repl ,
  33 if they are given the
  34 .B \-anno
  35 switch.  This allows you to keep track of your distribution of,
  36 forwarding of, and replies to a message.
  37 .PP
  38 By using
  39 .BR anno ,
  40 you can perform arbitrary annotations of your own.
  41 Each message selected will be annotated with the lines
  42 .PP
  43     field:\ date
  44     field:\ body
  45 .PP
  46 The
  47 .B \-nodate
  48 switch inhibits the date annotation, leaving only the
  49 body annotation.
  50 .PP
  51 If a
  52 .B \-component
  53 .I field
  54 is not specified when
  55 .B anno
  56 is invoked,
  57 .B anno
  58 will prompt the user for the name of field for the annotation.
  59 .PP
  60 The field specified should be a valid 822-style message field name,
  61 which means that it should consist of alphanumerics (or dashes) only.
  62 The body specified is arbitrary text.
  63 .PP
  64 Normally
  65 .B anno
  66 does the annotation inplace in order to preserve
  67 any links to the message.  You may change this by using the
  68 .B \-noinplace
  69 switch.
  70
  71 .SH FILES
  72 .fc ^ ~
  73 .nf
  74 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
  75 ^$HOME/\&.mh\(ruprofile~^The user profile
  76 .fi
  77
  78 .SH "PROFILE COMPONENTS"
  79 .fc ^ ~
  80 .nf
  81 .ta 2.4i
  82 .ta \w'ExtraBigProfileName  'u
  83 ^Path:~^To determine the user's nmh directory
  84 ^Current\-Folder:~^To find the default current folder
  85 .fi
  86
  87 .SH "SEE ALSO"
  88 dist(1), forw(1), repl(1)
  89
  90 .SH DEFAULTS
  91 .nf
  92 .RI ` +folder "' defaults to the current folder"
  93 .RI ` msgs "' defaults to cur"
  94 .RB ` \-inplace '
  95 .RB ` \-date '
  96 .fi
  97
  98 .SH CONTEXT
  99 If a folder is given, it will become the current folder.  The first
 100 message annotated will become the current message.