summaryrefslogtreecommitdiff
path: root/doc/api-channels.texi (follow)
Commit message (Expand)AuthorAgeFilesLines
* channel.scm: Remove trailing bang from 'channel-send-eof'.•••This procedure merely does I/O without mutating its argument, so it does not deserve the trailing '!' (similar to Scheme's 'write', 'put-bytevector', etc. procedures). * libguile-ssh/channel-func.c (gssh_channel_send_eof_x): Rename to... (gssh_channel_send_eof): ... this. Change Scheme name to '%channel-send-eof'. Adjust caller. * modules/ssh/channel.scm (channel-send-eof!): Rename to... (channel-send-eof): ... this. * tests/client-server.scm ("channel-send-eof!"): Rename to... ("channel-send-eof"): ... this. Adjust accordingly. * doc/api-channels.texi (Channel Management): Adjust accordingly. Signed-off-by: Artyom V. Poptsov <poptsov.artyom@gmail.com> Ludovic Courtès2016-11-061-2/+2
* channel.scm (channel-send-eof!): New procedure•••* modules/ssh/channel.scm (channel-send-eof!): New procedure. * libguile-ssh/channel-func.c (gssh_channel_send_eof_x): New procedure. * doc/api-channels.texi: Add description of 'channel-send-eof!'. * tests/client-server.scm ("channel-send-eof!"): New TC. * doc/version.texi, NEWS: Update. Artyom V. Poptsov2016-10-301-0/+42
* api-channels.texi (channel-request-exec): Recommend to use remote pipes•••* doc/api-channels.texi (channel-request-exec): Recommend to use remote pipes as more high-level interface. Artyom V. Poptsov2016-08-071-0/+2
* doc/api-tunnels.texi: Add to the repository•••* doc/api-tunnels.texi: Add to the repository. * doc/api-channels.texi: Move tunnels description to 'api-tunnels.texi'. * doc/guile-ssh.texi, doc/version.texi: Update. * doc/Makefile.am (guile_ssh_TEXINFOS): Add 'api-tunnels.texi'. * NEWS: Update. Artyom V. Poptsov2015-12-201-124/+0
* doc/api-popen.texi: Add to the repository•••* doc/api-popen.texi: Add to the repository. * doc/Makefile.am (guile_ssh_TEXINFOS): Add 'api-popen.texi'. * doc/api-channels.texi: Move description of remote pipes to 'api-popen.texi'. * doc/guile-ssh.texi: Add reference to "Remote Pipes" node. * doc/version.texi: Update. Artyom V. Poptsov2015-12-061-34/+0
* doc/api-channels.texi: Fix a typoArtyom V. Poptsov2015-12-061-1/+1
* doc/api-channels.texi: Improve description of remote pipesArtyom V. Poptsov2015-12-061-0/+6
* channel.scm: Implement I/O pipes•••* modules/ssh/channel.scm (open-remote-pipe, open-remote-pipe*): Accept pipe MODE as an argument. (open-remote-input-pipe, open-remote-input-pipe*) (open-remote-output-pipe, open-remote-output-pipe*): New procedures. * doc/api-channels.texi: Update description of remote pipes. Artyom V. Poptsov2015-12-061-6/+17
* channel.scm (make-channel): Use mode symbols from (ice-9 popen)•••* modules/ssh/channel.scm (make-channel): Use mode symbols 'OPEN_READ', 'OPEN_WRITE' and 'OPEN_BOTH' from (ice-9 popen). * doc/api-channels.texi, NEWS: Update. Artyom V. Poptsov2015-12-051-4/+4
* channel.scm (make-channel): Accept optional flags•••* modules/ssh/channel.scm (make-channel): Accept optional flags that allow to create an input, output or input/output channel. The procedure creates a bidirectional tunnel by default. * libguile-ssh/channel-type.c (guile_ssh_make_channel): Likewise. Rename the Scheme procedure to '%make-channel'. All callers updated. (_scm_from_channel_data): Accept flags. Assert flags value. (print_channel): Print the direction of a channel. (init_channel_type): Define 'RDNG' and 'WRTNG' symbols. * libguile-ssh/channel-type.h: Update. * libguile-ssh/message-func.c (guile_ssh_message_channel_request_open_reply_accept): Update. * doc/api-channels.texi: Update description of 'make-channel'. Artyom V. Poptsov2015-12-051-3/+7
* channel.scm: Add remote pipes•••* modules/ssh/channel.scm (open-remote-pipe, open-remote-pipe*): New procedures. * doc/api-channels.texi: Add "Remote Pipes" section. * NEWS: Update. Artyom V. Poptsov2015-12-041-0/+17
* doc/api-channels.texi: Update•••* doc/api-channels.texi: Update description of 'channel-listen-forward'. Artyom V. Poptsov2015-11-011-2/+2
* examples/rpc/{client,server}.scm.in: Add to the repository•••* examples/rpc/client.scm.in, examples/rpc/server.scm.in: Add to the repository. * doc/api-channels.texi: Mention a path to the full RPC client example in the description of 'call-with-ssh-forward'. * examples/Makefile.am: Add 'rpc/client.scm.in', rpc/server.scm.in. * examples/.gitignore: Ignore 'rpc/client.scm', 'rpc/server.scm'. * examples/README: Update. Artyom V. Poptsov2015-07-311-0/+3
* api-channels.texi: Update description of 'channel-accept-forward'•••* doc/api-channels.texi: Update description of 'channel-accept-forward', add an usage example. Artyom V. Poptsov2015-06-271-1/+32
* tunnel.scm (call-with-ssh-forward): Return a value of PROC call•••* ssh/tunnel.scm (call-with-ssh-forward): Return a value of PROC call. * doc/api-channels.texi: Update description of 'call-with-ssh-forward'. Artyom V. Poptsov2015-06-141-1/+2
* doc/api-channels.texi: Add description of 'channel-cancel-forward'•••* doc/api-channels.texi: Add description of 'channel-cancel-forward'. * doc/version.texi: Update. Artyom V. Poptsov2015-06-131-0/+16
* doc/api-channels.texi: Update examplesArtyom V. Poptsov2015-06-061-6/+6
* doc/api-channels.texi: Update description of 'tunnel-*' procsArtyom V. Poptsov2015-06-061-4/+4
* ssh/tunnel.scm: Change API•••* ssh/tunnel.scm: Change API so it will be similar to OpenSSH port forwarding interface (think about '-R' and '-L' options). (make-tunnel): Rename options. Update the docstring. (tunnel-source-host): Rename to 'tunnel-bind-address'. All callers updated. (tunnel-local-port): Rename to 'tunnel-port'. All callers updated. (tunnel-remote-host): Rename to 'tunnel-host'. All callers updated. (tunnel-remote-port): Rename to 'tunnel-host-port'. All callers updated. (tunnel-open-forward-channel, tunnel-listen-forward, main-loop/reverse) (start-forward, call-with-ssh-forward): Update. * tests/client-server.scm ("make-tunnel"): Update. * doc/api-channels.texi: Update description of 'make-tunnel'. Artyom V. Poptsov2015-06-061-8/+16
* doc/api-channels.texi: Update•••* doc/api-channels.texi: Update description of 'make-tunnel'. Add description of 'tunnel-reverse?'. Artyom V. Poptsov2015-06-061-1/+16
* ssh/channel.scm (channel-accept-forward): New procedure•••* ssh/channel.scm (channel-accept-forward): New procedure. * ssh/channel-func.c (guile_ssh_channel_accept_forward): New procedure. * doc/api-channels.texi: Add description of 'channel-accept-forward'. Artyom V. Poptsov2015-06-061-0/+7
* doc/api-channels.texi: Update•••* doc/api-channels.texi: Rename 'channel-open-forward/reverse' to 'channel-listen-forward', update the description. Artyom V. Poptsov2015-06-061-6/+14
* doc/api-channels.texi: Update•••* doc/api-channels.texi (channel-open-forward, channel-open-forward/reverse): Describe return values. Artyom V. Poptsov2015-05-281-0/+20
* doc/api-channels.texi (Tunnels): Update•••* doc/api-channels.texi (Tunnels): Add description of procedures, add examples. Artyom V. Poptsov2015-05-241-1/+48
* doc/api-channels.texi: Update•••* doc/api-channels.texi: Update. Improve description of procedures in "Port Forwarding" chapter. Split the documentation into few sections. Add new "Tunnels" chapter. Add examples. Artyom V. Poptsov2015-05-231-14/+114
* Merge branch 'master' into wip-port-forwarding•••Conflicts: ChangeLog doc/api-channels.texi ssh/channel.scm Artyom V. Poptsov2015-05-011-0/+19
|\
| * channel-func.c (guile_ssh_channel_request_send_exit_status): Update docstring•••* doc/api-channels.texi (Channels): Update description of `guile_ssh_channel_request_send_exit_status'. * ssh/channel-func.c (guile_ssh_channel_request_send_exit_status): Update the docstring. Artyom V. Poptsov2015-02-091-1/+1
| * ssh/channel.scm (channel-request-send-exit-status): New procedure•••* ssh/channel.scm (channel-request-send-exit-status): Export. * ssh/channel-func.c (guile_ssh_channel_request_send_exit_status): New procedure. * ssh/channel-func.h: Update. * tests/client-server.scm ("channel-request-exec, exit status"): New TC. (start-server/channel-test): Update for exit status test. * doc/api-channels.texi (Channels): Add description of `channel-request-send-exit-status'. Artyom V. Poptsov2015-02-081-0/+7
| * ssh/channel.scm (channel-get-exit-status): New procedure•••* ssh/channel-func.c (guile_ssh_channel_get_exit_status): New procedure. * ssh/channel-func.h: Update. * ssh/channel.scm (channel-get-exit-status): Export. * doc/api-channels.texi (Channels): Add description of `channel-get-exit-status'. * NEWS: Update. Artyom V. Poptsov2015-02-081-0/+7
| * ssh/channel.scm (channel-get-session): New procedure•••* ssh/channel-func.c (guile_ssh_channel_get_session): New procedure. * ssh/channel-func.h (guile_ssh_channel_get_session): Likewise. * ssh/channel.scm (channel-get-session): Export. * tests/client-server.scm ("channel-get-session"): New TC. * doc/api-channels.texi (Channels): Add description of `channel-get-session' procedure. * NEWS: Update. Artyom Poptsov2014-07-201-0/+5
* | Merge branch 'master' into port-forwarding•••Conflicts: NEWS Artyom V. Poptsov2014-08-081-16/+24
|\|
| * ssh/channel-type.h (GSSH_VALIDATE_OPEN_CHANNEL): New macro•••* ssh/channel-type.h (GSSH_VALIDATE_OPEN_CHANNEL): New macro. * ssh/channel-func.c (guile_ssh_channel_request_exec) (guile_ssh_channel_request_pty, guile_ssh_channel_request_shell) (guile_ssh_channel_request_env, guile_ssh_channel_set_pty_size_x) (guile_ssh_channel_set_stream_x, guile_ssh_channel_get_stream): Expect an open channel as an argument. * doc/api-channels.texi (Channels): Update. Artyom Poptsov2014-07-181-16/+19
| * doc/api-channels.texi (Channels): Add note on `channel-request-exec'•••* doc/api-channels.texi (Channels): Add note that `channel-request-exec' can be used to execute only a single command on a channel. Artyom Poptsov2014-07-131-0/+5
* | ssh/channel.scm: Don't export primitive procedures•••* ssh/channel.scm (%channel-open-forward) (%channel-open-forward/reverse): Don't export primitive procedures. * doc/api-channels.texi (Channels): Update. * NEWS: Update. Artyom Poptsov2014-06-201-15/+5
* | doc/api-channels.texi (Channels): Add subsection on port forwardingArtyom Poptsov2014-06-151-0/+41
|/
* doc/: Improve documentation of the Guile-SSH modules.•••* 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. Artyom Poptsov2014-01-311-4/+10
* api-channels.texi (Channels): Add brief description. Update.•••* doc/api-channels.texi (Channels): Add brief description of the channel type. Add example of `channel-request-exec' usage. Add description of `channel-set-stream!' and `channel-get-stream' procedure. Artyom Poptsov2014-01-281-0/+41
* doc/guile-ssh.texi (Top): Add `Concept Index'.•••* doc/api-version.texi (Version): Update concepts. * doc/api-sessions.texi (Sessions): Likewise. * doc/api-messages.texi (Messages, Parsing of Requests): Likewise. * doc/api-channels.texi (Channels): Likewise. * doc/api-auth.texi (Auth): Likewise. * doc/guile-ssh.texi (Top): Add `Concept Index'. * doc/indices.texi (Concept Index): New node. Artyom Poptsov2014-01-281-1/+4
* 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. Artyom Poptsov2014-01-281-2/+3
* Add documentation in Texinfo format.•••* configure.ac: Add `doc/Makefile' to `AC_CONFIG_FILES'. * Makefile.am (SUBDIRS): Add `doc' directory. * doc/Makefile.am: New file. * doc/api-auth.texi, doc/api-channels.texi, doc/api-keys.texi, doc/api-messages.texi, doc/api-servers.texi, doc/api-sessions.texi, doc/api-version.texi, doc/fdl.texi, doc/guile-ssh.texi, doc/indices.texi, doc/version.texi: New file. Artyom Poptsov2014-01-271-0/+57