aboutsummaryrefslogtreecommitdiffstats
path: root/lib/observer/doc/src/etop.xml
diff options
context:
space:
mode:
authorGustav Simonsson <[email protected]>2012-03-16 10:34:17 +0100
committerGustav Simonsson <[email protected]>2012-03-16 10:34:17 +0100
commitdbc73d9b5421437f6fac029c06013996de478521 (patch)
tree0b94819bece6d255bf107573ca47f85f6c3cc64c /lib/observer/doc/src/etop.xml
parente5cc75f496d41589003548c16d199f0b37a919dc (diff)
parentb65ab3aeaea983e3766d0398638eee8c068615d8 (diff)
downloadotp-dbc73d9b5421437f6fac029c06013996de478521.tar.gz
otp-dbc73d9b5421437f6fac029c06013996de478521.tar.bz2
otp-dbc73d9b5421437f6fac029c06013996de478521.zip
Merge branch 'rj/minor-doc-improvements' into maint
* rj/minor-doc-improvements: Remove dashes from error_logger doc Add start/0,1 and help/0 to etop's doc Remove/add extra/missing white spaces
Diffstat (limited to 'lib/observer/doc/src/etop.xml')
-rw-r--r--lib/observer/doc/src/etop.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/lib/observer/doc/src/etop.xml b/lib/observer/doc/src/etop.xml
index 78047caab3..4eb5603549 100644
--- a/lib/observer/doc/src/etop.xml
+++ b/lib/observer/doc/src/etop.xml
@@ -114,6 +114,37 @@ Default: <c>on</c></item>
</description>
<funcs>
<func>
+ <name>start() -> ok</name>
+ <fsummary>Start etop</fsummary>
+ <desc>
+ <p>This function starts <c>etop</c>.
+ Note that etop is preferably started with the etop and getop scripts</p>
+ </desc>
+ </func>
+ <func>
+ <name>start(Options) -> ok</name>
+ <fsummary>Start etop</fsummary>
+ <type>
+ <v>Options = [Option]</v>
+ <v>Option = {Key, Value}</v>
+ <v>Key = atom()</v>
+ <v>Value = term()</v>
+ </type>
+ <desc>
+ <p>This function starts <c>etop</c>. Use
+ <seealso marker="#help/0">help/0</seealso> to see a
+ description of the possible options.</p>
+ </desc>
+ </func>
+ <func>
+ <name>help() -> ok</name>
+ <fsummary>Print etop's help</fsummary>
+ <desc>
+ <p>This function prints the help of <c>etop</c> and
+ its options.</p>
+ </desc>
+ </func>
+ <func>
<name>config(Key,Value) -> Result</name>
<fsummary>Change tool's configuration</fsummary>
<type>