git.marmaro.de Git - mmh/blob - man/mhsign.man1

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH MHSIGN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 mhsign \- sign or encrypt a message with gnupg
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B mhsign
  11 .RB [ \-encrypt ]
  12 .RB [ \-mime ]
  13 .I file
  14 .RB [ \-Version ]
  15 .RB [ \-help ]
  16 .ad
  17 .SH DESCRIPTION
  18 .B mhsign
  19 is a script to simplify signing and encrypting command line
  20 MH mail, using gnupg.
  21 .PP
  22 .B mhsign
  23 is normally invoked automatically by
  24 .BR send .
  25 When used directly, the source file, typically an MH draft file,
  26 is replaced by the signed or encrypted message.
  27 To permit recovery from mistakes,
  28 a backup copy of the original file is saved, under the same name
  29 with `.orig' appended.
  30 .PP
  31 The following options are recognized:
  32 .TP
  33 .B \-encrypt
  34 Encrypt to recipients, in addition to signing.
  35 The message will also be encrypted to the signing key.
  36 .TP
  37 .B \-mime
  38 Use the PGP/MIME standard for signing and encrypting.
  39 This is automatic if the message is already a multipart MIME message.
  40 Otherwise the default is to sign/encrypt in the old-fashioned
  41 non-MIME manner, for compatibility with older software.
  42 .QP
  43 When a message is signed but not encrypted, using the PGP/MIME
  44 formatting, any line beginning with ``From '' will be indented, and any
  45 trailing spaces will be removed from lines in the message body.
  46 This is to ensure maximum compatibility.
  47 Where trailing blanks are important (sending patches, for example),
  48 it would be wise to use quoted-printable or other MIME encoding
  49 for that component.
  50 .PP
  51 The signing key is automatically determinded by gnupg,
  52 unless the the profile entry
  53 .IR Pgpkey
  54 defines it.
  55 The environment variable
  56 .IR MMHPGPKEY
  57 has highest precedence and can be used to overrule the key uid temporarily.
  58 .PP
  59 For encryption, the public keys of the recipients are taken from
  60 the gnupg keyring.
  61 To handle exceptions, e.g. recipient addresses that do not
  62 match the key uid in the keyring, a file named
  63 .I pgpkeys
  64 may be used.
  65 It should be located either in the gnupg directory (normally $HOME/.gnupg)
  66 or in the mmh directory (normally $HOME/.mmh).
  67 If both files exist, the one in the gnupg directory takes precedence.
  68 .PP
  69 A sample
  70 .I pgpkeys
  71 file:
  72 .sp
  73 .RS 5
  74 .nf
  75 0x88888888      john@nowhere.example.org
  76 e5fda812        meillo@marmaro.de
  77 .fi
  78 .RE
  79
  80 .SH FILES
  81 .fc ^ ~
  82 .nf
  83 .ta \w'%etcdir%/ExtraBigFileName  'u
  84 ^$HOME/.gnupg/pgpkeys~^Pubkey exceptions for encrypting
  85 ^$HOME/.mmh/pgpkeys~^... alternative location
  86 .fi
  87
  88 .SH "PROFILE COMPONENTS"
  89 .fc ^ ~
  90 .nf
  91 .ta 2.4i
  92 .ta \w'ExtraBigProfileName  'u
  93 ^Pgpkey:~^To determine the user's signing key
  94 .fi
  95
  96 .SH "SEE ALSO"
  97 whom(1), send(1), mhpgp(1), gpg(1)
  98
  99 .SH DEFAULTS
 100 None
 101
 102 .SH CONTEXT
 103 None
 104
 105 .SH BUGS
 106 None