summaryrefslogtreecommitdiff
path: root/doc/api-sessions.texi
diff options
context:
space:
mode:
authorArtyom Poptsov <poptsov.artyom@gmail.com>2014-06-22 03:59:01 +0400
committerArtyom Poptsov <poptsov.artyom@gmail.com>2014-06-22 03:59:01 +0400
commit3249da81c0016a987514a74ad7c3f62ffca62957 (patch)
tree36a96ed442f4ce52c08662b0848a964254e9bfe3 /doc/api-sessions.texi
parenttests/client-server.scm (spawn-server-thread): Catch all exceptions (diff)
downloadguile-ssh-3249da81c0016a987514a74ad7c3f62ffca62957.tar.gz
ssh/session.scm (session-get): New procedure
* ssh/session-func.c (guile_ssh_session_get): New procedure. * ssh/session-func.h (guile_ssh_session_get): Likewise. * ssh/session.scm (session-get): New procedure. * tests/session.scm ("session-get"): New TC. * doc/api-sessions.texi (Sessions): Add description of `session-get' procedure. * NEWS: Update.
Diffstat (limited to 'doc/api-sessions.texi')
-rw-r--r--doc/api-sessions.texi14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api-sessions.texi b/doc/api-sessions.texi
index e1b3ef8..ed2dcea 100644
--- a/doc/api-sessions.texi
+++ b/doc/api-sessions.texi
@@ -212,7 +212,21 @@ is expected to be a number from 1 to 9, 9 being the most efficient but
slower.
@end table
+@end deffn
+
+@deffn {Scheme Procedure} session-get session option
+Get value of the @var{option} for @var{session}. The @var{option} is expected
+to be a symbol.
+
+Please not that currently not all the possible session options can be gotten
+with this procedure. Here is the list of allowed options:
+@table @samp
+@item host
+@item user
+@item identity
+@item proxycommand
+@end table
@end deffn
@deffn {Scheme Procedure} connect! session