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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH ANNO %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 anno \- annotate messages
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 anno
  15 \%[+folder] \%[msgs]
  16 \%[\-component\ field]
  17 \%[\-inplace]
  18 .br
  19 \%[\-noinplace]
  20 \%[\-date] \%[\-nodate]
  21 \%[\-text\ body]
  22 .br
  23 \%[\-version]
  24 \%[\-help]
  25 .in -.5i
  26 .SH DESCRIPTION
  27 \fIAnno\fR annotates the specified messages in the named folder using
  28 the field and body.
  29
  30 Usually, annotation is performed by the commands \fIdist\fR, \fIforw\fR,
  31 and \fIrepl\fR, if they are given the `\-anno' switch.  This allows you
  32 to keep track of your distribution of, forwarding of, and replies to
  33 a message.
  34
  35 By using \fIanno\fR, you can perform arbitrary annotations of your own.
  36 Each message selected will be annotated with the lines
  37
  38     field:\ date
  39     field:\ body
  40
  41 The `\-nodate' switch inhibits the date annotation, leaving only the
  42 body annotation.
  43
  44 If a `\-component\ field' is not specified when \fIanno\fR is invoked,
  45 \fIanno\fR will prompt the user for the name of field for the annotation.
  46
  47 The field specified should be a valid 822-style message field name,
  48 which means that it should consist of alphanumerics (or dashes) only.
  49 The body specified is arbitrary text.
  50
  51 Normally \fIanno\fR does the annotation inplace in order to preserve
  52 any links to the message.  You may change this by using the `\-noinplace'
  53 switch.
  54 .Fi
  55 ^$HOME/\&.mh\(ruprofile~^The user profile
  56 .Pr
  57 ^Path:~^To determine the user's nmh directory
  58 .Ps
  59 ^Current\-Folder:~^To find the default current folder
  60 .Sa
  61 dist (1), forw (1), repl (1)
  62 .De
  63 `+folder' defaults to the current folder
  64 .Ds
  65 `msgs' defaults to cur
  66 .Ds
  67 `\-inplace'
  68 .Ds
  69 `\-date'
  70 .Co
  71 If a folder is given, it will become the current folder.  The first
  72 message annotated will become the current message.
  73 .En