Guile-SSH is a library that provides access to the SSH protocol for programs written in GNU Guile interpreter. It is a wrapper to the underlying libssh library.
Files:
- AUTHORS contains list of people who contributed to the library development.
- COPYING contains the terms of GNU General Public License.
- INSTALL contains general instructions for building/installing of Guile-SSH.
- NEWS describes user-visible changes.
- TODO contains plans for the further development and list of known bugs.
Directories:
- examples – Examples of Guile-SSH usage.
- libguile-ssh – Sources of the Guile-SSH library.
- modules – Scheme modules.
- doc – Documentation in Texinfo format.
- tests – Unit tests.
Files are usually installed according to the prefix specified to
configure script, /usr/local by default. Building and installing
gives you:
Libraries, in ${prefix}/lib:
- libguile-ssh.so.<version>
- libguile-ssh.la
- libguile-ssh.a
Guile modules, in ${GUILE_SITE}/ssh:
- auth.scm – User authentication.
- channel.scm – Channel manipulation.
- dist.scm – Distributed forms.
- dist/job.scm – Low-level distributed job API.
- dist/node.scm – Low-level distributed node API.
- key.scm – Keys management.
- log.scm – Interface to libssh logging facilities
- message.scm – Procedures for working with SSH messages.
- server.scm – Server API.
- session.scm – Session management.
- tunnel.scm – SSH tunnels.
- version.scm – Information about versions.
All the modules will be compiled and produced .go files will be installed to
site-ccache directory which is something like this:
${libdir}/guile/2.0/site-ccache/ssh/.
Documentation in Info format, in ${prefix}/share/info/:
- guile-ssh.info
Examples, in ${prefix}/share/guile-ssh/examples:
- ssshd.scm – SSH server example.
- sssh.scm – SSH client example.
- echo/
- client.scm – Echo client example.
- server.scm – Echo server example.
- rpc/
- client.scm – A simple Guile-RPC client that makes an RPC call over a Guile-SSH tunnel.
- server.scm – A simple Guile-RPC server.
For a basic explanation of the installation of the package, see the INSTALL file.
Please note that you will need Automake 1.12 or later to run
self-tests with make check (but the library itself can be built with
older Automake version such as 1.11).
important You probably want to call configure with the
--with-guilesitedir option so that this package is installed in
Guile’s default path. But, if you don’t know where your Guile site
directory is, run configure without the option, and it will give you
a suggestion.
Please see the documentation in Info format for API documentation and usage
examples – you can open it by typing info guile-ssh in the shell, or using
C-h i m guile-ssh RET combo in Emacs. Also take a look on examples in the
examples directory.