aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--man/pgg.texi34
1 files changed, 23 insertions, 11 deletions
diff --git a/man/pgg.texi b/man/pgg.texi
index b3829e5fa83..2475cf56817 100644
--- a/man/pgg.texi
+++ b/man/pgg.texi
@@ -129,7 +129,7 @@ signer's public key, for example, the function @code{pgg-verify-region}
129fails immediately, but if the function had been called interactively, it 129fails immediately, but if the function had been called interactively, it
130would ask you to retrieve the signer's public key from the server. 130would ask you to retrieve the signer's public key from the server.
131 131
132@deffn Command pgg-encrypt-region start end recipients &optional sign 132@deffn Command pgg-encrypt-region start end recipients &optional sign passphrase
133Encrypt the current region between @var{start} and @var{end} for 133Encrypt the current region between @var{start} and @var{end} for
134@var{recipients}. When the function were called interactively, you 134@var{recipients}. When the function were called interactively, you
135would be asked about the recipients. 135would be asked about the recipients.
@@ -138,29 +138,41 @@ If encryption is successful, it replaces the current region contents (in
138the accessible portion) with the resulting data. 138the accessible portion) with the resulting data.
139 139
140If optional argument @var{sign} is non-@code{nil}, the function is 140If optional argument @var{sign} is non-@code{nil}, the function is
141request to do a combined sign and encrypt. This currently only work 141request to do a combined sign and encrypt. This currently is
142with GnuPG. 142confirmed to work with GnuPG, but might not work with PGP or PGP5.
143
144If optional @var{passphrase} is @code{nil}, the passphrase will be
145obtained from the passphrase cache or user.
143@end deffn 146@end deffn
144 147
145@deffn Command pgg-encrypt-symmetric-region start end 148@deffn Command pgg-encrypt-symmetric-region &optional start end passphrase
146Encrypt the current region between @var{start} and @var{end} using a 149Encrypt the current region between @var{start} and @var{end} using a
147symmetric cipher. After invocation you are asked for a passphrase. 150symmetric cipher. After invocation you are asked for a passphrase.
148 151
149This is currently only implemented for GnuPG. 152If optional @var{passphrase} is @code{nil}, the passphrase will be
153obtained from the passphrase cache or user.
154
155symmetric-cipher encryption is currently only implemented for GnuPG.
150@end deffn 156@end deffn
151 157
152@deffn Command pgg-decrypt-region start end 158@deffn Command pgg-decrypt-region start end &optional passphrase
153Decrypt the current region between @var{start} and @var{end}. If 159Decrypt the current region between @var{start} and @var{end}. If
154decryption is successful, it replaces the current region contents (in 160decryption is successful, it replaces the current region contents (in
155the accessible portion) with the resulting data. 161the accessible portion) with the resulting data.
162
163If optional @var{passphrase} is @code{nil}, the passphrase will be
164obtained from the passphrase cache or user.
156@end deffn 165@end deffn
157 166
158@deffn Command pgg-sign-region start end &optional cleartext 167@deffn Command pgg-sign-region start end &optional cleartext passphrase
159Make the signature from text between @var{start} and @var{end}. If the 168Make the signature from text between @var{start} and @var{end}. If the
160optional third argument @var{cleartext} is non-@code{nil}, or the 169optional third argument @var{cleartext} is non-@code{nil}, or the
161function is called interactively, it does not create a detached 170function is called interactively, it does not create a detached
162signature. In such a case, it replaces the current region contents (in 171signature. In such a case, it replaces the current region contents (in
163the accessible portion) with the resulting data. 172the accessible portion) with the resulting data.
173
174If optional @var{passphrase} is @code{nil}, the passphrase will be
175obtained from the passphrase cache or user.
164@end deffn 176@end deffn
165 177
166@deffn Command pgg-verify-region start end &optional signature fetch 178@deffn Command pgg-verify-region start end &optional signature fetch
@@ -309,26 +321,26 @@ argument @var{type} is non-@code{nil}, it searches from the secret
309keyrings. 321keyrings.
310@end deffn 322@end deffn
311 323
312@deffn Method pgg-scheme-encrypt-region scheme start end recipients &optional sign 324@deffn Method pgg-scheme-encrypt-region scheme start end recipients &optional sign passphrase
313Encrypt the current region between @var{start} and @var{end} for 325Encrypt the current region between @var{start} and @var{end} for
314@var{recipients}. If @var{sign} is non-@code{nil}, do a combined sign 326@var{recipients}. If @var{sign} is non-@code{nil}, do a combined sign
315and encrypt. If encryption is successful, it returns @code{t}, 327and encrypt. If encryption is successful, it returns @code{t},
316otherwise @code{nil}. 328otherwise @code{nil}.
317@end deffn 329@end deffn
318 330
319@deffn Method pgg-scheme-encrypt-symmetric-region scheme start end 331@deffn Method pgg-scheme-encrypt-symmetric-region scheme start end &optional passphrase
320Encrypt the current region between @var{start} and @var{end} using a 332Encrypt the current region between @var{start} and @var{end} using a
321symmetric cipher and a passphrases. If encryption is successful, it 333symmetric cipher and a passphrases. If encryption is successful, it
322returns @code{t}, otherwise @code{nil}. This function is currently only 334returns @code{t}, otherwise @code{nil}. This function is currently only
323implemented for GnuPG. 335implemented for GnuPG.
324@end deffn 336@end deffn
325 337
326@deffn Method pgg-scheme-decrypt-region scheme start end 338@deffn Method pgg-scheme-decrypt-region scheme start end &optional passphrase
327Decrypt the current region between @var{start} and @var{end}. If 339Decrypt the current region between @var{start} and @var{end}. If
328decryption is successful, it returns @code{t}, otherwise @code{nil}. 340decryption is successful, it returns @code{t}, otherwise @code{nil}.
329@end deffn 341@end deffn
330 342
331@deffn Method pgg-scheme-sign-region scheme start end &optional cleartext 343@deffn Method pgg-scheme-sign-region scheme start end &optional cleartext passphrase
332Make the signature from text between @var{start} and @var{end}. If the 344Make the signature from text between @var{start} and @var{end}. If the
333optional third argument @var{cleartext} is non-@code{nil}, it does not 345optional third argument @var{cleartext} is non-@code{nil}, it does not
334create a detached signature. If signing is successful, it returns 346create a detached signature. If signing is successful, it returns