diff options
| author | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-01-28 03:15:50 +0400 |
|---|---|---|
| committer | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-01-28 03:15:50 +0400 |
| commit | a82ea1e7eccad2ffe4e1606e72afa2e7ba7a35f4 (patch) | |
| tree | 59350b13d4a7d99f6d2478140bc62ae0b295e72e /doc/api-keys.texi | |
| parent | doc/api-{sessions,servers}.texi: Improve documentation. (diff) | |
| download | guile-ssh-a82ea1e7eccad2ffe4e1606e72afa2e7ba7a35f4.tar.gz | |
doc/*: Improve the documentation.
* doc/api-auth.texi, api-channels.texi, api-keys.texi,
api-servers.texi, api-sessions.texi, api-version.texi,
guile-ssh.texi: Improve.
Diffstat (limited to 'doc/api-keys.texi')
| -rw-r--r-- | doc/api-keys.texi | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/api-keys.texi b/doc/api-keys.texi index f0706f3..7bd1f08 100644 --- a/doc/api-keys.texi +++ b/doc/api-keys.texi @@ -10,15 +10,17 @@ @tindex key @deffn {Scheme Procedure} key? x -Return @code{#t} if @var{x} is a SSH key, @code{#f} otherwise. +Return @code{#t} if @var{x} is a Guile-SSH key, @code{#f} otherwise. @end deffn @deffn {Scheme Procedure} public-key? x -Return @code{#t} if @var{x} is a SSH public key, @code{#f} otherwise. +Return @code{#t} if @var{x} is a Guile-SSH public key, @code{#f} +otherwise. @end deffn @deffn {Scheme Procedure} private-key? x -Return @code{#t} if @var{x} is a SSH private key, @code{#f} otherwise. +Return @code{#t} if @var{x} is a Guile-SSH private key, @code{#f} +otherwise. @end deffn @deffn {Scheme Procedure} public-key->string public-key @@ -29,7 +31,7 @@ Convert @var{public-key} to a string. Read private key from a @var{file}. If the the key is encrypted the user will be asked for passphrase to decrypt the key. -Return a new SSH key of @code{#f} on error. +Return a new Guile-SSH key of @code{#f} on error. @end deffn @deffn {Scheme Procedure} private-key->public-key private-key |