summaryrefslogtreecommitdiff
path: root/doc/api-keys.texi
diff options
context:
space:
mode:
authorArtyom Poptsov <poptsov.artyom@gmail.com>2014-01-31 16:34:47 +0400
committerArtyom Poptsov <poptsov.artyom@gmail.com>2014-01-31 16:34:47 +0400
commit38bc61ef69ce50c17be7d28012e55415c272f48a (patch)
tree185f72d3db5decc0703e1da0793d7d20ee51c85f /doc/api-keys.texi
parentdoc/api-auth.texi (Auth): Add description of `(ssh auth)' module. (diff)
downloadguile-ssh-38bc61ef69ce50c17be7d28012e55415c272f48a.tar.gz
doc/: Improve documentation of the Guile-SSH modules.
* doc/api-messages.texi (Messages): Improve documentation of the module. * doc/api-servers.texi (Servers): Likewise. * doc/api-sessions.texi (Sessions): Likewise. * doc/api-keys.texi (Keys): Likewise. * doc/api-version.texi (Version): Likewise. * doc/api-channels.texi (Channels): Likewise. Add references. Improve documentation of `make-channel' and `channel-open-session' procedure.
Diffstat (limited to 'doc/api-keys.texi')
-rw-r--r--doc/api-keys.texi3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api-keys.texi b/doc/api-keys.texi
index c880f8e..62f9ccf 100644
--- a/doc/api-keys.texi
+++ b/doc/api-keys.texi
@@ -10,6 +10,9 @@
@cindex private keys
@tindex key
+The @code{(ssh key)} module provides procedures for handling of
+Guile-SSH keys.
+
@deffn {Scheme Procedure} key? x
Return @code{#t} if @var{x} is a Guile-SSH key, @code{#f} otherwise.
@end deffn