diff options
| author | Hans Nilsson <hans@erlang.org> | 2019-10-16 12:56:01 +0200 |
|---|---|---|
| committer | Hans Nilsson <hans@erlang.org> | 2019-10-16 12:56:01 +0200 |
| commit | fcef3eb30bf76316b90098f7e604665eb2eaad93 (patch) | |
| tree | 223ceff8164b2b49eb181292429d18d656e456c5 /lib/ssh/doc/src/ssh.xml | |
| parent | a0e23291e0ade3cb8e84709745790b1cd770ffc1 (diff) | |
| parent | 271f6d7f53dfec236b5ada78db060649daa17475 (diff) | |
| download | erlang-fcef3eb30bf76316b90098f7e604665eb2eaad93.tar.gz | |
Merge branch 'maint'
* maint:
ssh: Update the 'exec' documentation
ssh: Add references to the exec doc from the refman
Diffstat (limited to 'lib/ssh/doc/src/ssh.xml')
| -rw-r--r-- | lib/ssh/doc/src/ssh.xml | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index d58b640961..22ffeb133a 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -403,6 +403,9 @@ <p>This option changes how the daemon executes exec-requests from clients. The term in the return value is formatted to a string if it is a non-string type. No trailing newline is added in the ok-case. </p> + <p>See the User's Guide section on + <seealso marker="using_ssh#one-time-execution">One-Time Execution</seealso> for examples. + </p> <p>Error texts are returned on channel-type 1 which usually is piped to <c>stderr</c> on e.g Linux systems. Texts from a successful execution are returned on channel-type 0 and will in similar manner be piped to <c>stdout</c>. The exit-status code @@ -789,7 +792,12 @@ <datatype> <name name="max_idle_time_common_option"/> <desc> - <p>Sets a time-out on a connection when no channels are active. Defaults to <c>infinity</c>.</p> + <p>Sets a time-out on a connection when no channels are open. Defaults to <c>infinity</c>. + The unit is milliseconds. + </p> + <p>The timeout is not active until channels are started, so it does + not limit the time from the connection creation to the first channel opening. + </p> </desc> </datatype> |