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