diff options
| author | Siri Hansen <[email protected]> | 2017-05-17 16:13:00 +0200 |
|---|---|---|
| committer | Siri Hansen <[email protected]> | 2017-05-19 14:39:48 +0200 |
| commit | 8d27ace14a1dd9b9899fedec818b789081e33e83 (patch) | |
| tree | 961faf4dbdd0a9ff84f5365b23365ce4e129afc5 /lib/common_test/doc | |
| parent | 91da20e4cc10a1b73672e558be34b14adc8ac0ae (diff) | |
| download | otp-8d27ace14a1dd9b9899fedec818b789081e33e83.tar.gz otp-8d27ace14a1dd9b9899fedec818b789081e33e83.tar.bz2 otp-8d27ace14a1dd9b9899fedec818b789081e33e83.zip | |
[ct] Add ct_ssh:shell/2,3
Diffstat (limited to 'lib/common_test/doc')
| -rw-r--r-- | lib/common_test/doc/src/ct_ssh.xml | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml index 137e4c3f1d..63627d8840 100644 --- a/lib/common_test/doc/src/ct_ssh.xml +++ b/lib/common_test/doc/src/ct_ssh.xml @@ -1034,6 +1034,33 @@ ChannelId, 0, Data, End, Timeout)</c></seealso>.</p> </func> <func> + <name>shell(SSH, ChannelId) -> ok | {error, Reason}</name> + <fsummary>Equivalent to shell(SSH, ChannelId, DefaultTimeout).</fsummary> + <desc><marker id="shell-2"/> + <p>Equivalent to + <seealso marker="#shell-3"><c>ct_ssh:shell(SSH, ChannelId, + DefaultTimeout)</c></seealso>.</p> + </desc> + </func> + + <func> + <name>shell(SSH, ChannelId, Timeout) -> ok | {error, Reason}</name> + <fsummary>Requests that the user default shell is executed at the + server end.</fsummary> + <type> + <v>SSH = connection()</v> + <v>ChannelId = integer()</v> + <v>Timeout = integer()</v> + <v>Reason = term()</v> + </type> + <desc><marker id="shell-3"/> + <p>Requests that the user default shell (typically defined in + <c>/etc/passwd</c> in Unix systems) is executed at the + server end.</p> + </desc> + </func> + + <func> <name>subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason}</name> <fsummary>Equivalent to subsystem(SSH, ChannelId, Subsystem, DefaultTimeout).</fsummary> |