diff options
| -rw-r--r-- | man/pgg.texi | 34 |
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} | |||
| 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. |
| @@ -138,29 +138,41 @@ 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 | |||
| 144 | If optional @var{passphrase} is @code{nil}, the passphrase will be | ||
| 145 | obtained 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 |
| 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 |
| 153 | obtained from the passphrase cache or user. | ||
| 154 | |||
| 155 | symmetric-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 |
| 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. |
| 162 | |||
| 163 | If optional @var{passphrase} is @code{nil}, the passphrase will be | ||
| 164 | obtained 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 |
| 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 |
| @@ -309,26 +321,26 @@ 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 |