Mercurial > emacs
comparison man/pgg.texi @ 66700:3ee6314bb247
(User Commands): Document additional passphrase
argument for pgg-encrypt-*, pgg-decrypt-*, and pgg-sign-* functions.
(Backend methods): Likewise for corresponding pgg-scheme-* functions.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Fri, 04 Nov 2005 14:44:06 +0000 |
parents | 34f7069d89f0 |
children | 28264c86d408 |
comparison
equal
deleted
inserted
replaced
66699:7c6404662359 | 66700:3ee6314bb247 |
---|---|
127 intended to be used as library functions. In case you don't have the | 127 intended to be used as library functions. In case you don't have the |
128 signer's public key, for example, the function @code{pgg-verify-region} | 128 signer's public key, for example, the function @code{pgg-verify-region} |
129 fails immediately, but if the function had been called interactively, it | 129 fails immediately, but if the function had been called interactively, it |
130 would ask you to retrieve the signer's public key from the server. | 130 would 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 |
133 Encrypt the current region between @var{start} and @var{end} for | 133 Encrypt 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 |
135 would be asked about the recipients. | 135 would be asked about the recipients. |
136 | 136 |
137 If encryption is successful, it replaces the current region contents (in | 137 If encryption is successful, it replaces the current region contents (in |
138 the accessible portion) with the resulting data. | 138 the accessible portion) with the resulting data. |
139 | 139 |
140 If optional argument @var{sign} is non-@code{nil}, the function is | 140 If optional argument @var{sign} is non-@code{nil}, the function is |
141 request to do a combined sign and encrypt. This currently only work | 141 request to do a combined sign and encrypt. This currently is |
142 with GnuPG. | 142 confirmed to work with GnuPG, but might not work with PGP or PGP5. |
143 @end deffn | 143 |
144 | 144 If optional @var{passphrase} is @code{nil}, the passphrase will be |
145 @deffn Command pgg-encrypt-symmetric-region start end | 145 obtained from the passphrase cache or user. |
146 @end deffn | |
147 | |
148 @deffn Command pgg-encrypt-symmetric-region &optional start end passphrase | |
146 Encrypt the current region between @var{start} and @var{end} using a | 149 Encrypt the current region between @var{start} and @var{end} using a |
147 symmetric cipher. After invocation you are asked for a passphrase. | 150 symmetric cipher. After invocation you are asked for a passphrase. |
148 | 151 |
149 This is currently only implemented for GnuPG. | 152 If optional @var{passphrase} is @code{nil}, the passphrase will be |
150 @end deffn | 153 obtained from the passphrase cache or user. |
151 | 154 |
152 @deffn Command pgg-decrypt-region start end | 155 symmetric-cipher encryption is currently only implemented for GnuPG. |
156 @end deffn | |
157 | |
158 @deffn Command pgg-decrypt-region start end &optional passphrase | |
153 Decrypt the current region between @var{start} and @var{end}. If | 159 Decrypt the current region between @var{start} and @var{end}. If |
154 decryption is successful, it replaces the current region contents (in | 160 decryption is successful, it replaces the current region contents (in |
155 the accessible portion) with the resulting data. | 161 the accessible portion) with the resulting data. |
156 @end deffn | 162 |
157 | 163 If optional @var{passphrase} is @code{nil}, the passphrase will be |
158 @deffn Command pgg-sign-region start end &optional cleartext | 164 obtained from the passphrase cache or user. |
165 @end deffn | |
166 | |
167 @deffn Command pgg-sign-region start end &optional cleartext passphrase | |
159 Make the signature from text between @var{start} and @var{end}. If the | 168 Make the signature from text between @var{start} and @var{end}. If the |
160 optional third argument @var{cleartext} is non-@code{nil}, or the | 169 optional third argument @var{cleartext} is non-@code{nil}, or the |
161 function is called interactively, it does not create a detached | 170 function is called interactively, it does not create a detached |
162 signature. In such a case, it replaces the current region contents (in | 171 signature. In such a case, it replaces the current region contents (in |
163 the accessible portion) with the resulting data. | 172 the accessible portion) with the resulting data. |
173 | |
174 If optional @var{passphrase} is @code{nil}, the passphrase will be | |
175 obtained 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 |
167 Verify the current region between @var{start} and @var{end}. If the | 179 Verify the current region between @var{start} and @var{end}. If the |
168 optional third argument @var{signature} is non-@code{nil}, or the function | 180 optional third argument @var{signature} is non-@code{nil}, or the function |
307 Return keys associated with @var{string}. If the optional third | 319 Return keys associated with @var{string}. If the optional third |
308 argument @var{type} is non-@code{nil}, it searches from the secret | 320 argument @var{type} is non-@code{nil}, it searches from the secret |
309 keyrings. | 321 keyrings. |
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 |
313 Encrypt the current region between @var{start} and @var{end} for | 325 Encrypt 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 |
315 and encrypt. If encryption is successful, it returns @code{t}, | 327 and encrypt. If encryption is successful, it returns @code{t}, |
316 otherwise @code{nil}. | 328 otherwise @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 |
320 Encrypt the current region between @var{start} and @var{end} using a | 332 Encrypt the current region between @var{start} and @var{end} using a |
321 symmetric cipher and a passphrases. If encryption is successful, it | 333 symmetric cipher and a passphrases. If encryption is successful, it |
322 returns @code{t}, otherwise @code{nil}. This function is currently only | 334 returns @code{t}, otherwise @code{nil}. This function is currently only |
323 implemented for GnuPG. | 335 implemented 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 |
327 Decrypt the current region between @var{start} and @var{end}. If | 339 Decrypt the current region between @var{start} and @var{end}. If |
328 decryption is successful, it returns @code{t}, otherwise @code{nil}. | 340 decryption 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 |
332 Make the signature from text between @var{start} and @var{end}. If the | 344 Make the signature from text between @var{start} and @var{end}. If the |
333 optional third argument @var{cleartext} is non-@code{nil}, it does not | 345 optional third argument @var{cleartext} is non-@code{nil}, it does not |
334 create a detached signature. If signing is successful, it returns | 346 create a detached signature. If signing is successful, it returns |
335 @code{t}, otherwise @code{nil}. | 347 @code{t}, otherwise @code{nil}. |
336 @end deffn | 348 @end deffn |