summaryrefslogtreecommitdiff
path: root/doc/api-keys.texi
diff options
context:
space:
mode:
authorArtyom Poptsov <poptsov.artyom@gmail.com>2014-01-27 21:31:15 +0400
committerArtyom Poptsov <poptsov.artyom@gmail.com>2014-01-27 21:31:15 +0400
commitc09968b89dfdfb1b50904523a0458a1f61ea91d4 (patch)
tree8aeb49a5a8f406dc9047afc0084e52169b184ab0 /doc/api-keys.texi
parentsrc/server-type.c (guile_ssh_server_close_x): Remove. (diff)
downloadguile-ssh-c09968b89dfdfb1b50904523a0458a1f61ea91d4.tar.gz
Add documentation in Texinfo format.
* configure.ac: Add `doc/Makefile' to `AC_CONFIG_FILES'. * Makefile.am (SUBDIRS): Add `doc' directory. * doc/Makefile.am: New file. * doc/api-auth.texi, doc/api-channels.texi, doc/api-keys.texi, doc/api-messages.texi, doc/api-servers.texi, doc/api-sessions.texi, doc/api-version.texi, doc/fdl.texi, doc/guile-ssh.texi, doc/indices.texi, doc/version.texi: New file.
Diffstat (limited to 'doc/api-keys.texi')
-rw-r--r--doc/api-keys.texi51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/api-keys.texi b/doc/api-keys.texi
new file mode 100644
index 0000000..f0706f3
--- /dev/null
+++ b/doc/api-keys.texi
@@ -0,0 +1,51 @@
+@c -*-texinfo-*-
+@c This file is part of Guile-SSH Reference Manual.
+@c Copyright (C) 2014 Artyom V. Poptsov
+@c See the file guile-ssh.texi for copying conditions.
+
+@node Keys
+@section Keys
+
+@cindex key
+@tindex key
+
+@deffn {Scheme Procedure} key? x
+Return @code{#t} if @var{x} is a 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.
+@end deffn
+
+@deffn {Scheme Procedure} private-key? x
+Return @code{#t} if @var{x} is a SSH private key, @code{#f} otherwise.
+@end deffn
+
+@deffn {Scheme Procedure} public-key->string public-key
+Convert @var{public-key} to a string.
+@end deffn
+
+@deffn {Scheme Procedure} private-key-from-file session file
+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.
+@end deffn
+
+@deffn {Scheme Procedure} private-key->public-key private-key
+Get a public key from the @var{private-key}.
+@end deffn
+
+@deffn {Scheme Procedure} public-key-from-file session file
+Read public key from a @var{file}. Return a public key or @code{#f}
+on error.
+@end deffn
+
+@deffn {Scheme Procedure} get-key-type key
+Get a symbol that represents the type of the Guile-SSH @var{key}.
+Possible types are: @code{dss}, @code{rsa}, @code{rsa1}, @code{unknown}.
+@end deffn
+
+@c Local Variables:
+@c TeX-master: "guile-ssh.texi"
+@c End: