summaryrefslogtreecommitdiff
path: root/doc/api-servers.texi
diff options
context:
space:
mode:
authorArtyom Poptsov <poptsov.artyom@gmail.com>2014-01-28 03:15:50 +0400
committerArtyom Poptsov <poptsov.artyom@gmail.com>2014-01-28 03:15:50 +0400
commita82ea1e7eccad2ffe4e1606e72afa2e7ba7a35f4 (patch)
tree59350b13d4a7d99f6d2478140bc62ae0b295e72e /doc/api-servers.texi
parentdoc/api-{sessions,servers}.texi: Improve documentation. (diff)
downloadguile-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-servers.texi')
-rw-r--r--doc/api-servers.texi14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api-servers.texi b/doc/api-servers.texi
index 8326875..a9a59ba 100644
--- a/doc/api-servers.texi
+++ b/doc/api-servers.texi
@@ -15,6 +15,20 @@ otherwise.
Make a new Guile-SSH server.
@end deffn
+@deffn {Scheme Procedure} make-server [keywords]
+Make a new Guile-SSH server with the specified configuration specified
+by keywords. Return a new Guile-SSH server.
+
+Example:
+
+@lisp
+(let ((s (make-server #:bindport 12345
+ #:rsakey "/home/bob/.ssh/id_rsa"
+ #:log-verbosity 'nolog)))
+ ...)
+@end lisp
+@end deffn
+
@deffn {Scheme Procedure} server-set! server option value
Set a @var{option} to @var{value} for Guile-SSH @var{server}. Throw
@code{guile-ssh-error} on error. Return value is undefined.