diff options
| -rw-r--r-- | examples/README | 44 |
1 files changed, 23 insertions, 21 deletions
diff --git a/examples/README b/examples/README index 931f114..2afbce7 100644 --- a/examples/README +++ b/examples/README @@ -1,47 +1,49 @@ # -*- mode: org; -*- -* Overview - This directory includes an examples of programs that use Guile-SSH - library to access SSH protocol. +* Examples +** Overview + This directory includes an examples of programs that use Guile-SSH + library to access SSH protocol. - Executable =.scm=-files are produced from =.scm.in= files during the build - process. -* =sssh.scm= + 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 +*** Usage Please see #+BEGIN_EXAMPLE $ ./sssh.scm --help #+END_EXAMPLE for information about program usage. -** Examples +*** Examples #+BEGIN_EXAMPLE $ ./sssh.scm --identity=~/.ssh/id_rsa --user=avp localhost "uname -a" #+END_EXAMPLE -* =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 +** =ssshd.scm= +** =echo= + Echo client and server. +** =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 #+BEGIN_EXAMPLE $ sscp avp@127.0.0.1:/etc/profile profile #+END_EXAMPLE -* =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 +** =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 +*** Examples #+BEGIN_EXAMPLE $ ./pg-tunnel.scm --host=example.org --dbname=example --user=alice \ 'select * from people' |