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