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 .RB [ \-Version ]
  14 .RB [ \-help ]
  15 .I file
  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 When a message is signed but not encrypted, using the PGP/MIME
  42 formatting, any line beginning with ``From '' will be indented, and any
  43 trailing spaces will be removed from lines in the message body.
  44 This is to ensure maximum compatibility.
  45 Where trailing blanks are important (sending patches, for example),
  46 it would be wise to use quoted-printable or other MIME encoding
  47 for that component.
  48 .PP
  49 The signing key is automatically determinded by gnupg,
  50 unless the the profile entry
  51 .IR Pgpkey
  52 defines it.
  53 The environment variable
  54 .IR MMHPGPKEY
  55 has highest precedence and can be used to overrule the key uid temporarily.
  56 .PP
  57 For encryption, the public keys of the recipients are taken from
  58 the gnupg keyring.
  59 To handle exceptions, e.g. recipient addresses that do not
  60 match the key uid in the keyring, a file named
  61 .I pgpkeys
  62 may be used.
  63 It should be located either in the gnupg directory (normally $HOME/.gnupg)
  64 or in the mmh directory (normally $HOME/.mmh).
  65 If both files exist, the one in the gnupg directory takes precedence.
  66 .PP
  67 A sample
  68 .I pgpkeys
  69 file:
  70 .sp
  71 .RS 5
  72 .nf
  73 0x88888888      john@nowhere.example.org
  74 e5fda812        meillo@marmaro.de
  75 .fi
  76 .RE
  77
  78 .SH FILES
  79 .fc ^ ~
  80 .nf
  81 .ta \w'%etcdir%/ExtraBigFileName  'u
  82 ^$HOME/.gnupg/pgpkeys~^Pubkey exceptions for encrypting
  83 ^$HOME/.mmh/pgpkeys~^... alternative location
  84 .fi
  85
  86 .SH "PROFILE COMPONENTS"
  87 .fc ^ ~
  88 .nf
  89 .ta 2.4i
  90 .ta \w'ExtraBigProfileName  'u
  91 ^Pgpkey:~^To determine the user's signing key
  92 .fi
  93
  94 .SH "SEE ALSO"
  95 whom(1), send(1), mhpgp(1), gpg(1), hostname(1)
  96
  97 .SH DEFAULTS
  98 None
  99
 100 .SH CONTEXT
 101 None
 102
 103 .SH BUGS
 104 The order of the command line arguments is relevant: Options must
 105 come first, the file must be last.
 106 .PP
 107 This script uses
 108 .B hostname
 109 to get the hostname if it isn't in the address, though
 110 .B hostname
 111 isn't specified by POSIX.