diff options
| author | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2017-01-03 20:47:32 +0300 |
|---|---|---|
| committer | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2017-01-03 20:47:32 +0300 |
| commit | 93aa449c6cee281454fa6c711d4c66d06c7973ff (patch) | |
| tree | a406ad67a5f3ab53cf8745c1d714731157e25a84 /doc | |
| parent | dist.scm, node.scm: Update copyright dates (diff) | |
| download | guile-ssh-93aa449c6cee281454fa6c711d4c66d06c7973ff.tar.gz | |
doc/api-shell.texi: Add an example for 'loadavg'
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api-shell.texi | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/api-shell.texi b/doc/api-shell.texi index 49b7225..e16c075 100644 --- a/doc/api-shell.texi +++ b/doc/api-shell.texi @@ -80,4 +80,19 @@ result and a return code. @deffn {Scheme Procedure} loadavg session Get average load of a host using a @var{session}. Return a list of five elements as described in proc(5) man page. + +Example: + +@lisp +(use-modules (ssh session) + (ssh auth) + (ssh shell)) + +(let ((s (make-session #:host "example.org"))) + (connect! s) + (userauth-agent! s) + (loadavg s)) +@result{} ("0.01" "0.05" "0.10" "4/1927" "242011") +@end lisp + @end deffn |