aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/shell.xml
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2011-05-18 16:21:34 +0200
committerLukas Larsson <[email protected]>2011-05-18 16:21:34 +0200
commit15426ac367eed736c165a5bdbb1c051a87944f68 (patch)
treefcabce7847168a8416600fe35f94a411a5f73d6e /lib/stdlib/doc/src/shell.xml
parent4cd0717b717803ce8f03a12de4bf89f452ed1df7 (diff)
parentf44bbb331fb517e989d4d906b7f63ec110bbbc18 (diff)
downloadotp-15426ac367eed736c165a5bdbb1c051a87944f68.tar.gz
otp-15426ac367eed736c165a5bdbb1c051a87944f68.tar.bz2
otp-15426ac367eed736c165a5bdbb1c051a87944f68.zip
Merge branch 'dev' of super:otp into dev
* 'dev' of super:otp: (166 commits) Corrected documentation error and added examples to Users Guide In TLS 1.1, failure to properly close a connection no longer requires that a session not be resumed. This is a change from TLS 1.0 to conform with widespread implementation practice. Erlang ssl will now in TLS 1.0 conform to the widespread implementation practice instead of the specification to avoid performance issues. Add escript to bootstrap/bin Remove unused variable warning in inet_res Remove unused variable in epmd_port Remove compiler warnings in inet_drv Add SASL test suite Allow same module name in multiple applications if explicitely excluded Fix bugs concerning the option report_missing_types Fix default encoding in SAX parser. re: remove gratuitous "it " in manpage Spelling in (backward *compatibility*) comment. Improve erl_docgen's support for Dialyzer specs and types dialyzer warning on mnesia_tm Add documentation text about majority checking add mnesia_majority_test suite where_to_wlock optimization + change_table_majority/2 bug in mnesia_tm:needs_majority/2 optimize sticky_lock maj. check check majority for sticky locks ...
Diffstat (limited to 'lib/stdlib/doc/src/shell.xml')
-rw-r--r--lib/stdlib/doc/src/shell.xml37
1 files changed, 11 insertions, 26 deletions
diff --git a/lib/stdlib/doc/src/shell.xml b/lib/stdlib/doc/src/shell.xml
index 73cc1b33bd..bc2120c37d 100644
--- a/lib/stdlib/doc/src/shell.xml
+++ b/lib/stdlib/doc/src/shell.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>1996</year><year>2010</year>
+ <year>1996</year><year>2011</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -763,26 +763,20 @@ loop(N) ->
<funcs>
<func>
- <name>history(N) -> integer()</name>
+ <name name="history" arity="1"/>
<fsummary>Sets the number of previous commands to keep</fsummary>
- <type>
- <v>N = integer()</v>
- </type>
<desc>
<p>Sets the number of previous commands to keep in the
- history list to <c>N</c>. The previous number is returned.
+ history list to <c><anno>N</anno></c>. The previous number is returned.
The default number is 20.</p>
</desc>
</func>
<func>
- <name>results(N) -> integer()</name>
+ <name name="results" arity="1"/>
<fsummary>Sets the number of previous results to keep</fsummary>
- <type>
- <v>N = integer()</v>
- </type>
<desc>
<p>Sets the number of results from previous commands to keep in
- the history list to <c>N</c>. The previous number is returned.
+ the history list to <c><anno>N</anno></c>. The previous number is returned.
The default number is 20.</p>
</desc>
</func>
@@ -790,7 +784,7 @@ loop(N) ->
<name>catch_exception(Bool) -> Bool</name>
<fsummary>Sets the exception handling of the shell</fsummary>
<type>
- <v>Bool = bool()</v>
+ <v>Bool = boolean()</v>
</type>
<desc>
<p>Sets the exception handling of the evaluator process. The
@@ -804,38 +798,29 @@ loop(N) ->
</desc>
</func>
<func>
- <name>prompt_func(PromptFunc) -> prompt_func()</name>
+ <name name="prompt_func" arity="1"/>
<fsummary>Sets the shell prompt</fsummary>
- <type>
- <v>PromptFunc = prompt_func()</v>
- <v>prompt_func() = default | {Mod, Func}</v>
- <v>Mod = Func = atom()</v>
- </type>
<desc>
<p>Sets the shell prompt function to <c>PromptFunc</c>. The
previous prompt function is returned.</p>
</desc>
</func>
<func>
- <name>start_restricted(Module) -> ok | {error, Reason}</name>
+ <name name="start_restricted" arity="1"/>
<fsummary>Exits a normal shell and starts a restricted shell.</fsummary>
- <type>
- <v>Module = atom()</v>
- <v>Reason = atom()</v>
- </type>
<desc>
<p>Exits a normal shell and starts a restricted
- shell. <c>Module</c> specifies the callback module for the
+ shell. <c><anno>Module</anno></c> specifies the callback module for the
functions <c>local_allowed/3</c> and <c>non_local_allowed/3</c>.
The function is meant to be called from the shell.</p>
<p>If the callback module cannot be loaded, an error tuple is
- returned. The <c>Reason</c> in the error tuple is the one
+ returned. The <c><anno>Reason</anno></c> in the error tuple is the one
returned by the code loader when trying to load the code of the callback
module.</p>
</desc>
</func>
<func>
- <name>stop_restricted() -> ok</name>
+ <name name="stop_restricted" arity="0"/>
<fsummary>Exits a restricted shell and starts a normal shell.</fsummary>
<desc>
<p>Exits a restricted shell and starts a normal shell. The function