diff options
| -rw-r--r-- | ChangeLog | 10 | ||||
| -rw-r--r-- | doc/api-channels.texi | 14 | ||||
| -rw-r--r-- | doc/api-keys.texi | 3 | ||||
| -rw-r--r-- | doc/api-messages.texi | 6 | ||||
| -rw-r--r-- | doc/api-servers.texi | 3 | ||||
| -rw-r--r-- | doc/api-sessions.texi | 3 | ||||
| -rw-r--r-- | doc/api-version.texi | 4 |
7 files changed, 32 insertions, 11 deletions
@@ -1,8 +1,16 @@ 2014-01-31 Artyom Poptsov <poptsov.artyom@gmail.com> + * 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. * doc/api-auth.texi (Auth): Add general description of `(ssh auth)' module. - * doc/api-messages.texi (Message Handling): Add general description of a message. Improve description of `message-reply-success' procedure. diff --git a/doc/api-channels.texi b/doc/api-channels.texi index 680fb63..02122e7 100644 --- a/doc/api-channels.texi +++ b/doc/api-channels.texi @@ -9,9 +9,13 @@ @cindex data transferring @tindex channel +The @code{(ssh channel)} module provides facilities to create +Guile-SSH channels and manipulating of them. + Channels are implemented as GNU Guile ports. Therefore they can be used with regular I/O procedures such as @code{display}, @code{write}, -@code{read-line} and friends. This section describes operations that +@code{read-line} and friends (@pxref{Input and Output,,, guile, The +GNU Guile Reference Manual}). This section describes operations that are specific for the channels. @deffn {Scheme Procedure} channel? x @@ -20,12 +24,14 @@ otherwise. @end deffn @deffn {Scheme Procedure} make-channel session -Allocate a new Guile-SSH channel. +Allocate a new Guile-SSH channel for the @var{session} +(@pxref{Sessions}). @end deffn @deffn {Scheme Procedure} channel-open-session channel -Open a new session. Throw @code{guile-ssh-error} on error. Return -value is undefined. +Open a session channel. This procedure actually turn the +@var{channel} into an open port available for I/O operations. Throw +@code{guile-ssh-error} on error. Return value is undefined. @end deffn @deffn {Scheme Procedure} channel-request-exec channel command 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 diff --git a/doc/api-messages.texi b/doc/api-messages.texi index 980c46f..b017be5 100644 --- a/doc/api-messages.texi +++ b/doc/api-messages.texi @@ -9,6 +9,9 @@ @cindex talking to a SSH client @tindex message +The @code{(ssh message)} module provides procedures for handling of +Guile-SSH messages. + @menu * Message Handling:: * Parsing of Requests:: @@ -23,9 +26,6 @@ it accepts messages with @code{server-message-get} procedure (@pxref{Servers}), handles the received request and replies to the message. -The @code{(ssh message)} module provides procedures for handling of -Guile-SSH messages. - @deffn {Scheme Procedure} message? x Return @code{#t} if @var{x} a Guile-SSH message, @code{#f} otherwise. @end deffn diff --git a/doc/api-servers.texi b/doc/api-servers.texi index e19a3ed..9f2668e 100644 --- a/doc/api-servers.texi +++ b/doc/api-servers.texi @@ -9,6 +9,9 @@ @cindex servers @tindex server +The @code{(ssh server)} module provides facilities for creation and +managing of Guile-SSH servers. + @deffn {Scheme Procedure} server? x Return @code{#t} if @var{x} is a Guile-SSH server, @code{#f} otherwise. diff --git a/doc/api-sessions.texi b/doc/api-sessions.texi index 9e506fa..ca0bc4a 100644 --- a/doc/api-sessions.texi +++ b/doc/api-sessions.texi @@ -36,7 +36,8 @@ So the overall picture can be thought like this: libssh docs say that there is no limit to number of channels for a single session in theory. -This chapter describes session management. +This chapter describes session management. The code is in the +@code{(ssh session)} module. @deffn {Scheme Procedure} session? x diff --git a/doc/api-version.texi b/doc/api-version.texi index c2ff68d..ccf0188 100644 --- a/doc/api-version.texi +++ b/doc/api-version.texi @@ -8,8 +8,8 @@ @cindex versions -This module provides functions that is used for getting information -about current versions. +The @code{(ssh version)} module provides functions that is used for +getting information about current versions. @deffn {Scheme Procedure} get-libssh-version Get version of the libssh. Returns libssh version as a string in the |