diff options
| author | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2015-12-23 21:50:48 +0300 |
|---|---|---|
| committer | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2015-12-23 21:50:48 +0300 |
| commit | a37cbea2c13fa224910668860dec09466980bb98 (patch) | |
| tree | f8385109480637eb6e521dda0326975aa4f86802 /examples | |
| parent | NEWS: Update (diff) | |
| download | guile-ssh-a37cbea2c13fa224910668860dec09466980bb98.tar.gz | |
examples/README: Update
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/README | 49 |
1 files changed, 26 insertions, 23 deletions
diff --git a/examples/README b/examples/README index 1fca52f..931f114 100644 --- a/examples/README +++ b/examples/README @@ -1,11 +1,14 @@ # -*- mode: org; -*- * Overview -This directory includes an examples of programs that use Guile-SSH -library to access SSH protocol. + This directory includes an examples of programs that use Guile-SSH + library to access SSH protocol. -* Scheme Secure Shell (SSSH) -SSSH uses Guile-SSH API to implement basic SSH client functionality. + Executable =.scm=-files are produced from =.scm.in= files during the build + process. +* =sssh.scm= +Scheme Secure Shell (SSSH) uses Guile-SSH API to implement basic SSH client +functionality. ** Usage Please see #+BEGIN_EXAMPLE @@ -18,28 +21,28 @@ for information about program usage. $ ./sssh.scm --identity=~/.ssh/id_rsa --user=avp localhost "uname -a" #+END_EXAMPLE -* Scheme Secure Shell Daemon (SSSHD) -SSSHD uses Guile-SSH API to implement basic SSH server functionality. +* =ssshd.scm= +* =echo= +* =rrepl.scm= + A demo program that allows to connect to a remote REPL (RREPL) server. Pass + =--help= (or =-h=) flag to the program to get usage information. +* =rpc= +* =sscp.scm= ** Usage -Please see #+BEGIN_EXAMPLE - ./ssshd.scm --help +$ sscp avp@127.0.0.1:/etc/profile profile #+END_EXAMPLE -for information about program usage. - +* =pg-tunnel.scm= + An example of using Guile-SSH tunnels and [[http://www.nongnu.org/guile-pg/][Guile-PG]] to access a remote + PostgreSQL database. +** Usage + Please see +#+BEGIN_EXAMPLE + $ ./pg-tunnel.scm --help +#+END_EXAMPLE + for information about program usage. ** Examples #+BEGIN_EXAMPLE - $ ./ssshd.scm -r ~/.ssh/id_rsa +$ ./pg-tunnel.scm --host=example.org --dbname=example --user=alice \ + 'select * from people' #+END_EXAMPLE - -* Echo server and client -Implementation of an SSH based echo protocol ([[https://tools.ietf.org/html/rfc862][RFC862]]) with Guile-SSH. -Please find sources in =echo/= directory: - - echo/client.scm - - echo/server.scm -* RREPL - A demo program that allows to connect to a remote REPL (RREPL) server. Pass - =--help= (or =-h=) flag to the program to get usage information. -* RPC over SSH - A demo [[https://www.gnu.org/software/guile-rpc/][Guile-RPC]] client program that uses an SSH tunnel to make an RPC call - over a secure connection. See =rpc/= directory. |