diff options
| author | Hans Nilsson <[email protected]> | 2015-11-03 14:53:30 +0100 |
|---|---|---|
| committer | Hans Nilsson <[email protected]> | 2015-11-04 12:09:57 +0100 |
| commit | 19f3eafbb237af7b6a9d81ebbddae19c41418f8b (patch) | |
| tree | ed8911bc1a9580b444fe01e7189eb0c969aa76de /lib/ssh/doc | |
| parent | 53bfbb61333af35cde29bb786817856925dcedf0 (diff) | |
| download | otp-19f3eafbb237af7b6a9d81ebbddae19c41418f8b.tar.gz otp-19f3eafbb237af7b6a9d81ebbddae19c41418f8b.tar.bz2 otp-19f3eafbb237af7b6a9d81ebbddae19c41418f8b.zip | |
ssh: changes after doc review
Diffstat (limited to 'lib/ssh/doc')
| -rw-r--r-- | lib/ssh/doc/src/ssh.xml | 25 |
1 files changed, 24 insertions, 1 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 31a5e71401..f530a68dd9 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -61,6 +61,29 @@ </section> <section> + <title>OPTIONS</title> + <p>The exact behaviour of some functions can be adjusted with the use of options which are documented together + with the functions. Generally could each option be used at most one time in each function call. If given two or more + times, the effect is not predictable unless explicitly documented.</p> + <p>The options are of different kinds:</p> + <taglist> + <tag>Limits</tag> + <item><p>which alters limits in the system, for example number of simultaneous login attempts.</p></item> + + <tag>Timeouts</tag> + <item><p>which give some defined behaviour if too long time elapses before a given event or action, + for example time to wait for an answer.</p></item> + + <tag>Callbacks</tag> + <item><p>which gives the caller of the function the possibility to execute own code on some events, + for example calling an own logging function or to perform an own login function</p></item> + + <tag>Behaviour</tag> + <item><p>which changes the systems behaviour.</p></item> + </taglist> + </section> + + <section> <title>DATA TYPES</title> <p>Type definitions that are used more than once in this module, or abstractions to indicate the intended use of the data @@ -471,7 +494,7 @@ kex is implicit but public_key is set explicitly.</p> </p> </item> - <tag><c><![CDATA[{pwdfun, fun(User::string(), Password::string(), PeerAddress::{ip_adress(),port_number()}, State::any()) -> boolean()}]]></c></tag> + <tag><c><![CDATA[{pwdfun, fun(User::string(), Password::string(), PeerAddress::{ip_adress(),port_number()}, State::any()) -> boolean() | disconnect | {boolean(),any()} }]]></c></tag> <item> <p>Provides a function for password validation. This could used for calling an external system or if passwords should be stored as a hash. The fun returns: |