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