From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/asn1/doc/src/asn1ct.xml | 14 +- lib/common_test/doc/src/common_test_app.xml | 20 +- lib/common_test/doc/src/ct.xml | 76 +++---- lib/common_test/doc/src/ct_cover.xml | 6 +- lib/common_test/doc/src/ct_ftp.xml | 26 +-- lib/common_test/doc/src/ct_master.xml | 20 +- lib/common_test/doc/src/ct_rpc.xml | 18 +- lib/common_test/doc/src/ct_snmp.xml | 28 +-- lib/common_test/doc/src/ct_ssh.xml | 148 +++++++------- lib/common_test/doc/src/ct_telnet.xml | 30 +-- lib/common_test/doc/src/unix_telnet.xml | 4 +- lib/compiler/doc/src/compile.xml | 20 +- lib/crypto/doc/src/crypto.xml | 12 +- lib/debugger/doc/src/debugger.xml | 12 +- lib/debugger/doc/src/i.xml | 64 +++--- lib/debugger/doc/src/int.xml | 64 +++--- lib/dialyzer/doc/src/dialyzer.xml | 12 +- lib/erl_interface/doc/src/ei.xml | 160 +++++++-------- lib/erl_interface/doc/src/ei_connect.xml | 78 +++---- lib/erl_interface/doc/src/erl_connect.xml | 50 ++--- lib/erl_interface/doc/src/erl_error.xml | 10 +- lib/erl_interface/doc/src/erl_eterm.xml | 58 +++--- lib/erl_interface/doc/src/erl_format.xml | 4 +- lib/erl_interface/doc/src/erl_global.xml | 8 +- lib/erl_interface/doc/src/erl_malloc.xml | 16 +- lib/erl_interface/doc/src/erl_marshal.xml | 18 +- lib/erl_interface/doc/src/registry.xml | 40 ++-- lib/et/doc/src/et.xml | 10 +- lib/et/doc/src/et_collector.xml | 46 ++--- lib/et/doc/src/et_selector.xml | 8 +- lib/et/doc/src/et_viewer.xml | 14 +- lib/ftp/doc/src/ftp.xml | 78 +++---- lib/inets/doc/src/httpd.xml | 24 +-- lib/inets/doc/src/httpd_socket.xml | 8 +- lib/inets/doc/src/httpd_util.xml | 50 ++--- lib/inets/doc/src/inets.xml | 20 +- lib/inets/doc/src/mod_alias.xml | 10 +- lib/inets/doc/src/mod_auth.xml | 56 +++--- lib/inets/doc/src/mod_esi.xml | 8 +- lib/inets/doc/src/mod_security.xml | 30 +-- lib/kernel/doc/src/application.xml | 64 +++--- lib/kernel/doc/src/auth.xml | 12 +- lib/kernel/doc/src/code.xml | 70 +++---- lib/kernel/doc/src/disk_log.xml | 74 +++---- lib/kernel/doc/src/erl_boot_server.xml | 12 +- lib/kernel/doc/src/erl_ddll.xml | 32 +-- lib/kernel/doc/src/error_handler.xml | 6 +- lib/kernel/doc/src/error_logger.xml | 44 ++-- lib/kernel/doc/src/file.xml | 98 ++++----- lib/kernel/doc/src/gen_sctp.xml | 36 ++-- lib/kernel/doc/src/gen_tcp.xml | 24 +-- lib/kernel/doc/src/gen_udp.xml | 16 +- lib/kernel/doc/src/global.xml | 42 ++-- lib/kernel/doc/src/global_group.xml | 22 +- lib/kernel/doc/src/heart.xml | 8 +- lib/kernel/doc/src/inet.xml | 34 ++-- lib/kernel/doc/src/inet_res.xml | 38 ++-- lib/kernel/doc/src/net_adm.xml | 22 +- lib/kernel/doc/src/net_kernel.xml | 24 +-- lib/kernel/doc/src/os.xml | 22 +- lib/kernel/doc/src/pg2.xml | 22 +- lib/kernel/doc/src/rpc.xml | 56 +++--- lib/kernel/doc/src/seq_trace.xml | 20 +- lib/kernel/doc/src/wrap_log_reader.xml | 12 +- lib/megaco/doc/src/megaco.xml | 102 +++++----- lib/megaco/doc/src/megaco_codec_meas.xml | 6 +- lib/megaco/doc/src/megaco_codec_mstone1.xml | 26 +-- lib/megaco/doc/src/megaco_codec_mstone2.xml | 6 +- lib/megaco/doc/src/megaco_codec_transform.xml | 6 +- lib/megaco/doc/src/megaco_edist_compress.xml | 6 +- lib/megaco/doc/src/megaco_encoder.xml | 14 +- lib/megaco/doc/src/megaco_flex_scanner.xml | 12 +- lib/megaco/doc/src/megaco_tcp.xml | 30 +-- lib/megaco/doc/src/megaco_transport.xml | 8 +- lib/megaco/doc/src/megaco_udp.xml | 30 +-- lib/megaco/doc/src/megaco_user.xml | 48 ++--- lib/mnesia/doc/src/mnesia.xml | 224 ++++++++++----------- lib/mnesia/doc/src/mnesia_frag_hash.xml | 12 +- lib/mnesia/doc/src/mnesia_registry.xml | 6 +- lib/observer/doc/src/crashdump.xml | 6 +- lib/observer/doc/src/etop.xml | 8 +- lib/observer/doc/src/ttb.xml | 40 ++-- lib/odbc/doc/src/odbc.xml | 52 ++--- lib/os_mon/doc/src/cpu_sup.xml | 14 +- lib/os_mon/doc/src/disksup.xml | 12 +- lib/os_mon/doc/src/memsup.xml | 24 +-- lib/os_mon/doc/src/nteventlog.xml | 8 +- lib/os_mon/doc/src/os_mon_mib.xml | 6 +- lib/os_mon/doc/src/os_sup.xml | 10 +- lib/otp_mibs/doc/src/otp_mib.xml | 6 +- lib/parsetools/doc/src/leex.xml | 16 +- lib/parsetools/doc/src/yecc.xml | 6 +- lib/public_key/doc/src/public_key.xml | 6 +- lib/reltool/doc/src/reltool.xml | 30 +-- lib/runtime_tools/doc/src/dbg.xml | 110 +++++----- lib/runtime_tools/doc/src/erts_alloc_config.xml | 10 +- lib/sasl/doc/src/alarm_handler.xml | 8 +- lib/sasl/doc/src/rb.xml | 30 +-- lib/sasl/doc/src/release_handler.xml | 38 ++-- lib/sasl/doc/src/systools.xml | 16 +- lib/snmp/doc/src/snmp.xml | 72 +++---- lib/snmp/doc/src/snmp_community_mib.xml | 10 +- lib/snmp/doc/src/snmp_framework_mib.xml | 10 +- lib/snmp/doc/src/snmp_generic.xml | 28 +-- lib/snmp/doc/src/snmp_index.xml | 18 +- lib/snmp/doc/src/snmp_notification_mib.xml | 10 +- lib/snmp/doc/src/snmp_pdus.xml | 26 +-- lib/snmp/doc/src/snmp_standard_mib.xml | 14 +- lib/snmp/doc/src/snmp_target_mib.xml | 16 +- lib/snmp/doc/src/snmp_user_based_sm_mib.xml | 10 +- lib/snmp/doc/src/snmp_view_based_acm_mib.xml | 18 +- lib/snmp/doc/src/snmpa.xml | 206 +++++++++---------- lib/snmp/doc/src/snmpa_conf.xml | 110 +++++----- lib/snmp/doc/src/snmpa_discovery_handler.xml | 4 +- lib/snmp/doc/src/snmpa_error.xml | 6 +- lib/snmp/doc/src/snmpa_error_io.xml | 6 +- lib/snmp/doc/src/snmpa_error_logger.xml | 6 +- lib/snmp/doc/src/snmpa_error_report.xml | 6 +- lib/snmp/doc/src/snmpa_local_db.xml | 24 +-- lib/snmp/doc/src/snmpa_mpd.xml | 6 +- lib/snmp/doc/src/snmpa_network_interface.xml | 12 +- .../doc/src/snmpa_network_interface_filter.xml | 10 +- .../snmpa_notification_delivery_info_receiver.xml | 6 +- lib/snmp/doc/src/snmpa_notification_filter.xml | 4 +- lib/snmp/doc/src/snmpa_supervisor.xml | 10 +- lib/snmp/doc/src/snmpc.xml | 10 +- lib/snmp/doc/src/snmpm.xml | 168 ++++++++-------- lib/snmp/doc/src/snmpm_conf.xml | 48 ++--- lib/snmp/doc/src/snmpm_mpd.xml | 8 +- lib/snmp/doc/src/snmpm_network_interface.xml | 20 +- .../doc/src/snmpm_network_interface_filter.xml | 10 +- lib/snmp/doc/src/snmpm_user.xml | 14 +- lib/ssh/doc/src/ssh.xml | 38 ++-- lib/ssh/doc/src/ssh_connection.xml | 32 +-- lib/ssh/doc/src/ssh_sftp.xml | 104 +++++----- lib/ssh/doc/src/ssh_sftpd.xml | 4 +- lib/ssl/doc/src/ssl.xml | 42 ++-- lib/stdlib/doc/src/array.xml | 60 +++--- lib/stdlib/doc/src/base64.xml | 14 +- lib/stdlib/doc/src/beam_lib.xml | 30 +-- lib/stdlib/doc/src/c.xml | 60 +++--- lib/stdlib/doc/src/calendar.xml | 48 ++--- lib/stdlib/doc/src/dets.xml | 90 ++++----- lib/stdlib/doc/src/dict.xml | 40 ++-- lib/stdlib/doc/src/digraph.xml | 66 +++--- lib/stdlib/doc/src/digraph_utils.xml | 38 ++-- lib/stdlib/doc/src/epp.xml | 12 +- lib/stdlib/doc/src/erl_eval.xml | 32 +-- lib/stdlib/doc/src/erl_expand_records.xml | 4 +- lib/stdlib/doc/src/erl_id_trans.xml | 4 +- lib/stdlib/doc/src/erl_internal.xml | 20 +- lib/stdlib/doc/src/erl_lint.xml | 12 +- lib/stdlib/doc/src/erl_parse.xml | 18 +- lib/stdlib/doc/src/erl_pp.xml | 32 +-- lib/stdlib/doc/src/erl_scan.xml | 16 +- lib/stdlib/doc/src/erl_tar.xml | 28 +-- lib/stdlib/doc/src/ets.xml | 122 +++++------ lib/stdlib/doc/src/file_sorter.xml | 30 +-- lib/stdlib/doc/src/filelib.xml | 20 +- lib/stdlib/doc/src/filename.xml | 36 ++-- lib/stdlib/doc/src/gb_sets.xml | 70 +++---- lib/stdlib/doc/src/gb_trees.xml | 48 ++--- lib/stdlib/doc/src/gen_event.xml | 44 ++-- lib/stdlib/doc/src/gen_server.xml | 48 ++--- lib/stdlib/doc/src/io.xml | 84 ++++---- lib/stdlib/doc/src/io_lib.xml | 36 ++-- lib/stdlib/doc/src/lists.xml | 140 ++++++------- lib/stdlib/doc/src/log_mf_h.xml | 6 +- lib/stdlib/doc/src/math.xml | 44 ++-- lib/stdlib/doc/src/ms_transform.xml | 8 +- lib/stdlib/doc/src/orddict.xml | 40 ++-- lib/stdlib/doc/src/ordsets.xml | 36 ++-- lib/stdlib/doc/src/pool.xml | 18 +- lib/stdlib/doc/src/proc_lib.xml | 50 ++--- lib/stdlib/doc/src/proplists.xml | 40 ++-- lib/stdlib/doc/src/qlc.xml | 54 ++--- lib/stdlib/doc/src/queue.xml | 62 +++--- lib/stdlib/doc/src/random.xml | 18 +- lib/stdlib/doc/src/re.xml | 18 +- lib/stdlib/doc/src/sets.xml | 36 ++-- lib/stdlib/doc/src/shell.xml | 12 +- lib/stdlib/doc/src/slave.xml | 22 +- lib/stdlib/doc/src/sofs.xml | 168 ++++++++-------- lib/stdlib/doc/src/string.xml | 76 +++---- lib/stdlib/doc/src/supervisor.xml | 20 +- lib/stdlib/doc/src/supervisor_bridge.xml | 10 +- lib/stdlib/doc/src/sys.xml | 62 +++--- lib/stdlib/doc/src/timer.xml | 40 ++-- lib/stdlib/doc/src/unicode.xml | 16 +- lib/stdlib/doc/src/win32reg.xml | 28 +-- lib/stdlib/doc/src/zip.xml | 42 ++-- lib/tftp/doc/src/tftp.xml | 20 +- lib/tools/doc/src/cover.xml | 70 +++---- lib/tools/doc/src/cprof.xml | 42 ++-- lib/tools/doc/src/eprof.xml | 22 +- lib/tools/doc/src/fprof.xml | 50 ++--- lib/tools/doc/src/instrument.xml | 2 +- lib/tools/doc/src/make.xml | 10 +- lib/tools/doc/src/tags.xml | 16 +- lib/tools/doc/src/xref.xml | 64 +++--- lib/xmerl/doc/src/xmerl_sax_parser.xml | 10 +- 201 files changed, 3430 insertions(+), 3430 deletions(-) (limited to 'lib') diff --git a/lib/asn1/doc/src/asn1ct.xml b/lib/asn1/doc/src/asn1ct.xml index ccf07a9cc1..e86dbd9f5e 100644 --- a/lib/asn1/doc/src/asn1ct.xml +++ b/lib/asn1/doc/src/asn1ct.xml @@ -32,7 +32,7 @@ A asn1.sgml - asn1ct + asn1ct ASN.1 compiler and compile-time support functions

The ASN.1 compiler takes an ASN.1 module as input and generates a @@ -72,8 +72,8 @@ - compile(Asn1module) -> ok | {error, Reason} - compile(Asn1module, Options) -> ok | {error, Reason} + compile(Asn1module) -> ok | {error, Reason} + compile(Asn1module, Options) -> ok | {error, Reason} Compiles an ASN.1 module and generates encode/decode functions according to encoding rules BER or PER. Asn1module = atom() | string() @@ -336,7 +336,7 @@ File3.asn - value(Module, Type) -> {ok, Value} | {error, Reason} + value(Module, Type) -> {ok, Value} | {error, Reason} Creates an ASN.1 value for test purposes. Module = Type = atom() @@ -361,9 +361,9 @@ File3.asn - test(Module) -> ok | {error, Reason} - test(Module, Type | Options) -> ok | {error, Reason} - test(Module, Type, Value | Options) -> ok | {error, Reason} + test(Module) -> ok | {error, Reason} + test(Module, Type | Options) -> ok | {error, Reason} + test(Module, Type, Value | Options) -> ok | {error, Reason} Performs a test of encode and decode for types in an ASN.1 module. Module = Type = atom() diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml index 0401293444..7887a2c3ea 100644 --- a/lib/common_test/doc/src/common_test_app.xml +++ b/lib/common_test/doc/src/common_test_app.xml @@ -32,7 +32,7 @@ PA1 common_test_app.sgml - common_test + common_test A framework for automated testing of any target nodes. @@ -68,7 +68,7 @@ - Module:all() -> Tests | {skip,Reason} + Module:all() -> Tests | {skip,Reason} Returns the list of all test case groups and test cases in the module. @@ -115,7 +115,7 @@ - Module:groups() -> GroupDefs + Module:groups() -> GroupDefs Returns a list of test case group definitions. GroupDefs = [Group] @@ -140,7 +140,7 @@ - Module:suite() -> [Info] + Module:suite() -> [Info] Test suite info function (providing default data for the suite). @@ -213,7 +213,7 @@ - Module:init_per_suite(Config) -> NewConfig | {skip,Reason} | + Module:init_per_suite(Config) -> NewConfig | {skip,Reason} | {skip_and_save,Reason,SaveConfig} Test suite initializations. @@ -248,7 +248,7 @@ - Module:end_per_suite(Config) -> term() | + Module:end_per_suite(Config) -> term() | {save_config,SaveConfig} Test suite finalization. @@ -352,7 +352,7 @@ - Module:init_per_group(GroupName, Config) -> NewConfig | + Module:init_per_group(GroupName, Config) -> NewConfig | {skip,Reason} Test case group initializations. @@ -390,7 +390,7 @@ - Module:end_per_group(GroupName, Config) -> term() | + Module:end_per_group(GroupName, Config) -> term() | {return_group_result,Status} Test case group finalization. @@ -424,7 +424,7 @@ - Module:init_per_testcase(TestCase, Config) -> NewConfig | {fail,Reason} | {skip,Reason} + Module:init_per_testcase(TestCase, Config) -> NewConfig | {fail,Reason} | {skip,Reason} Test case initializations. TestCase = atom() @@ -454,7 +454,7 @@ - Module:end_per_testcase(TestCase, Config) -> term() | {fail,Reason} | {save_config,SaveConfig} + Module:end_per_testcase(TestCase, Config) -> term() | {fail,Reason} | {save_config,SaveConfig} Test case finalization. TestCase = atom() diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml index e55637a7fe..83c0ecb309 100644 --- a/lib/common_test/doc/src/ct.xml +++ b/lib/common_test/doc/src/ct.xml @@ -32,7 +32,7 @@ A ct.xml - ct + ct Main user interface for the Common Test framework. @@ -139,7 +139,7 @@ - abort_current_testcase(Reason) -> ok | {error, ErrorReason} + abort_current_testcase(Reason) -> ok | {error, ErrorReason} Aborts the currently executing test case. Reason = term() @@ -290,7 +290,7 @@ - comment(Comment) -> ok + comment(Comment) -> ok Prints the specified Comment in the comment field in the table on the test suite result page. @@ -353,7 +353,7 @@ - decrypt_config_file(EncryptFileName, TargetFileName) -> ok | {error, Reason} + decrypt_config_file(EncryptFileName, TargetFileName) -> ok | {error, Reason} Decrypts EncryptFileName, previously generated with encrypt_config_file/2,3. @@ -372,7 +372,7 @@ - decrypt_config_file(EncryptFileName, TargetFileName, KeyOrFile) -> ok | {error, Reason} + decrypt_config_file(EncryptFileName, TargetFileName, KeyOrFile) -> ok | {error, Reason} Decrypts EncryptFileName, previously generated with encrypt_config_file/2,3. @@ -390,7 +390,7 @@ - encrypt_config_file(SrcFileName, EncryptFileName) -> ok | {error, Reason} + encrypt_config_file(SrcFileName, EncryptFileName) -> ok | {error, Reason} Encrypts the source configuration file with DES3 and saves the result in file EncryptFileName. @@ -416,7 +416,7 @@ - encrypt_config_file(SrcFileName, EncryptFileName, KeyOrFile) -> ok | {error, Reason} + encrypt_config_file(SrcFileName, EncryptFileName, KeyOrFile) -> ok | {error, Reason} Encrypts the source configuration file with DES3 and saves the result in the target file EncryptFileName. @@ -442,7 +442,7 @@ - fail(Reason) -> ok + fail(Reason) -> ok Terminates a test case with the specified error Reason. @@ -470,7 +470,7 @@ - get_config(Required) -> Value + get_config(Required) -> Value Equivalent to get_config(Required, undefined, []).

Equivalent to ct:get_config(Required, @@ -479,7 +479,7 @@ - get_config(Required, Default) -> Value + get_config(Required, Default) -> Value Equivalent to get_config(Required, Default, []).

Equivalent to ct:get_config(Required, @@ -488,7 +488,7 @@ - get_config(Required, Default, Opts) -> ValueOrElement + get_config(Required, Default, Opts) -> ValueOrElement Reads configuration data values. Required = KeyOrName | {KeyOrName, SubKey} | {KeyOrName, SubKey, SubKey} @@ -582,7 +582,7 @@ - get_status() -> TestStatus | {error, Reason} | no_tests_running + get_status() -> TestStatus | {error, Reason} | no_tests_running Returns status of ongoing test. TestStatus = [StatusElem] @@ -608,7 +608,7 @@ - get_target_name(Handle) -> {ok, TargetName} | {error, Reason} + get_target_name(Handle) -> {ok, TargetName} | {error, Reason} Returns the name of the target that the specified connection belongs to. @@ -697,7 +697,7 @@ - install(Opts) -> ok | {error, Reason} + install(Opts) -> ok | {error, Reason} Installs configuration files and event handlers. Opts = [Opt] @@ -724,7 +724,7 @@ - listenv(Telnet) -> [Env] + listenv(Telnet) -> [Env] Performs command listenv on the specified Telnet connection and returns the result as a list of key-value pairs. @@ -740,7 +740,7 @@ - log(Format) -> ok + log(Format) -> ok Equivalent to log(default, 50, Format, [], []).

Equivalent to @@ -749,7 +749,7 @@ - log(X1, X2) -> ok + log(X1, X2) -> ok Equivalent to log(Category, Importance, Format, FormatArgs, []). @@ -763,7 +763,7 @@ - log(X1, X2, X3) -> ok + log(X1, X2, X3) -> ok Equivalent to log(Category, Importance, Format, FormatArgs, Opts). @@ -859,7 +859,7 @@ - pal(Format) -> ok + pal(Format) -> ok Equivalent to pal(default, 50, Format, [], []).

Equivalent to @@ -869,7 +869,7 @@ - pal(X1, X2) -> ok + pal(X1, X2) -> ok Equivalent to pal(Category, Importance, Format, FormatArgs, []). @@ -883,7 +883,7 @@ - pal(X1, X2, X3) -> ok + pal(X1, X2, X3) -> ok Equivalent to pal(Category, Importance, Format, FormatArgs, Opts). @@ -945,7 +945,7 @@ - parse_table(Data) -> {Heading, Table} + parse_table(Data) -> {Heading, Table} Parses the printout from an SQL table and returns a list of tuples. @@ -967,7 +967,7 @@ - print(Format) -> ok + print(Format) -> ok Equivalent to print(default, 50, Format, [], []).

Equivalent to ct:print(default, @@ -990,7 +990,7 @@ - print(X1, X2, X3) -> ok + print(X1, X2, X3) -> ok Equivalent to print(Category, Importance, Format, FormatArgs, Opts). @@ -1124,7 +1124,7 @@ - require(Required) -> ok | {error, Reason} + require(Required) -> ok | {error, Reason} Checks if the required configuration is available. Required = Key | {Key, SubKeys} | {Key, SubKey, SubKeys} @@ -1178,7 +1178,7 @@ - require(Name, Required) -> ok | {error, Reason} + require(Name, Required) -> ok | {error, Reason} Checks if the required configuration is available and gives it a name. @@ -1237,7 +1237,7 @@ - run(TestDirs) -> Result + run(TestDirs) -> Result Runs all test cases in all suites in the specified directories. @@ -1251,7 +1251,7 @@ - run(TestDir, Suite) -> Result + run(TestDir, Suite) -> Result Runs all test cases in the specified suite.

Runs all test cases in the specified suite.

@@ -1261,7 +1261,7 @@ - run(TestDir, Suite, Cases) -> Result + run(TestDir, Suite, Cases) -> Result Runs the specified test cases. TestDir = string() @@ -1283,7 +1283,7 @@ - run_test(Opts) -> Result + run_test(Opts) -> Result Runs tests as specified by the combination of options in Opts. @@ -1355,7 +1355,7 @@ - run_testspec(TestSpec) -> Result + run_testspec(TestSpec) -> Result Runs a test specified by TestSpec. TestSpec = [term()] @@ -1412,7 +1412,7 @@ - start_interactive() -> ok + start_interactive() -> ok Starts Common Test in interactive mode.

Starts Common Test in interactive mode.

@@ -1440,7 +1440,7 @@ - step(TestDir, Suite, Case) -> Result + step(TestDir, Suite, Case) -> Result Steps through a test case with the debugger. Case = atom() @@ -1453,7 +1453,7 @@ - step(TestDir, Suite, Case, Opts) -> Result + step(TestDir, Suite, Case, Opts) -> Result Steps through a test case with the debugger. Case = atom() @@ -1470,7 +1470,7 @@ - stop_interactive() -> ok + stop_interactive() -> ok Exits the interactive mode.

Exits the interactive mode.

@@ -1501,7 +1501,7 @@ - testcases(TestDir, Suite) -> Testcases | {error, Reason} + testcases(TestDir, Suite) -> Testcases | {error, Reason} Returns all test cases in the specified suite. TestDir = string() @@ -1539,7 +1539,7 @@ - userdata(TestDir, Suite) -> SuiteUserData | {error, Reason} + userdata(TestDir, Suite) -> SuiteUserData | {error, Reason} Returns any data specified with tag userdata in the list of tuples returned from Suite:suite/0. @@ -1556,7 +1556,7 @@ - userdata(TestDir, Suite, Case::GroupOrCase) -> TCUserData | {error, Reason} + userdata(TestDir, Suite, Case::GroupOrCase) -> TCUserData | {error, Reason} Returns any data specified with tag userdata in the list of tuples returned from Suite:group(GroupName) or Suite:Case(). diff --git a/lib/common_test/doc/src/ct_cover.xml b/lib/common_test/doc/src/ct_cover.xml index f777fd1ce9..61365d3522 100644 --- a/lib/common_test/doc/src/ct_cover.xml +++ b/lib/common_test/doc/src/ct_cover.xml @@ -32,7 +32,7 @@ A ct_cover.xml - ct_cover + ct_cover Common Test framework code coverage support module. @@ -47,7 +47,7 @@ - add_nodes(Nodes) -> {ok, StartedNodes} | {error, Reason} + add_nodes(Nodes) -> {ok, StartedNodes} | {error, Reason} Adds nodes to current cover test (only works if cover support is active). @@ -83,7 +83,7 @@ - remove_nodes(Nodes) -> ok | {error, Reason} + remove_nodes(Nodes) -> ok | {error, Reason} Removes nodes from the current cover test. Nodes = [atom()] diff --git a/lib/common_test/doc/src/ct_ftp.xml b/lib/common_test/doc/src/ct_ftp.xml index 592c5eb05d..7ee6049486 100644 --- a/lib/common_test/doc/src/ct_ftp.xml +++ b/lib/common_test/doc/src/ct_ftp.xml @@ -32,7 +32,7 @@ A ct_ftp.xml - ct_ftp + ct_ftp FTP client module (based on the FTP application). @@ -59,7 +59,7 @@ - cd(Connection, Dir) -> ok | {error, Reason} + cd(Connection, Dir) -> ok | {error, Reason} Changes directory on remote host. Connection = connection() @@ -71,7 +71,7 @@ - close(Connection) -> ok | {error, Reason} + close(Connection) -> ok | {error, Reason} Closes the FTP connection. Connection = connection() @@ -82,7 +82,7 @@ - delete(Connection, File) -> ok | {error, Reason} + delete(Connection, File) -> ok | {error, Reason} Deletes a file on remote host. Connection = connection() @@ -94,7 +94,7 @@ - get(KeyOrName, RemoteFile, LocalFile) -> ok | {error, Reason} + get(KeyOrName, RemoteFile, LocalFile) -> ok | {error, Reason} Opens an FTP connection and fetches a file from the remote host. @@ -122,7 +122,7 @@ - ls(Connection, Dir) -> {ok, Listing} | {error, Reason} + ls(Connection, Dir) -> {ok, Listing} | {error, Reason} Lists directory Dir. Connection = connection() @@ -135,7 +135,7 @@ - open(KeyOrName) -> {ok, Handle} | {error, Reason} + open(KeyOrName) -> {ok, Handle} | {error, Reason} Opens an FTP connection to the specified node. KeyOrName = Key | Name @@ -164,7 +164,7 @@ - put(KeyOrName, LocalFile, RemoteFile) -> ok | {error, Reason} + put(KeyOrName, LocalFile, RemoteFile) -> ok | {error, Reason} Opens an FTP connection and sends a file to the remote host. @@ -203,7 +203,7 @@ - recv(Connection, RemoteFile) -> ok | {error, Reason} + recv(Connection, RemoteFile) -> ok | {error, Reason} Fetches a file over FTP.

Fetches a file over FTP.

@@ -215,7 +215,7 @@ - recv(Connection, RemoteFile, LocalFile) -> ok | {error, Reason} + recv(Connection, RemoteFile, LocalFile) -> ok | {error, Reason} Fetches a file over FTP. Connection = connection() @@ -230,7 +230,7 @@ - send(Connection, LocalFile) -> ok | {error, Reason} + send(Connection, LocalFile) -> ok | {error, Reason} Sends a file over FTP.

Sends a file over FTP.

@@ -243,7 +243,7 @@ - send(Connection, LocalFile, RemoteFile) -> ok | {error, Reason} + send(Connection, LocalFile, RemoteFile) -> ok | {error, Reason} Sends a file over FTP. Connection = connection() @@ -258,7 +258,7 @@ - type(Connection, Type) -> ok | {error, Reason} + type(Connection, Type) -> ok | {error, Reason} Changes the file transfer type. Connection = connection() diff --git a/lib/common_test/doc/src/ct_master.xml b/lib/common_test/doc/src/ct_master.xml index 8afd7c537e..2ab421fe9e 100644 --- a/lib/common_test/doc/src/ct_master.xml +++ b/lib/common_test/doc/src/ct_master.xml @@ -32,7 +32,7 @@ A ct_master.xml - ct_master + ct_master Distributed test execution control for Common Test. @@ -46,7 +46,7 @@ - abort() -> ok + abort() -> ok Stops all running tests.

Stops all running tests.

@@ -54,7 +54,7 @@ - abort(Nodes) -> ok + abort(Nodes) -> ok Stops tests on specified nodes. Nodes = atom() | [atom()] @@ -98,7 +98,7 @@ - progress() -> [{Node, Status}] + progress() -> [{Node, Status}] Returns test progress. Node = atom() @@ -112,7 +112,7 @@ - run(TestSpecs) -> ok + run(TestSpecs) -> ok Equivalent to run(TestSpecs, false, [], []). TestSpecs = string() | [SeparateOrMerged] @@ -124,7 +124,7 @@ - run(TestSpecs, InclNodes, ExclNodes) -> ok + run(TestSpecs, InclNodes, ExclNodes) -> ok Equivalent to run(TestSpecs, false, InclNodes, ExclNodes). @@ -140,7 +140,7 @@ - run(TestSpecs, AllowUserTerms, InclNodes, ExclNodes) -> ok + run(TestSpecs, AllowUserTerms, InclNodes, ExclNodes) -> ok Tests are spawned on the nodes as specified in TestSpecs. @@ -162,7 +162,7 @@ - run_on_node(TestSpecs, Node) -> ok + run_on_node(TestSpecs, Node) -> ok Equivalent to run_on_node(TestSpecs, false, Node). TestSpecs = string() | [SeparateOrMerged] @@ -177,7 +177,7 @@ - run_on_node(TestSpecs, AllowUserTerms, Node) -> ok + run_on_node(TestSpecs, AllowUserTerms, Node) -> ok Tests are spawned on Node according to TestSpecs. TestSpecs = string() | [SeparateOrMerged] @@ -191,7 +191,7 @@ - run_test(Node, Opts) -> ok + run_test(Node, Opts) -> ok Tests are spawned on Node using ct:run_test/1. Node = atom() diff --git a/lib/common_test/doc/src/ct_rpc.xml b/lib/common_test/doc/src/ct_rpc.xml index 90e6b833f7..00a4dcec08 100644 --- a/lib/common_test/doc/src/ct_rpc.xml +++ b/lib/common_test/doc/src/ct_rpc.xml @@ -32,7 +32,7 @@ A ct_rpc.xml - ct_rpc + ct_rpc Common Test specific layer on Erlang/OTP rpc. @@ -43,7 +43,7 @@ - app_node(App, Candidates) -> NodeName + app_node(App, Candidates) -> NodeName From a set of candidate nodes determines which of them is running the application App. @@ -61,7 +61,7 @@ - app_node(App, Candidates, FailOnBadRPC) -> NodeName + app_node(App, Candidates, FailOnBadRPC) -> NodeName Same as app_node/2, except that argument FailOnBadRPC determines if the search for a candidate node is to stop if badrpc is received at some point. @@ -81,7 +81,7 @@ - app_node(App, Candidates, FailOnBadRPC, Cookie) -> NodeName + app_node(App, Candidates, FailOnBadRPC, Cookie) -> NodeName Same as app_node/2, except that argument FailOnBadRPC determines if the search for a candidate node is to stop if badrpc is received at some point. @@ -105,7 +105,7 @@ - call(Node, Module, Function, Args) -> term() | {badrpc, Reason} + call(Node, Module, Function, Args) -> term() | {badrpc, Reason} Same as call(Node, Module, Function, Args, infinity).

Same as call(Node, Module, Function, Args, infinity).

@@ -113,7 +113,7 @@ - call(Node, Module, Function, Args, TimeOut) -> term() | {badrpc, Reason} + call(Node, Module, Function, Args, TimeOut) -> term() | {badrpc, Reason} Evaluates apply(Module, Function, Args) on the node Node. @@ -136,7 +136,7 @@ - call(Node, Module, Function, Args, TimeOut, Cookie) -> term() | {badrpc, Reason} + call(Node, Module, Function, Args, TimeOut, Cookie) -> term() | {badrpc, Reason} Evaluates apply(Module, Function, Args) on the node Node. @@ -163,7 +163,7 @@ - cast(Node, Module, Function, Args) -> ok + cast(Node, Module, Function, Args) -> ok Evaluates apply(Module, Function, Args) on the node Node. @@ -187,7 +187,7 @@ - cast(Node, Module, Function, Args, Cookie) -> ok + cast(Node, Module, Function, Args, Cookie) -> ok Evaluates apply(Module, Function, Args) on the node Node. diff --git a/lib/common_test/doc/src/ct_snmp.xml b/lib/common_test/doc/src/ct_snmp.xml index 3d8c5d3e92..343781814a 100644 --- a/lib/common_test/doc/src/ct_snmp.xml +++ b/lib/common_test/doc/src/ct_snmp.xml @@ -32,7 +32,7 @@ A ct_snmp.xml - ct_snmp + ct_snmp Common Test user interface module for the SNMP application. @@ -240,7 +240,7 @@ - get_next_values(Agent, Oids, MgrAgentConfName) -> SnmpReply + get_next_values(Agent, Oids, MgrAgentConfName) -> SnmpReply Issues a synchronous SNMP get next request. Agent = agent_name() @@ -254,7 +254,7 @@ - get_values(Agent, Oids, MgrAgentConfName) -> SnmpReply + get_values(Agent, Oids, MgrAgentConfName) -> SnmpReply Issues a synchronous SNMP get request. Agent = agent_name() @@ -268,7 +268,7 @@ - load_mibs(Mibs) -> ok | {error, Reason} + load_mibs(Mibs) -> ok | {error, Reason} Loads the MIBs into agent snmp_master_agent. Mibs = [MibName] @@ -281,7 +281,7 @@ - register_agents(MgrAgentConfName, ManagedAgents) -> ok | {error, Reason} + register_agents(MgrAgentConfName, ManagedAgents) -> ok | {error, Reason} Explicitly instructs the manager to handle this agent. @@ -300,7 +300,7 @@ - register_users(MgrAgentConfName, Users) -> ok | {error, Reason} + register_users(MgrAgentConfName, Users) -> ok | {error, Reason} Registers the manager entity (=user) responsible for specific agent(s). @@ -319,7 +319,7 @@ - register_usm_users(MgrAgentConfName, UsmUsers) -> ok | {error, Reason} + register_usm_users(MgrAgentConfName, UsmUsers) -> ok | {error, Reason} Explicitly instructs the manager to handle this USM user. MgrAgentConfName = atom() @@ -337,7 +337,7 @@ - set_info(Config) -> [{Agent, OldVarsAndVals, NewVarsAndVals}] + set_info(Config) -> [{Agent, OldVarsAndVals, NewVarsAndVals}] Returns a list of all successful set requests performed in the test case in reverse order. @@ -357,7 +357,7 @@ - set_values(Agent, VarsAndVals, MgrAgentConfName, Config) -> SnmpReply + set_values(Agent, VarsAndVals, MgrAgentConfName, Config) -> SnmpReply Issues a synchronous SNMP set request. Agent = agent_name() @@ -372,7 +372,7 @@ - start(Config, MgrAgentConfName) -> ok + start(Config, MgrAgentConfName) -> ok Equivalent to start(Config, MgrAgentConfName, undefined). @@ -383,7 +383,7 @@ - start(Config, MgrAgentConfName, SnmpAppConfName) -> ok + start(Config, MgrAgentConfName, SnmpAppConfName) -> ok Starts an SNMP manager and/or agent. Config = [{Key, Value}] @@ -415,7 +415,7 @@ - stop(Config) -> ok + stop(Config) -> ok Stops the SNMP manager and/or agent, and removes all files created. @@ -443,7 +443,7 @@ - unregister_agents(MgrAgentConfName) -> ok + unregister_agents(MgrAgentConfName) -> ok Unregisters all managed agents. MgrAgentConfName = atom() @@ -468,7 +468,7 @@ - unregister_users(MgrAgentConfName) -> ok + unregister_users(MgrAgentConfName) -> ok Unregisters all users. MgrAgentConfName = atom() diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml index bb0aaa46b7..8d9f31aff8 100644 --- a/lib/common_test/doc/src/ct_ssh.xml +++ b/lib/common_test/doc/src/ct_ssh.xml @@ -32,7 +32,7 @@ A ct_ssh.xml - ct_ssh + ct_ssh SSH/SFTP client module. @@ -95,7 +95,7 @@ - apread(SSH, Handle, Position, Length) -> Result + apread(SSH, Handle, Position, Length) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -109,7 +109,7 @@ - apread(SSH, Server, Handle, Position, Length) -> Result + apread(SSH, Server, Handle, Position, Length) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -123,7 +123,7 @@ - apwrite(SSH, Handle, Position, Data) -> Result + apwrite(SSH, Handle, Position, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -137,7 +137,7 @@ - apwrite(SSH, Server, Handle, Position, Data) -> Result + apwrite(SSH, Server, Handle, Position, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -151,7 +151,7 @@ - aread(SSH, Handle, Len) -> Result + aread(SSH, Handle, Len) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -165,7 +165,7 @@ - aread(SSH, Server, Handle, Len) -> Result + aread(SSH, Server, Handle, Len) -> Result For inforamtion and other types, see ssh_sftp(3). SSH = connection() @@ -179,7 +179,7 @@ - awrite(SSH, Handle, Data) -> Result + awrite(SSH, Handle, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -193,7 +193,7 @@ - awrite(SSH, Server, Handle, Data) -> Result + awrite(SSH, Server, Handle, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -207,7 +207,7 @@ - close(SSH, Handle) -> Result + close(SSH, Handle) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -221,7 +221,7 @@ - close(SSH, Server, Handle) -> Result + close(SSH, Server, Handle) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -235,7 +235,7 @@ - connect(KeyOrName) -> {ok, Handle} | {error, Reason} + connect(KeyOrName) -> {ok, Handle} | {error, Reason} Equivalent to connect(KeyOrName, host, []).

Equivalent to @@ -245,7 +245,7 @@ - connect(KeyOrName, ConnType) -> {ok, Handle} | {error, Reason} + connect(KeyOrName, ConnType) -> {ok, Handle} | {error, Reason} Equivalent to connect(KeyOrName, ConnType, []).

Equivalent to @@ -255,7 +255,7 @@ - connect(KeyOrName, ConnType, ExtraOpts) -> {ok, Handle} | {error, Reason} + connect(KeyOrName, ConnType, ExtraOpts) -> {ok, Handle} | {error, Reason} Opens an SSH or SFTP connection using the information associated with KeyOrName. @@ -301,7 +301,7 @@ - del_dir(SSH, Name) -> Result + del_dir(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -315,7 +315,7 @@ - del_dir(SSH, Server, Name) -> Result + del_dir(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -329,7 +329,7 @@ - delete(SSH, Name) -> Result + delete(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -343,7 +343,7 @@ - delete(SSH, Server, Name) -> Result + delete(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -357,7 +357,7 @@ - disconnect(SSH) -> ok | {error, Reason} + disconnect(SSH) -> ok | {error, Reason} Closes an SSH/SFTP connection. SSH = connection() @@ -369,7 +369,7 @@ - exec(SSH, Command) -> {ok, Data} | {error, Reason} + exec(SSH, Command) -> {ok, Data} | {error, Reason} Equivalent to exec(SSH, Command, DefaultTimeout).

Equivalent to @@ -379,7 +379,7 @@ - exec(SSH, Command, Timeout) -> {ok, Data} | {error, Reason} + exec(SSH, Command, Timeout) -> {ok, Data} | {error, Reason} Requests server to perform Command. SSH = connection() @@ -396,7 +396,7 @@ - exec(SSH, ChannelId, Command, Timeout) -> {ok, Data} | {error, Reason} + exec(SSH, ChannelId, Command, Timeout) -> {ok, Data} | {error, Reason} Requests server to perform Command. SSH = connection() @@ -414,7 +414,7 @@ - get_file_info(SSH, Handle) -> Result + get_file_info(SSH, Handle) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -428,7 +428,7 @@ - get_file_info(SSH, Server, Handle) -> Result + get_file_info(SSH, Server, Handle) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -442,7 +442,7 @@ - list_dir(SSH, Path) -> Result + list_dir(SSH, Path) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -456,7 +456,7 @@ - list_dir(SSH, Server, Path) -> Result + list_dir(SSH, Server, Path) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -470,7 +470,7 @@ - make_dir(SSH, Name) -> Result + make_dir(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -484,7 +484,7 @@ - make_dir(SSH, Server, Name) -> Result + make_dir(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -498,7 +498,7 @@ - make_symlink(SSH, Name, Target) -> Result + make_symlink(SSH, Name, Target) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -512,7 +512,7 @@ - make_symlink(SSH, Server, Name, Target) -> Result + make_symlink(SSH, Server, Name, Target) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -526,7 +526,7 @@ - open(SSH, File, Mode) -> Result + open(SSH, File, Mode) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -540,7 +540,7 @@ - open(SSH, Server, File, Mode) -> Result + open(SSH, Server, File, Mode) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -554,7 +554,7 @@ - opendir(SSH, Path) -> Result + opendir(SSH, Path) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -568,7 +568,7 @@ - opendir(SSH, Server, Path) -> Result + opendir(SSH, Server, Path) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -582,7 +582,7 @@ - position(SSH, Handle, Location) -> Result + position(SSH, Handle, Location) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -596,7 +596,7 @@ - position(SSH, Server, Handle, Location) -> Result + position(SSH, Server, Handle, Location) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -610,7 +610,7 @@ - pread(SSH, Handle, Position, Length) -> Result + pread(SSH, Handle, Position, Length) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -624,7 +624,7 @@ - pread(SSH, Server, Handle, Position, Length) -> Result + pread(SSH, Server, Handle, Position, Length) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -638,7 +638,7 @@ - pwrite(SSH, Handle, Position, Data) -> Result + pwrite(SSH, Handle, Position, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -652,7 +652,7 @@ - pwrite(SSH, Server, Handle, Position, Data) -> Result + pwrite(SSH, Server, Handle, Position, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -666,7 +666,7 @@ - read(SSH, Handle, Len) -> Result + read(SSH, Handle, Len) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -680,7 +680,7 @@ - read(SSH, Server, Handle, Len) -> Result + read(SSH, Server, Handle, Len) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -694,7 +694,7 @@ - read_file(SSH, File) -> Result + read_file(SSH, File) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -708,7 +708,7 @@ - read_file(SSH, Server, File) -> Result + read_file(SSH, Server, File) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -722,7 +722,7 @@ - read_file_info(SSH, Name) -> Result + read_file_info(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -736,7 +736,7 @@ - read_file_info(SSH, Server, Name) -> Result + read_file_info(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -750,7 +750,7 @@ - read_link(SSH, Name) -> Result + read_link(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -764,7 +764,7 @@ - read_link(SSH, Server, Name) -> Result + read_link(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -778,7 +778,7 @@ - read_link_info(SSH, Name) -> Result + read_link_info(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -792,7 +792,7 @@ - read_link_info(SSH, Server, Name) -> Result + read_link_info(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -806,7 +806,7 @@ - receive_response(SSH, ChannelId) -> {ok, Data} | {error, Reason} + receive_response(SSH, ChannelId) -> {ok, Data} | {error, Reason} Equivalent to receive_response(SSH, ChannelId, close). @@ -817,7 +817,7 @@ ChannelId, close).

 - receive_response(SSH, ChannelId, End) -> {ok, Data} | {error, Reason} + receive_response(SSH, ChannelId, End) -> {ok, Data} | {error, Reason} Equivalent to receive_response(SSH, ChannelId, End, DefaultTimeout). @@ -828,7 +828,7 @@ ChannelId, End, DefaultTimeout).

 - receive_response(SSH, ChannelId, End, Timeout) -> {ok, Data} | {timeout, Data} | {error, Reason} + receive_response(SSH, ChannelId, End, Timeout) -> {ok, Data} | {timeout, Data} | {error, Reason} Receives expected data from server on the specified session channel. @@ -863,7 +863,7 @@ ChannelId, End, DefaultTimeout).

 - rename(SSH, OldName, NewName) -> Result + rename(SSH, OldName, NewName) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -877,7 +877,7 @@ ChannelId, End, DefaultTimeout).

 - rename(SSH, Server, OldName, NewName) -> Result + rename(SSH, Server, OldName, NewName) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -891,7 +891,7 @@ ChannelId, End, DefaultTimeout).

 - send(SSH, ChannelId, Data) -> ok | {error, Reason} + send(SSH, ChannelId, Data) -> ok | {error, Reason} Equivalent to send(SSH, ChannelId, 0, Data, DefaultTimeout). @@ -901,7 +901,7 @@ ChannelId, End, DefaultTimeout).

 - send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason} + send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason} Equivalent to send(SSH, ChannelId, 0, Data, Timeout).

Equivalent to ct_ssh:send(SSH, @@ -910,7 +910,7 @@ ChannelId, End, DefaultTimeout).

 - send(SSH, ChannelId, Type, Data, Timeout) -> ok | {error, Reason} + send(SSH, ChannelId, Type, Data, Timeout) -> ok | {error, Reason} Sends data to server on specified session channel. SSH = connection() @@ -926,7 +926,7 @@ ChannelId, End, DefaultTimeout).

 - send_and_receive(SSH, ChannelId, Data) -> {ok, Data} | {error, Reason} + send_and_receive(SSH, ChannelId, Data) -> {ok, Data} | {error, Reason} Equivalent to send_and_receive(SSH, ChannelId, Data, close). @@ -937,7 +937,7 @@ ChannelId, End, DefaultTimeout).

 - send_and_receive(SSH, ChannelId, Data, End) -> {ok, Data} | {error, Reason} + send_and_receive(SSH, ChannelId, Data, End) -> {ok, Data} | {error, Reason} Equivalent to send_and_receive(SSH, ChannelId, 0, Data, End, DefaultTimeout). @@ -948,7 +948,7 @@ ChannelId, 0, Data, End, DefaultTimeout).

 - send_and_receive(SSH, ChannelId, Data, End, Timeout) -> {ok, Data} | {error, Reason} + send_and_receive(SSH, ChannelId, Data, End, Timeout) -> {ok, Data} | {error, Reason} Equivalent to send_and_receive(SSH, ChannelId, 0, Data, End, Timeout). @@ -959,7 +959,7 @@ ChannelId, 0, Data, End, Timeout).

 - send_and_receive(SSH, ChannelId, Type, Data, End, Timeout) -> {ok, Data} | {error, Reason} + send_and_receive(SSH, ChannelId, Type, Data, End, Timeout) -> {ok, Data} | {error, Reason} Sends data to server on specified session channel and waits to receive the server response. @@ -981,7 +981,7 @@ ChannelId, 0, Data, End, Timeout).

 - session_close(SSH, ChannelId) -> ok | {error, Reason} + session_close(SSH, ChannelId) -> ok | {error, Reason} Closes an SSH session channel. SSH = connection() @@ -994,7 +994,7 @@ ChannelId, 0, Data, End, Timeout).

 - session_open(SSH) -> {ok, ChannelId} | {error, Reason} + session_open(SSH) -> {ok, ChannelId} | {error, Reason} Equivalent to session_open(SSH, DefaultTimeout).

Equivalent to @@ -1004,7 +1004,7 @@ ChannelId, 0, Data, End, Timeout).

 - session_open(SSH, Timeout) -> {ok, ChannelId} | {error, Reason} + session_open(SSH, Timeout) -> {ok, ChannelId} | {error, Reason} Opens a channel for an SSH session. SSH = connection() @@ -1018,7 +1018,7 @@ ChannelId, 0, Data, End, Timeout).

 - sftp_connect(SSH) -> {ok, Server} | {error, Reason} + sftp_connect(SSH) -> {ok, Server} | {error, Reason} Starts an SFTP session on an already existing SSH connection. @@ -1061,7 +1061,7 @@ ChannelId, 0, Data, End, Timeout).

 - subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason} + subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason} Equivalent to subsystem(SSH, ChannelId, Subsystem, DefaultTimeout). @@ -1072,7 +1072,7 @@ ChannelId, 0, Data, End, Timeout).

 - subsystem(SSH, ChannelId, Subsystem, Timeout) -> Status | {error, Reason} + subsystem(SSH, ChannelId, Subsystem, Timeout) -> Status | {error, Reason} Sends a request to execute a predefined subsystem. SSH = connection() @@ -1088,7 +1088,7 @@ ChannelId, 0, Data, End, Timeout).

 - write(SSH, Handle, Data) -> Result + write(SSH, Handle, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1102,7 +1102,7 @@ ChannelId, 0, Data, End, Timeout).

 - write(SSH, Server, Handle, Data) -> Result + write(SSH, Server, Handle, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1116,7 +1116,7 @@ ChannelId, 0, Data, End, Timeout).

 - write_file(SSH, File, Iolist) -> Result + write_file(SSH, File, Iolist) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1130,7 +1130,7 @@ ChannelId, 0, Data, End, Timeout).

 - write_file(SSH, Server, File, Iolist) -> Result + write_file(SSH, Server, File, Iolist) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1144,7 +1144,7 @@ ChannelId, 0, Data, End, Timeout).

 - write_file_info(SSH, Name, Info) -> Result + write_file_info(SSH, Name, Info) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1158,7 +1158,7 @@ ChannelId, 0, Data, End, Timeout).

 - write_file_info(SSH, Server, Name, Info) -> Result + write_file_info(SSH, Server, Name, Info) -> Result For information and other types, see ssh_sftp(3). SSH = connection() diff --git a/lib/common_test/doc/src/ct_telnet.xml b/lib/common_test/doc/src/ct_telnet.xml index 2d69338bca..9a12ce79ed 100644 --- a/lib/common_test/doc/src/ct_telnet.xml +++ b/lib/common_test/doc/src/ct_telnet.xml @@ -32,7 +32,7 @@ A ct_telnet.xml - ct_telnet + ct_telnet Common Test specific layer on top of Telnet client ct_telnet_client.erl @@ -205,7 +205,7 @@ - close(Connection) -> ok | {error, Reason} + close(Connection) -> ok | {error, Reason} Closes the Telnet connection and stops the process managing it. @@ -223,7 +223,7 @@ - cmd(Connection, Cmd) -> {ok, Data} | {error, Reason} + cmd(Connection, Cmd) -> {ok, Data} | {error, Reason} Equivalent to cmd(Connection, Cmd, []).

Equivalent to @@ -233,7 +233,7 @@ - cmd(Connection, Cmd, Opts) -> {ok, Data} | {error, Reason} + cmd(Connection, Cmd, Opts) -> {ok, Data} | {error, Reason} Sends a command through Telnet and waits for prompt. Connection = connection() @@ -262,7 +262,7 @@ - cmdf(Connection, CmdFormat, Args) -> {ok, Data} | {error, Reason} + cmdf(Connection, CmdFormat, Args) -> {ok, Data} | {error, Reason} Equivalent to cmdf(Connection, CmdFormat, Args, []).

Equivalent to @@ -272,7 +272,7 @@ - cmdf(Connection, CmdFormat, Args, Opts) -> {ok, Data} | {error, Reason} + cmdf(Connection, CmdFormat, Args, Opts) -> {ok, Data} | {error, Reason} Sends a Telnet command and waits for prompt (uses a format string and a list of arguments to build the command). @@ -294,7 +294,7 @@ - expect(Connection, Patterns) -> term() + expect(Connection, Patterns) -> term() Equivalent to expect(Connections, Patterns, []).

Equivalent to @@ -304,7 +304,7 @@ - expect(Connection, Patterns, Opts) -> {ok, Match} | {ok, MatchList, HaltReason} | {error, Reason} + expect(Connection, Patterns, Opts) -> {ok, Match} | {ok, MatchList, HaltReason} | {error, Reason} Gets data from Telnet and waits for the expected pattern. @@ -422,7 +422,7 @@ - get_data(Connection) -> {ok, Data} | {error, Reason} + get_data(Connection) -> {ok, Data} | {error, Reason} Gets all data received by the Telnet client since the last command was sent. @@ -446,7 +446,7 @@ - open(Name) -> {ok, Handle} | {error, Reason} + open(Name) -> {ok, Handle} | {error, Reason} Equivalent to open(Name, telnet).

Equivalent to @@ -456,7 +456,7 @@ - open(Name, ConnType) -> {ok, Handle} | {error, Reason} + open(Name, ConnType) -> {ok, Handle} | {error, Reason} Opens a Telnet connection to the specified target host. @@ -471,7 +471,7 @@ - open(KeyOrName, ConnType, TargetMod) -> {ok, Handle} | {error, Reason} + open(KeyOrName, ConnType, TargetMod) -> {ok, Handle} | {error, Reason} Equivalent to open(KeyOrName, ConnType, TargetMod, []).

Equivalent to @@ -481,7 +481,7 @@ - open(KeyOrName, ConnType, TargetMod, Extra) -> {ok, Handle} | {error, Reason} + open(KeyOrName, ConnType, TargetMod, Extra) -> {ok, Handle} | {error, Reason} Opens a Telnet connection to the specified target host. @@ -531,7 +531,7 @@ - send(Connection, Cmd) -> ok | {error, Reason} + send(Connection, Cmd) -> ok | {error, Reason} Equivalent to send(Connection, Cmd, []).

Equivalent to @@ -566,7 +566,7 @@ - sendf(Connection, CmdFormat, Args) -> ok | {error, Reason} + sendf(Connection, CmdFormat, Args) -> ok | {error, Reason} Equivalent to sendf(Connection, CmdFormat, Args, []).

Equivalent to diff --git a/lib/common_test/doc/src/unix_telnet.xml b/lib/common_test/doc/src/unix_telnet.xml index eaa184d8fc..03d91b7dbe 100644 --- a/lib/common_test/doc/src/unix_telnet.xml +++ b/lib/common_test/doc/src/unix_telnet.xml @@ -32,7 +32,7 @@ A unix_telnet.xml - unix_telnet + unix_telnet Callback module for ct_telnet, for connecting to a Telnet server on a UNIX host. @@ -107,7 +107,7 @@ - get_prompt_regexp() -> PromptRegexp + get_prompt_regexp() -> PromptRegexp Callback for ct_telnet.erl. PromptRegexp = prompt_regexp() diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml index 4c8b34e278..7f3d6aa60e 100644 --- a/lib/compiler/doc/src/compile.xml +++ b/lib/compiler/doc/src/compile.xml @@ -29,7 +29,7 @@ A compile.sgml - compile + compile Erlang Compiler

This module provides an interface to the standard Erlang @@ -53,7 +53,7 @@ - file(File) + file(File) Compiles a file.

Is the same as @@ -63,7 +63,7 @@ - file(File, Options) -> CompRet + file(File, Options) -> CompRet Compiles a file. CompRet = ModRet | BinRet | ErrRet @@ -718,7 +718,7 @@ module.beam: module.erl \ - forms(Forms) + forms(Forms) Compiles a list of forms.

Is the same as @@ -728,7 +728,7 @@ module.beam: module.erl \ - forms(Forms, Options) -> CompRet + forms(Forms, Options) -> CompRet Compiles a list of forms. Forms = [Form] @@ -749,7 +749,7 @@ module.beam: module.erl \ - format_error(ErrorDescriptor) -> chars() + format_error(ErrorDescriptor) -> chars() Formats an error descriptor. ErrorDescriptor = errordesc() @@ -764,7 +764,7 @@ module.beam: module.erl \ - output_generated(Options) -> true | false + output_generated(Options) -> true | false Determines whether the compiler generates an output file. Options = [term()] @@ -779,7 +779,7 @@ module.beam: module.erl \ - noenv_file(File, Options) -> CompRet + noenv_file(File, Options) -> CompRet Compiles a file (ignoring ERL_COMPILER_OPTIONS).

Works like file/2, @@ -789,7 +789,7 @@ module.beam: module.erl \ - noenv_forms(Forms, Options) -> CompRet + noenv_forms(Forms, Options) -> CompRet Compiles a list of forms (ignoring ERL_COMPILER_OPTIONS).

Works like forms/2, @@ -799,7 +799,7 @@ module.beam: module.erl \ - noenv_output_generated(Options) -> true | false + noenv_output_generated(Options) -> true | false Determines whether the compiler generates an output file (ignoring ERL_COMPILER_OPTIONS). diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index 5a2343fb7e..5c1909fc7f 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -23,7 +23,7 @@ crypto - crypto + crypto Crypto Functions

This module provides a set of cryptographic functions. @@ -622,7 +622,7 @@ - + XOR data

Performs bit-wise XOR (exclusive or) on the data supplied.

@@ -805,7 +805,7 @@ - + Provides information about the libraries used by crypto.

Provides the name and version of the libraries used by crypto.

@@ -922,7 +922,7 @@ - rand_uniform(Lo, Hi) -> N + rand_uniform(Lo, Hi) -> N Generate a random number Lo, Hi, N = integer() @@ -935,7 +935,7 @@ - + Equivalent to application:start(crypto).

Equivalent to application:start(crypto).

@@ -943,7 +943,7 @@ - + Equivalent to application:stop(crypto).

Equivalent to application:stop(crypto).

diff --git a/lib/debugger/doc/src/debugger.xml b/lib/debugger/doc/src/debugger.xml index 1ecdbcd064..77285095e7 100644 --- a/lib/debugger/doc/src/debugger.xml +++ b/lib/debugger/doc/src/debugger.xml @@ -28,7 +28,7 @@ - debugger + debugger Erlang Debugger.

Erlang Debugger for debugging and testing of Erlang programs.

@@ -36,10 +36,10 @@ - start() - start(File) - start(Mode) - start(Mode, File) + start() + start(File) + start(Mode) + start(Mode, File) Start Debugger. Mode = local | global @@ -60,7 +60,7 @@ - quick(Module, Name, Args) + quick(Module, Name, Args) Debug a process. Module = Name = atom() diff --git a/lib/debugger/doc/src/i.xml b/lib/debugger/doc/src/i.xml index 628b91e9e4..06b0eb876a 100644 --- a/lib/debugger/doc/src/i.xml +++ b/lib/debugger/doc/src/i.xml @@ -28,7 +28,7 @@ - i + i Debugger/Interpreter Interface.

The i module provides short forms for some of @@ -51,7 +51,7 @@ - im() -> pid() + im() -> pid() Start a graphical monitor.

Starts a new graphical monitor. This is the Monitor window, @@ -63,10 +63,10 @@ - ii(AbsModules) -> ok - ii(AbsModule) -> {module, Module} | error - ini(AbsModules) -> ok - ini(AbsModule) -> {module, Module} | error + ii(AbsModules) -> ok + ii(AbsModule) -> {module, Module} | error + ini(AbsModules) -> ok + ini(AbsModule) -> {module, Module} | error Interpret a module. AbsModules = [AbsModule] @@ -84,8 +84,8 @@ - iq(AbsModule) -> ok - inq(AbsModule) -> ok + iq(AbsModule) -> ok + inq(AbsModule) -> ok Stop interpreting a module. AbsModule = Module | File @@ -100,7 +100,7 @@ - il() -> ok + il() -> ok Make a printout of all interpreted modules

Makes a printout of all interpreted modules. @@ -110,7 +110,7 @@ - ip() -> ok + ip() -> ok Print the current status of all interpreted processes. @@ -119,7 +119,7 @@ - ic() -> ok + ic() -> ok Clear information about processes executing interpreted code. @@ -129,8 +129,8 @@ - iaa(Flags) -> true - iaa(Flags, Function) -> true + iaa(Flags) -> true + iaa(Flags, Function) -> true Set when and how to attach to a process. Flags = [init | break | exit] @@ -148,7 +148,7 @@ - ist(Flag) -> true + ist(Flag) -> true Set how to save call frames. Flag = all | no_tail | false @@ -160,7 +160,7 @@ - ia(Pid) -> ok | no_proc + ia(Pid) -> ok | no_proc Attache to a process. Pid = pid() @@ -172,7 +172,7 @@ - ia(X,Y,Z) -> ok | no_proc + ia(X,Y,Z) -> ok | no_proc Attache to a process. X = Y = Z = int() @@ -184,7 +184,7 @@ - ia(Pid, Function) -> ok | no_proc + ia(Pid, Function) -> ok | no_proc Attache to a process. Pid = pid() @@ -199,7 +199,7 @@ - ia(X,Y,Z, Function) -> ok | no_proc + ia(X,Y,Z, Function) -> ok | no_proc Attache to a process. X = Y = Z = int() @@ -217,7 +217,7 @@ - ib(Module, Line) -> ok | {error, break_exists} + ib(Module, Line) -> ok | {error, break_exists} Create a breakpoint. Module = atom() @@ -229,7 +229,7 @@ - ib(Module, Name, Arity) -> ok | {error, function_not_found} + ib(Module, Name, Arity) -> ok | {error, function_not_found} Create breakpoints in the specified function. @@ -243,7 +243,7 @@ - ir() -> ok + ir() -> ok Delete all breakpoints.

Deletes all breakpoints.

@@ -251,7 +251,7 @@ - ir(Module) -> ok + ir(Module) -> ok Delete all breakpoints in a module. Module = atom() @@ -262,7 +262,7 @@ - ir(Module, Line) -> ok + ir(Module, Line) -> ok Delete a breakpoint. Module = atom() @@ -274,7 +274,7 @@ - ir(Module, Name, Arity) -> ok | {error, function_not_found} + ir(Module, Name, Arity) -> ok | {error, function_not_found} Delete breakpoints from the specified function. @@ -288,7 +288,7 @@ - ibd(Module, Line) -> ok + ibd(Module, Line) -> ok Make a breakpoint inactive. Module = atom() @@ -300,7 +300,7 @@ - ibe(Module, Line) -> ok + ibe(Module, Line) -> ok Make a breakpoint active. Module = atom() @@ -312,7 +312,7 @@ - iba(Module, Line, Action) -> ok + iba(Module, Line, Action) -> ok Set the trigger action of a breakpoint. Module = atom() @@ -326,7 +326,7 @@ - ibc(Module, Line, Function) -> ok + ibc(Module, Line, Function) -> ok Set the conditional test of a breakpoint. Module = atom() @@ -348,7 +348,7 @@ - ipb() -> ok + ipb() -> ok Print all existing breakpoints.

Prints all existing breakpoints.

@@ -356,7 +356,7 @@ - ipb(Module) -> ok + ipb(Module) -> ok Print all existing breakpoints in a module. Module = atom() @@ -367,7 +367,7 @@ - iv() -> atom() + iv() -> atom() Return the current version number of the interpreter. @@ -377,7 +377,7 @@ - help() -> ok + help() -> ok Print help text.

Prints help text.

diff --git a/lib/debugger/doc/src/int.xml b/lib/debugger/doc/src/int.xml index 31e9dfe923..a0078714e6 100644 --- a/lib/debugger/doc/src/int.xml +++ b/lib/debugger/doc/src/int.xml @@ -28,7 +28,7 @@ - int + int Interpreter Interface.

The Erlang interpreter provides mechanisms for breakpoints and @@ -94,10 +94,10 @@ - i(AbsModule) -> {module,Module} | error - i(AbsModules) -> ok - ni(AbsModule) -> {module,Module} | error - ni(AbsModules) -> ok + i(AbsModule) -> {module,Module} | error + i(AbsModules) -> ok + ni(AbsModule) -> {module,Module} | error + ni(AbsModules) -> ok Interpret a module. AbsModules = [AbsModule] @@ -144,8 +144,8 @@ - n(AbsModule) -> ok - nn(AbsModule) -> ok + n(AbsModule) -> ok + nn(AbsModule) -> ok Stop interpreting a module. AbsModule = Module | File | [Module | File] @@ -163,7 +163,7 @@ - interpreted() -> [Module] + interpreted() -> [Module] Get all interpreted modules. Module = atom() @@ -174,7 +174,7 @@ - file(Module) -> File | {error,not_loaded} + file(Module) -> File | {error,not_loaded} Get the filename for an interpreted module. Module = atom() @@ -187,7 +187,7 @@ - interpretable(AbsModule) -> true | {error,Reason} + interpretable(AbsModule) -> true | {error,Reason} Check if a module can be interpreted. AbsModule = Module | File @@ -255,9 +255,9 @@ - auto_attach() -> false | {Flags,Function} - auto_attach(false) - auto_attach(Flags, Function) + auto_attach() -> false | {Flags,Function} + auto_attach(false) + auto_attach(Flags, Function) Get and set when and how to attach to a process. Flags = [init | break | exit] @@ -290,8 +290,8 @@ spawn(Module, Name, [Pid | Args]) - stack_trace() -> Flag - stack_trace(Flag) + stack_trace() -> Flag + stack_trace(Flag) Get and set if and how to save call frames. Flag = all | no_tail | false @@ -322,7 +322,7 @@ spawn(Module, Name, [Pid | Args]) - break(Module, Line) -> ok | {error,break_exists} + break(Module, Line) -> ok | {error,break_exists} Create a breakpoint. Module = atom() @@ -334,7 +334,7 @@ spawn(Module, Name, [Pid | Args]) - delete_break(Module, Line) -> ok + delete_break(Module, Line) -> ok Delete a breakpoint. Module = atom() @@ -346,7 +346,7 @@ spawn(Module, Name, [Pid | Args]) - break_in(Module, Name, Arity) -> ok + break_in(Module, Name, Arity) -> ok | {error,function_not_found} Create breakpoints in the specified function. @@ -360,7 +360,7 @@ spawn(Module, Name, [Pid | Args]) - del_break_in(Module, Name, Arity) -> ok + del_break_in(Module, Name, Arity) -> ok | {error,function_not_found} Delete breakpoints from the specified function. @@ -374,8 +374,8 @@ spawn(Module, Name, [Pid | Args]) - no_break() -> ok - no_break(Module) -> ok + no_break() -> ok + no_break(Module) -> ok Delete all breakpoints.

Deletes all breakpoints, or all breakpoints in Module.

@@ -383,7 +383,7 @@ spawn(Module, Name, [Pid | Args]) - disable_break(Module, Line) -> ok + disable_break(Module, Line) -> ok Make a breakpoint inactive. Module = atom() @@ -395,7 +395,7 @@ spawn(Module, Name, [Pid | Args]) - enable_break(Module, Line) -> ok + enable_break(Module, Line) -> ok Make a breakpoint active. Module = atom() @@ -407,7 +407,7 @@ spawn(Module, Name, [Pid | Args]) - action_at_break(Module, Line, Action) -> ok + action_at_break(Module, Line, Action) -> ok Set the trigger action of a breakpoint. Module = atom() @@ -421,7 +421,7 @@ spawn(Module, Name, [Pid | Args]) - test_at_break(Module, Line, Function) -> ok + test_at_break(Module, Line, Function) -> ok Set the conditional test of a breakpoint. Module = atom() @@ -438,7 +438,7 @@ spawn(Module, Name, [Pid | Args]) - get_binding(Var, Bindings) -> {value,Value} | unbound + get_binding(Var, Bindings) -> {value,Value} | unbound Retrieve a variable binding. Var = atom() @@ -453,8 +453,8 @@ spawn(Module, Name, [Pid | Args]) - all_breaks() -> [Break] - all_breaks(Module) -> [Break] + all_breaks() -> [Break] + all_breaks(Module) -> [Break] Get all breakpoints. Break = {Point,Options} @@ -474,7 +474,7 @@ spawn(Module, Name, [Pid | Args]) - snapshot() -> [Snapshot] + snapshot() -> [Snapshot] Get information about all processes executing interpreted code. @@ -519,7 +519,7 @@ spawn(Module, Name, [Pid | Args]) - clear() -> ok + clear() -> ok Clear information about processes executing interpreted code. @@ -529,8 +529,8 @@ spawn(Module, Name, [Pid | Args]) - continue(Pid) -> ok | {error,not_interpreted} - continue(X,Y,Z) -> ok | {error,not_interpreted} + continue(Pid) -> ok | {error,not_interpreted} + continue(X,Y,Z) -> ok | {error,not_interpreted} Resume process execution. Pid = pid() diff --git a/lib/dialyzer/doc/src/dialyzer.xml b/lib/dialyzer/doc/src/dialyzer.xml index e34ffd6def..f5e8337eb1 100644 --- a/lib/dialyzer/doc/src/dialyzer.xml +++ b/lib/dialyzer/doc/src/dialyzer.xml @@ -29,7 +29,7 @@ dialyzer.xml - dialyzer + dialyzer Dialyzer, a DIscrepancy AnaLYZer for ERlang programs. @@ -472,7 +472,7 @@ dialyzer --plts plt_1 ... plt_n -- files_to_analyze - format_warning(Msg) -> string() + format_warning(Msg) -> string() Get the string version of a warning message. Msg = {Tag, Id, msg()} @@ -485,8 +485,8 @@ dialyzer --plts plt_1 ... plt_n -- files_to_analyze - gui() -> ok | {error, Msg} - gui(OptList) -> ok | {error, Msg} + gui() -> ok | {error, Msg} + gui(OptList) -> ok | {error, Msg} Dialyzer GUI version. OptList @@ -539,7 +539,7 @@ WarnOpts :: error_handling - plt_info(string()) -> {'ok', [{atom(), any()}]} | {'error', atom()} + plt_info(string()) -> {'ok', [{atom(), any()}]} | {'error', atom()} Return information about the specified PLT.

Returns information about the specified PLT.

@@ -547,7 +547,7 @@ WarnOpts :: error_handling - run(OptList) -> Warnings + run(OptList) -> Warnings Dialyzer command-line version. OptList diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 2a17643270..16f4e18637 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -124,7 +124,7 @@ typedef enum { - intei_decode_atom(const char *buf, int *index, char *p) + intei_decode_atom(const char *buf, int *index, char *p) Decode an atom.

Decodes an atom from the binary format. The NULL-terminated @@ -158,7 +158,7 @@ typedef enum { - intei_decode_bignum(const char *buf, int *index, mpz_t obj) + intei_decode_bignum(const char *buf, int *index, mpz_t obj) Decode a GMP arbitrary precision integer.

Decodes an integer in the binary format to a GMP @@ -168,7 +168,7 @@ typedef enum { - intei_decode_binary(const char *buf, int *index, void *p, long *len) + intei_decode_binary(const char *buf, int *index, void *p, long *len) Decode a binary.

Decodes a binary from the binary format. Parameter @@ -180,7 +180,7 @@ typedef enum { - intei_decode_boolean(const char *buf, int *index, int *p) + intei_decode_boolean(const char *buf, int *index, int *p) Decode a boolean.

Decodes a boolean value from the binary format. @@ -190,7 +190,7 @@ typedef enum { - intei_decode_char(const char *buf, int *index, char *p) + intei_decode_char(const char *buf, int *index, char *p) Decode an 8-bit integer between 0-255.

Decodes a char (8-bit) integer between 0-255 from the binary format. @@ -203,7 +203,7 @@ typedef enum { - intei_decode_double(const char *buf, int *index, double *p) + intei_decode_double(const char *buf, int *index, double *p) Decode a double.

Decodes a double-precision (64-bit) floating @@ -212,7 +212,7 @@ typedef enum { - intei_decode_ei_term(const char* buf, int* index, ei_term* term) + intei_decode_ei_term(const char* buf, int* index, ei_term* term) Decode a term, without previous knowledge of type.

Decodes any term, or at least tries to. If the term @@ -233,8 +233,8 @@ typedef enum { - intei_decode_fun(const char *buf, int *index, erlang_fun *p) - voidfree_fun(erlang_fun* f) + intei_decode_fun(const char *buf, int *index, erlang_fun *p) + voidfree_fun(erlang_fun* f) Decode a fun.

Decodes a fun from the binary format. Parameter @@ -248,7 +248,7 @@ typedef enum { - intei_decode_list_header(const char *buf, int *index, int *arity) + intei_decode_list_header(const char *buf, int *index, int *arity) Decode a list.

Decodes a list header from the binary @@ -265,7 +265,7 @@ typedef enum { - intei_decode_long(const char *buf, int *index, long *p) + intei_decode_long(const char *buf, int *index, long *p) Decode integer.

Decodes a long integer from the binary format. @@ -275,7 +275,7 @@ typedef enum { - intei_decode_longlong(const char *buf, int *index, long long *p) + intei_decode_longlong(const char *buf, int *index, long long *p) Decode integer.

Decodes a GCC long long or Visual C++ @@ -299,7 +299,7 @@ typedef enum { - intei_decode_pid(const char *buf, int *index, erlang_pid *p) + intei_decode_pid(const char *buf, int *index, erlang_pid *p) Decode a pid.

Decodes a process identifier (pid) from the binary format.

@@ -307,7 +307,7 @@ typedef enum { - intei_decode_port(const char *buf, int *index, erlang_port *p) + intei_decode_port(const char *buf, int *index, erlang_port *p) Decode a port.

Decodes a port identifier from the binary format.

@@ -315,7 +315,7 @@ typedef enum { - intei_decode_ref(const char *buf, int *index, erlang_ref *p) + intei_decode_ref(const char *buf, int *index, erlang_ref *p) Decode a reference.

Decodes a reference from the binary format.

@@ -323,7 +323,7 @@ typedef enum { - intei_decode_string(const char *buf, int *index, char *p) + intei_decode_string(const char *buf, int *index, char *p) Decode a string.

Decodes a string from the binary format. A @@ -338,7 +338,7 @@ typedef enum { - intei_decode_term(const char *buf, int *index, void *t) + intei_decode_term(const char *buf, int *index, void *t) Decode a ETERM.

Decodes a term from the binary format. The term @@ -352,7 +352,7 @@ typedef enum { - intei_decode_trace(const char *buf, int *index, erlang_trace *p) + intei_decode_trace(const char *buf, int *index, erlang_trace *p) Decode a trace token.

Decodes an Erlang trace token from the binary format.

@@ -360,7 +360,7 @@ typedef enum { - intei_decode_tuple_header(const char *buf, int *index, int *arity) + intei_decode_tuple_header(const char *buf, int *index, int *arity) Decode a tuple.

Decodes a tuple header, the number of elements @@ -370,7 +370,7 @@ typedef enum { - intei_decode_ulong(const char *buf, int *index, unsigned long *p) + intei_decode_ulong(const char *buf, int *index, unsigned long *p) Decode unsigned integer.

Decodes an unsigned long integer from the binary format. @@ -380,7 +380,7 @@ typedef enum { - intei_decode_ulonglong(const char *buf, int *index, unsigned long long *p) + intei_decode_ulonglong(const char *buf, int *index, unsigned long long *p) Decode unsigned integer.

Decodes a GCC unsigned long long or Visual C++ @@ -390,7 +390,7 @@ typedef enum { - intei_decode_version(const char *buf, int *index, int *version) + intei_decode_version(const char *buf, int *index, int *version) Decode an empty list (nil).

Decodes the version magic number for the @@ -400,10 +400,10 @@ typedef enum { - intei_encode_atom(char *buf, int *index, const char *p) - intei_encode_atom_len(char *buf, int *index, const char *p, int len) - intei_x_encode_atom(ei_x_buff* x, const char *p) - intei_x_encode_atom_len(ei_x_buff* x, const char *p, int len) + intei_encode_atom(char *buf, int *index, const char *p) + intei_encode_atom_len(char *buf, int *index, const char *p, int len) + intei_x_encode_atom(ei_x_buff* x, const char *p) + intei_x_encode_atom_len(ei_x_buff* x, const char *p, int len) Encode an atom.

Encodes an atom in the binary format. Parameter p @@ -435,8 +435,8 @@ typedef enum { - intei_encode_bignum(char *buf, int *index, mpz_t obj) - intei_x_encode_bignum(ei_x_buff *x, mpz_t obj) + intei_encode_bignum(char *buf, int *index, mpz_t obj) + intei_x_encode_bignum(ei_x_buff *x, mpz_t obj) Encode an arbitrary precision integer.

Encodes a GMP mpz_t integer to binary format. @@ -446,8 +446,8 @@ typedef enum { - intei_encode_binary(char *buf, int *index, const void *p, long len) - intei_x_encode_binary(ei_x_buff* x, const void *p, long len) + intei_encode_binary(char *buf, int *index, const void *p, long len) + intei_x_encode_binary(ei_x_buff* x, const void *p, long len) Encode a binary.

Encodes a binary in the binary format. The data is at @@ -456,8 +456,8 @@ typedef enum { - intei_encode_boolean(char *buf, int *index, int p) - intei_x_encode_boolean(ei_x_buff* x, int p) + intei_encode_boolean(char *buf, int *index, int p) + intei_x_encode_boolean(ei_x_buff* x, int p) Encode a boolean.

Encodes a boolean value as the atom true if @@ -467,8 +467,8 @@ typedef enum { - intei_encode_char(char *buf, int *index, char p) - intei_x_encode_char(ei_x_buff* x, char p) + intei_encode_char(char *buf, int *index, char p) + intei_x_encode_char(ei_x_buff* x, char p) Encode an 8-bit integer between 0-255.

Encodes a char (8-bit) as an integer between 0-255 in the binary @@ -481,8 +481,8 @@ typedef enum { - intei_encode_double(char *buf, int *index, double p) - intei_x_encode_double(ei_x_buff* x, double p) + intei_encode_double(char *buf, int *index, double p) + intei_x_encode_double(ei_x_buff* x, double p) Encode a double float.

Encodes a double-precision (64-bit) floating point number in @@ -493,8 +493,8 @@ typedef enum { - intei_encode_empty_list(char* buf, int* index) - intei_x_encode_empty_list(ei_x_buff* x) + intei_encode_empty_list(char* buf, int* index) + intei_x_encode_empty_list(ei_x_buff* x) Encode an empty list (nil).

Encodes an empty list. It is often used at the tail of a list.

@@ -502,8 +502,8 @@ typedef enum { - intei_encode_fun(char *buf, int *index, const erlang_fun *p) - intei_x_encode_fun(ei_x_buff* x, const erlang_fun* fun) + intei_encode_fun(char *buf, int *index, const erlang_fun *p) + intei_x_encode_fun(ei_x_buff* x, const erlang_fun* fun) Encode a fun.

Encodes a fun in the binary format. Parameter p @@ -515,8 +515,8 @@ typedef enum { - intei_encode_list_header(char *buf, int *index, int arity) - intei_x_encode_list_header(ei_x_buff* x, int arity) + intei_encode_list_header(char *buf, int *index, int arity) + intei_x_encode_list_header(ei_x_buff* x, int arity) Encode a list.

Encodes a list header, with a specified @@ -552,8 +552,8 @@ ei_x_encode_empty_list(&x); - intei_encode_long(char *buf, int *index, long p) - intei_x_encode_long(ei_x_buff* x, long p) + intei_encode_long(char *buf, int *index, long p) + intei_x_encode_long(ei_x_buff* x, long p) Encode integer.

Encodes a long integer in the binary format. @@ -563,8 +563,8 @@ ei_x_encode_empty_list(&x); - intei_encode_longlong(char *buf, int *index, long long p) - intei_x_encode_longlong(ei_x_buff* x, long long p) + intei_encode_longlong(char *buf, int *index, long long p) + intei_x_encode_longlong(ei_x_buff* x, long long p) Encode integer.

Encodes a GCC long long or Visual C++ @@ -595,8 +595,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_pid(char *buf, int *index, const erlang_pid *p) - intei_x_encode_pid(ei_x_buff* x, const erlang_pid *p) + intei_encode_pid(char *buf, int *index, const erlang_pid *p) + intei_x_encode_pid(ei_x_buff* x, const erlang_pid *p) Encode a pid.

Encodes an Erlang process identifier (pid) in the binary @@ -607,8 +607,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_port(char *buf, int *index, const erlang_port *p) - intei_x_encode_port(ei_x_buff* x, const erlang_port *p) + intei_encode_port(char *buf, int *index, const erlang_port *p) + intei_x_encode_port(ei_x_buff* x, const erlang_port *p) Encode a port.

Encodes an Erlang port in the binary format. Parameter @@ -619,8 +619,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_ref(char *buf, int *index, const erlang_ref *p) - intei_x_encode_ref(ei_x_buff* x, const erlang_ref *p) + intei_encode_ref(char *buf, int *index, const erlang_ref *p) + intei_x_encode_ref(ei_x_buff* x, const erlang_ref *p) Encode a ref.

Encodes an Erlang reference in the binary format. Parameter @@ -631,10 +631,10 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_string(char *buf, int *index, const char *p) - intei_encode_string_len(char *buf, int *index, const char *p, int len) - intei_x_encode_string(ei_x_buff* x, const char *p) - intei_x_encode_string_len(ei_x_buff* x, const char* s, int len) + intei_encode_string(char *buf, int *index, const char *p) + intei_encode_string_len(char *buf, int *index, const char *p, int len) + intei_x_encode_string(ei_x_buff* x, const char *p) + intei_x_encode_string_len(ei_x_buff* x, const char* s, int len) Encode a string.

Encodes a string in the binary format. (A string in Erlang @@ -645,8 +645,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_term(char *buf, int *index, void *t) - intei_x_encode_term(ei_x_buff* x, void *t) + intei_encode_term(char *buf, int *index, void *t) + intei_x_encode_term(ei_x_buff* x, void *t) Encode an erl_interface term.

Encodes an ETERM, as obtained from @@ -656,8 +656,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_trace(char *buf, int *index, const erlang_trace *p) - intei_x_encode_trace(ei_x_buff* x, const erlang_trace *p) + intei_encode_trace(char *buf, int *index, const erlang_trace *p) + intei_x_encode_trace(ei_x_buff* x, const erlang_trace *p) Encode a trace token.

Encodes an Erlang trace token in the binary format. @@ -668,8 +668,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_tuple_header(char *buf, int *index, int arity) - intei_x_encode_tuple_header(ei_x_buff* x, int arity) + intei_encode_tuple_header(char *buf, int *index, int arity) + intei_x_encode_tuple_header(ei_x_buff* x, int arity) Encode a tuple.

Encodes a tuple header, with a specified @@ -687,8 +687,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_encode_ulong(char *buf, int *index, unsigned long p) - intei_x_encode_ulong(ei_x_buff* x, unsigned long p) + intei_encode_ulong(char *buf, int *index, unsigned long p) + intei_x_encode_ulong(ei_x_buff* x, unsigned long p) Encode unsigned integer.

Encodes an unsigned long integer in the binary format. @@ -698,8 +698,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_encode_ulonglong(char *buf, int *index, unsigned long long p) - intei_x_encode_ulonglong(ei_x_buff* x, unsigned long long p) + intei_encode_ulonglong(char *buf, int *index, unsigned long long p) + intei_x_encode_ulonglong(ei_x_buff* x, unsigned long long p) Encode unsigned integer.

Encodes a GCC unsigned long long or Visual C++ @@ -709,8 +709,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_encode_version(char *buf, int *index) - intei_x_encode_version(ei_x_buff* x) + intei_encode_version(char *buf, int *index) + intei_x_encode_version(ei_x_buff* x) Encode version.

Encodes a version magic number for the binary format. Must @@ -719,7 +719,7 @@ ei_encode_tuple_header(buf, &i, 0); - intei_get_type(const char *buf, const int *index, int *type, int *size) + intei_get_type(const char *buf, const int *index, int *type, int *size) Fetch the type and size of an encoded term.

Returns the type in type and size in @@ -733,8 +733,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_print_term(FILE* fp, const char* buf, int* index) - intei_s_print_term(char** s, const char* buf, int* index) + intei_print_term(FILE* fp, const char* buf, int* index) + intei_s_print_term(char** s, const char* buf, int* index) Print a term in clear text.

Prints a term, in clear text, to the file @@ -759,7 +759,7 @@ ei_encode_tuple_header(buf, &i, 0); - voidei_set_compat_rel(release_number) + voidei_set_compat_rel(release_number) Set the ei library in compatibility mode. unsigned release_number; @@ -794,7 +794,7 @@ ei_encode_tuple_header(buf, &i, 0); - intei_skip_term(const char* buf, int* index) + intei_skip_term(const char* buf, int* index) Skip a term.

Skips a term in the specified buffer; @@ -815,8 +815,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_x_append(ei_x_buff* x, const ei_x_buff* x2) - intei_x_append_buf(ei_x_buff* x, const char* buf, int len) + intei_x_append(ei_x_buff* x, const ei_x_buff* x2) + intei_x_append_buf(ei_x_buff* x, const char* buf, int len) Append a buffer at the end.

Appends data at the end of buffer x.

@@ -824,8 +824,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_x_format(ei_x_buff* x, const char* fmt, ...) - intei_x_format_wo_ver(ei_x_buff* x, const char *fmt, ... ) + intei_x_format(ei_x_buff* x, const char* fmt, ...) + intei_x_format_wo_ver(ei_x_buff* x, const char *fmt, ... ) Format a term from a format string and parameters.

Formats a term, given as a string, to a buffer. @@ -853,7 +853,7 @@ encodes the tuple {numbers,12,3.14159} - intei_x_free(ei_x_buff* x) + intei_x_free(ei_x_buff* x) Free a buffer.

Frees an ei_x_buff buffer. @@ -862,8 +862,8 @@ encodes the tuple {numbers,12,3.14159} - intei_x_new(ei_x_buff* x) - intei_x_new_with_version(ei_x_buff* x) + intei_x_new(ei_x_buff* x) + intei_x_new_with_version(ei_x_buff* x) Allocate a new buffer.

Allocates a new ei_x_buff buffer. The diff --git a/lib/erl_interface/doc/src/ei_connect.xml b/lib/erl_interface/doc/src/ei_connect.xml index 9c35b75db3..6f16c0652e 100644 --- a/lib/erl_interface/doc/src/ei_connect.xml +++ b/lib/erl_interface/doc/src/ei_connect.xml @@ -87,10 +87,10 @@ - struct hostent *ei_gethostbyaddr(const char *addr, int len, int type) - struct hostent *ei_gethostbyaddr_r(const char *addr, int length, int type, struct hostent *hostp, char *buffer, int buflen, int *h_errnop) - struct hostent *ei_gethostbyname(const char *name) - struct hostent *ei_gethostbyname_r(const char *name, struct hostent *hostp, char *buffer, int buflen, int *h_errnop) + struct hostent *ei_gethostbyaddr(const char *addr, int len, int type) + struct hostent *ei_gethostbyaddr_r(const char *addr, int length, int type, struct hostent *hostp, char *buffer, int buflen, int *h_errnop) + struct hostent *ei_gethostbyname(const char *name) + struct hostent *ei_gethostbyname_r(const char *name, struct hostent *hostp, char *buffer, int buflen, int *h_errnop) Name lookup functions.

Convenience functions for some common name lookup functions.

@@ -98,7 +98,7 @@ - intei_accept(ei_cnode *ec, int listensock, ErlConnect *conp) + intei_accept(ei_cnode *ec, int listensock, ErlConnect *conp) Accept a connection from another node.

Used by a server process to accept a @@ -130,7 +130,7 @@ typedef struct { - intei_accept_tmo(ei_cnode *ec, int listensock, ErlConnect *conp, unsigned timeout_ms) + intei_accept_tmo(ei_cnode *ec, int listensock, ErlConnect *conp, unsigned timeout_ms) Accept a connection from another node with optional time-out. @@ -141,8 +141,8 @@ typedef struct { - intei_connect(ei_cnode* ec, char *nodename) - intei_xconnect(ei_cnode* ec, Erl_IpAddr adr, char *alivename) + intei_connect(ei_cnode* ec, char *nodename) + intei_xconnect(ei_cnode* ec, Erl_IpAddr adr, char *alivename) Establish a connection to an Erlang node.

Sets up a connection to an Erlang node.

@@ -192,8 +192,8 @@ fd = ei_xconnect(&ec, &addr, ALIVE); - intei_connect_init(ei_cnode* ec, const char* this_node_name, const char *cookie, short creation) - intei_connect_xinit(ei_cnode* ec, const char *thishostname, const char *thisalivename, const char *thisnodename, Erl_IpAddr thisipaddr, const char *cookie, short creation) + intei_connect_init(ei_cnode* ec, const char* this_node_name, const char *cookie, short creation) + intei_connect_xinit(ei_cnode* ec, const char *thishostname, const char *thisalivename, const char *thisnodename, Erl_IpAddr thisipaddr, const char *cookie, short creation) Initialize for a connection.

Initializes the ec structure, to @@ -273,8 +273,8 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { - intei_connect_tmo(ei_cnode* ec, char *nodename, unsigned timeout_ms) - intei_xconnect_tmo(ei_cnode* ec, Erl_IpAddr adr, char *alivename, unsigned timeout_ms) + intei_connect_tmo(ei_cnode* ec, char *nodename, unsigned timeout_ms) + intei_xconnect_tmo(ei_cnode* ec, Erl_IpAddr adr, char *alivename, unsigned timeout_ms) Establish a connection to an Erlang node with optional time-out. @@ -299,7 +299,7 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { - intei_publish(ei_cnode *ec, int port) + intei_publish(ei_cnode *ec, int port) Publish a node name.

Used by a server process to register @@ -336,7 +336,7 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { - intei_publish_tmo(ei_cnode *ec, int port, unsigned timeout_ms) + intei_publish_tmo(ei_cnode *ec, int port, unsigned timeout_ms) Publish a node name with optional time-out.

Equivalent to @@ -346,7 +346,7 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { - intei_receive(int fd, unsigned char* bufp, int bufsize) + intei_receive(int fd, unsigned char* bufp, int bufsize) Receive a message.

Receives a message consisting of a sequence @@ -387,7 +387,7 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { - intei_receive_encoded(int fd, char **mbufp, int *bufsz, erlang_msg *msg, int *msglen) + intei_receive_encoded(int fd, char **mbufp, int *bufsz, erlang_msg *msg, int *msglen) Obsolete function for receiving a message.

This function is retained for compatibility with code @@ -417,7 +417,7 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { - intei_receive_encoded_tmo(int fd, char **mbufp, int *bufsz, erlang_msg *msg, int *msglen, unsigned timeout_ms) + intei_receive_encoded_tmo(int fd, char **mbufp, int *bufsz, erlang_msg *msg, int *msglen, unsigned timeout_ms) Obsolete function for receiving a message with time-out. @@ -428,8 +428,8 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { - intei_receive_msg(int fd, erlang_msg* msg, ei_x_buff* x) - intei_xreceive_msg(int fd, erlang_msg* msg, ei_x_buff* x) + intei_receive_msg(int fd, erlang_msg* msg, ei_x_buff* x) + intei_xreceive_msg(int fd, erlang_msg* msg, ei_x_buff* x) Receive a message.

Receives a message to the buffer in x. @@ -493,8 +493,8 @@ typedef struct { - intei_receive_msg_tmo(int fd, erlang_msg* msg, ei_x_buff* x, unsigned imeout_ms) - intei_xreceive_msg_tmo(int fd, erlang_msg* msg, ei_x_buff* x, unsigned timeout_ms) + intei_receive_msg_tmo(int fd, erlang_msg* msg, ei_x_buff* x, unsigned imeout_ms) + intei_xreceive_msg_tmo(int fd, erlang_msg* msg, ei_x_buff* x, unsigned timeout_ms) Receive a message with optional time-out.

Equivalent to ei_receive_msg and ei_xreceive_msg @@ -504,7 +504,7 @@ typedef struct { - intei_receive_tmo(int fd, unsigned char* bufp, int bufsize, unsigned timeout_ms) + intei_receive_tmo(int fd, unsigned char* bufp, int bufsize, unsigned timeout_ms) Receive a message with optional time-out.

Equivalent to @@ -514,7 +514,7 @@ typedef struct { - intei_reg_send(ei_cnode* ec, int fd, char* server_name, char* buf, int len) + intei_reg_send(ei_cnode* ec, int fd, char* server_name, char* buf, int len) Send a message to a registered name.

Sends an Erlang term to a registered process.

@@ -546,7 +546,7 @@ if (ei_reg_send(&ec, fd, x.buff, x.index) < 0) - intei_reg_send_tmo(ei_cnode* ec, int fd, char* server_name, char* buf, int len, unsigned timeout_ms) + intei_reg_send_tmo(ei_cnode* ec, int fd, char* server_name, char* buf, int len, unsigned timeout_ms) Send a message to a registered name with optional time-out @@ -557,9 +557,9 @@ if (ei_reg_send(&ec, fd, x.buff, x.index) < 0) - intei_rpc(ei_cnode *ec, int fd, char *mod, char *fun, const char *argbuf, int argbuflen, ei_x_buff *x) - intei_rpc_to(ei_cnode *ec, int fd, char *mod, char *fun, const char *argbuf, int argbuflen) - intei_rpc_from(ei_cnode *ec, int fd, int timeout, erlang_msg *msg, ei_x_buff *x) + intei_rpc(ei_cnode *ec, int fd, char *mod, char *fun, const char *argbuf, int argbuflen, ei_x_buff *x) + intei_rpc_to(ei_cnode *ec, int fd, char *mod, char *fun, const char *argbuf, int argbuflen) + intei_rpc_from(ei_cnode *ec, int fd, int timeout, erlang_msg *msg, ei_x_buff *x) Remote Procedure Call from C to Erlang.

Supports calling Erlang functions on remote nodes. @@ -658,7 +658,7 @@ if (ei_decode_version(result.buff, &index) < 0 - erlang_pid *ei_self(ei_cnode *ec) + erlang_pid *ei_self(ei_cnode *ec) Retrieve the pid of the C-node.

Retrieves the pid of the C-node. Every C-node @@ -671,7 +671,7 @@ if (ei_decode_version(result.buff, &index) < 0 - intei_send(int fd, erlang_pid* to, char* buf, int len) + intei_send(int fd, erlang_pid* to, char* buf, int len) Send a message.

Sends an Erlang term to a process.

@@ -692,7 +692,7 @@ if (ei_decode_version(result.buff, &index) < 0 - intei_send_encoded(int fd, erlang_pid* to, char* buf, int len) + intei_send_encoded(int fd, erlang_pid* to, char* buf, int len) Obsolete function to send a message.

Works exactly as ei_send, the alternative name is retained for @@ -702,7 +702,7 @@ if (ei_decode_version(result.buff, &index) < 0 - intei_send_encoded_tmo(int fd, erlang_pid* to, char* buf, int len, unsigned timeout_ms) + intei_send_encoded_tmo(int fd, erlang_pid* to, char* buf, int len, unsigned timeout_ms) Obsolete function to send a message with optional time-out. @@ -713,7 +713,7 @@ if (ei_decode_version(result.buff, &index) < 0 - intei_send_reg_encoded(int fd, const erlang_pid *from, const char *to, const char *buf, int len) + intei_send_reg_encoded(int fd, const erlang_pid *from, const char *to, const char *buf, int len) Obsolete function to send a message to a registered name. @@ -741,7 +741,7 @@ self->num = fd; - intei_send_reg_encoded_tmo(int fd, const erlang_pid *from, const char *to, const char *buf, int len) + intei_send_reg_encoded_tmo(int fd, const erlang_pid *from, const char *to, const char *buf, int len) Obsolete function to send a message to a registered name with time-out. @@ -752,7 +752,7 @@ self->num = fd; - intei_send_tmo(int fd, erlang_pid* to, char* buf, int len, unsigned timeout_ms) + intei_send_tmo(int fd, erlang_pid* to, char* buf, int len, unsigned timeout_ms) Send a message with optional time-out.

Equivalent to @@ -762,9 +762,9 @@ self->num = fd; - const char *ei_thisnodename(ei_cnode *ec) - const char *ei_thishostname(ei_cnode *ec) - const char *ei_thisalivename(ei_cnode *ec) + const char *ei_thisnodename(ei_cnode *ec) + const char *ei_thishostname(ei_cnode *ec) + const char *ei_thisalivename(ei_cnode *ec) Retrieve some values.

Can be used to retrieve information about @@ -779,7 +779,7 @@ self->num = fd; - intei_unpublish(ei_cnode *ec) + intei_unpublish(ei_cnode *ec) Forcefully unpublish a node name.

Can be called by a process to unregister a @@ -802,7 +802,7 @@ self->num = fd; - intei_unpublish_tmo(ei_cnode *ec, unsigned timeout_ms) + intei_unpublish_tmo(ei_cnode *ec, unsigned timeout_ms) Unpublish a node name with optional time-out.

Equivalent to diff --git a/lib/erl_interface/doc/src/erl_connect.xml b/lib/erl_interface/doc/src/erl_connect.xml index 8df03d4ecc..139ac9e2f0 100644 --- a/lib/erl_interface/doc/src/erl_connect.xml +++ b/lib/erl_interface/doc/src/erl_connect.xml @@ -49,7 +49,7 @@ - interl_accept(listensock, conp) + interl_accept(listensock, conp) Accept a connection. int listensock; @@ -78,7 +78,7 @@ typedef struct { - interl_close_connection(fd) + interl_close_connection(fd) Close a connection to an Erlang node. int fd; @@ -95,8 +95,8 @@ typedef struct { - interl_connect(node) - interl_xconnect(addr, alive) + interl_connect(node) + interl_xconnect(addr, alive) Establish a connection to an Erlang node. char *node, *alive; @@ -149,8 +149,8 @@ erl_xconnect( &addr , ALIVE ); - interl_connect_init(number, cookie, creation) - interl_connect_xinit(host, alive, node, addr, cookie, creation) + interl_connect_init(number, cookie, creation) + interl_connect_xinit(host, alive, node, addr, cookie, creation) Initialize communication. int number; @@ -246,7 +246,7 @@ if (!erl_connect_init(17, "samplecookiestring...", 0)) - interl_publish(port) + interl_publish(port) Publish a node name. int port; @@ -277,7 +277,7 @@ if (!erl_connect_init(17, "samplecookiestring...", 0)) - interl_receive(fd, bufp, bufsize) + interl_receive(fd, bufp, bufsize) Receive a message. int fd; @@ -316,7 +316,7 @@ if (!erl_connect_init(17, "samplecookiestring...", 0)) - interl_receive_msg(fd, bufp, bufsize, emsg) + interl_receive_msg(fd, bufp, bufsize, emsg) Receive and decode a message. int fd; @@ -411,7 +411,7 @@ typedef struct { - interl_reg_send(fd, to, msg) + interl_reg_send(fd, to, msg) Send a message to a registered name. int fd; @@ -439,9 +439,9 @@ typedef struct { - ETERM *erl_rpc(fd, mod, fun, args) - interl_rpc_from(fd, timeout, emsg) - interl_rpc_to(fd, mod, fun, args) + ETERM *erl_rpc(fd, mod, fun, args) + interl_rpc_from(fd, timeout, emsg) + interl_rpc_to(fd, mod, fun, args) Remote Procedure Call. int fd, timeout; @@ -511,7 +511,7 @@ typedef struct { - interl_send(fd, to, msg) + interl_send(fd, to, msg) Send a message. int fd; @@ -541,11 +541,11 @@ typedef struct { - const char *erl_thisalivename() - const char *erl_thiscookie() - shorterl_thiscreation() - const char *erl_thishostname() - const char *erl_thisnodename() + const char *erl_thisalivename() + const char *erl_thiscookie() + shorterl_thiscreation() + const char *erl_thishostname() + const char *erl_thisnodename() Retrieve some values.

Retrieves information about @@ -556,7 +556,7 @@ typedef struct { - interl_unpublish(alive) + interl_unpublish(alive) Forcefully unpublish a node name. char *alive; @@ -583,7 +583,7 @@ typedef struct { - interl_xreceive_msg(fd, bufpp, bufsizep, emsg) + interl_xreceive_msg(fd, bufpp, bufsizep, emsg) Receive and decode a message. int fd; @@ -616,10 +616,10 @@ typedef struct { - struct hostent *erl_gethostbyaddr(addr, length, type) - struct hostent *erl_gethostbyaddr_r(addr, length, type, hostp, buffer, buflen, h_errnop) - struct hostent *erl_gethostbyname(name) - struct hostent *erl_gethostbyname_r(name, hostp, buffer, buflen, h_errnop) + struct hostent *erl_gethostbyaddr(addr, length, type) + struct hostent *erl_gethostbyaddr_r(addr, length, type, hostp, buffer, buflen, h_errnop) + struct hostent *erl_gethostbyname(name) + struct hostent *erl_gethostbyname_r(name, hostp, buffer, buflen, h_errnop) Name lookup functions. diff --git a/lib/erl_interface/doc/src/erl_error.xml b/lib/erl_interface/doc/src/erl_error.xml index 8139c9b343..6fac94e442 100644 --- a/lib/erl_interface/doc/src/erl_error.xml +++ b/lib/erl_interface/doc/src/erl_error.xml @@ -47,7 +47,7 @@ - voiderl_err_msg(FormatStr, ... ) + voiderl_err_msg(FormatStr, ... ) Non-fatal error, and not system call error. const char *FormatStr; @@ -59,7 +59,7 @@ - voiderl_err_quit(FormatStr, ... ) + voiderl_err_quit(FormatStr, ... ) Fatal error, but not system call error. const char *FormatStr; @@ -73,7 +73,7 @@ - voiderl_err_ret(FormatStr, ... ) + voiderl_err_ret(FormatStr, ... ) Non-fatal system call error. const char *FormatStr; @@ -86,7 +86,7 @@ - voiderl_err_sys(FormatStr, ... ) + voiderl_err_sys(FormatStr, ... ) Fatal system call error. const char *FormatStr; @@ -113,7 +113,7 @@ - volatile interl_errno + volatile interl_errno Variable erl_errno contains the Erl_Interface error number. You can change the value if you wish. diff --git a/lib/erl_interface/doc/src/erl_eterm.xml b/lib/erl_interface/doc/src/erl_eterm.xml index 9a05196a70..070ed30dfe 100644 --- a/lib/erl_interface/doc/src/erl_eterm.xml +++ b/lib/erl_interface/doc/src/erl_eterm.xml @@ -142,7 +142,7 @@ - ETERM *erl_cons(head, tail) + ETERM *erl_cons(head, tail) Prepend a term to the head of a list. ETERM *head; @@ -181,7 +181,7 @@ erl_free_compound(list); - ETERM *erl_copy_term(term) + ETERM *erl_copy_term(term) Create a copy of an Erlang term. ETERM *term; @@ -193,7 +193,7 @@ erl_free_compound(list); - ETERM *erl_element(position, tuple) + ETERM *erl_element(position, tuple) Extract an element from an Erlang tuple. int position; @@ -215,7 +215,7 @@ erl_free_compound(list); - ETERM *erl_hd(list) + ETERM *erl_hd(list) Extract the first element from a list. ETERM *list; @@ -230,7 +230,7 @@ erl_free_compound(list); - voiderl_init(NULL, 0) + voiderl_init(NULL, 0) Initialization routine. void *NULL; @@ -245,7 +245,7 @@ erl_free_compound(list); - interl_iolist_length(list) + interl_iolist_length(list) Return the length of an I/O list. ETERM *list; @@ -262,7 +262,7 @@ erl_free_compound(list); - ETERM *erl_iolist_to_binary(term) + ETERM *erl_iolist_to_binary(term) Convert an I/O list to a binary. ETERM *list; @@ -289,7 +289,7 @@ iohead ::= Binary - char *erl_iolist_to_string(list) + char *erl_iolist_to_string(list) Convert an I/O list to a NULL-terminated string. ETERM *list; @@ -312,7 +312,7 @@ iohead ::= Binary - interl_length(list) + interl_length(list) Determine the length of a list. ETERM *list; @@ -328,7 +328,7 @@ iohead ::= Binary - ETERM *erl_mk_atom(string) + ETERM *erl_mk_atom(string) Create an atom. const char *string; @@ -355,7 +355,7 @@ iohead ::= Binary - ETERM *erl_mk_binary(bptr, size) + ETERM *erl_mk_binary(bptr, size) Create a binary object. char *bptr; @@ -378,7 +378,7 @@ iohead ::= Binary - ETERM *erl_mk_empty_list() + ETERM *erl_mk_empty_list() Create an empty Erlang list.

Creates and returns an empty Erlang list. @@ -388,7 +388,7 @@ iohead ::= Binary - ETERM *erl_mk_estring(string, len) + ETERM *erl_mk_estring(string, len) Create an Erlang string. char *string; @@ -408,7 +408,7 @@ iohead ::= Binary - ETERM *erl_mk_float(f) + ETERM *erl_mk_float(f) Create an Erlang float. double f; @@ -426,7 +426,7 @@ iohead ::= Binary - ETERM *erl_mk_int(n) + ETERM *erl_mk_int(n) Create an Erlang integer. int n; @@ -443,7 +443,7 @@ iohead ::= Binary - ETERM *erl_mk_list(array, arrsize) + ETERM *erl_mk_list(array, arrsize) Create a list from an array. ETERM **array; @@ -465,7 +465,7 @@ iohead ::= Binary - ETERM *erl_mk_long_ref(node, n1, n2, n3, creation) + ETERM *erl_mk_long_ref(node, n1, n2, n3, creation) Create an Erlang reference. const char *node; @@ -495,7 +495,7 @@ iohead ::= Binary - ETERM *erl_mk_pid(node, number, serial, creation) + ETERM *erl_mk_pid(node, number, serial, creation) Create a process identifier. const char *node; @@ -525,7 +525,7 @@ iohead ::= Binary - ETERM *erl_mk_port(node, number, creation) + ETERM *erl_mk_port(node, number, creation) Create a port identifier. const char *node; @@ -550,7 +550,7 @@ iohead ::= Binary - ETERM *erl_mk_ref(node, number, creation) + ETERM *erl_mk_ref(node, number, creation) Create an old Erlang reference. const char *node; @@ -578,7 +578,7 @@ iohead ::= Binary - ETERM *erl_mk_string(string) + ETERM *erl_mk_string(string) Create a string. char *string; @@ -593,7 +593,7 @@ iohead ::= Binary - ETERM *erl_mk_tuple(array, arrsize) + ETERM *erl_mk_tuple(array, arrsize) Create an Erlang tuple from an array. ETERM **array; @@ -621,7 +621,7 @@ iohead ::= Binary - ETERM *erl_mk_uint(n) + ETERM *erl_mk_uint(n) Create an unsigned integer. unsigned int n; @@ -638,7 +638,7 @@ iohead ::= Binary - ETERM *erl_mk_var(name) + ETERM *erl_mk_var(name) Create an Erlang variable. char *name; @@ -653,7 +653,7 @@ iohead ::= Binary - interl_print_term(stream, term) + interl_print_term(stream, term) Print an Erlang term. FILE *stream; @@ -672,7 +672,7 @@ iohead ::= Binary - voiderl_set_compat_rel(release_number) + voiderl_set_compat_rel(release_number) Set the Erl_Interface library in compatibility mode. unsigned release_number; @@ -706,7 +706,7 @@ iohead ::= Binary - interl_size(term) + interl_size(term) Return the arity of a tuple or binary. ETERM *term; @@ -723,7 +723,7 @@ iohead ::= Binary - ETERM *erl_tl(list) + ETERM *erl_tl(list) Extract the tail from a list. ETERM *list; @@ -738,7 +738,7 @@ iohead ::= Binary - ETERM *erl_var_content(term, name) + ETERM *erl_var_content(term, name) Extract the content of a variable. ETERM *term; diff --git a/lib/erl_interface/doc/src/erl_format.xml b/lib/erl_interface/doc/src/erl_format.xml index 5b8b7b5e78..b5e895c720 100644 --- a/lib/erl_interface/doc/src/erl_format.xml +++ b/lib/erl_interface/doc/src/erl_format.xml @@ -41,7 +41,7 @@ - ETERM *erl_format(FormatStr, ...) + ETERM *erl_format(FormatStr, ...) Create an Erlang term. char *FormatStr; @@ -81,7 +81,7 @@ erl_format("[{name,~a},{age,~i},{data,~w}]", - interl_match(Pattern, Term) + interl_match(Pattern, Term) Perform pattern matching. ETERM *Pattern,*Term; diff --git a/lib/erl_interface/doc/src/erl_global.xml b/lib/erl_interface/doc/src/erl_global.xml index 2fa0045adf..72d43e81d5 100644 --- a/lib/erl_interface/doc/src/erl_global.xml +++ b/lib/erl_interface/doc/src/erl_global.xml @@ -48,7 +48,7 @@ - char **erl_global_names(fd,count) + char **erl_global_names(fd,count) Obtain list of global names. int fd; @@ -79,7 +79,7 @@ - interl_global_register(fd,name,pid) + interl_global_register(fd,name,pid) Register a name in global. int fd; @@ -103,7 +103,7 @@ - interl_global_unregister(fd,name) + interl_global_unregister(fd,name) Unregister a name from global. int fd; @@ -122,7 +122,7 @@ - ETERM *erl_global_whereis(fd,name,node) + ETERM *erl_global_whereis(fd,name,node) Look up a name in global. int fd; diff --git a/lib/erl_interface/doc/src/erl_malloc.xml b/lib/erl_interface/doc/src/erl_malloc.xml index c0eebc29e9..aae3b7e078 100644 --- a/lib/erl_interface/doc/src/erl_malloc.xml +++ b/lib/erl_interface/doc/src/erl_malloc.xml @@ -41,7 +41,7 @@ - ETERM *erl_alloc_eterm(etype) + ETERM *erl_alloc_eterm(etype) Allocate an ETERM structure. unsigned char etype; @@ -89,7 +89,7 @@ - voiderl_eterm_release(void) + voiderl_eterm_release(void) Clear the ETERM freelist.

Clears the freelist, where blocks are placed when they are @@ -99,7 +99,7 @@ - voiderl_eterm_statistics(allocated, freed) + voiderl_eterm_statistics(allocated, freed) Report term allocation statistics. long *allocated; @@ -127,7 +127,7 @@ - voiderl_free(ptr) + voiderl_free(ptr) Free some memory. void *ptr; @@ -139,7 +139,7 @@ - voiderl_free_array(array, size) + voiderl_free_array(array, size) Free an array of ETERM structures. ETERM **array; @@ -156,7 +156,7 @@ - voiderl_free_compound(t) + voiderl_free_compound(t) Free an array of ETERM structures. ETERM *t; @@ -179,7 +179,7 @@ - voiderl_free_term(t) + voiderl_free_term(t) Free an ETERM structure. ETERM *t; @@ -190,7 +190,7 @@ - voiderl_malloc(size) + voiderl_malloc(size) Allocate some memory. long size; diff --git a/lib/erl_interface/doc/src/erl_marshal.xml b/lib/erl_interface/doc/src/erl_marshal.xml index 2ad658f78b..1a6d3bb43c 100644 --- a/lib/erl_interface/doc/src/erl_marshal.xml +++ b/lib/erl_interface/doc/src/erl_marshal.xml @@ -42,7 +42,7 @@ - interl_compare_ext(bufp1, bufp2) + interl_compare_ext(bufp1, bufp2) Compare encoded byte sequences. unsigned char *bufp1,*bufp2; @@ -62,8 +62,8 @@ - ETERM *erl_decode(bufp) - ETERM *erl_decode_buf(bufpp) + ETERM *erl_decode(bufp) + ETERM *erl_decode_buf(bufpp) Convert a term from Erlang external format. unsigned char *bufp; @@ -102,8 +102,8 @@ - interl_encode(term, bufp) - interl_encode_buf(term, bufpp) + interl_encode(term, bufp) + interl_encode_buf(term, bufpp) Convert a term into Erlang external format. ETERM *term; @@ -179,7 +179,7 @@ - interl_ext_size(bufp) + interl_ext_size(bufp) Count elements in encoded term. unsigned char *bufp; @@ -190,7 +190,7 @@ - unsigned charerl_ext_type(bufp) + unsigned charerl_ext_type(bufp) Determine type of an encoded byte sequence. unsigned char *bufp; @@ -228,7 +228,7 @@ - unsigned char *erl_peek_ext(bufp, pos) + unsigned char *erl_peek_ext(bufp, pos) Step over encoded term. unsigned char *bufp; @@ -252,7 +252,7 @@ - interl_term_len(t) + interl_term_len(t) Determine encoded size of term. ETERM *t; diff --git a/lib/erl_interface/doc/src/registry.xml b/lib/erl_interface/doc/src/registry.xml index 6d70fb3475..1c90c5c9dd 100644 --- a/lib/erl_interface/doc/src/registry.xml +++ b/lib/erl_interface/doc/src/registry.xml @@ -44,7 +44,7 @@ - intei_reg_close(reg) + intei_reg_close(reg) Close a registry. ei_reg *reg; @@ -59,7 +59,7 @@ - intei_reg_delete(reg,key) + intei_reg_delete(reg,key) Delete an object from the registry. ei_reg *reg; @@ -85,7 +85,7 @@ - intei_reg_dump(fd,reg,mntab,flags) + intei_reg_dump(fd,reg,mntab,flags) Back up a registry to Mnesia. int fd; @@ -125,7 +125,7 @@ - doubleei_reg_getfval(reg,key) + doubleei_reg_getfval(reg,key) Get a floating point object. ei_reg *reg; @@ -151,7 +151,7 @@ - intei_reg_getival(reg,key) + intei_reg_getival(reg,key) Get an integer object. ei_reg *reg; @@ -177,7 +177,7 @@ - const void *ei_reg_getpval(reg,key,size) + const void *ei_reg_getpval(reg,key,size) Get a binary object. ei_reg *reg; @@ -207,7 +207,7 @@ - const char *ei_reg_getsval(reg,key) + const char *ei_reg_getsval(reg,key) Get a string object. ei_reg *reg; @@ -232,7 +232,7 @@ - intei_reg_getval(reg,key,flags,v,...) + intei_reg_getval(reg,key,flags,v,...) Get any object. ei_reg *reg; @@ -278,7 +278,7 @@ - intei_reg_markdirty(reg,key) + intei_reg_markdirty(reg,key) Mark an object as dirty. ei_reg *reg; @@ -305,7 +305,7 @@ - ei_reg *ei_reg_open(size) + ei_reg *ei_reg_open(size) Create and open a registry. int size; @@ -326,7 +326,7 @@ - intei_reg_purge(reg) + intei_reg_purge(reg) Remove deleted objects. ei_reg *reg; @@ -346,7 +346,7 @@ - intei_reg_resize(reg,newsize) + intei_reg_resize(reg,newsize) Resize a registry. ei_reg *reg; @@ -363,7 +363,7 @@ - intei_reg_restore(fd,reg,mntab) + intei_reg_restore(fd,reg,mntab) Restore a registry from Mnesia. int fd; @@ -399,7 +399,7 @@ - intei_reg_setfval(reg,key,f) + intei_reg_setfval(reg,key,f) Assign a floating point object. ei_reg *reg; @@ -424,7 +424,7 @@ - intei_reg_setival(reg,key,i) + intei_reg_setival(reg,key,i) Assign an integer object. ei_reg *reg; @@ -448,7 +448,7 @@ - intei_reg_setpval(reg,key,p,size) + intei_reg_setpval(reg,key,p,size) Assign a binary object. ei_reg *reg; @@ -479,7 +479,7 @@ - intei_reg_setsval(reg,key,s) + intei_reg_setsval(reg,key,s) Assign a string object. ei_reg *reg; @@ -507,7 +507,7 @@ - intei_reg_setval(reg,key,flags,v,...) + intei_reg_setval(reg,key,flags,v,...) Assign a value to any object type. ei_reg *reg; @@ -552,7 +552,7 @@ - intei_reg_stat(reg,key,obuf) + intei_reg_stat(reg,key,obuf) Get object information. ei_reg *reg; @@ -590,7 +590,7 @@ struct ei_reg_stat { - intei_reg_tabstat(reg,obuf) + intei_reg_tabstat(reg,obuf) Get registry information. ei_reg *reg; diff --git a/lib/et/doc/src/et.xml b/lib/et/doc/src/et.xml index ec7381f633..a362d00b3e 100644 --- a/lib/et/doc/src/et.xml +++ b/lib/et/doc/src/et.xml @@ -32,7 +32,7 @@ %VSN% et - et + et Main API of the Event Trace (ET) application

Interface module for the Event Trace (ET) application

@@ -79,8 +79,8 @@ - phone_home(DetailLevel, FromTo, Label, Contents) -> hopefully_traced - phone_home(DetailLevel, From, To, Label, Contents) -> hopefully_traced + phone_home(DetailLevel, FromTo, Label, Contents) -> hopefully_traced + phone_home(DetailLevel, From, To, Label, Contents) -> hopefully_traced Send a signal to the outer space

These functions sends a signal to the outer space and the @@ -90,8 +90,8 @@ - report_event(DetailLevel, FromTo, Label, Contents) -> hopefully_traced - report_event(DetailLevel, From, To, Label, Contents) -> hopefully_traced + report_event(DetailLevel, FromTo, Label, Contents) -> hopefully_traced + report_event(DetailLevel, From, To, Label, Contents) -> hopefully_traced Deprecated functions

Deprecated functions which for the time being are kept for diff --git a/lib/et/doc/src/et_collector.xml b/lib/et/doc/src/et_collector.xml index fd90ecfc41..f908612797 100644 --- a/lib/et/doc/src/et_collector.xml +++ b/lib/et/doc/src/et_collector.xml @@ -32,14 +32,14 @@ %VSN% et_collector.xml - et_collector + et_collector Collect trace events and provide a backing storage appropriate for iteration

Interface module for the Event Trace (ET) application

 - start_link(Options) -> {ok, CollectorPid} | {error, Reason} + start_link(Options) -> {ok, CollectorPid} | {error, Reason} Start a collector process Options = [option()] @@ -105,7 +105,7 @@ - stop(CollectorPid) -> ok + stop(CollectorPid) -> ok Stop a collector process CollectorPid = pid() @@ -115,7 +115,7 @@ - save_event_file(CollectorPid, FileName, Options) -> ok | {error, Reason} + save_event_file(CollectorPid, FileName, Options) -> ok | {error, Reason} Save the events to a file CollectorPid = pid() @@ -139,7 +139,7 @@ - load_event_file(CollectorPid, FileName) -> {ok, BadBytes} | exit(Reason) + load_event_file(CollectorPid, FileName) -> {ok, BadBytes} | exit(Reason) Load the event table from a file CollectorPid = pid() @@ -152,9 +152,9 @@ - report(Handle, TraceOrEvent) -> {ok, Continuation} | exit(Reason) - report_event(Handle, DetailLevel, FromTo, Label, Contents) -> {ok, Continuation} | exit(Reason) - report_event(Handle, DetailLevel, From, To, Label, Contents) -> {ok, Continuation} | exit(Reason) + report(Handle, TraceOrEvent) -> {ok, Continuation} | exit(Reason) + report_event(Handle, DetailLevel, FromTo, Label, Contents) -> {ok, Continuation} | exit(Reason) + report_event(Handle, DetailLevel, From, To, Label, Contents) -> {ok, Continuation} | exit(Reason) Report an event to the collector Handle = Initial | Continuation @@ -181,7 +181,7 @@ - make_key(Type, Stuff) -> Key + make_key(Type, Stuff) -> Key Make a key out of an event record or an old key Type = record(table_handle) | trace_ts | event_ts @@ -193,7 +193,7 @@ - get_table_handle(CollectorPid) -> Handle + get_table_handle(CollectorPid) -> Handle Return a table handle CollectorPid = pid() @@ -204,7 +204,7 @@ - get_global_pid() -> CollectorPid | exit(Reason) + get_global_pid() -> CollectorPid | exit(Reason) Return a the identity of the globally registered collector if there is any CollectorPid = pid() @@ -216,7 +216,7 @@ - change_pattern(CollectorPid, RawPattern) -> {old_pattern, TracePattern} + change_pattern(CollectorPid, RawPattern) -> {old_pattern, TracePattern} Change active trace pattern globally on all trace nodes CollectorPid = pid() @@ -232,9 +232,9 @@ - dict_insert(CollectorPid, {filter, collector}, FilterFun) -> ok - dict_insert(CollectorPid, {subscriber, SubscriberPid}, Void) -> ok - dict_insert(CollectorPid, Key, Val) -> ok + dict_insert(CollectorPid, {filter, collector}, FilterFun) -> ok + dict_insert(CollectorPid, {subscriber, SubscriberPid}, Void) -> ok + dict_insert(CollectorPid, Key, Val) -> ok Insert a dictionary entry and send a {et, {dict_insert, Key, Val}} tuple to all registered subscribers. CollectorPid = pid() @@ -259,7 +259,7 @@ - dict_lookup(CollectorPid, Key) -> [Val] + dict_lookup(CollectorPid, Key) -> [Val] Lookup a dictionary entry and return zero or one value CollectorPid = pid() @@ -273,7 +273,7 @@ - dict_delete(CollectorPid, Key) -> ok + dict_delete(CollectorPid, Key) -> ok Delete a dictionary entry and send a {et, {dict_delete, Key}} tuple to all registered subscribers. CollectorPid = pid() @@ -290,7 +290,7 @@ - dict_match(CollectorPid, Pattern) -> [Match] + dict_match(CollectorPid, Pattern) -> [Match] Match some dictionary entries CollectorPid = pid() @@ -306,7 +306,7 @@ - multicast(_CollectorPid, Msg) -> ok + multicast(_CollectorPid, Msg) -> ok Sends a message to all registered subscribers CollectorPid = pid() @@ -318,7 +318,7 @@ - start_trace_client(CollectorPid, Type, Parameters) -> file_loaded | {trace_client_pid, pid()} | exit(Reason) + start_trace_client(CollectorPid, Type, Parameters) -> file_loaded | {trace_client_pid, pid()} | exit(Reason) Load raw Erlang trace from a file, port or process. Type = dbg_trace_client_type() @@ -330,14 +330,14 @@ - iterate(Handle, Prev, Limit) -> NewAcc + iterate(Handle, Prev, Limit) -> NewAcc Iterates over the currently stored events

Short for iterate(Handle, Prev, Limit, undefined, Prev) -> NewAcc

 - iterate(Handle, Prev, Limit, Fun, Acc) -> NewAcc + iterate(Handle, Prev, Limit, Fun, Acc) -> NewAcc Iterate over the currently stored events Handle = collector_pid() | table_handle() @@ -361,7 +361,7 @@ - clear_table(Handle) -> ok + clear_table(Handle) -> ok Clear the event table Handle = collector_pid() | table_handle() diff --git a/lib/et/doc/src/et_selector.xml b/lib/et/doc/src/et_selector.xml index 30ca74c872..3c766cafb7 100644 --- a/lib/et/doc/src/et_selector.xml +++ b/lib/et/doc/src/et_selector.xml @@ -32,7 +32,7 @@ %VSN% et_selector.xml - et_selector + et_selector Define event transforms and trace patterns

@@ -40,7 +40,7 @@ - make_pattern(RawPattern) -> TracePattern + make_pattern(RawPattern) -> TracePattern Makes a trace pattern suitable to feed change_pattern/1 @@ -61,7 +61,7 @@ - change_pattern(Pattern) -> ok + change_pattern(Pattern) -> ok Activates/deactivates tracing by changing the current trace pattern @@ -85,7 +85,7 @@ - parse_event(Mod, ValidTraceData) -> false | true | {true, Event} + parse_event(Mod, ValidTraceData) -> false | true | {true, Event} Transforms trace data and makes an event record out of it diff --git a/lib/et/doc/src/et_viewer.xml b/lib/et/doc/src/et_viewer.xml index e0b39636e9..9d59eef668 100644 --- a/lib/et/doc/src/et_viewer.xml +++ b/lib/et/doc/src/et_viewer.xml @@ -32,14 +32,14 @@ %VSN% et_viewer.xml - et_viewer + et_viewer Displays a sequence chart for trace events (messages/actions)

- file(FileName) -> {ok, ViewerPid} | {error, Reason} + file(FileName) -> {ok, ViewerPid} | {error, Reason} Start a new event viewer and a corresponding collector and load them with trace events from a trace file. FileName() = string() @@ -52,7 +52,7 @@ - start() -> ok + start() -> ok Simplified start of a sequence chart viewer with global tracing activated.

Simplified start of a sequence chart viewer with @@ -62,7 +62,7 @@ - start(Options) -> ok + start(Options) -> ok Start of a sequence chart viewer without linking to the parent process.

Start of a sequence chart viewer without linking @@ -70,7 +70,7 @@ - start_link(Options) -> {ok, ViewerPid} | {error, Reason} + start_link(Options) -> {ok, ViewerPid} | {error, Reason} Start a sequence chart viewer for trace events (messages/actions) Options = [option() | collector_option()] @@ -125,7 +125,7 @@ - get_collector_pid(ViewerPid) -> CollectorPid + get_collector_pid(ViewerPid) -> CollectorPid Returns the identifier of the collector process ViewerPid = pid() @@ -136,7 +136,7 @@ - stop(ViewerPid) -> ok + stop(ViewerPid) -> ok Stops a viewer ViewerPid = pid() diff --git a/lib/ftp/doc/src/ftp.xml b/lib/ftp/doc/src/ftp.xml index 21bb7cd133..ead2367925 100644 --- a/lib/ftp/doc/src/ftp.xml +++ b/lib/ftp/doc/src/ftp.xml @@ -29,7 +29,7 @@ B ftp.xml - ftp + ftp A File Transfer Protocol client. @@ -272,7 +272,7 @@ - account(Pid, Account) -> ok | {error, Reason} + account(Pid, Account) -> ok | {error, Reason} Specifies which account to use. Pid = pid() @@ -289,8 +289,8 @@ - append(Pid, LocalFile) -> - append(Pid, LocalFile, RemoteFile) -> ok | {error, Reason} + append(Pid, LocalFile) -> + append(Pid, LocalFile, RemoteFile) -> ok | {error, Reason} Transfers a file to remote server, and appends it to Remotefile. @@ -310,7 +310,7 @@ - append_bin(Pid, Bin, RemoteFile) -> ok | {error, Reason} + append_bin(Pid, Bin, RemoteFile) -> ok | {error, Reason} Transfers a binary into a remote file. Pid = pid() @@ -328,7 +328,7 @@ - append_chunk(Pid, Bin) -> ok | {error, Reason} + append_chunk(Pid, Bin) -> ok | {error, Reason} Appends a chunk to the remote file. Pid = pid() @@ -348,7 +348,7 @@ - append_chunk_start(Pid, File) -> ok | {error, Reason} + append_chunk_start(Pid, File) -> ok | {error, Reason} Starts transfer of file chunks for appending to File. Pid = pid() @@ -365,7 +365,7 @@ - append_chunk_end(Pid) -> ok | {error, Reason} + append_chunk_end(Pid) -> ok | {error, Reason} Stops transfer of chunks for appending. Pid = pid() @@ -381,7 +381,7 @@ - cd(Pid, Dir) -> ok | {error, Reason} + cd(Pid, Dir) -> ok | {error, Reason} Changes remote working directory. Pid = pid() @@ -397,7 +397,7 @@ - close(Pid) -> ok + close(Pid) -> ok Ends the FTP session. Pid = pid() @@ -411,7 +411,7 @@ - delete(Pid, File) -> ok | {error, Reason} + delete(Pid, File) -> ok | {error, Reason} Deletes a file at the remote server. Pid = pid() @@ -426,7 +426,7 @@ - formaterror(Tag) -> string() + formaterror(Tag) -> string() Returns error diagnostics. Tag = {error, atom()} | atom() @@ -440,7 +440,7 @@ - lcd(Pid, Dir) -> ok | {error, Reason} + lcd(Pid, Dir) -> ok | {error, Reason} Changes local working directory. Pid = pid() @@ -455,7 +455,7 @@ - lpwd(Pid) -> {ok, Dir} + lpwd(Pid) -> {ok, Dir} Gets local current working directory. Pid = pid() @@ -470,8 +470,8 @@ - ls(Pid) -> - ls(Pid, Pathname) -> {ok, Listing} | {error, Reason} + ls(Pid) -> + ls(Pid, Pathname) -> {ok, Listing} | {error, Reason} List of files. Pid = pid() @@ -493,7 +493,7 @@ - mkdir(Pid, Dir) -> ok | {error, Reason} + mkdir(Pid, Dir) -> ok | {error, Reason} Creates a remote directory. Pid = pid() @@ -510,8 +510,8 @@ - nlist(Pid) -> - nlist(Pid, Pathname) -> {ok, Listing} | {error, Reason} + nlist(Pid) -> + nlist(Pid, Pathname) -> {ok, Listing} | {error, Reason} List of files. Pid = pid() @@ -535,8 +535,8 @@ - open(Host) -> {ok, Pid} | {error, Reason} - open(Host, Opts) -> {ok, Pid} | {error, Reason} + open(Host) -> {ok, Pid} | {error, Reason} + open(Host, Opts) -> {ok, Pid} | {error, Reason} Starts a standalone FTP client. Host = string() | ip_address() @@ -587,7 +587,7 @@ - pwd(Pid) -> {ok, Dir} | {error, Reason} + pwd(Pid) -> {ok, Dir} | {error, Reason} Gets the remote current working directory. Pid = pid() @@ -603,8 +603,8 @@ - recv(Pid, RemoteFile) -> - recv(Pid, RemoteFile, LocalFile) -> ok | {error, Reason} + recv(Pid, RemoteFile) -> + recv(Pid, RemoteFile, LocalFile) -> ok | {error, Reason} Transfers a file from remote server. Pid = pid() @@ -627,7 +627,7 @@ - recv_bin(Pid, RemoteFile) -> {ok, Bin} | {error, Reason} + recv_bin(Pid, RemoteFile) -> {ok, Bin} | {error, Reason} Transfers a file from remote server as a binary. Pid = pid() @@ -644,7 +644,7 @@ - recv_chunk_start(Pid, RemoteFile) -> ok | {error, Reason} + recv_chunk_start(Pid, RemoteFile) -> ok | {error, Reason} Starts chunk-reading of the remote file. Pid = pid() @@ -660,7 +660,7 @@ - recv_chunk(Pid) -> ok | {ok, Bin} | {error, Reason} + recv_chunk(Pid) -> ok | {ok, Bin} | {error, Reason} Receives a chunk of the remote file. Pid = pid() @@ -682,7 +682,7 @@ - rename(Pid, Old, New) -> ok | {error, Reason} + rename(Pid, Old, New) -> ok | {error, Reason} Renames a file at the remote server. Pid = pid() @@ -697,7 +697,7 @@ - rmdir(Pid, Dir) -> ok | {error, Reason} + rmdir(Pid, Dir) -> ok | {error, Reason} Removes a remote directory. Pid = pid() @@ -714,8 +714,8 @@ - send(Pid, LocalFile) -> - send(Pid, LocalFile, RemoteFile) -> ok | {error, Reason} + send(Pid, LocalFile) -> + send(Pid, LocalFile, RemoteFile) -> ok | {error, Reason} Transfers a file to the remote server. Pid = pid() @@ -732,7 +732,7 @@ - send_bin(Pid, Bin, RemoteFile) -> ok | {error, Reason} + send_bin(Pid, Bin, RemoteFile) -> ok | {error, Reason} Transfers a binary into a remote file. Pid = pid() @@ -749,7 +749,7 @@ - send_chunk(Pid, Bin) -> ok | {error, Reason} + send_chunk(Pid, Bin) -> ok | {error, Reason} Writes a chunk to the remote file. Pid = pid() @@ -769,7 +769,7 @@ - send_chunk_start(Pid, File) -> ok | {error, Reason} + send_chunk_start(Pid, File) -> ok | {error, Reason} Starts transfer of file chunks. Pid = pid() @@ -785,7 +785,7 @@ - send_chunk_end(Pid) -> ok | {error, Reason} + send_chunk_end(Pid) -> ok | {error, Reason} Stops transfer of chunks. Pid = pid() @@ -832,7 +832,7 @@ - type(Pid, Type) -> ok | {error, Reason} + type(Pid, Type) -> ok | {error, Reason} Sets transfer type to asciior binary. Pid = pid() @@ -849,7 +849,7 @@ - user(Pid, User, Password) -> ok | {error, Reason} + user(Pid, User, Password) -> ok | {error, Reason} User login. Pid = pid() @@ -864,7 +864,7 @@ - user(Pid, User, Password, Account) -> ok | {error, Reason} + user(Pid, User, Password, Account) -> ok | {error, Reason} User login. Pid = pid() @@ -880,7 +880,7 @@ - quote(Pid, Command) -> [FTPLine] + quote(Pid, Command) -> [FTPLine] Sends an arbitrary FTP command. Pid = pid() diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml index 1a203fae90..66369e8df9 100644 --- a/lib/inets/doc/src/httpd.xml +++ b/lib/inets/doc/src/httpd.xml @@ -29,7 +29,7 @@ 2.2 httpd.sgml - httpd + httpd HTTP server API @@ -874,8 +874,8 @@ text/plain asc txt - info(Pid) -> - info(Pid, Properties) -> [{Option, Value}] + info(Pid) -> + info(Pid, Properties) -> [{Option, Value}] Fetches information about the HTTP server. Properties = [property()] @@ -899,10 +899,10 @@ text/plain asc txt - info(Address, Port) -> - info(Address, Port, Profile) -> + info(Address, Port) -> + info(Address, Port, Profile) -> info(Address, Port, Profile, Properties) -> [{Option, Value}] - info(Address, Port, Properties) -> [{Option, Value}] + info(Address, Port, Properties) -> [{Option, Value}] Fetches information about the HTTP server. Address = ip_address() @@ -927,7 +927,7 @@ text/plain asc txt - reload_config(Config, Mode) -> ok | {error, Reason} + reload_config(Config, Mode) -> ok | {error, Reason} Reloads the HTTP server configuration without restarting the server. @@ -1051,7 +1051,7 @@ text/plain asc txt - Module:do(ModData)-> {proceed, OldData} | {proceed, NewData} | {break, NewData} | done + Module:do(ModData)-> {proceed, OldData} | {proceed, NewData} | {break, NewData} | done Called for each request to the web server. OldData = list() @@ -1105,7 +1105,7 @@ text/plain asc txt - Module:load(Line, AccIn)-> eof | ok | {ok, AccOut} | {ok, AccOut, {Option, Value}} | {ok, AccOut, [{Option, Value}]} | {error, Reason} + Module:load(Line, AccIn)-> eof | ok | {ok, AccOut} | {ok, AccOut, {Option, Value}} | {ok, AccOut, [{Option, Value}]} | {error, Reason} Converts a line in an Apache-like config file to an {Option, Value} tuple. @@ -1128,7 +1128,7 @@ text/plain asc txt - Module:remove(ConfigDB) -> ok | {error, Reason} + Module:remove(ConfigDB) -> ok | {error, Reason} Callback function that is called when the web server is closed. ConfigDB = ets_table() @@ -1143,7 +1143,7 @@ text/plain asc txt - Module:store({Option, Value}, Config)-> {ok, {Option, NewValue}} | {error, Reason} + Module:store({Option, Value}, Config)-> {ok, {Option, NewValue}} | {error, Reason} Checks the validity of the configuration options. Line = string() @@ -1171,7 +1171,7 @@ text/plain asc txt - parse_query(QueryString) -> [{Key,Value}] + parse_query(QueryString) -> [{Key,Value}] Parses incoming data to erl and eval scripts. QueryString = string() diff --git a/lib/inets/doc/src/httpd_socket.xml b/lib/inets/doc/src/httpd_socket.xml index d3aa82a540..22ead06f38 100644 --- a/lib/inets/doc/src/httpd_socket.xml +++ b/lib/inets/doc/src/httpd_socket.xml @@ -29,7 +29,7 @@ 2.2 httpd_socket.sgml - httpd_socket + httpd_socket Communication utility functions to be used by the Erlang web server API programmer. @@ -43,7 +43,7 @@ - deliver(SocketType, Socket, Data) -> Result + deliver(SocketType, Socket, Data) -> Result Sends binary data over socket. SocketType = socket_type() @@ -63,7 +63,7 @@ - peername(SocketType,Socket) -> {Port,IPAddress} + peername(SocketType,Socket) -> {Port,IPAddress} Returns the port and IP address of the remote socket. SocketType = socket_type() @@ -81,7 +81,7 @@ - resolve() -> HostName + resolve() -> HostName Returns the official name of the current host. HostName = string() diff --git a/lib/inets/doc/src/httpd_util.xml b/lib/inets/doc/src/httpd_util.xml index 220a2ede35..29971ba8ae 100644 --- a/lib/inets/doc/src/httpd_util.xml +++ b/lib/inets/doc/src/httpd_util.xml @@ -29,7 +29,7 @@ 2.2 httpd_util.sgml - httpd_util + httpd_util Miscellaneous utility functions to be used when implementing Erlang web server API modules. @@ -41,7 +41,7 @@ - convert_request_date(DateString) -> ErlDate|bad_date + convert_request_date(DateString) -> ErlDate|bad_date Converts the date to the Erlang date format. DateString = string() @@ -57,7 +57,7 @@ - create_etag(FileInfo) -> Etag + create_etag(FileInfo) -> Etag Calculates the Etag for a file. FileInfo = file_info() @@ -71,7 +71,7 @@ - day(NthDayOfWeek) -> DayOfWeek + day(NthDayOfWeek) -> DayOfWeek Converts the day of the week (integer [1-7]) to an abbreviated string. @@ -87,7 +87,7 @@ - decode_hex(HexValue) -> DecValue + decode_hex(HexValue) -> DecValue Converts a hexadecimal value into its decimal equivalent. HexValue = DecValue = string() @@ -99,7 +99,7 @@ - flatlength(NestedList) -> Size + flatlength(NestedList) -> Size Computes the size of a possibly nested list. NestedList = list() @@ -112,7 +112,7 @@ - hexlist_to_integer(HexString) -> Number + hexlist_to_integer(HexString) -> Number Converts a hexadecimal string to an integer. Number = integer() @@ -125,7 +125,7 @@ - integer_to_hexlist(Number) -> HexString + integer_to_hexlist(Number) -> HexString Converts an integer to a hexadecimal string. Number = integer() @@ -138,8 +138,8 @@ - lookup(ETSTable,Key) -> Result - lookup(ETSTable,Key,Undefined) -> Result + lookup(ETSTable,Key) -> Result + lookup(ETSTable,Key,Undefined) -> Result Extracts the first value associated with a Key in an ETS table. @@ -160,8 +160,8 @@ - lookup_mime(ConfigDB,Suffix) - lookup_mime(ConfigDB,Suffix,Undefined) -> MimeType + lookup_mime(ConfigDB,Suffix) + lookup_mime(ConfigDB,Suffix,Undefined) -> MimeType Returns the MIME type associated with a specific file suffix. ConfigDB = ets_table() @@ -179,8 +179,8 @@ - lookup_mime_default(ConfigDB,Suffix) - lookup_mime_default(ConfigDB,Suffix,Undefined) -> MimeType + lookup_mime_default(ConfigDB,Suffix) + lookup_mime_default(ConfigDB,Suffix,Undefined) -> MimeType Returns the MIME type associated with a specific file suffix or the value of the DefaultType. @@ -201,7 +201,7 @@ - message(StatusCode,PhraseArgs,ConfigDB) -> Message + message(StatusCode,PhraseArgs,ConfigDB) -> Message Returns an informative HTTP 1.1 status string in HTML. StatusCode = 301 | 400 | 403 | 404 | 500 | 501 | 504 @@ -236,7 +236,7 @@ - month(NthMonth) -> Month + month(NthMonth) -> Month Converts the month as an integer (1-12) to an abbreviated string. NthMonth = 1-12 @@ -250,7 +250,7 @@ - multi_lookup(ETSTable,Key) -> Result + multi_lookup(ETSTable,Key) -> Result Extracts the values associated with a key in an ETS table. ETSTable = ets_table() @@ -265,7 +265,7 @@ - reason_phrase(StatusCode) -> Description + reason_phrase(StatusCode) -> Description Returns the description of an HTTP 1.1 status code. StatusCode = 100| 200 | 201 | 202 | 204 | 205 | 206 | 300 | 301 | 302 | 303 | 304 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 410 411 | 412 | 413 | 414 415 | 416 | 417 | 500 | 501 | 502 | 503 | 504 | 505 @@ -280,8 +280,8 @@ - rfc1123_date() -> RFC1123Date - rfc1123_date({{YYYY,MM,DD},{Hour,Min,Sec}}) -> RFC1123Date + rfc1123_date() -> RFC1123Date + rfc1123_date({{YYYY,MM,DD},{Hour,Min,Sec}}) -> RFC1123Date Returns the current date in RFC 1123 format. YYYY = MM = DD = Hour = Min = Sec = integer() @@ -295,7 +295,7 @@ - split(String,RegExp,N) -> SplitRes + split(String,RegExp,N) -> SplitRes Splits a string in N chunks using a regular expression. String = RegExp = string() @@ -313,7 +313,7 @@ - split_script_path(RequestLine) -> Splitted + split_script_path(RequestLine) -> Splitted Splits a RequestLine in a file reference to an executable, and a QueryString or a PathInfostring. @@ -330,7 +330,7 @@ - split_path(RequestLine) -> {Path,QueryStringOrPathInfo} + split_path(RequestLine) -> {Path,QueryStringOrPathInfo} Splits a RequestLine in a file reference, and a QueryString or a PathInfo string. @@ -356,7 +356,7 @@ - strip(String) -> Stripped + strip(String) -> Stripped Returns String where the leading and trailing space tabs are removed. @@ -370,7 +370,7 @@ - suffix(FileName) -> Suffix + suffix(FileName) -> Suffix Extracts the file suffix from a given filename. FileName = Suffix = string() diff --git a/lib/inets/doc/src/inets.xml b/lib/inets/doc/src/inets.xml index 9b0ffaad5e..176af3137a 100644 --- a/lib/inets/doc/src/inets.xml +++ b/lib/inets/doc/src/inets.xml @@ -29,7 +29,7 @@ - inets + inets The Inets services API.

This module provides the most basic API to the @@ -51,7 +51,7 @@ - services() -> [{Service, Pid}] + services() -> [{Service, Pid}] Returns a list of currently running services. Service = service() @@ -68,7 +68,7 @@ - services_info() -> [{Service, Pid, Info}] + services_info() -> [{Service, Pid, Info}] Returns a list of currently running services where each service is described by an [{Option, Value}] list. @@ -91,7 +91,7 @@ - service_names() -> [Service] + service_names() -> [Service] Returns a list of available service names. Service = service() @@ -104,8 +104,8 @@ - start() -> - start(Type) -> ok | {error, Reason} + start() -> + start(Type) -> ok | {error, Reason} Starts the Inets application. Type = permanent | transient | temporary @@ -120,8 +120,8 @@ - start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason} - start(Service, ServiceConfig, How) -> {ok, Pid} | {error, Reason} + start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason} + start(Service, ServiceConfig, How) -> {ok, Pid} | {error, Reason} Dynamically starts an Inets service after the Inets application has been started. @@ -156,7 +156,7 @@ - stop() -> ok + stop() -> ok Stops the Inets application.

Stops the Inets application. See also @@ -167,7 +167,7 @@ - stop(Service, Reference) -> ok | {error, Reason} + stop(Service, Reference) -> ok | {error, Reason} Stops a started service of the Inets application or takes down a stand_alone service gracefully. diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml index 6ae19700a5..ff57d49d08 100644 --- a/lib/inets/doc/src/mod_alias.xml +++ b/lib/inets/doc/src/mod_alias.xml @@ -29,7 +29,7 @@ 2.2 mod_alias.sgml - mod_alias + mod_alias URL aliasing.

Erlang web server internal API for handling of, for example, @@ -40,7 +40,7 @@ - default_index(ConfigDB, Path) -> NewPath + default_index(ConfigDB, Path) -> NewPath Returns a new path with the default resource or file appended. ConfigDB = config_db() @@ -64,7 +64,7 @@ - path(PathData, ConfigDB, RequestURI) -> Path + path(PathData, ConfigDB, RequestURI) -> Path Returns the file path to a URL. PathData = interaction_data() @@ -89,7 +89,7 @@ - real_name(ConfigDB, RequestURI, Aliases) -> Ret + real_name(ConfigDB, RequestURI, Aliases) -> Ret Expands a request URI using Aliases config directives. ConfigDB = config_db() @@ -120,7 +120,7 @@ - real_script_name(ConfigDB, RequestURI, ScriptAliases) -> Ret + real_script_name(ConfigDB, RequestURI, ScriptAliases) -> Ret Expands a request URI using ScriptAliases config directives. diff --git a/lib/inets/doc/src/mod_auth.xml b/lib/inets/doc/src/mod_auth.xml index 6400444601..ad864ca4d1 100644 --- a/lib/inets/doc/src/mod_auth.xml +++ b/lib/inets/doc/src/mod_auth.xml @@ -29,7 +29,7 @@ 2.3 mod_auth.sgml - mod_auth + mod_auth User authentication using text files, Dets, or Mnesia database.

This module provides for basic user authentication using @@ -38,9 +38,9 @@ - add_group_member(GroupName, UserName, Options) -> true | {error, Reason} - add_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} - add_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} + add_group_member(GroupName, UserName, Options) -> true | {error, Reason} + add_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} + add_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} Adds a user to a group. GroupName = string() @@ -65,9 +65,9 @@ - add_user(UserName, Options) -> true| {error, Reason} - add_user(UserName, Password, UserData, Port, Dir) -> true | {error, Reason} - add_user(UserName, Password, UserData, Address, Port, Dir) -> true | {error, Reason} + add_user(UserName, Options) -> true| {error, Reason} + add_user(UserName, Password, UserData, Port, Dir) -> true | {error, Reason} + add_user(UserName, Password, UserData, Address, Port, Dir) -> true | {error, Reason} Adds a user to the user database. UserName = string() @@ -92,8 +92,8 @@ - delete_group(GroupName, Options) -> true | {error,Reason} <name>delete_group(GroupName, Port, Dir) -> true | {error, Reason} - delete_group(GroupName, Address, Port, Dir) -> true | {error, Reason} + delete_group(GroupName, Options) -> true | {error,Reason} <name>delete_group(GroupName, Port, Dir) -> true | {error, Reason} + delete_group(GroupName, Address, Port, Dir) -> true | {error, Reason} Deletes a group. Options = [Option] @@ -115,9 +115,9 @@ - delete_group_member(GroupName, UserName, Options) -> true | {error, Reason} - delete_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} - delete_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} + delete_group_member(GroupName, UserName, Options) -> true | {error, Reason} + delete_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} + delete_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} Removes a user from a group. GroupName = string() @@ -141,9 +141,9 @@ - delete_user(UserName,Options) -> true | {error, Reason} - delete_user(UserName, Port, Dir) -> true | {error, Reason} - delete_user(UserName, Address, Port, Dir) -> true | {error, Reason} + delete_user(UserName,Options) -> true | {error, Reason} + delete_user(UserName, Port, Dir) -> true | {error, Reason} + delete_user(UserName, Address, Port, Dir) -> true | {error, Reason} Deletes a user from the user database. UserName = string() @@ -166,9 +166,9 @@ - get_user(UserName,Options) -> {ok, #httpd_user} |{error, Reason} - get_user(UserName, Port, Dir) -> {ok, #httpd_user} | {error, Reason} - get_user(UserName, Address, Port, Dir) -> {ok, #httpd_user} | {error, Reason} + get_user(UserName,Options) -> {ok, #httpd_user} |{error, Reason} + get_user(UserName, Port, Dir) -> {ok, #httpd_user} | {error, Reason} + get_user(UserName, Address, Port, Dir) -> {ok, #httpd_user} | {error, Reason} Returns a user from the user database. UserName = string() @@ -190,9 +190,9 @@ - list_groups(Options) -> {ok, Groups} | {error, Reason} - list_groups(Port, Dir) -> {ok, Groups} | {error, Reason} - list_groups(Address, Port, Dir) -> {ok, Groups} | {error, Reason} + list_groups(Options) -> {ok, Groups} | {error, Reason} + list_groups(Port, Dir) -> {ok, Groups} | {error, Reason} + list_groups(Address, Port, Dir) -> {ok, Groups} | {error, Reason} Lists all the groups. Options = [Option] @@ -214,9 +214,9 @@ - list_group_members(GroupName, Options) -> {ok, Users} | {error, Reason} - list_group_members(GroupName, Port, Dir) -> {ok, Users} | {error, Reason} - list_group_members(GroupName, Address, Port, Dir) -> {ok, Users} | {error, Reason} + list_group_members(GroupName, Options) -> {ok, Users} | {error, Reason} + list_group_members(GroupName, Port, Dir) -> {ok, Users} | {error, Reason} + list_group_members(GroupName, Address, Port, Dir) -> {ok, Users} | {error, Reason} Lists the members of a group. GroupName = string() @@ -240,9 +240,9 @@ - list_users(Options) -> {ok, Users} | {error, Reason} + list_users(Options) -> {ok, Users} | {error, Reason} list_users(Port, Dir) -> {ok, Users} | {error, Reason} - list_users(Address, Port, Dir) -> {ok, Users} | {error, Reason} + list_users(Address, Port, Dir) -> {ok, Users} | {error, Reason} Lists users in the user database. Options = [Option] @@ -264,8 +264,8 @@ - update_password(Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} - update_password(Address,Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} + update_password(Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} + update_password(Address,Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} Changes AuthAcessPassword. Port = integer() diff --git a/lib/inets/doc/src/mod_esi.xml b/lib/inets/doc/src/mod_esi.xml index ede7dc8f7d..bc5f98068f 100644 --- a/lib/inets/doc/src/mod_esi.xml +++ b/lib/inets/doc/src/mod_esi.xml @@ -25,7 +25,7 @@ mod_esi mod_esi.sgml - mod_esi + mod_esi Erlang Server Interface

This module defines the Erlang Server Interface (ESI) API. @@ -88,7 +88,7 @@ - deliver(SessionID, Data) -> ok | {error, Reason} + deliver(SessionID, Data) -> ok | {error, Reason} Sends Data back to client. SessionID = term() @@ -121,7 +121,7 @@ - Module:Function(SessionID, Env, Input)-> {continue, State} | _ + Module:Function(SessionID, Env, Input)-> {continue, State} | _ Creates a dynamic web page and returns it chunk by chunk to the server process by calling mod_esi:deliver/2. @@ -179,7 +179,7 @@ - Module:Function(Env, Input)-> Response + Module:Function(Env, Input)-> Response Creates a dynamic web page and returns it as a list. This function is deprecated and is only kept for backwards compatibility. diff --git a/lib/inets/doc/src/mod_security.xml b/lib/inets/doc/src/mod_security.xml index 340705f697..c26d7468c2 100644 --- a/lib/inets/doc/src/mod_security.xml +++ b/lib/inets/doc/src/mod_security.xml @@ -29,7 +29,7 @@ 1.0 mod_security.sgml - mod_security + mod_security Security Audit and Trailing Functionality

Security Audit and Trailing Functionality

@@ -37,8 +37,8 @@ - block_user(User, Port, Dir, Seconds) -> true | {error, Reason} - block_user(User, Address, Port, Dir, Seconds) -> true | {error, Reason} + block_user(User, Port, Dir, Seconds) -> true | {error, Reason} + block_user(User, Address, Port, Dir, Seconds) -> true | {error, Reason} Blocks a user from access to a directory for a certain amount of time. User = string() @@ -56,10 +56,10 @@ - list_auth_users(Port) -> Users | [] - list_auth_users(Address, Port) -> Users | [] - list_auth_users(Port, Dir) -> Users | [] - list_auth_users(Address, Port, Dir) -> Users | [] + list_auth_users(Port) -> Users | [] + list_auth_users(Address, Port) -> Users | [] + list_auth_users(Port, Dir) -> Users | [] + list_auth_users(Address, Port, Dir) -> Users | [] Lists users that have authenticated within the SecurityAuthTimeout time for a given address (if specified), port number, and directory (if specified). @@ -77,10 +77,10 @@ - list_blocked_users(Port) -> Users | [] - list_blocked_users(Address, Port) -> Users | [] - list_blocked_users(Port, Dir) -> Users | [] - list_blocked_users(Address, Port, Dir) -> Users | [] + list_blocked_users(Port) -> Users | [] + list_blocked_users(Address, Port) -> Users | [] + list_blocked_users(Port, Dir) -> Users | [] + list_blocked_users(Address, Port, Dir) -> Users | [] Lists users that are currently blocked from access to a specified port number, for a given address (if specified). @@ -97,10 +97,10 @@ - unblock_user(User, Port) -> true | {error, Reason} - unblock_user(User, Address, Port) -> true | {error, Reason} - unblock_user(User, Port, Dir) -> true | {error, Reason} - unblock_user(User, Address, Port, Dir) -> true | {error, Reason} + unblock_user(User, Port) -> true | {error, Reason} + unblock_user(User, Address, Port) -> true | {error, Reason} + unblock_user(User, Port, Dir) -> true | {error, Reason} + unblock_user(User, Address, Port, Dir) -> true | {error, Reason} Removes a blocked user from the block list. User = string() diff --git a/lib/kernel/doc/src/application.xml b/lib/kernel/doc/src/application.xml index ec5d081676..4e32c1a3a5 100644 --- a/lib/kernel/doc/src/application.xml +++ b/lib/kernel/doc/src/application.xml @@ -28,7 +28,7 @@ - application + application Generic OTP application functions

In OTP, application denotes a component implementing @@ -95,8 +95,8 @@ - - + + Get the configuration parameters for an application.

Returns the configuration parameters and their values for @@ -108,8 +108,8 @@ - - + + Get the application specification keys.

Returns the application specification keys and their values @@ -122,8 +122,8 @@ - - + + Get the name of an application containing a certain process or module.

Returns the name of the application to which the process @@ -136,8 +136,8 @@ - - + + Get the value of a configuration parameter.

Returns the value of configuration parameter Par @@ -162,8 +162,8 @@ - - + + Get the value of an application specification key.

Returns the value of the application specification key @@ -180,8 +180,8 @@ - - + + Load an application. @@ -226,7 +226,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - + Get the currently loaded applications.

Returns a list with information about the applications, and included @@ -238,7 +238,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - + Change the permission for an application to run at a node.

Changes the permission for Application to run at @@ -271,8 +271,8 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - - + + Set the value of a configuration parameter.

Sets the value of configuration parameter Par for @@ -302,8 +302,8 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - - + + Load and start an application.

Starts Application. If it is not loaded, @@ -353,7 +353,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - + Get the start type of an ongoing application startup.

This function is intended to be called by a process belonging @@ -370,7 +370,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - + Stop an application.

Stops Application. The application master calls @@ -399,7 +399,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - + Take over a distributed application.

Takes over the distributed application @@ -424,7 +424,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - + Unload an application.

Unloads the application specification for Application @@ -435,8 +435,8 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - - + + Unset the value of a configuration parameter.

Removes the configuration parameter Par and its value @@ -459,8 +459,8 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - - + + Get the currently running applications.

Returns a list with information about the applications that @@ -484,7 +484,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - Module:start(StartType, StartArgs) -> {ok, Pid} | {ok, Pid, State} | {error, Reason} + Module:start(StartType, StartArgs) -> {ok, Pid} | {ok, Pid, State} | {error, Reason} Start an application. StartType = start_type() @@ -526,7 +526,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - Module:start_phase(Phase, StartType, PhaseArgs) -> ok | {error, Reason} + Module:start_phase(Phase, StartType, PhaseArgs) -> ok | {error, Reason} Extended start of an application. Phase = atom() @@ -551,7 +551,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - Module:prep_stop(State) -> NewState + Module:prep_stop(State) -> NewState Prepare an application for termination. State = NewState = term() @@ -569,7 +569,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - Module:stop(State) + Module:stop(State) Clean up after termination of an application. State = term() @@ -585,7 +585,7 @@ Nodes = [cp1@cave, {cp2@cave, cp3@cave}] - Module:config_change(Changed, New, Removed) -> ok + Module:config_change(Changed, New, Removed) -> ok Update the configuration parameters for an application. Changed = [{Par,Val}] diff --git a/lib/kernel/doc/src/auth.xml b/lib/kernel/doc/src/auth.xml index 5901446960..a57da18de9 100644 --- a/lib/kernel/doc/src/auth.xml +++ b/lib/kernel/doc/src/auth.xml @@ -28,7 +28,7 @@ - auth + auth Erlang network authentication server.

This module is deprecated. For a description of the Magic @@ -42,7 +42,7 @@ - + Magic cookie for local node (deprecated).

Use @@ -51,7 +51,7 @@ - + Set the magic for the local node (deprecated). The cookie can also be specified as a list with a single atom element. @@ -63,7 +63,7 @@ - + Status of communication authorization (deprecated).

Returns yes if communication with Node is @@ -76,7 +76,7 @@ - node_cookie([Node, Cookie]) -> yes | no + node_cookie([Node, Cookie]) -> yes | no Set the magic cookie for a node and verify authorization (deprecated). Node = node() @@ -88,7 +88,7 @@ - + Set the magic cookie for a node and verify authorization (deprecated).

Sets the magic cookie of Node to diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml index 8dae6d90f3..85178da930 100644 --- a/lib/kernel/doc/src/code.xml +++ b/lib/kernel/doc/src/code.xml @@ -28,7 +28,7 @@ - code + code Erlang code server.

This module contains the interface to the Erlang @@ -322,7 +322,7 @@ zip:create("mnesia-4.4.7.ez", - + Set the code server search path.

Sets the code path to the list of directories Path.

@@ -336,15 +336,15 @@ zip:create("mnesia-4.4.7.ez", - + Return the code server search path.

Returns the code path.

 - - + + Add a directory to the end of the code path. @@ -357,7 +357,7 @@ zip:create("mnesia-4.4.7.ez", - + Add a directory to the beginning of the code path. @@ -370,8 +370,8 @@ zip:create("mnesia-4.4.7.ez", - - + + Add directories to the end of the code path.

Adds the directories in Dirs to the end of the code @@ -381,7 +381,7 @@ zip:create("mnesia-4.4.7.ez", - + Add directories to the beginning of the code path.

Traverses Dirs and adds @@ -397,7 +397,7 @@ zip:create("mnesia-4.4.7.ez", - + Delete a directory from the code path.

Deletes a directory from the code path. The argument can be @@ -417,7 +417,7 @@ zip:create("mnesia-4.4.7.ez", - + Replace a directory with another in the code path.

Replaces an old occurrence of a directory @@ -441,7 +441,7 @@ zip:create("mnesia-4.4.7.ez", - + Load a module. @@ -460,7 +460,7 @@ zip:create("mnesia-4.4.7.ez", - + Load a module, residing in a specified file. @@ -477,7 +477,7 @@ zip:create("mnesia-4.4.7.ez", - + Ensure that a module is loaded.

Tries to load a module in the same way as @@ -489,7 +489,7 @@ zip:create("mnesia-4.4.7.ez", - + Load object code for a module. @@ -639,7 +639,7 @@ ok = code:finish_loading(Prepared), - + Remove current code for a module.

Removes the current code for Module, that is, @@ -652,7 +652,7 @@ ok = code:finish_loading(Prepared), - + Remove old code for a module.

Purges the code for Module, that is, removes code @@ -668,7 +668,7 @@ ok = code:finish_loading(Prepared), - + Remove old code for a module, unless no process uses it.

Purges the code for Module, that is, removes code @@ -683,7 +683,7 @@ ok = code:finish_loading(Prepared), - + Check if a module is loaded. @@ -702,7 +702,7 @@ ok = code:finish_loading(Prepared), - + Get all loaded modules. @@ -716,7 +716,7 @@ ok = code:finish_loading(Prepared), - + The object code file of a module. @@ -731,7 +731,7 @@ ok = code:finish_loading(Prepared), - + Gets the object code for a module.

Searches the code path for the object code of module @@ -750,7 +750,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Root directory of Erlang/OTP.

Returns the root directory of Erlang/OTP, which is @@ -762,7 +762,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Library directory of Erlang/OTP.

Returns the library directory, $OTPROOT/lib, where @@ -774,7 +774,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Library directory for an application.

Returns the path @@ -807,7 +807,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Subdirectory for an application.

Returns the path to a subdirectory directly under the top @@ -827,7 +827,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Library directory for the compiler.

Returns the compiler library directory. Equivalent to @@ -835,7 +835,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Priv directory for an application.

Returns the path to the priv directory in an @@ -846,7 +846,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Object code file extension.

Returns the object code file extension corresponding to @@ -854,7 +854,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Mark a directory as sticky.

Marks Dir as sticky.

@@ -862,7 +862,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Remove a sticky directory mark.

Unsticks a directory that is marked as @@ -871,7 +871,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Test if a module is sticky.

Returns true if Module is the @@ -882,7 +882,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Full name of a file located in the code path.

Searches the code path for Filename, a file of @@ -893,7 +893,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Search for modules with identical names.

Searches all directories in the code path for module names with @@ -943,7 +943,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Test if a module has native code.

Returns:

diff --git a/lib/kernel/doc/src/disk_log.xml b/lib/kernel/doc/src/disk_log.xml index 884cb32c0c..e308b06f3c 100644 --- a/lib/kernel/doc/src/disk_log.xml +++ b/lib/kernel/doc/src/disk_log.xml @@ -34,7 +34,7 @@ D disk_log.sgml - disk_log + disk_log A disk-based term logging facility.

disk_log is a disk-based term logger that enables @@ -238,7 +238,7 @@ - + Return the accessible disk logs on the current node.

Returns the names of the disk logs accessible on the current node. @@ -248,8 +248,8 @@ - - + + Asynchronously log an item on to a disk log. @@ -275,8 +275,8 @@ - - + + Asynchronously log many items on to a disk log. @@ -303,8 +303,8 @@ - - + + Block a disk log. @@ -330,21 +330,21 @@ - + Change option head or head_func for an owner of a disk log.

Changes the value of option head or head_func for an owner of a disk log.

 - + Change option notify for an owner of a disk log.

Changes the value of option notify for an owner of a disk log.

- + Change the size of an open disk log.

Changes the size of an open log. @@ -384,10 +384,10 @@ - - - - + + + + Read a chunk of items written to a disk log. @@ -447,7 +447,7 @@ - + Return information about a chunk continuation of a disk log.

Returns the pair {node, Node}, @@ -457,7 +457,7 @@ - + Step forward or backward among the wrap log files of a disk log.

Can be used with chunk/2,3 and bchunk/2,3 @@ -480,7 +480,7 @@ - + Close a disk log. @@ -505,7 +505,7 @@ - + Return an English description of a disk log error reply.

Given the error returned by any function in this module, @@ -517,7 +517,7 @@ - + Change to the next wrap log file of a disk log. @@ -534,7 +534,7 @@ - + Return information about a disk log. @@ -685,8 +685,8 @@ - - + + Close a disk log on one node. @@ -704,8 +704,8 @@ - - + + Log an item onto a disk log. @@ -739,8 +739,8 @@ - - + + Log many items onto a disk log. @@ -768,7 +768,7 @@ - + Open a disk log file. @@ -1041,7 +1041,7 @@ - + Return the name of the disk log handled by a pid.

Returns the log name @@ -1053,9 +1053,9 @@ - - - + + + Reopen a disk log and save the old log. @@ -1087,7 +1087,7 @@ - + Flush the contents of a disk log to the disk. @@ -1097,9 +1097,9 @@ - - - + + + Truncate a disk log. @@ -1129,7 +1129,7 @@ - + Unblock a disk log. diff --git a/lib/kernel/doc/src/erl_boot_server.xml b/lib/kernel/doc/src/erl_boot_server.xml index 4109251387..89f9855c49 100644 --- a/lib/kernel/doc/src/erl_boot_server.xml +++ b/lib/kernel/doc/src/erl_boot_server.xml @@ -28,7 +28,7 @@ - erl_boot_server + erl_boot_server Boot server for other Erlang machines.

This server is used to assist diskless Erlang nodes that fetch @@ -52,14 +52,14 @@ - + Add a slave to the list of allowed slaves.

Adds a Slave node to the list of allowed slave hosts.

 - + Delete a slave from the list of allowed slaves.

Deletes a Slave node from the list of allowed slave @@ -67,7 +67,7 @@ - + Start the boot server.

Starts the boot server. Slaves is a list of @@ -76,7 +76,7 @@ - + Start the boot server and link to the the caller.

Starts the boot server and links to the caller. This function @@ -85,7 +85,7 @@ - + Return the current list of allowed slave hosts.

Returns the current list of allowed slave hosts.

diff --git a/lib/kernel/doc/src/erl_ddll.xml b/lib/kernel/doc/src/erl_ddll.xml index 75114e015c..f2d5e1b397 100644 --- a/lib/kernel/doc/src/erl_ddll.xml +++ b/lib/kernel/doc/src/erl_ddll.xml @@ -28,7 +28,7 @@ - erl_ddll + erl_ddll Dynamic driver loader and linker.

This module provides an interface for loading @@ -196,7 +196,7 @@ - + Remove a monitor for a driver.

Removes a driver monitor in much the same way as @@ -212,7 +212,7 @@ - + Format an error descriptor.

Takes an ErrorDesc returned by load, unload, or @@ -229,7 +229,7 @@ - + Retrieve information about all drivers.

Returns a list of tuples {DriverName, InfoList}, @@ -240,7 +240,7 @@ - + Retrieve information about one driver.

Returns a list of tuples {Tag, Value}, @@ -266,7 +266,7 @@ - + Retrieve specific information about one driver.

Returns specific information about one aspect of a driver. @@ -328,7 +328,7 @@ - + Load a driver.

Loads and links the dynamic driver Name. @@ -390,7 +390,7 @@ - + Load a driver.

Works essentially as load/2, but loads the driver @@ -413,7 +413,7 @@ - + List loaded drivers.

Returns a list of all the available drivers, both @@ -425,7 +425,7 @@ - + Create a monitor for a driver.

Creates a driver monitor and works in many @@ -588,7 +588,7 @@ - + Replace a driver.

Reloads the driver named Name from a possibly @@ -626,7 +626,7 @@ - + Replace a driver.

Works exactly as reload/2, @@ -644,7 +644,7 @@ - + Load a driver.

Provides more control than the @@ -931,7 +931,7 @@ - + Unload a driver.

This is the low-level function to unload (or decrement @@ -1116,7 +1116,7 @@ - + Unload a driver.

Unloads, or at least dereferences the driver named @@ -1143,7 +1143,7 @@ - + Unload a driver.

Unloads, or at least dereferences the driver named diff --git a/lib/kernel/doc/src/error_handler.xml b/lib/kernel/doc/src/error_handler.xml index 28d15d0b67..eb01e87aee 100644 --- a/lib/kernel/doc/src/error_handler.xml +++ b/lib/kernel/doc/src/error_handler.xml @@ -30,7 +30,7 @@ - error_handler + error_handler Default system error handler.

This module defines what happens when certain types @@ -51,7 +51,7 @@ - + Called when an undefined function is encountered. A (possibly empty) list of arguments Arg1,..,ArgN @@ -93,7 +93,7 @@ - + Called when an undefined lambda (fun) is encountered. A (possibly empty) list of arguments Arg1,..,ArgN diff --git a/lib/kernel/doc/src/error_logger.xml b/lib/kernel/doc/src/error_logger.xml index 8cb3e2ce16..c170b4fa34 100644 --- a/lib/kernel/doc/src/error_logger.xml +++ b/lib/kernel/doc/src/error_logger.xml @@ -28,7 +28,7 @@ - error_logger + error_logger Erlang error logger. @@ -76,8 +76,8 @@ - - + + Add an event handler to the error logger.

Adds a new event handler to the error logger. The event @@ -96,7 +96,7 @@ - + Delete an event handler from the error logger.

Deletes an event handler from the error logger by calling @@ -108,9 +108,9 @@ - - - + + + Log a standard error event.

Log a standard error event. The Format @@ -142,7 +142,7 @@ ok - + Log a standard error event.

Log a standard error event. Error logger forwards the event @@ -169,7 +169,7 @@ ok - + Log a user-defined error event.

Log a user-defined error event. Error logger forwards the @@ -211,8 +211,8 @@ ok - - + + Log a standard information event.

Log a standard information event. The Format @@ -244,7 +244,7 @@ ok - + Log a standard information event.

Log a standard information event. Error logger forwards the @@ -271,7 +271,7 @@ ok - + Log a user-defined information event.

Log a user-defined information event. Error logger forwards @@ -294,9 +294,9 @@ ok - - - + + + Enable or disable error printouts to a file. @@ -346,7 +346,7 @@ ok - + Enable or disable printouts to the terminal.

Enables (Flag == true) or disables @@ -363,7 +363,7 @@ ok - + Return the current mapping for warning events.

Returns the current mapping for warning events. Events sent @@ -400,8 +400,8 @@ ok - - + + Log a standard warning event.

Log a standard warning event. The Format @@ -429,7 +429,7 @@ ok - + Log a standard warning event.

Log a standard warning event. Error logger forwards the event @@ -446,7 +446,7 @@ ok - + Log a user-defined warning event.

Log a user-defined warning event. Error logger forwards the diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml index 87ac8071c6..fc25e83d40 100644 --- a/lib/kernel/doc/src/file.xml +++ b/lib/kernel/doc/src/file.xml @@ -28,7 +28,7 @@ - file + file File interface module.

This module provides an interface to the file system.

@@ -209,7 +209,7 @@ - + Change group of a file.

Changes group of a file. See @@ -225,7 +225,7 @@ - + Change owner of a file.

Changes owner of a file. See @@ -233,7 +233,7 @@ - + Change owner and group of a file.

Changes owner and group of a file. See @@ -241,7 +241,7 @@ - + Change the modification time of a file.

Changes the modification and access times of a file. See @@ -249,7 +249,7 @@ - + Change the modification and last access time of a file.

Changes the modification and last access times of a file. See @@ -257,7 +257,7 @@ - + Close a file.

Closes the file referenced by IoDevice. It mostly @@ -270,7 +270,7 @@ - + Read Erlang terms from a file.

Reads Erlang terms, separated by '.', from @@ -308,8 +308,8 @@ f.txt: {person, "kalle", 25}. - - + + Copy file contents.

Copies ByteCount bytes from @@ -369,7 +369,7 @@ f.txt: {person, "kalle", 25}. - + Delete a directory.

Tries to delete directory Dir. @@ -405,7 +405,7 @@ f.txt: {person, "kalle", 25}. - + Delete a file.

Tries to delete file Filename. @@ -442,7 +442,7 @@ f.txt: {person, "kalle", 25}. - + Evaluate Erlang expressions in a file.

Reads and evaluates Erlang expressions, separated by '.' (or @@ -476,7 +476,7 @@ f.txt: {person, "kalle", 25}. - + Evaluate Erlang expressions in a file.

The same as eval/1, but the variable bindings @@ -486,7 +486,7 @@ f.txt: {person, "kalle", 25}. - + Return a descriptive string for an error reason.

Given the error reason returned by any function in this @@ -494,7 +494,7 @@ f.txt: {person, "kalle", 25}. - + Get the current working directory.

Returns {ok, Dir}, where Dir @@ -516,7 +516,7 @@ f.txt: {person, "kalle", 25}. - + Get the current working directory for the specified drive.

Returns {ok, Dir} or @@ -547,7 +547,7 @@ f.txt: {person, "kalle", 25}. - + List files in a directory.

Lists all files in a directory, except files @@ -603,7 +603,7 @@ f.txt: {person, "kalle", 25}. - + Make a directory.

Tries to create directory Dir. Missing parent @@ -637,7 +637,7 @@ f.txt: {person, "kalle", 25}. - + Make a hard link to a file.

Makes a hard link from Existing to @@ -666,7 +666,7 @@ f.txt: {person, "kalle", 25}. - + Make a symbolic link to a file or directory.

Creates a symbolic link New to @@ -714,7 +714,7 @@ f.txt: {person, "kalle", 25}. - + Open a file.

Opens file File in the mode determined @@ -997,7 +997,7 @@ f.txt: {person, "kalle", 25}. - + Read Erlang terms from a file.

Searches the path Path (a list of directory @@ -1039,7 +1039,7 @@ f.txt: {person, "kalle", 25}. - + Evaluate Erlang expressions in a file.

Searches the path Path (a list of directory @@ -1085,7 +1085,7 @@ f.txt: {person, "kalle", 25}. - + Open a file.

Searches the path Path (a list of directory @@ -1114,7 +1114,7 @@ f.txt: {person, "kalle", 25}. - + Evaluate and return the value of Erlang expressions in a file.

Searches the path Path (a list of directory @@ -1158,7 +1158,7 @@ f.txt: {person, "kalle", 25}. - + Evaluate and return the value of Erlang expressions in a file.

The same as path_script/2 but the variable bindings @@ -1168,7 +1168,7 @@ f.txt: {person, "kalle", 25}. - + Return the name of the file handled by a pid.

If Pid is an I/O device, that is, a pid returned from @@ -1193,7 +1193,7 @@ f.txt: {person, "kalle", 25}. - + Set position in a file.

Sets the position of the file referenced by IoDevice @@ -1245,7 +1245,7 @@ f.txt: {person, "kalle", 25}. - + Read from a file at certain positions.

Performs a sequence of pread/3 in one operation, @@ -1263,7 +1263,7 @@ f.txt: {person, "kalle", 25}. - + Read from a file at a certain position.

Combines position/2 and read/2 in one @@ -1283,7 +1283,7 @@ f.txt: {person, "kalle", 25}. - + Write to a file at certain positions.

Performs a sequence of pwrite/3 in one operation, @@ -1298,7 +1298,7 @@ f.txt: {person, "kalle", 25}. - + Write to a file at a certain position.

Combines position/2 and write/2 in one @@ -1317,7 +1317,7 @@ f.txt: {person, "kalle", 25}. - + Read from a file.

Reads Number bytes/characters from the file @@ -1371,7 +1371,7 @@ f.txt: {person, "kalle", 25}. - + Read a file.

Returns {ok, Binary}, where @@ -1407,7 +1407,7 @@ f.txt: {person, "kalle", 25}. - + Retrieve information about a file. @@ -1562,7 +1562,7 @@ f.txt: {person, "kalle", 25}. - + Read a line from a file.

Reads a line of bytes/characters from the file referenced by @@ -1619,7 +1619,7 @@ f.txt: {person, "kalle", 25}. - + See what a link is pointing to.

Returns @@ -1677,7 +1677,7 @@ f.txt: {person, "kalle", 25}. - + Retrieve information about a link or file. @@ -1699,7 +1699,7 @@ f.txt: {person, "kalle", 25}. - + Rename a file.

Tries to rename the file Source to @@ -1762,7 +1762,7 @@ f.txt: {person, "kalle", 25}. - + Evaluate and return the value of Erlang expressions in a file.

Reads and evaluates Erlang expressions, separated by '.' (or @@ -1797,7 +1797,7 @@ f.txt: {person, "kalle", 25}. - + Evaluate and return the value of Erlang expressions in a file.

The same as script/1 but the variable bindings @@ -1843,7 +1843,7 @@ f.txt: {person, "kalle", 25}. - + Set the current working directory.

Sets the current working directory of the file server to @@ -1890,7 +1890,7 @@ f.txt: {person, "kalle", 25}. - + Synchronize the in-memory state of a file with that on the physical medium.

Ensures that any buffers kept by the operating system @@ -1906,7 +1906,7 @@ f.txt: {person, "kalle", 25}. - + Truncate a file.

Truncates the file referenced by IoDevice at @@ -1915,7 +1915,7 @@ f.txt: {person, "kalle", 25}. - + Write to a file.

Writes Bytes to the file referenced by @@ -1941,7 +1941,7 @@ f.txt: {person, "kalle", 25}. - + Write a file.

Writes the contents of the iodata term Bytes @@ -1978,7 +1978,7 @@ f.txt: {person, "kalle", 25}. - + Write a file.

Same as write_file/2, but takes a third argument @@ -1989,7 +1989,7 @@ f.txt: {person, "kalle", 25}. - + Change file information. diff --git a/lib/kernel/doc/src/gen_sctp.xml b/lib/kernel/doc/src/gen_sctp.xml index 591079aef8..1e7009b3a8 100644 --- a/lib/kernel/doc/src/gen_sctp.xml +++ b/lib/kernel/doc/src/gen_sctp.xml @@ -32,7 +32,7 @@ A gen_sctp.xml - gen_sctp + gen_sctp Functions for communicating with sockets using the SCTP protocol. @@ -100,7 +100,7 @@ - + Abnormally terminate the association specified by Assoc, without flushing of unsent data. @@ -113,7 +113,7 @@ - + Close the socket and all associations on it.

Closes the socket and all associations on it. The unsent @@ -128,7 +128,7 @@ - + Same as connect(Socket, Addr, Port, Opts, infinity).

Same as connect(Socket, Addr, @@ -137,7 +137,7 @@ - + Establish a new association for socket Socket, with a peer (SCTP server socket). @@ -248,7 +248,7 @@ connect(Socket, Ip, Port>, - + Assign a new controlling process pid to the socket.

Assigns a new controlling process Pid to @@ -259,7 +259,7 @@ connect(Socket, Ip, Port>, - + Gracefully terminate the association specified by Assoc, with flushing of all unsent data. @@ -272,7 +272,7 @@ connect(Socket, Ip, Port>, - + Translate an SCTP error number into a string.

Translates an SCTP error number from, for example, @@ -283,8 +283,8 @@ connect(Socket, Ip, Port>, - - + + Set up a socket to listen.

Sets up a socket to listen on the IP address and port number @@ -300,10 +300,10 @@ connect(Socket, Ip, Port>, - - - - + + + + Create an SCTP socket and binds it to local addresses.

Creates an SCTP socket and binds it to the local addresses @@ -387,8 +387,8 @@ connect(Socket, Ip, Port>, - - + + Receive a message from a socket.

Receives the Data message from any association @@ -532,7 +532,7 @@ connect(Socket, Ip, Port>, - + Send a message using an #sctp_sndrcvinfo{}record.

Sends the Data message with all sending @@ -547,7 +547,7 @@ connect(Socket, Ip, Port>, - + Send a message over an existing association and specified stream. diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml index 24d63693fd..fc16473393 100644 --- a/lib/kernel/doc/src/gen_tcp.xml +++ b/lib/kernel/doc/src/gen_tcp.xml @@ -27,7 +27,7 @@ 1997-10-24 A - gen_tcp + gen_tcp Interface to TCP/IP sockets.

This module provides functions for communicating @@ -116,8 +116,8 @@ do_recv(Sock, Bs) -> - - + + Accept an incoming connection request on a listening socket. Returned by listen/2. @@ -163,7 +163,7 @@ do_recv(Sock, Bs) -> - + Close a TCP socket.

Closes a TCP socket.

@@ -188,8 +188,8 @@ do_recv(Sock, Bs) -> - - + + Connect to a TCP port.

Connects to a server on TCP port Port on the host @@ -268,7 +268,7 @@ do_recv(Sock, Bs) -> - + Change controlling process of a socket.

Assigns a new controlling process Pid to @@ -292,7 +292,7 @@ do_recv(Sock, Bs) -> - + Set up a socket to listen on a port.

Sets up a socket to listen on port Port on @@ -349,8 +349,8 @@ do_recv(Sock, Bs) -> - - + + Receive a packet from a passive socket. See the description of HttpPacket in @@ -375,7 +375,7 @@ do_recv(Sock, Bs) -> - + Send a packet.

Sends a packet on a socket.

@@ -386,7 +386,7 @@ do_recv(Sock, Bs) -> - + Asynchronously close a socket.

Closes a socket in one or two directions.

diff --git a/lib/kernel/doc/src/gen_udp.xml b/lib/kernel/doc/src/gen_udp.xml index 840ca3c188..d20fc1fdfd 100644 --- a/lib/kernel/doc/src/gen_udp.xml +++ b/lib/kernel/doc/src/gen_udp.xml @@ -28,7 +28,7 @@ 1997-12-03 A - gen_udp + gen_udp Interface to UDP sockets.

This module provides functions for communicating @@ -53,7 +53,7 @@ - + Close a UDP socket.

Closes a UDP socket.

@@ -61,7 +61,7 @@ - + Change controlling process of a socket.

Assigns a new controlling process Pid to @@ -77,8 +77,8 @@ - - + + Associate a UDP port number with the process calling it.

Associates a UDP port number (Port) with the @@ -189,8 +189,8 @@ - - + + Receive a packet from a passive socket.

@@ -213,7 +213,7 @@ - + Send a packet.

diff --git a/lib/kernel/doc/src/global.xml b/lib/kernel/doc/src/global.xml index 4442741f54..dfe71de5ce 100644 --- a/lib/kernel/doc/src/global.xml +++ b/lib/kernel/doc/src/global.xml @@ -28,7 +28,7 @@ 1997-11-17 - global + global A global name registration facility.

This module consists of the following services:

@@ -100,8 +100,8 @@ - - + + Delete a lock.

Deletes the lock Id synchronously.

@@ -109,7 +109,7 @@ - + Name resolving function that notifies both pids.

Can be used as a name resolving function for @@ -123,7 +123,7 @@ - + Name resolving function that kills one pid.

Can be used as a name resolving function for @@ -136,7 +136,7 @@ - + Name resolving function that notifies one pid.

Can be used as a name resolving function for @@ -150,8 +150,8 @@ - - + + Atomically re-register a name. {Module, Function} @@ -167,8 +167,8 @@ - - + + Globally register a name for a pid. {Module, Function} is also @@ -221,7 +221,7 @@ - + All globally registered names.

Returns a list of all globally registered names.

@@ -229,7 +229,7 @@ - + Send a message to a globally registered pid.

Sends message Msg to the pid globally registered @@ -241,9 +241,9 @@ - - - + + + Set a lock on the specified nodes. @@ -287,7 +287,7 @@ - + Synchronize the global name server.

Synchronizes the global name server with all nodes known to @@ -302,9 +302,9 @@ - - - + + + Micro transaction facility. @@ -322,7 +322,7 @@ - + Remove a globally registered name for a pid.

Removes the globally registered name Name from @@ -331,7 +331,7 @@ - + Get the pid with a specified globally registered name.

Returns the pid with the globally registered name diff --git a/lib/kernel/doc/src/global_group.xml b/lib/kernel/doc/src/global_group.xml index 8f947b9adf..74d15cd476 100644 --- a/lib/kernel/doc/src/global_group.xml +++ b/lib/kernel/doc/src/global_group.xml @@ -28,7 +28,7 @@ 1998-12-18 B - global_group + global_group Grouping nodes to global name registration groups.

This module makes it possible to partition the nodes of a @@ -105,7 +105,7 @@ - + Return the global group names.

Returns a tuple containing the name of the global group that @@ -116,7 +116,7 @@ - + Information about global groups. @@ -173,7 +173,7 @@ - + Subscribe to node status changes.

Depending on Flag, the calling process @@ -187,7 +187,7 @@ - + Return the group nodes.

Returns the names of all group nodes, regardless of their @@ -196,7 +196,7 @@ - + Return globally registered names.

Returns a list of all names that are globally registered @@ -205,8 +205,8 @@ - - + + Send a message to a globally registered pid.

Searches for Name, globally registered on @@ -224,7 +224,7 @@ - + Synchronize the group nodes.

Synchronizes the group nodes, that is, the global name @@ -242,8 +242,8 @@ - - + + Get the pid with a specified globally registered name.

Searches for Name, globally registered on diff --git a/lib/kernel/doc/src/heart.xml b/lib/kernel/doc/src/heart.xml index 8c4fcbaacd..4243b1ffe8 100644 --- a/lib/kernel/doc/src/heart.xml +++ b/lib/kernel/doc/src/heart.xml @@ -28,7 +28,7 @@ 1998-01-28 A - heart + heart Heartbeat monitoring of an Erlang runtime system.

This modules contains the interface to the heart process. @@ -119,7 +119,7 @@ - + Set a temporary reboot command.

Sets a temporary reboot command. This command is used if @@ -136,7 +136,7 @@ - + Clear the temporary boot command.

Clears the temporary boot command. If the system terminates, @@ -145,7 +145,7 @@ - + Get the temporary reboot command.

Gets the temporary reboot command. If the command is cleared, diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index 8e7ca99084..104c698591 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -28,7 +28,7 @@ 1998-02-04 A - inet + inet Access to TCP/IP protocols.

This module provides access to TCP/IP protocols.

@@ -298,7 +298,7 @@ fe80::204:acff:fe17:bf38 - + Close a socket of any type.

Closes a socket of any type.

@@ -306,7 +306,7 @@ fe80::204:acff:fe17:bf38 - + Return a descriptive string for an error reason.

Returns a diagnostic error string. For possible POSIX values and @@ -316,7 +316,7 @@ fe80::204:acff:fe17:bf38 - + Return a list of IP configuration parameters.

@@ -335,7 +335,7 @@ fe80::204:acff:fe17:bf38 - + Return the IP address for a host.

Returns the IP address for Host as a tuple of @@ -345,7 +345,7 @@ fe80::204:acff:fe17:bf38 - + Return the IP addresses for a host.

Returns a list of all IP addresses for Host. @@ -355,7 +355,7 @@ fe80::204:acff:fe17:bf38 - + Return a hostent record for the host with the specified address. @@ -364,7 +364,7 @@ fe80::204:acff:fe17:bf38 - + Return a hostent record for the host with the specified name. @@ -376,7 +376,7 @@ fe80::204:acff:fe17:bf38 - + Return a hostent record for the host with the specified name. @@ -386,7 +386,7 @@ fe80::204:acff:fe17:bf38 - + Return the local hostname.

Returns the local hostname. Never fails.

@@ -459,7 +459,7 @@ fe80::204:acff:fe17:bf38 - + Get one or more options for a socket.

Gets one or more options for a socket. For a list of available @@ -529,8 +529,8 @@ get_tcpi_sacked(Sock) -> - - + + Get one or more statistic options for a socket. @@ -728,7 +728,7 @@ get_tcpi_sacked(Sock) -> - + Return the address and port for the other end of a connection. @@ -774,7 +774,7 @@ get_tcpi_sacked(Sock) -> - + Return the local port number for a socket.

Returns the local port number for a socket.

@@ -782,7 +782,7 @@ get_tcpi_sacked(Sock) -> - + Set one or more options for a socket.

Sets one or more options for a socket.

@@ -1486,7 +1486,7 @@ inet:setopts(Sock,[{raw,6,8,<<30:32/native>>}]),]]> - + Return the local address and port number for a socket. diff --git a/lib/kernel/doc/src/inet_res.xml b/lib/kernel/doc/src/inet_res.xml index 351d86a93a..1904e371f7 100644 --- a/lib/kernel/doc/src/inet_res.xml +++ b/lib/kernel/doc/src/inet_res.xml @@ -28,7 +28,7 @@ 2009-09-11 A - inet_res + inet_res A rudimentary DNS client.

This module performs DNS name resolving to recursive name servers.

@@ -185,8 +185,8 @@ inet_dns:record_type(_) -> undefined. - - + + Resolve a DNS record of the specified type for the specified host. @@ -205,8 +205,8 @@ inet_dns:record_type(_) -> undefined. - - + + Return a hostent record for the host with the specified address. @@ -217,9 +217,9 @@ inet_dns:record_type(_) -> undefined. - - - + + + Return a hostent record for the host with the specified name. @@ -235,9 +235,9 @@ inet_dns:record_type(_) -> undefined. - - - + + + Resolve the DNS data for the record of the specified type and class for the specified name. @@ -257,9 +257,9 @@ inet_dns:record_type(_) -> undefined. - - - + + + Resolve a DNS record of the specified type and class for the specified name. @@ -326,9 +326,9 @@ example_lookup(Name, Class, Type) -> - - - + + + Resolve a DNS record of the specified type and class for the specified name. @@ -344,8 +344,8 @@ example_lookup(Name, Class, Type) -> - - + + Resolve a DNS record of the specified type and class for the specified name. diff --git a/lib/kernel/doc/src/net_adm.xml b/lib/kernel/doc/src/net_adm.xml index 6957a3b5e4..c3e1619f1b 100644 --- a/lib/kernel/doc/src/net_adm.xml +++ b/lib/kernel/doc/src/net_adm.xml @@ -28,7 +28,7 @@ 1996-09-10 A - net_adm + net_adm Various Erlang net administration routines.

This module contains various network utility functions.

@@ -36,7 +36,7 @@ - + Official name of a host.

Returns the official name of Host, or @@ -46,7 +46,7 @@ - + Read file .hosts.erlang.

Reads file .hosts.erlang, see section @@ -58,7 +58,7 @@ - + Name of the local host.

Returns the name of the local host. If Erlang was started @@ -68,8 +68,8 @@ - - + + Names of Erlang nodes at a host.

Similar to epmd -names, see @@ -86,7 +86,7 @@ - + Set up a connection to a node.

Sets up a connection to Node. Returns @@ -95,8 +95,8 @@ - - + + Lookup and connect to all nodes at all hosts in .hosts.erlang. @@ -117,8 +117,8 @@ - - + + Lookup and connect to all nodes at specified hosts. diff --git a/lib/kernel/doc/src/net_kernel.xml b/lib/kernel/doc/src/net_kernel.xml index 1ed5d5cca1..419d3cad84 100644 --- a/lib/kernel/doc/src/net_kernel.xml +++ b/lib/kernel/doc/src/net_kernel.xml @@ -28,7 +28,7 @@ 1996-09-10 A - net_kernel + net_kernel Erlang networking kernel.

The net kernel is a system process, registered as @@ -81,7 +81,7 @@ $ erl -sname foobar - + Permit access to a specified set of nodes

Permits access to the specified set of nodes.

@@ -98,7 +98,7 @@ $ erl -sname foobar - + Establish a connection to a node.

Establishes a connection to Node. Returns @@ -110,7 +110,7 @@ $ erl -sname foobar - + Get net_ticktime.

Gets net_ticktime (see @@ -146,8 +146,8 @@ $ erl -sname foobar - - + + Subscribe to node status change messages.

The calling process subscribes or unsubscribes to node @@ -267,8 +267,8 @@ $ erl -sname foobar - - + + Set net_ticktime.

Sets net_ticktime (see @@ -345,9 +345,9 @@ $ erl -sname foobar - start([Name]) -> {ok, pid()} | {error, Reason} - start([Name, NameType]) -> {ok, pid()} | {error, Reason} - start([Name, NameType, Ticktime]) -> {ok, pid()} | {error, Reason} + start([Name]) -> {ok, pid()} | {error, Reason} + start([Name, NameType]) -> {ok, pid()} | {error, Reason} + start([Name, NameType, Ticktime]) -> {ok, pid()} | {error, Reason} Turn an Erlang runtime system into a distributed node. Name = atom() @@ -364,7 +364,7 @@ $ erl -sname foobar - + Turn a node into a non-distributed Erlang runtime system.

Turns a distributed node into a non-distributed node. For diff --git a/lib/kernel/doc/src/os.xml b/lib/kernel/doc/src/os.xml index 9bd859452c..0500e4cfb3 100644 --- a/lib/kernel/doc/src/os.xml +++ b/lib/kernel/doc/src/os.xml @@ -28,7 +28,7 @@ - os + os Operating system-specific functions.

The functions in this module are operating system-specific. @@ -134,7 +134,7 @@ - + Execute a command in a shell of the target OS. @@ -173,8 +173,8 @@ DirOut = os:cmd("dir"), % on Win32 platform - - + + Absolute filename of a program.

These two functions look up an executable program, with the @@ -190,7 +190,7 @@ DirOut = os:cmd("dir"), % on Win32 platform - + List all environment variables.

Returns a list of all environment variables. @@ -205,7 +205,7 @@ DirOut = os:cmd("dir"), % on Win32 platform - + Get the value of an environment variable.

Returns the Value of the environment variable @@ -235,7 +235,7 @@ DirOut = os:cmd("dir"), % on Win32 platform - + Return the process identifier of the emulator process. @@ -251,7 +251,7 @@ DirOut = os:cmd("dir"), % on Win32 platform - + Set a new value for an environment variable.

Sets a new Value for environment variable @@ -332,7 +332,7 @@ DirOut = os:cmd("dir"), % on Win32 platform - + Current OS system time on the erlang:timestamp/0 format. Timestamp = {MegaSecs, Secs, MicroSecs} @@ -397,7 +397,7 @@ calendar:now_to_universal_time(TS), - + Return the OS family and, in some cases, the OS name of the current OS. @@ -429,7 +429,7 @@ calendar:now_to_universal_time(TS), - + Return the OS versions.

Returns the OS version. diff --git a/lib/kernel/doc/src/pg2.xml b/lib/kernel/doc/src/pg2.xml index 0631b317b4..058d711756 100644 --- a/lib/kernel/doc/src/pg2.xml +++ b/lib/kernel/doc/src/pg2.xml @@ -32,7 +32,7 @@ A2 pg2.xml - pg2 + pg2 Distributed named process groups.

This module implements process groups. Each message can be sent @@ -66,7 +66,7 @@ - + Create a new, empty process group.

Creates a new, empty process group. The group is globally @@ -75,7 +75,7 @@ - + Delete a process group.

Deletes a process group.

@@ -83,7 +83,7 @@ - + Common dispatch function.

A useful dispatch function that can be used from @@ -93,7 +93,7 @@ - + Return all local processes in a group.

Returns all processes running on the local node in the @@ -104,7 +104,7 @@ - + Return all processes in a group.

Returns all processes in the group Name. This @@ -114,7 +114,7 @@ - + Join a process to a group.

Joins the process Pid to the group Name. @@ -124,7 +124,7 @@ - + Make a process leave a group.

Makes the process Pid leave the group Name. @@ -134,8 +134,8 @@ - - + + Start the pg2 server.

Starts the pg2 server. Normally, the server does not need @@ -149,7 +149,7 @@ - + Return a list of all known groups.

Returns a list of all known groups.

diff --git a/lib/kernel/doc/src/rpc.xml b/lib/kernel/doc/src/rpc.xml index fab616e630..c55454506e 100644 --- a/lib/kernel/doc/src/rpc.xml +++ b/lib/kernel/doc/src/rpc.xml @@ -28,7 +28,7 @@ 1996-09-10 A - rpc + rpc Remote Procedure Call services.

This module contains services similar to Remote @@ -51,7 +51,7 @@ - + Broadcast a message asynchronously to a registered process on all nodes. @@ -61,7 +61,7 @@ - + Broadcast a message asynchronously to a registered process on specific nodes. @@ -72,7 +72,7 @@ - + Evaluate a function call on a node, asynchronous version. @@ -98,7 +98,7 @@ - + Evaluate a function call on a node in the RPC server's context. @@ -115,7 +115,7 @@ - + Evaluate a function call on a node in the RPC server's context. @@ -127,7 +127,7 @@ - + Evaluate a function call on a node.

Evaluates apply(Module, Function, @@ -138,7 +138,7 @@ - + Evaluate a function call on a node.

Evaluates apply(Module, Function, @@ -158,7 +158,7 @@ - + Run a function on a node ignoring the result.

Evaluates apply(Module, Function, @@ -171,7 +171,7 @@ - + Run a function on all nodes, ignoring the result.

Equivalent to eval_everywhere([node()|nodes()], @@ -181,7 +181,7 @@ - + Run a function on specific nodes, ignoring the result. @@ -192,7 +192,7 @@ - + Interact with the servers on a number of nodes.

Equivalent to multi_server_call([node()|nodes()], @@ -201,7 +201,7 @@ - + Interact with the servers on a number of nodes.

Can be used when interacting with servers called @@ -224,7 +224,7 @@ - + Evaluate a function call on a number of nodes.

Equivalent to multicall([node()|nodes()], Module, @@ -233,7 +233,7 @@ - + Evaluate a function call on a number of nodes.

Equivalent to multicall(Nodes, Module, @@ -242,7 +242,7 @@ - + Evaluate a function call on a number of nodes.

Equivalent to multicall([node()|nodes()], Module, @@ -252,7 +252,7 @@ - + Evaluate a function call on a number of nodes.

In contrast to an RPC, a multicall is an RPC that is sent @@ -288,7 +288,7 @@ - + Deliver the result of evaluating a function call on a node (non-blocking). @@ -297,7 +297,7 @@ - + Deliver the result of evaluating a function call on a node (non-blocking). @@ -315,7 +315,7 @@ - + Evaluate many function calls on all nodes in parallel. @@ -328,7 +328,7 @@ - + Information about a process.

Location transparent version of the BIF @@ -337,8 +337,8 @@ - - + + Information about a process.

Location transparent version of the BIF @@ -347,7 +347,7 @@ - + Parallel evaluation of mapping a function over a list. @@ -360,7 +360,7 @@ - + Broadcast a message synchronously to a registered process on all nodes. @@ -370,7 +370,7 @@ - + Broadcast a message synchronously to a registered process on specific nodes. @@ -391,7 +391,7 @@ - + Interact with a server on a node.

Can be used when interacting with a server called @@ -410,7 +410,7 @@ - + Deliver the result of evaluating a function call on a node (blocking). diff --git a/lib/kernel/doc/src/seq_trace.xml b/lib/kernel/doc/src/seq_trace.xml index 1a4a74419a..aa29223dd0 100644 --- a/lib/kernel/doc/src/seq_trace.xml +++ b/lib/kernel/doc/src/seq_trace.xml @@ -28,7 +28,7 @@ 1998-04-16 A - seq_trace + seq_trace Sequential tracing of messages.

Sequential tracing makes it possible to trace all messages @@ -51,7 +51,7 @@ - + Set the trace token

Sets the trace token for the calling process to Token. @@ -71,7 +71,7 @@ seq_trace:set_token(OldToken), % activate the trace token again - + Set a component of the trace token @@ -158,7 +158,7 @@ seq_trace:set_token(OldToken), % activate the trace token again - + Return the value of the trace token

Returns the value of the trace token for the calling process. @@ -169,7 +169,7 @@ seq_trace:set_token(OldToken), % activate the trace token again - + Return the value of a trace token component @@ -182,7 +182,7 @@ seq_trace:set_token(OldToken), % activate the trace token again - + Put the Erlang term TraceInfointo the sequential trace output

Puts the Erlang term TraceInfo into the sequential @@ -192,7 +192,7 @@ seq_trace:set_token(OldToken), % activate the trace token again - + Put the Erlang term TraceInfointo the sequential trace output

Same as print/1 with the additional condition that @@ -201,7 +201,7 @@ seq_trace:set_token(OldToken), % activate the trace token again - + Stop all sequential tracing on the local node

Sets the trace token to empty for all processes on the @@ -213,7 +213,7 @@ seq_trace:set_token(OldToken), % activate the trace token again - + Set the system tracer @@ -227,7 +227,7 @@ seq_trace:set_token(OldToken), % activate the trace token again - + Return the pid() or port() of the current system tracer. diff --git a/lib/kernel/doc/src/wrap_log_reader.xml b/lib/kernel/doc/src/wrap_log_reader.xml index 7fb9c1c023..5f37e7ec5f 100644 --- a/lib/kernel/doc/src/wrap_log_reader.xml +++ b/lib/kernel/doc/src/wrap_log_reader.xml @@ -32,7 +32,7 @@ A wrap_log_reader.sgml - wrap_log_reader + wrap_log_reader A service to read internally formatted wrap disk logs. @@ -65,8 +65,8 @@ - - + + Read a chunk of objects written to a wrap log. @@ -105,7 +105,7 @@ - + Close a log.

Closes a log file properly.

@@ -113,8 +113,8 @@ - - + + Open a log file. diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml index d4a7451bfc..c7bcdfcd6f 100644 --- a/lib/megaco/doc/src/megaco.xml +++ b/lib/megaco/doc/src/megaco.xml @@ -32,7 +32,7 @@ %VSN% megaco.xml - megaco + megaco Main API of the Megaco application

Interface module for the Megaco application

@@ -135,7 +135,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - start() -> ok | {error, Reason} + start() -> ok | {error, Reason} Starts the Megaco application Reason = term() @@ -153,7 +153,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - stop() -> ok | {error, Reason} + stop() -> ok | {error, Reason} Stops the Megaco application Reason = term() @@ -166,7 +166,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - start_user(UserMid, Config) -> ok | {error, Reason} + start_user(UserMid, Config) -> ok | {error, Reason} Initial configuration of a user UserMid = megaco_mid() @@ -188,7 +188,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - stop_user(UserMid) -> ok | {error, Reason} + stop_user(UserMid) -> ok | {error, Reason} Delete the configuration of a user UserMid = megaco_mid() @@ -203,8 +203,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - user_info(UserMid) -> [{Item, Value}] - user_info(UserMid, Item) -> Value | exit(Reason) + user_info(UserMid) -> [{Item, Value}] + user_info(UserMid, Item) -> Value | exit(Reason) Lookup user information Handle = user_info_handle() @@ -703,7 +703,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - update_user_info(UserMid, Item, Value) -> ok | {error, Reason} + update_user_info(UserMid, Item, Value) -> ok | {error, Reason} Update information about a user UserMid = megaco_mid() @@ -721,8 +721,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - conn_info(ConnHandle) -> [{Item, Value}] - conn_info(ConnHandle, Item) -> Value | exit(Reason) + conn_info(ConnHandle) -> [{Item, Value}] + conn_info(ConnHandle, Item) -> Value | exit(Reason) Lookup information about an active connection ConnHandle = #megaco_conn_handle{} @@ -1222,7 +1222,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - update_conn_info(ConnHandle, Item, Value) -> ok | {error, Reason} + update_conn_info(ConnHandle, Item, Value) -> ok | {error, Reason} Update information about an active connection ConnHandle = #megaco_conn_handle{} @@ -1241,8 +1241,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - system_info() -> [{Item, Value}] | exit(Reason) - system_info(Item) -> Value | exit(Reason) + system_info() -> [{Item, Value}] | exit(Reason) + system_info(Item) -> Value | exit(Reason) Lookup system information Item = system_info_item() @@ -1289,7 +1289,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - info() -> Info + info() -> Info All the information of the application Info = [{Key, Value}] @@ -1311,8 +1311,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid) -> {ok, ConnHandle} | {error, Reason} - connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid, Extra) -> {ok, ConnHandle} | {error, Reason} + connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid) -> {ok, ConnHandle} | {error, Reason} + connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid, Extra) -> {ok, ConnHandle} | {error, Reason} Establish a "virtual" connection ReceiveHandle = #megaco_receive_handle{} @@ -1436,7 +1436,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - disconnect(ConnHandle, DiscoReason) -> ok | {error, ErrReason} + disconnect(ConnHandle, DiscoReason) -> ok | {error, ErrReason} Tear down a "virtual" connection ConnHandle = conn_handle() @@ -1454,7 +1454,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - call(ConnHandle, Actions, Options) -> {ProtocolVersion, UserReply} + call(ConnHandle, Actions, Options) -> {ProtocolVersion, UserReply} Sends one or more transaction request(s) and waits for the reply ConnHandle = conn_handle() @@ -1545,7 +1545,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - cast(ConnHandle, Actions, Options) -> ok | {error, Reason} + cast(ConnHandle, Actions, Options) -> ok | {error, Reason} Sends one or more transaction request(s) but does NOT wait for a reply ConnHandle = conn_handle() @@ -1582,7 +1582,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - encode_actions(ConnHandle, Actions, Options) -> {ok, BinOrBins} | {error, Reason} + encode_actions(ConnHandle, Actions, Options) -> {ok, BinOrBins} | {error, Reason} Encode action requests for one or more transaction request(s) ConnHandle = conn_handle() @@ -1607,9 +1607,9 @@ megaco_incr_timer() = #megaco_incr_timer{} - token_tag2string(Tag) -> Result - token_tag2string(Tag, EncoderMod) -> Result - token_tag2string(Tag, EncoderMod, Version) -> Result + token_tag2string(Tag) -> Result + token_tag2string(Tag, EncoderMod) -> Result + token_tag2string(Tag, EncoderMod, Version) -> Result Convert a token tag to a string Tag = atom() @@ -1635,7 +1635,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - cancel(ConnHandle, CancelReason) -> ok | {error, ErrReason} + cancel(ConnHandle, CancelReason) -> ok | {error, ErrReason} Cancel all outstanding messages for this connection ConnHandle = conn_handle() @@ -1655,8 +1655,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok - process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok + process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok + process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok Process a received message ReceiveHandle = #megaco_receive_handle{} @@ -1755,8 +1755,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok - receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok + receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok + receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok Process a received message ReceiveHandle = #megaco_receive_handle{} @@ -1783,7 +1783,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - parse_digit_map(DigitMapBody) -> {ok, ParsedDigitMap} | {error, Reason} + parse_digit_map(DigitMapBody) -> {ok, ParsedDigitMap} | {error, Reason} Parses a digit map body DigitMapBody = string() @@ -1802,8 +1802,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - eval_digit_map(DigitMap) -> {ok, MatchResult} | {error, Reason} - eval_digit_map(DigitMap, Timers) -> {ok, MatchResult} | {error, Reason} + eval_digit_map(DigitMap) -> {ok, MatchResult} | {error, Reason} + eval_digit_map(DigitMap, Timers) -> {ok, MatchResult} | {error, Reason} Collect digit map letters according to the digit map DigitMap = #'DigitMapValue'{} | parsed_digit_map() @@ -1839,7 +1839,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - report_digit_event(DigitMapEvalPid, Events) -> ok | {error, Reason} + report_digit_event(DigitMapEvalPid, Events) -> ok | {error, Reason} Send one or more events to the event collector process DigitMapEvalPid = pid() @@ -1866,7 +1866,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - test_digit_event(DigitMap, Events) -> {ok, Kind, Letters} | {error, Reason} + test_digit_event(DigitMap, Events) -> {ok, Kind, Letters} | {error, Reason} Feed digit map collector with events and return the result DigitMap = #'DigitMapValue'{} | parsed_digit_map() @@ -1900,7 +1900,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - encode_sdp(SDP) -> {ok, PP} | {error, Reason} + encode_sdp(SDP) -> {ok, PP} | {error, Reason} Encode an SDP construct SDP = sdp_property_parm() | sdp_property_group() | sdp_property_groups() | asn1_NOVALUE @@ -1929,7 +1929,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - decode_sdp(PP) -> {ok, SDP} | {error, Reason} + decode_sdp(PP) -> {ok, SDP} | {error, Reason} Decode an property parameter construct PP = property_parm() | property_group() | property_groups() | asn1_NOVALUE @@ -1969,7 +1969,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - get_sdp_record_from_PropertGroup(Type, PG) -> [sdp()] + get_sdp_record_from_PropertGroup(Type, PG) -> [sdp()] Get all sdp records of a certain type from a property group Type = v | c | m | o | a | b | t | r | z | k | s | i | u | e | p @@ -1986,8 +1986,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - versions1() -> {ok, VersionInfo} | {error, Reason} - versions2() -> {ok, Info} | {error, Reason} + versions1() -> {ok, VersionInfo} | {error, Reason} + versions2() -> {ok, Info} | {error, Reason} Retreive various system and application info VersionInfo = [version_info()] @@ -2007,8 +2007,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - print_version_info() -> void() - print_version_info(VersionInfo) -> void() + print_version_info() -> void() + print_version_info(VersionInfo) -> void() Formated print of result of the versions functions VersionInfo = [version_info()] @@ -2029,7 +2029,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - enable_trace(Level, Destination) -> void() + enable_trace(Level, Destination) -> void() Start megaco tracing Level = max | min | 0 <= integer() <= 100 @@ -2057,7 +2057,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - disable_trace() -> void() + disable_trace() -> void() Stop megaco tracing

This function is used to stop megaco tracing.

@@ -2065,7 +2065,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - set_trace(Level) -> void() + set_trace(Level) -> void() Change megaco trace level Level = max | min | 0 <= integer() <= 100 @@ -2081,10 +2081,10 @@ megaco_incr_timer() = #megaco_incr_timer{} - get_stats() -> {ok, TotalStats} | {error, Reason} - get_stats(GlobalCounter) -> {ok, CounterStats} | {error, Reason} - get_stats(ConnHandle) -> {ok, ConnHandleStats} | {error, Reason} - get_stats(ConnHandle, Counter) -> {ok, integer()} | {error, Reason} + get_stats() -> {ok, TotalStats} | {error, Reason} + get_stats(GlobalCounter) -> {ok, CounterStats} | {error, Reason} + get_stats(ConnHandle) -> {ok, ConnHandleStats} | {error, Reason} + get_stats(ConnHandle, Counter) -> {ok, integer()} | {error, Reason} TotalStats = [total_stats()] @@ -2110,8 +2110,8 @@ megaco_incr_timer() = #megaco_incr_timer{} - reset_stats() -> void() - reset_stats(ConnHandle) -> void() + reset_stats() -> void() + reset_stats(ConnHandle) -> void() ConnHandle = conn_handle() @@ -2123,7 +2123,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - test_request(ConnHandle, Version, EncodingMod, EncodingConfig, Actions) -> {MegaMsg, EncodeRes} + test_request(ConnHandle, Version, EncodingMod, EncodingConfig, Actions) -> {MegaMsg, EncodeRes} Tests if the Actions argument is correct ConnHandle = conn_handle() @@ -2150,7 +2150,7 @@ megaco_incr_timer() = #megaco_incr_timer{} - test_reply(ConnHandle, Version, EncodingMod, EncodingConfig, Reply) -> {MegaMsg, EncodeRes} + test_reply(ConnHandle, Version, EncodingMod, EncodingConfig, Reply) -> {MegaMsg, EncodeRes} Tests if the Reply argument is correct ConnHandle = conn_handle() diff --git a/lib/megaco/doc/src/megaco_codec_meas.xml b/lib/megaco/doc/src/megaco_codec_meas.xml index 13cc3eb834..5184fe392e 100644 --- a/lib/megaco/doc/src/megaco_codec_meas.xml +++ b/lib/megaco/doc/src/megaco_codec_meas.xml @@ -32,7 +32,7 @@ %VSN% megaco_codec_meas.xml - megaco_codec_meas + megaco_codec_meas This module implements a simple megaco codec measurement tool.

This module implements a simple megaco codec measurement tool.

@@ -43,8 +43,8 @@ - start() -> void() - start(MessagePackage) -> void() + start() -> void() + start(MessagePackage) -> void() MessagePackageRaw = message_package() diff --git a/lib/megaco/doc/src/megaco_codec_mstone1.xml b/lib/megaco/doc/src/megaco_codec_mstone1.xml index 2ff959a648..507a790c71 100644 --- a/lib/megaco/doc/src/megaco_codec_mstone1.xml +++ b/lib/megaco/doc/src/megaco_codec_mstone1.xml @@ -32,7 +32,7 @@ %VSN% megaco_codec_mstone1.xml - megaco_codec_mstone1 + megaco_codec_mstone1 This module implements a simple megaco codec-based performance tool.

This module implements the mstone1 tool, @@ -44,9 +44,9 @@ - start() -> void() - start(MessagePackage) -> void() - start(MessagePackage, Factor) -> void() + start() -> void() + start(MessagePackage) -> void() + start(MessagePackage, Factor) -> void() MessagePackage = message_package() @@ -63,9 +63,9 @@ - start_flex() -> void() - start_flex(MessagePackage) -> void() - start_flex(MessagePackage, Factor) -> void() + start_flex() -> void() + start_flex(MessagePackage) -> void() + start_flex(MessagePackage, Factor) -> void() MessagePackage = message_package() @@ -83,9 +83,9 @@ - start_only_drv() -> void() - start_only_drv(MessagePackage) -> void() - start_only_drv(MessagePackage, Factor) -> void() + start_only_drv() -> void() + start_only_drv(MessagePackage) -> void() + start_only_drv(MessagePackage, Factor) -> void() MessagePackage = message_package() @@ -105,9 +105,9 @@ - start_no_drv() -> void() - start_no_drv(MessagePackage) -> void() - start_no_drv(MessagePackage, Factor) -> void() + start_no_drv() -> void() + start_no_drv(MessagePackage) -> void() + start_no_drv(MessagePackage, Factor) -> void() MessagePackage = message_package() diff --git a/lib/megaco/doc/src/megaco_codec_mstone2.xml b/lib/megaco/doc/src/megaco_codec_mstone2.xml index 3da30d4f99..03990f5c3d 100644 --- a/lib/megaco/doc/src/megaco_codec_mstone2.xml +++ b/lib/megaco/doc/src/megaco_codec_mstone2.xml @@ -32,7 +32,7 @@ %VSN% megaco_codec_mstone2.xml - megaco_codec_mstone2 + megaco_codec_mstone2 This module implements a simple megaco codec-based performance tool.

This module implements the mstone2 tool, @@ -44,8 +44,8 @@ - start() -> void() - start(MessagePackage) -> void() + start() -> void() + start(MessagePackage) -> void() MessagePackage = message_package() diff --git a/lib/megaco/doc/src/megaco_codec_transform.xml b/lib/megaco/doc/src/megaco_codec_transform.xml index 26b83c3799..392868fdfa 100644 --- a/lib/megaco/doc/src/megaco_codec_transform.xml +++ b/lib/megaco/doc/src/megaco_codec_transform.xml @@ -32,7 +32,7 @@ %VSN% megaco_codec_transform.xml - megaco_codec_transform + megaco_codec_transform Megaco message transformation utility. @@ -45,8 +45,8 @@ - export_messages() -> void() - export_messages(MessagePackage) -> void() + export_messages() -> void() + export_messages(MessagePackage) -> void() MessagePackage = atom() diff --git a/lib/megaco/doc/src/megaco_edist_compress.xml b/lib/megaco/doc/src/megaco_edist_compress.xml index d5c7c7224d..16443e469c 100644 --- a/lib/megaco/doc/src/megaco_edist_compress.xml +++ b/lib/megaco/doc/src/megaco_edist_compress.xml @@ -32,7 +32,7 @@ %VSN% megaco_edist_compress.xml - megaco_edist_compress + megaco_edist_compress Megaco erlang dist compress behaviour.

The following functions should be exported from a @@ -40,7 +40,7 @@ - Module:encode(R, Version) -> T + Module:encode(R, Version) -> T Encode (compress) a megaco component. R = megaco_message() | transaction() | action_reply() | action_request() | command_request() @@ -53,7 +53,7 @@ - Module:decode(T, Version) -> R + Module:decode(T, Version) -> R Decode (decompress) a megaco component. T = term() diff --git a/lib/megaco/doc/src/megaco_encoder.xml b/lib/megaco/doc/src/megaco_encoder.xml index 13c6ed324b..cc8270440b 100644 --- a/lib/megaco/doc/src/megaco_encoder.xml +++ b/lib/megaco/doc/src/megaco_encoder.xml @@ -32,7 +32,7 @@ %VSN% megaco_encoder.xml - megaco_encoder + megaco_encoder Megaco encoder behaviour.

The following functions should be exported from a @@ -64,7 +64,7 @@ action_reply() = #'ActionReply'{} - Module:encode_message(EncodingConfig, Version, Message) -> {ok, Bin} | Error + Module:encode_message(EncodingConfig, Version, Message) -> {ok, Bin} | Error Encode a megaco message. EncodingConfig = list() @@ -81,7 +81,7 @@ action_reply() = #'ActionReply'{} - Module:decode_message(EncodingConfig, Version, Bin) -> {ok, Message} | Error + Module:decode_message(EncodingConfig, Version, Bin) -> {ok, Message} | Error Decode a megaco message. EncodingConfig = list() @@ -104,7 +104,7 @@ action_reply() = #'ActionReply'{} - Module:decode_mini_message(EncodingConfig, Version, Bin) -> {ok, Message} | Error + Module:decode_mini_message(EncodingConfig, Version, Bin) -> {ok, Message} | Error Perform a minimal decode of a megaco message. EncodingConfig = list() @@ -129,7 +129,7 @@ action_reply() = #'ActionReply'{} - Module:encode_transaction(EncodingConfig, Version, Transaction) -> OK | Error + Module:encode_transaction(EncodingConfig, Version, Transaction) -> OK | Error Encode a megaco transaction. EncodingConfig = list() @@ -155,7 +155,7 @@ action_reply() = #'ActionReply'{} - Module:encode_action_requests(EncodingConfig, Version, ARs) -> OK | Error + Module:encode_action_requests(EncodingConfig, Version, ARs) -> OK | Error Encode megaco action requests. EncodingConfig = list() @@ -181,7 +181,7 @@ action_reply() = #'ActionReply'{} - Module:encode_action_reply(EncodingConfig, Version, AR) -> OK | Error + Module:encode_action_reply(EncodingConfig, Version, AR) -> OK | Error Encode a megaco action reply. EncodingConfig = list() diff --git a/lib/megaco/doc/src/megaco_flex_scanner.xml b/lib/megaco/doc/src/megaco_flex_scanner.xml index 0856f3f429..121a7fbcff 100644 --- a/lib/megaco/doc/src/megaco_flex_scanner.xml +++ b/lib/megaco/doc/src/megaco_flex_scanner.xml @@ -32,7 +32,7 @@ %VSN% megaco_flex_scanner.xml - megaco_flex_scanner + megaco_flex_scanner Interface module to the flex scanner linked in driver.

This module contains the public interface to the flex scanner @@ -72,7 +72,7 @@ megaco_version() = integer() >= 1 - start() -> {ok, PortOrPorts} | {error, Reason} + start() -> {ok, PortOrPorts} | {error, Reason} PortOrPorts = megaco_ports() @@ -94,7 +94,7 @@ megaco_version() = integer() >= 1 - stop(PortOrPorts) -> stopped + stop(PortOrPorts) -> stopped PortOrPorts = megaco_ports() @@ -108,7 +108,7 @@ megaco_version() = integer() >= 1 - is_reentrant_enabled() -> Boolean + is_reentrant_enabled() -> Boolean Boolean = boolean() @@ -121,7 +121,7 @@ megaco_version() = integer() >= 1 - is_scanner_port(Port, PortOrPorts) -> Boolean + is_scanner_port(Port, PortOrPorts) -> Boolean Port = port() @@ -137,7 +137,7 @@ megaco_version() = integer() >= 1 - scan(Binary, PortOrPorts) -> {ok, Tokens, Version, LatestLine} | {error, Reason, LatestLine} + scan(Binary, PortOrPorts) -> {ok, Tokens, Version, LatestLine} | {error, Reason, LatestLine} Binary = binary() diff --git a/lib/megaco/doc/src/megaco_tcp.xml b/lib/megaco/doc/src/megaco_tcp.xml index 77aee32f6c..63713b2c56 100644 --- a/lib/megaco/doc/src/megaco_tcp.xml +++ b/lib/megaco/doc/src/megaco_tcp.xml @@ -32,7 +32,7 @@ %VSN% megaco_tcp.xml - megaco_tcp + megaco_tcp Interface module to TPKT transport protocol for Megaco/H.248.

This module contains the public interface to the TPKT (TCP/IP) version @@ -40,7 +40,7 @@ - start_transport() -> {ok, TransportRef} + start_transport() -> {ok, TransportRef} TransportRef = pid() @@ -51,7 +51,7 @@ - listen(TransportRef, ListenPortSpecList) -> ok + listen(TransportRef, ListenPortSpecList) -> ok TransportRef = pid() | regname() @@ -65,7 +65,7 @@ - connect(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason} + connect(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason} TransportRef = pid() | regname() @@ -86,7 +86,7 @@ - close(Handle) -> ok + close(Handle) -> ok Handle = socket_handle() @@ -96,7 +96,7 @@ - socket(Handle) -> Socket + socket(Handle) -> Socket Handle = socket_handle() @@ -109,7 +109,7 @@ - send_message(Handle, Message) -> ok + send_message(Handle, Message) -> ok Handle = socket_handle() @@ -120,7 +120,7 @@ - block(Handle) -> ok + block(Handle) -> ok Handle = socket_handle() @@ -130,7 +130,7 @@ - unblock(Handle) -> ok + unblock(Handle) -> ok Handle = socket_handle() @@ -141,7 +141,7 @@ - upgrade_receive_handle(ControlPid) -> ok + upgrade_receive_handle(ControlPid) -> ok ControlPid = pid() @@ -153,9 +153,9 @@ - get_stats() -> {ok, TotalStats} | {error, Reason} - get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason} - get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason} + get_stats() -> {ok, TotalStats} | {error, Reason} + get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason} + get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason} TotalStats = [send_handle_stats()] @@ -173,8 +173,8 @@ - reset_stats() -> void() - reset_stats(SendHandle) -> void() + reset_stats() -> void() + reset_stats(SendHandle) -> void() SendHandle = send_handle() diff --git a/lib/megaco/doc/src/megaco_transport.xml b/lib/megaco/doc/src/megaco_transport.xml index 3002e9b74e..ba8c794750 100644 --- a/lib/megaco/doc/src/megaco_transport.xml +++ b/lib/megaco/doc/src/megaco_transport.xml @@ -32,7 +32,7 @@ %VSN% megaco_transport.xml - megaco_transport + megaco_transport Megaco transport behaviour.

The following functions should be exported from a @@ -54,8 +54,8 @@ - Module:send_message(Handle, Msg) -> ok | {cancel, Reason} | Error - Module:send_message(Handle, Msg, Resend) -> ok | {cancel, Reason} | Error + Module:send_message(Handle, Msg) -> ok | {cancel, Reason} | Error + Module:send_message(Handle, Msg, Resend) -> ok | {cancel, Reason} | Error Send a megaco message. Handle = term() @@ -99,7 +99,7 @@ - Module:resend_message(Handle, Msg) -> ok | {cancel, Reason} | Error + Module:resend_message(Handle, Msg) -> ok | {cancel, Reason} | Error Re-send a megaco message. Handle = term() diff --git a/lib/megaco/doc/src/megaco_udp.xml b/lib/megaco/doc/src/megaco_udp.xml index b2559c77d5..3d776c19b6 100644 --- a/lib/megaco/doc/src/megaco_udp.xml +++ b/lib/megaco/doc/src/megaco_udp.xml @@ -32,7 +32,7 @@ %VSN% megaco_udp.xml - megaco_udp + megaco_udp Interface module to UDP transport protocol for Megaco/H.248.

This module contains the public interface to the UDP/IP version @@ -40,7 +40,7 @@ - start_transport() -> {ok, TransportRef} + start_transport() -> {ok, TransportRef} TransportRef = pid() @@ -51,7 +51,7 @@ - open(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason} + open(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason} TransportRef = pid() | regname() @@ -73,7 +73,7 @@ - close(Handle, Msg) -> ok + close(Handle, Msg) -> ok Handle = socket_handle() @@ -84,7 +84,7 @@ - socket(Handle) -> Socket + socket(Handle) -> Socket Handle = socket_handle() @@ -97,7 +97,7 @@ - create_send_handle(Handle, Host, Port) -> send_handle() + create_send_handle(Handle, Host, Port) -> send_handle() Handle = socket_handle() @@ -110,7 +110,7 @@ - send_message(SendHandle, Msg) -> ok + send_message(SendHandle, Msg) -> ok SendHandle = send_handle() @@ -125,7 +125,7 @@ - block(Handle) -> ok + block(Handle) -> ok Handle = socket_handle() @@ -135,7 +135,7 @@ - unblock(Handle) -> ok + unblock(Handle) -> ok Handle = socket_handle() @@ -146,7 +146,7 @@ - upgrade_receive_handle(ControlPid, NewHandle) -> ok + upgrade_receive_handle(ControlPid, NewHandle) -> ok ControlPid = pid() @@ -160,9 +160,9 @@ - get_stats() -> {ok, TotalStats} | {error, Reason} - get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason} - get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason} + get_stats() -> {ok, TotalStats} | {error, Reason} + get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason} + get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason} TotalStats = [total_stats()] @@ -180,8 +180,8 @@ - reset_stats() -> void() - reset_stats(SendHandle) -> void() + reset_stats() -> void() + reset_stats(SendHandle) -> void() SendHandle = send_handle() diff --git a/lib/megaco/doc/src/megaco_user.xml b/lib/megaco/doc/src/megaco_user.xml index 067be15fe0..198f2aa24c 100644 --- a/lib/megaco/doc/src/megaco_user.xml +++ b/lib/megaco/doc/src/megaco_user.xml @@ -32,7 +32,7 @@ %VSN% megaco_user.xml - megaco_user + megaco_user Callback module for users of the Megaco application

This module defines the callback behaviour of Megaco users. A @@ -164,8 +164,8 @@ protocol_version() = integer() ]]> - handle_connect(ConnHandle, ProtocolVersion) -> ok | error | {error,ErrorDescr} - handle_connect(ConnHandle, ProtocolVersion, Extra]) -> ok | error | {error,ErrorDescr} + handle_connect(ConnHandle, ProtocolVersion) -> ok | error | {error,ErrorDescr} + handle_connect(ConnHandle, ProtocolVersion, Extra]) -> ok | error | {error,ErrorDescr} Invoked when a new connection is established ConnHandle = conn_handle() @@ -202,7 +202,7 @@ protocol_version() = integer() ]]> - handle_disconnect(ConnHandle, ProtocolVersion, Reason) -> ok + handle_disconnect(ConnHandle, ProtocolVersion, Reason) -> ok Invoked when a connection is teared down ConnHandle = conn_handle() @@ -220,8 +220,8 @@ protocol_version() = integer() ]]> - handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED) -> reply | {reply, ED} | no_reply | {no_reply, ED} - handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED, Extra) -> reply | {reply, ED} | no_reply | {no_reply, ED} + handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED) -> reply | {reply, ED} | no_reply | {no_reply, ED} + handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED, Extra) -> reply | {reply, ED} | no_reply | {no_reply, ED} Invoked when a received message had syntax errors ReceiveHandle = receive_handle() @@ -258,8 +258,8 @@ protocol_version() = integer() ]]> - handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr) -> ok - handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr, Extra) -> ok + handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr) -> ok + handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr, Extra) -> ok Invoked when a received message just contains an error ConnHandle = conn_handle() @@ -291,8 +291,8 @@ protocol_version() = integer() ]]> - handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests) -> pending() | reply() | ignore_trans_request - handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests, Extra) -> pending() | reply() | ignore_trans_request + handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests) -> pending() | reply() | ignore_trans_request + handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests, Extra) -> pending() | reply() | ignore_trans_request Invoked for each transaction request ConnHandle = conn_handle() @@ -420,8 +420,8 @@ protocol_version() = integer() ]]> - handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData) -> reply() - handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData, Extra) -> reply() + handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData) -> reply() + handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData, Extra) -> reply() Optionally invoked for a time consuming transaction request ConnHandle = conn_handle() @@ -460,8 +460,8 @@ protocol_version() = integer() ]]> - handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData) -> ok - handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData, Extra) -> ok + handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData) -> ok + handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData, Extra) -> ok Optionally invoked for a transaction reply ConnHandle = conn_handle() @@ -593,8 +593,8 @@ protocol_version() = integer() ]]> - handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData) -> ok - handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData, Extra) -> ok + handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData) -> ok + handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData, Extra) -> ok Optionally invoked for a transaction acknowledgement ConnHandle = conn_handle() @@ -658,8 +658,8 @@ protocol_version() = integer() ]]> - handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans) -> ok - handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans, Extra) -> ok + handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans) -> ok + handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans, Extra) -> ok Invoked when an unexpected message is received ConnHandle = conn_handle() @@ -685,8 +685,8 @@ protocol_version() = integer() ]]> - handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid) -> ok - handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid, Extra) -> ok + handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid) -> ok + handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid, Extra) -> ok Invoked when an transaction request has been aborted ConnHandle = conn_handle() @@ -710,8 +710,8 @@ protocol_version() = integer() ]]> - handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl) -> ok - handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl, Extra) -> ok + handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl) -> ok + handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl, Extra) -> ok Segment Reply Indication ConnHandle = conn_handle() diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml index 5f11b55ab9..921721d4b7 100644 --- a/lib/mnesia/doc/src/mnesia.xml +++ b/lib/mnesia/doc/src/mnesia.xml @@ -32,7 +32,7 @@ - mnesia + mnesia A distributed telecommunications DBMS @@ -183,7 +183,7 @@ - abort(Reason) -> transaction abort + abort(Reason) -> transaction abort Terminates the current transaction.

Makes the transaction silently @@ -195,7 +195,7 @@ - activate_checkpoint(Args) -> {ok,Name,Nodes} | {error,Reason} + activate_checkpoint(Args) -> {ok,Name,Nodes} | {error,Reason} Activates a checkpoint. @@ -259,7 +259,7 @@ - activity(AccessContext, Fun [, Args]) -> ResultOfFun | exit(Reason) + activity(AccessContext, Fun [, Args]) -> ResultOfFun | exit(Reason) Executes Fun in AccessContext. @@ -271,7 +271,7 @@ - activity(AccessContext, Fun, Args, AccessMod) -> ResultOfFun | exit(Reason) + activity(AccessContext, Fun, Args, AccessMod) -> ResultOfFun | exit(Reason) Executes Fun in AccessContext. @@ -403,7 +403,7 @@ - add_table_copy(Tab, Node, Type) -> {aborted, R} | {atomic, ok} + add_table_copy(Tab, Node, Type) -> {aborted, R} | {atomic, ok} Copies a table to a remote node. @@ -420,7 +420,7 @@ mnesia:add_table_copy(person, Node, disc_copies) - add_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} + add_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} Creates an index for a table. @@ -441,7 +441,7 @@ mnesia:add_table_index(person, age) - all_keys(Tab) -> KeyList | transaction abort + all_keys(Tab) -> KeyList | transaction abort Returns all keys in a table. @@ -453,7 +453,7 @@ mnesia:add_table_index(person, age) - async_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) + async_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a context that is not protected by a transaction. @@ -493,7 +493,7 @@ mnesia:add_table_index(person, age) - backup(Opaque [, BackupMod]) -> ok | {error,Reason} + backup(Opaque [, BackupMod]) -> ok | {error,Reason} Backs up all tables in the database. @@ -505,7 +505,7 @@ mnesia:add_table_index(person, age) - backup_checkpoint(Name, Opaque [, BackupMod]) -> ok | {error,Reason} + backup_checkpoint(Name, Opaque [, BackupMod]) -> ok | {error,Reason} Backs up all tables in a checkpoint. @@ -520,7 +520,7 @@ mnesia:add_table_index(person, age) - change_config(Config, Value) -> {error, Reason} | {ok, ReturnValue} + change_config(Config, Value) -> {error, Reason} | {ok, ReturnValue} Changes a configuration parameter. @@ -554,7 +554,7 @@ mnesia:add_table_index(person, age) - change_table_access_mode(Tab, AccessMode) -> {aborted, R} | {atomic, ok} + change_table_access_mode(Tab, AccessMode) -> {aborted, R} | {atomic, ok} Changes the access mode for the table. @@ -568,7 +568,7 @@ mnesia:add_table_index(person, age) - change_table_copy_type(Tab, Node, To) -> {aborted, R} | {atomic, ok} + change_table_copy_type(Tab, Node, To) -> {aborted, R} | {atomic, ok} Changes the storage type of a table. @@ -585,7 +585,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - change_table_load_order(Tab, LoadOrder) -> {aborted, R} | {atomic, ok} + change_table_load_order(Tab, LoadOrder) -> {aborted, R} | {atomic, ok} Changes the load order priority for the table. @@ -607,7 +607,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - clear_table(Tab) -> {aborted, R} | {atomic, ok} + clear_table(Tab) -> {aborted, R} | {atomic, ok} Deletes all entries in a table. @@ -615,7 +615,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - create_schema(DiscNodes) -> ok | {error,Reason} + create_schema(DiscNodes) -> ok | {error,Reason} Creates a new schema on the specified nodes. @@ -637,7 +637,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - create_table(Name, TabDef) -> {atomic, ok} | {aborted, Reason} + create_table(Name, TabDef) -> {atomic, ok} | {aborted, Reason} Creates a Mnesia table called Namewith properties as described by argument TabDef. @@ -799,7 +799,7 @@ mnesia:create_table(person, - deactivate_checkpoint(Name) -> ok | {error, Reason} + deactivate_checkpoint(Name) -> ok | {error, Reason} Deactivates a checkpoint. @@ -811,7 +811,7 @@ mnesia:create_table(person, - del_table_copy(Tab, Node) -> {aborted, R} | {atomic, ok} + del_table_copy(Tab, Node) -> {aborted, R} | {atomic, ok} Deletes the replica of table Tab at node Node. @@ -825,7 +825,7 @@ mnesia:create_table(person, - del_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} + del_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} Deletes an index in a table. @@ -834,7 +834,7 @@ mnesia:create_table(person, - delete({Tab, Key}) -> transaction abort | ok + delete({Tab, Key}) -> transaction abort | ok Deletes all records in table Tab with the key Key. @@ -842,7 +842,7 @@ mnesia:create_table(person, - delete(Tab, Key, LockKind) -> transaction abort | ok + delete(Tab, Key, LockKind) -> transaction abort | ok Deletes all records in table Tabwith the key Key. @@ -857,7 +857,7 @@ mnesia:create_table(person, - delete_object(Record) -> transaction abort | ok + delete_object(Record) -> transaction abort | ok Delete a record. @@ -866,7 +866,7 @@ mnesia:create_table(person, - delete_object(Tab, Record, LockKind) -> transaction abort | ok + delete_object(Tab, Record, LockKind) -> transaction abort | ok Deletes a record. @@ -883,7 +883,7 @@ mnesia:create_table(person, - delete_schema(DiscNodes) -> ok | {error,Reason} + delete_schema(DiscNodes) -> ok | {error,Reason} Deletes the schema on the given nodes. @@ -904,7 +904,7 @@ mnesia:create_table(person, - delete_table(Tab) -> {aborted, Reason} | {atomic, ok} + delete_table(Tab) -> {aborted, Reason} | {atomic, ok} Deletes permanently all replicas of table Tab. @@ -912,7 +912,7 @@ mnesia:create_table(person, - dirty_all_keys(Tab) -> KeyList | exit({aborted, Reason}) + dirty_all_keys(Tab) -> KeyList | exit({aborted, Reason}) Dirty search for all record keys in table. @@ -920,7 +920,7 @@ mnesia:create_table(person, - dirty_delete({Tab, Key}) -> ok | exit({aborted, Reason}) + dirty_delete({Tab, Key}) -> ok | exit({aborted, Reason}) Dirty delete of a record. @@ -928,14 +928,14 @@ mnesia:create_table(person, - dirty_delete(Tab, Key) -> ok | exit({aborted, Reason}) + dirty_delete(Tab, Key) -> ok | exit({aborted, Reason}) Dirty delete of a record.

Dirty equivalent of the function mnesia:delete/3.

 - dirty_delete_object(Record) + dirty_delete_object(Record) Dirty delete of a record. @@ -944,14 +944,14 @@ mnesia:create_table(person, - dirty_delete_object(Tab, Record) + dirty_delete_object(Tab, Record) Dirty delete of a record.

Dirty equivalent of the function mnesia:delete_object/3.

 - dirty_first(Tab) -> Key | exit({aborted, Reason}) + dirty_first(Tab) -> Key | exit({aborted, Reason}) Returns the key for the first record in a table. @@ -967,7 +967,7 @@ mnesia:create_table(person, - dirty_index_match_object(Pattern, Pos) + dirty_index_match_object(Pattern, Pos) Dirty pattern match using index. @@ -977,7 +977,7 @@ mnesia:create_table(person, - dirty_index_match_object(Tab, Pattern, Pos) + dirty_index_match_object(Tab, Pattern, Pos) Dirty pattern match using index.

Dirty equivalent of the function @@ -985,7 +985,7 @@ mnesia:create_table(person, - dirty_index_read(Tab, SecondaryKey, Pos) + dirty_index_read(Tab, SecondaryKey, Pos) Dirty read using index. @@ -994,7 +994,7 @@ mnesia:create_table(person, - dirty_last(Tab) -> Key | exit({aborted, Reason}) + dirty_last(Tab) -> Key | exit({aborted, Reason}) Returns the key for the last record in a table. @@ -1006,7 +1006,7 @@ mnesia:create_table(person, - dirty_match_object(Pattern) -> RecordList | exit({aborted, Reason}) + dirty_match_object(Pattern) -> RecordList | exit({aborted, Reason}) Dirty pattern match pattern. @@ -1015,7 +1015,7 @@ mnesia:create_table(person, - dirty_match_object(Tab, Pattern) -> RecordList | exit({aborted, Reason}) + dirty_match_object(Tab, Pattern) -> RecordList | exit({aborted, Reason}) Dirty pattern match pattern.

Dirty equivalent of the function @@ -1023,7 +1023,7 @@ mnesia:create_table(person, - dirty_next(Tab, Key) -> Key | exit({aborted, Reason}) + dirty_next(Tab, Key) -> Key | exit({aborted, Reason}) Return the next key in a table. @@ -1038,7 +1038,7 @@ mnesia:create_table(person, - dirty_prev(Tab, Key) -> Key | exit({aborted, Reason}) + dirty_prev(Tab, Key) -> Key | exit({aborted, Reason}) Returns the previous key in a table. @@ -1050,7 +1050,7 @@ mnesia:create_table(person, - dirty_read({Tab, Key}) -> ValueList | exit({aborted, Reason} + dirty_read({Tab, Key}) -> ValueList | exit({aborted, Reason} Dirty read of records. @@ -1058,14 +1058,14 @@ mnesia:create_table(person, - dirty_read(Tab, Key) -> ValueList | exit({aborted, Reason} + dirty_read(Tab, Key) -> ValueList | exit({aborted, Reason} Dirty read of records.

Dirty equivalent of the function mnesia:read/3.

 - dirty_select(Tab, MatchSpec) -> ValueList | exit({aborted, Reason} + dirty_select(Tab, MatchSpec) -> ValueList | exit({aborted, Reason} Dirty matches the objects in Tab against MatchSpec. @@ -1073,7 +1073,7 @@ mnesia:create_table(person, - dirty_slot(Tab, Slot) -> RecordList | exit({aborted, Reason}) + dirty_slot(Tab, Slot) -> RecordList | exit({aborted, Reason}) Returns the list of records that are associated with Slot in a table. @@ -1089,7 +1089,7 @@ mnesia:create_table(person, - dirty_update_counter({Tab, Key}, Incr) -> NewVal | exit({aborted, Reason}) + dirty_update_counter({Tab, Key}, Incr) -> NewVal | exit({aborted, Reason}) Dirty update of a counter record. @@ -1097,7 +1097,7 @@ mnesia:create_table(person, - dirty_update_counter(Tab, Key, Incr) -> NewVal | exit({aborted, Reason}) + dirty_update_counter(Tab, Key, Incr) -> NewVal | exit({aborted, Reason}) Dirty update of a counter record.

Mnesia has no special counter records. However, @@ -1126,7 +1126,7 @@ mnesia:create_table(person, - dirty_write(Record) -> ok | exit({aborted, Reason}) + dirty_write(Record) -> ok | exit({aborted, Reason}) Dirty write of a record. @@ -1135,14 +1135,14 @@ mnesia:create_table(person, - dirty_write(Tab, Record) -> ok | exit({aborted, Reason}) + dirty_write(Tab, Record) -> ok | exit({aborted, Reason}) Dirty write of a record.

Dirty equivalent of the function mnesia:write/3.

 - dump_log() -> dumped + dump_log() -> dumped Performs a user-initiated dump of the local log file. @@ -1156,7 +1156,7 @@ mnesia:create_table(person, - dump_tables(TabList) -> {atomic, ok} | {aborted, Reason} + dump_tables(TabList) -> {atomic, ok} | {aborted, Reason} Dumps all RAM tables to disc. @@ -1168,7 +1168,7 @@ mnesia:create_table(person, - dump_to_textfile(Filename) + dump_to_textfile(Filename) Dumps local tables into a text file. @@ -1181,7 +1181,7 @@ mnesia:create_table(person, - error_description(Error) -> String + error_description(Error) -> String Returns a string describing a particular Mnesia error. @@ -1259,7 +1259,7 @@ mnesia:create_table(person, - ets(Fun, [, Args]) -> ResultOfFun | exit(Reason) + ets(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a raw context that is not protected by a transaction. @@ -1278,7 +1278,7 @@ mnesia:create_table(person, - first(Tab) -> Key | transaction abort + first(Tab) -> Key | transaction abort Returns the key for the first record in a table. @@ -1293,7 +1293,7 @@ mnesia:create_table(person, - foldl(Function, Acc, Table) -> NewAcc | transaction abort + foldl(Function, Acc, Table) -> NewAcc | transaction abort Calls Function for each record in Table. @@ -1306,7 +1306,7 @@ mnesia:create_table(person, - foldr(Function, Acc, Table) -> NewAcc | transaction abort + foldr(Function, Acc, Table) -> NewAcc | transaction abort Calls Function for each record in Table. @@ -1317,7 +1317,7 @@ mnesia:create_table(person, - force_load_table(Tab) -> yes | ErrorDescription + force_load_table(Tab) -> yes | ErrorDescription Forces a table to be loaded into the system. @@ -1335,7 +1335,7 @@ mnesia:create_table(person, - index_match_object(Pattern, Pos) -> transaction abort | ObjList + index_match_object(Pattern, Pos) -> transaction abort | ObjList Matches records and uses index information. @@ -1345,7 +1345,7 @@ mnesia:create_table(person, - index_match_object(Tab, Pattern, Pos, LockKind) -> transaction abort | ObjList + index_match_object(Tab, Pattern, Pos, LockKind) -> transaction abort | ObjList Matches records and uses index information. @@ -1377,7 +1377,7 @@ mnesia:create_table(person, - index_read(Tab, SecondaryKey, Pos) -> transaction abort | RecordList + index_read(Tab, SecondaryKey, Pos) -> transaction abort | RecordList Reads records through index table. @@ -1397,7 +1397,7 @@ mnesia:create_table(person, - info() -> ok + info() -> ok Prints system information on the terminal. @@ -1408,7 +1408,7 @@ mnesia:create_table(person, - install_fallback(Opaque) -> ok | {error,Reason} + install_fallback(Opaque) -> ok | {error,Reason} Installs a backup as fallback. @@ -1417,7 +1417,7 @@ mnesia:create_table(person, - install_fallback(Opaque), BackupMod) -> ok | {error,Reason} + install_fallback(Opaque), BackupMod) -> ok | {error,Reason} Installs a backup as fallback.

Calls mnesia:install_fallback(Opaque, Args), where @@ -1425,7 +1425,7 @@ mnesia:create_table(person, - install_fallback(Opaque, Args) -> ok | {error,Reason} + install_fallback(Opaque, Args) -> ok | {error,Reason} Installs a backup as fallback.

Installs a backup as fallback. The fallback is used to @@ -1483,7 +1483,7 @@ mnesia:create_table(person, - is_transaction() -> boolean + is_transaction() -> boolean Checks if code is running in a transaction. @@ -1492,7 +1492,7 @@ mnesia:create_table(person, - last(Tab) -> Key | transaction abort + last(Tab) -> Key | transaction abort Returns the key for the last record in a table.

Works exactly like @@ -1503,7 +1503,7 @@ mnesia:create_table(person, - load_textfile(Filename) + load_textfile(Filename) Loads tables from a text file. @@ -1516,7 +1516,7 @@ mnesia:create_table(person, - lock(LockItem, LockKind) -> Nodes | ok | transaction abort + lock(LockItem, LockKind) -> Nodes | ok | transaction abort Explicit grab lock. @@ -1605,7 +1605,7 @@ mnesia:create_table(person, - match_object(Pattern) -> transaction abort | RecList + match_object(Pattern) -> transaction abort | RecList Matches Pattern for records. @@ -1614,7 +1614,7 @@ mnesia:create_table(person, - match_object(Tab, Pattern, LockKind) -> transaction abort | RecList + match_object(Tab, Pattern, LockKind) -> transaction abort | RecList Matches Pattern for records. @@ -1639,7 +1639,7 @@ mnesia:create_table(person, - move_table_copy(Tab, From, To) -> {aborted, Reason} | {atomic, ok} + move_table_copy(Tab, From, To) -> {aborted, Reason} | {atomic, ok} Moves the copy of table Tab from node From to node To. @@ -1653,7 +1653,7 @@ mnesia:create_table(person, - next(Tab, Key) -> Key | transaction abort + next(Tab, Key) -> Key | transaction abort Returns the next key in a table. @@ -1665,7 +1665,7 @@ mnesia:create_table(person, - prev(Tab, Key) -> Key | transaction abort + prev(Tab, Key) -> Key | transaction abort Returns the previous key in a table.

Works exactly like @@ -1676,7 +1676,7 @@ mnesia:create_table(person, - read({Tab, Key}) -> transaction abort | RecordList + read({Tab, Key}) -> transaction abort | RecordList Reads records(s) with a given key. @@ -1684,14 +1684,14 @@ mnesia:create_table(person, - read(Tab, Key) -> transaction abort | RecordList + read(Tab, Key) -> transaction abort | RecordList Reads records(s) with a given key.

Calls function mnesia:read(Tab, Key, read).

 - read(Tab, Key, LockKind) -> transaction abort | RecordList + read(Tab, Key, LockKind) -> transaction abort | RecordList Reads records(s) with a given key. @@ -1716,7 +1716,7 @@ mnesia:create_table(person, - read_lock_table(Tab) -> ok | transaction abort + read_lock_table(Tab) -> ok | transaction abort Sets a read lock on an entire table. @@ -1725,7 +1725,7 @@ mnesia:create_table(person, - report_event(Event) -> ok + report_event(Event) -> ok Reports a user event to the Mnesia event handler. @@ -1743,7 +1743,7 @@ mnesia:create_table(person, - restore(Opaque, Args) -> {atomic, RestoredTabs} |{aborted, Reason} + restore(Opaque, Args) -> {atomic, RestoredTabs} |{aborted, Reason} Online restore of backup. @@ -1803,7 +1803,7 @@ mnesia:create_table(person, - s_delete({Tab, Key}) -> ok | transaction abort + s_delete({Tab, Key}) -> ok | transaction abort Sets sticky lock and delete records. @@ -1812,7 +1812,7 @@ mnesia:create_table(person, - s_delete_object(Record) -> ok | transaction abort + s_delete_object(Record) -> ok | transaction abort Sets sticky lock and delete record. @@ -1822,7 +1822,7 @@ mnesia:create_table(person, - s_write(Record) -> ok | transaction abort + s_write(Record) -> ok | transaction abort Writes Record and sets sticky lock. @@ -1832,21 +1832,21 @@ mnesia:create_table(person, - schema() -> ok + schema() -> ok Prints information about all table definitions on the terminal.

Prints information about all table definitions on the terminal.

 - schema(Tab) -> ok + schema(Tab) -> ok Prints information about one table definition on the terminal.

Prints information about one table definition on the terminal.

 - select(Tab, MatchSpec [, Lock]) -> transaction abort | [Object] + select(Tab, MatchSpec [, Lock]) -> transaction abort | [Object] Matches the objects in Tab against MatchSpec. @@ -1884,7 +1884,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - select(Tab, MatchSpec, NObjects, Lock) -> transaction abort | {[Object],Cont} | '$end_of_table' + select(Tab, MatchSpec, NObjects, Lock) -> transaction abort | {[Object],Cont} | '$end_of_table' Matches the objects in Tab against MatchSpec. @@ -1907,7 +1907,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - select(Cont) -> transaction abort | {[Object],Cont} | '$end_of_table' + select(Cont) -> transaction abort | {[Object],Cont} | '$end_of_table' Continues selecting objects.

Selects more objects with the match specification initiated @@ -1919,7 +1919,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_debug_level(Level) -> OldLevel + set_debug_level(Level) -> OldLevel Changes the internal debug level of Mnesia. @@ -1930,7 +1930,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_master_nodes(MasterNodes) -> ok | {error, Reason} + set_master_nodes(MasterNodes) -> ok | {error, Reason} Sets the master nodes for all tables. @@ -1943,7 +1943,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_master_nodes(Tab, MasterNodes) -> ok | {error, Reason} + set_master_nodes(Tab, MasterNodes) -> ok | {error, Reason} Sets the master nodes for a table. @@ -1968,14 +1968,14 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_close_table(Tab) -> {aborted, R} | {atomic, ok} + snmp_close_table(Tab) -> {aborted, R} | {atomic, ok} Removes the possibility for SNMP to manipulate the table.

Removes the possibility for SNMP to manipulate the table.

 - snmp_get_mnesia_key(Tab, RowIndex) -> {ok, Key} | undefined + snmp_get_mnesia_key(Tab, RowIndex) -> {ok, Key} | undefined Gets the corresponding Mnesia key from an SNMP index. Tab ::= atom() @@ -1990,7 +1990,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_get_next_index(Tab, RowIndex) -> {ok, NextIndex} | endOfTable + snmp_get_next_index(Tab, RowIndex) -> {ok, NextIndex} | endOfTable Gets the index of the next lexicographical row. Tab ::= atom() @@ -2006,7 +2006,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_get_row(Tab, RowIndex) -> {ok, Row} | undefined + snmp_get_row(Tab, RowIndex) -> {ok, Row} | undefined Retrieves a row indexed by an SNMP index. Tab ::= atom() @@ -2019,7 +2019,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_open_table(Tab, SnmpStruct) -> {aborted, R} | {atomic, ok} + snmp_open_table(Tab, SnmpStruct) -> {aborted, R} | {atomic, ok} Organizes a Mnesia table as an SNMP table. Tab ::= atom() @@ -2073,7 +2073,7 @@ mnesia:create_table(employee, - start() -> ok | {error, Reason} + start() -> ok | {error, Reason} Starts a local Mnesia system. @@ -2108,7 +2108,7 @@ mnesia:create_table(employee, - stop() -> stopped + stop() -> stopped Stops Mnesia locally. @@ -2117,7 +2117,7 @@ mnesia:create_table(employee, - subscribe(EventCategory) -> {ok, Node} | {error, Reason} + subscribe(EventCategory) -> {ok, Node} | {error, Reason} Subscribes to events of type EventCategory. @@ -2127,7 +2127,7 @@ mnesia:create_table(employee, - sync_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) + sync_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a context that is not protected by a transaction. @@ -2166,7 +2166,7 @@ mnesia:create_table(employee, - system_info(InfoKey) -> Info | exit({aborted, Reason}) + system_info(InfoKey) -> Info | exit({aborted, Reason}) Returns information about the Mnesia system. @@ -2408,7 +2408,7 @@ mnesia:create_table(employee, - table_info(Tab, InfoKey) -> Info | exit({aborted, Reason}) + table_info(Tab, InfoKey) -> Info | exit({aborted, Reason}) Returns local information about table. @@ -2628,7 +2628,7 @@ raise(Name, Amount) -> - transform_table(Tab, Fun, NewAttributeList, NewRecordName) -> {aborted, R} | {atomic, ok} + transform_table(Tab, Fun, NewAttributeList, NewRecordName) -> {aborted, R} | {atomic, ok} Changes format on all records in table Tab. @@ -2649,7 +2649,7 @@ raise(Name, Amount) -> - transform_table(Tab, Fun, NewAttributeList) -> {aborted, R} | {atomic, ok} + transform_table(Tab, Fun, NewAttributeList) -> {aborted, R} | {atomic, ok} Changes format on all records in table Tab.

Calls mnesia:transform_table(Tab, Fun, @@ -2689,7 +2689,7 @@ raise(Name, Amount) -> - uninstall_fallback() -> ok | {error,Reason} + uninstall_fallback() -> ok | {error,Reason} Uninstalls a fallback. @@ -2698,7 +2698,7 @@ raise(Name, Amount) -> - uninstall_fallback(Args) -> ok | {error,Reason} + uninstall_fallback(Args) -> ok | {error,Reason} Uninstalls a fallback.

Deinstalls a fallback before it @@ -2725,7 +2725,7 @@ raise(Name, Amount) -> - unsubscribe(EventCategory) -> {ok, Node} | {error, Reason} + unsubscribe(EventCategory) -> {ok, Node} | {error, Reason} Subscribes to events of type EventCategory. @@ -2735,7 +2735,7 @@ raise(Name, Amount) -> - wait_for_tables(TabList, Timeout) -> ok | {timeout, BadTabList} | {error, Reason} + wait_for_tables(TabList, Timeout) -> ok | {timeout, BadTabList} | {error, Reason} Waits for tables to be accessible. @@ -2746,7 +2746,7 @@ raise(Name, Amount) -> - wread({Tab, Key}) -> transaction abort | RecordList + wread({Tab, Key}) -> transaction abort | RecordList Reads records with given key. @@ -2754,7 +2754,7 @@ raise(Name, Amount) -> - write(Record) -> transaction abort | ok + write(Record) -> transaction abort | ok Writes a record into the database. @@ -2763,7 +2763,7 @@ raise(Name, Amount) -> - write(Tab, Record, LockKind) -> transaction abort | ok + write(Tab, Record, LockKind) -> transaction abort | ok Writes a record into the database. @@ -2779,7 +2779,7 @@ raise(Name, Amount) -> - write_lock_table(Tab) -> ok | transaction abort + write_lock_table(Tab) -> ok | transaction abort Sets write lock on an entire table. diff --git a/lib/mnesia/doc/src/mnesia_frag_hash.xml b/lib/mnesia/doc/src/mnesia_frag_hash.xml index c233acdb05..ccaba412d0 100644 --- a/lib/mnesia/doc/src/mnesia_frag_hash.xml +++ b/lib/mnesia/doc/src/mnesia_frag_hash.xml @@ -34,7 +34,7 @@ A mnesia_frag_hash.sgml - mnesia_frag_hash + mnesia_frag_hash Defines mnesia_frag_hash callback behavior

This module defines a callback behavior for user-defined hash @@ -50,7 +50,7 @@ - init_state(Tab, State) -> NewState | abort(Reason) + init_state(Tab, State) -> NewState | abort(Reason) Initiates the hash state for a new table. Tab = atom() @@ -72,7 +72,7 @@ - add_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) + add_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) Starts when a new fragment is added to a fragmented table. State = term() @@ -100,7 +100,7 @@ - del_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) + del_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) Starts when a fragment is deleted from a fragmented table. State = term() @@ -127,7 +127,7 @@ - key_to_frag_number(State, Key) -> FragNum | abort(Reason) + key_to_frag_number(State, Key) -> FragNum | abort(Reason) Resolves the key of a record into a fragment number. FragNum = integer() @@ -140,7 +140,7 @@ - match_spec_to_frag_numbers(State, MatchSpec) -> FragNums | abort(Reason) + match_spec_to_frag_numbers(State, MatchSpec) -> FragNums | abort(Reason) Resolves a MatchSpec into a list of fragment numbers. MatcSpec = ets_select_match_spec() diff --git a/lib/mnesia/doc/src/mnesia_registry.xml b/lib/mnesia/doc/src/mnesia_registry.xml index a76f716981..18ddc4ab9e 100644 --- a/lib/mnesia/doc/src/mnesia_registry.xml +++ b/lib/mnesia/doc/src/mnesia_registry.xml @@ -34,7 +34,7 @@ A mnesia_registry.sgml - mnesia_registry + mnesia_registry Dump support for registries in erl_interface.

This module is usually part of the erl_interface @@ -57,7 +57,7 @@ - create_table(Tab) -> ok | exit(Reason) + create_table(Tab) -> ok | exit(Reason) Creates a registry table in Mnesia.

A wrapper function for mnesia:create_table/2, @@ -73,7 +73,7 @@ - create_table(Tab, TabDef) -> ok | exit(Reason) + create_table(Tab, TabDef) -> ok | exit(Reason) Creates a customized registry table in Mnesia.

A wrapper function for mnesia:create_table/2, diff --git a/lib/observer/doc/src/crashdump.xml b/lib/observer/doc/src/crashdump.xml index 59679d794e..62c6ff1f25 100644 --- a/lib/observer/doc/src/crashdump.xml +++ b/lib/observer/doc/src/crashdump.xml @@ -34,7 +34,7 @@ PA1 crashdump.xml - crashdump_viewer + crashdump_viewer A WxWidgets based tool for browsing Erlang crashdumps. @@ -46,7 +46,7 @@ - start() -> ok + start() -> ok start(File) -> ok Start the Crashdump Viewer. @@ -62,7 +62,7 @@ - stop() -> ok + stop() -> ok Terminate the Crashdump Viewer.

Terminates the Crashdump Viewer and closes diff --git a/lib/observer/doc/src/etop.xml b/lib/observer/doc/src/etop.xml index dcf3fe252a..f0acc7b5d8 100644 --- a/lib/observer/doc/src/etop.xml +++ b/lib/observer/doc/src/etop.xml @@ -34,7 +34,7 @@ - etop + etop Erlang Top is a tool for presenting information about Erlang processes similar to the information presented by "top" in UNIX. @@ -128,7 +128,7 @@ - config(Key,Value) -> Result + config(Key,Value) -> Result Change the configuration of the tool. Result = ok | {error,Reason} @@ -142,7 +142,7 @@ - dump(File) -> Result + dump(File) -> Result Dump the current display to a file. Result = ok | {error,Reason} @@ -153,7 +153,7 @@ - stop() -> stop + stop() -> stop Terminate etop.

Terminates etop.

diff --git a/lib/observer/doc/src/ttb.xml b/lib/observer/doc/src/ttb.xml index 2aa2b0c8a5..c42bb9c60c 100644 --- a/lib/observer/doc/src/ttb.xml +++ b/lib/observer/doc/src/ttb.xml @@ -33,7 +33,7 @@ PA1 ttb.xml - ttb + ttb A base for building trace tools for distributed systems.

The Trace Tool Builder, ttb, is a base for building trace @@ -76,7 +76,7 @@ ttb:p(all, call). - tracer() -> Result + tracer() -> Result Equivalent to tracer(node()).

Equivalent to tracer(node()).

@@ -84,7 +84,7 @@ ttb:p(all, call). - tracer(Shortcut) -> Result + tracer(Shortcut) -> Result Handy shortcuts for common tracing settings. Shortcut = shell | dbg @@ -97,7 +97,7 @@ ttb:p(all, call). - tracer(Nodes) -> Result + tracer(Nodes) -> Result Equivalent to tracer(Nodes,[]).

Equivalent to tracer(Nodes,[]).

@@ -105,7 +105,7 @@ ttb:p(all, call). - tracer(Nodes,Opts) -> Result + tracer(Nodes,Opts) -> Result Start a trace port on each specified node. Result = {ok, ActivatedNodes} | {error,Reason} @@ -243,7 +243,7 @@ ttb:p(all, call). - p(Item,Flags) -> Return + p(Item,Flags) -> Return Set the specified trace flags on the specified processes or ports. Return = {ok,[{Item,MatchDesc}]} @@ -338,7 +338,7 @@ ttb:p(all, call). - list_history() -> History + list_history() -> History Return all calls stored in history. History = [{N,Func,Args}] @@ -352,7 +352,7 @@ ttb:p(all, call). - run_history(N) -> ok | {error, Reason} + run_history(N) -> ok | {error, Reason} Execute one entry of the history. N = integer() | [integer()] @@ -364,7 +364,7 @@ ttb:p(all, call). - write_config(ConfigFile,Config) + write_config(ConfigFile,Config) Equivalent to write_config(ConfigFile,Config,[]).

Equivalent to write_config(ConfigFile,Config,[]).

@@ -372,7 +372,7 @@ ttb:p(all, call). - write_config(ConfigFile,Config,Opts) -> ok | {error,Reason} + write_config(ConfigFile,Config,Opts) -> ok | {error,Reason} Create a configuration file. ConfigFile = string() @@ -405,7 +405,7 @@ ttb:p(all, call). - run_config(ConfigFile) -> ok | {error,Reason} + run_config(ConfigFile) -> ok | {error,Reason} Execute all entries in a configuration file. ConfigFile = string() @@ -418,7 +418,7 @@ ttb:p(all, call). - run_config(ConfigFile,NumList) -> ok | {error,Reason} + run_config(ConfigFile,NumList) -> ok | {error,Reason} Execute selected entries from a configuration file. ConfigFile = string() @@ -437,7 +437,7 @@ ttb:p(all, call). - list_config(ConfigFile) -> Config | {error,Reason} + list_config(ConfigFile) -> Config | {error,Reason} List all entries in a configuration file. ConfigFile = string() @@ -449,7 +449,7 @@ ttb:p(all, call). - write_trace_info(Key,Info) -> ok + write_trace_info(Key,Info) -> ok Write any information to file .ti. Key = term() @@ -465,7 +465,7 @@ ttb:p(all, call). - seq_trigger_ms() -> MatchSpec + seq_trigger_ms() -> MatchSpec Equivalent to seq_trigger_ms(all).

Equivalent to seq_trigger_ms(all).

@@ -473,7 +473,7 @@ ttb:p(all, call). - seq_trigger_ms(Flags) -> MatchSpec + seq_trigger_ms(Flags) -> MatchSpec Return a match_spec() which starts sequential tracing. MatchSpec = match_spec() @@ -521,7 +521,7 @@ ttb:p(all, call). - stop() + stop() Equivalent to stop([]).

Equivalent to stop([]).

@@ -529,7 +529,7 @@ ttb:p(all, call). - stop(Opts) -> stopped | {stopped, Dir} + stop(Opts) -> stopped | {stopped, Dir} Stop tracing and fetch/format logs from all nodes. Opts = Opt | [Opt] @@ -583,7 +583,7 @@ ttb:p(all, call). - format(File) + format(File) Equivalent to format(File,[]).

Equivalent to format(File,[]).

@@ -591,7 +591,7 @@ ttb:p(all, call). - format(File,Options) -> ok | {error, Reason} + format(File,Options) -> ok | {error, Reason} Format a binary trace log. File = string() | [string()] diff --git a/lib/odbc/doc/src/odbc.xml b/lib/odbc/doc/src/odbc.xml index 4bb1f035f9..4d941b3b36 100644 --- a/lib/odbc/doc/src/odbc.xml +++ b/lib/odbc/doc/src/odbc.xml @@ -29,7 +29,7 @@ - odbc + odbc Erlang ODBC application

This application provides an Erlang interface to communicate @@ -130,8 +130,8 @@ - commit(Ref, CommitMode) -> - commit(Ref, CommitMode, TimeOut) -> ok | {error, Reason} + commit(Ref, CommitMode) -> + commit(Ref, CommitMode, TimeOut) -> ok | {error, Reason} Commits or rollbacks a transaction. Ref = connection_reference() @@ -145,7 +145,7 @@ - connect(ConnectStr, Options) -> {ok, Ref} | {error, Reason} + connect(ConnectStr, Options) -> {ok, Ref} | {error, Reason} Opens a connection to the database. ConnectStr = string() @@ -236,7 +236,7 @@ - disconnect(Ref) -> ok | {error, Reason} + disconnect(Ref) -> ok | {error, Reason} Closes a connection to a database. Ref = connection_reference() @@ -255,8 +255,8 @@ - describe_table(Ref, Table) -> - describe_table(Ref, Table, Timeout) -> {ok, Description} | {error, Reason} + describe_table(Ref, Table) -> + describe_table(Ref, Table, Timeout) -> {ok, Description} | {error, Reason} Queries the database to find out the data types of the columns of the table Table. Ref = connection_reference() @@ -271,8 +271,8 @@ - first(Ref) -> - first(Ref, Timeout) -> {selected, ColNames, Rows} | {error, Reason} + first(Ref) -> + first(Ref, Timeout) -> {selected, ColNames, Rows} | {error, Reason} Returns the first row of the result set and positions a cursor at this row. Ref = connection_reference() @@ -287,8 +287,8 @@ - last(Ref) -> - last(Ref, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} + last(Ref) -> + last(Ref, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} Returns the last row of the result set and positions a cursor at this row. Ref = connection_reference() @@ -303,8 +303,8 @@ - next(Ref) -> - next(Ref, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} + next(Ref) -> + next(Ref, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} Returns the next row of the result set relative the current cursor position and positions the cursor at this row. Ref = connection_reference() @@ -325,8 +325,8 @@ - param_query(Ref, SQLQuery, Params) -> - param_query(Ref, SQLQuery, Params, TimeOut) -> ResultTuple | {error, Reason} + param_query(Ref, SQLQuery, Params) -> + param_query(Ref, SQLQuery, Params, TimeOut) -> ResultTuple | {error, Reason} Executes a parameterized SQL query. Ref = connection_reference() @@ -353,8 +353,8 @@ - prev(Ref) -> - prev(ConnectionReference, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} + prev(Ref) -> + prev(ConnectionReference, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} Returns the previous row of the result set relative the current cursor position and positions the cursor at this row. Ref = connection_reference() @@ -371,8 +371,8 @@ - start() -> - start(Type) -> ok | {error, Reason} + start() -> + start(Type) -> ok | {error, Reason} Starts the odb application. @@ -389,7 +389,7 @@ - stop() -> ok + stop() -> ok Stops the odbc application. @@ -400,8 +400,8 @@ - sql_query(Ref, SQLQuery) -> - sql_query(Ref, SQLQuery, TimeOut) -> ResultTuple | [ResultTuple] |{error, Reason} + sql_query(Ref, SQLQuery) -> + sql_query(Ref, SQLQuery, TimeOut) -> ResultTuple | [ResultTuple] |{error, Reason} Executes a SQL query or a batch of SQL queries. If it is a SELECT query the result set is returned, on the format{selected, ColNames, Rows}. For other query types the tuple {updated, NRows}is returned, and for batched queries, if the driver supports them, this function can also return a list of result tuples. Ref = connection_reference() @@ -429,8 +429,8 @@ - select_count(Ref, SelectQuery) -> - select_count(Ref, SelectQuery, TimeOut) -> {ok, NrRows} | {error, Reason} + select_count(Ref, SelectQuery) -> + select_count(Ref, SelectQuery, TimeOut) -> {ok, NrRows} | {error, Reason} Executes a SQL SELECT query and associates the result set with the connection. A cursor is positioned before the first row in the result set and the tuple {ok, NrRows}is returned. Ref = connection_reference() @@ -453,8 +453,8 @@ - select(Ref, Position, N) -> - select(Ref, Position, N, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} + select(Ref, Position, N) -> + select(Ref, Position, N, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} Selects Nconsecutive rows of the result set. Ref = connection_reference() diff --git a/lib/os_mon/doc/src/cpu_sup.xml b/lib/os_mon/doc/src/cpu_sup.xml index bada165a06..b7adb2bcd2 100644 --- a/lib/os_mon/doc/src/cpu_sup.xml +++ b/lib/os_mon/doc/src/cpu_sup.xml @@ -28,7 +28,7 @@ - cpu_sup + cpu_sup A CPU Load and CPU Utilization Supervisor Process

cpu_sup is a process which supervises the CPU load @@ -76,7 +76,7 @@ - nprocs() -> UnixProcesses | {error, Reason} + nprocs() -> UnixProcesses | {error, Reason} Get the number of UNIX processes running on this host UnixProcesses = int() @@ -90,7 +90,7 @@ - avg1() -> SystemLoad | {error, Reason} + avg1() -> SystemLoad | {error, Reason} Get the system load average for the last minute SystemLoad = int() @@ -104,7 +104,7 @@ - avg5() -> SystemLoad | {error, Reason} + avg5() -> SystemLoad | {error, Reason} Get the system load average for the last five minutes SystemLoad = int() @@ -118,7 +118,7 @@ - avg15() -> SystemLoad | {error, Reason} + avg15() -> SystemLoad | {error, Reason} Get the system load average for the last fifteen minutes SystemLoad = int() @@ -132,7 +132,7 @@ - util() -> CpuUtil | {error, Reason} + util() -> CpuUtil | {error, Reason} Get the CPU utilization CpuUtil = float() @@ -156,7 +156,7 @@ - util(Opts) -> UtilSpec | {error, Reason} + util(Opts) -> UtilSpec | {error, Reason} Get the CPU utilization Opts = [detailed | per_cpu] diff --git a/lib/os_mon/doc/src/disksup.xml b/lib/os_mon/doc/src/disksup.xml index 610ef2c907..116a6dfd19 100644 --- a/lib/os_mon/doc/src/disksup.xml +++ b/lib/os_mon/doc/src/disksup.xml @@ -28,7 +28,7 @@ - disksup + disksup A Disk Supervisor Process

disksup is a process which supervises the available disk @@ -92,7 +92,7 @@ - get_disk_data() -> [DiskData] + get_disk_data() -> [DiskData] Get data for the disks in the system DiskData = {Id, KByte, Capacity} @@ -112,7 +112,7 @@ - get_check_interval() -> MS + get_check_interval() -> MS Get time interval, in milliseconds, for the periodic disk space check MS = int() @@ -123,7 +123,7 @@ - set_check_interval(Minutes) -> ok + set_check_interval(Minutes) -> ok Set time interval, in minutes, for the periodic disk space check Minutes = int()>=1 @@ -138,7 +138,7 @@ - get_almost_full_threshold() -> Percent + get_almost_full_threshold() -> Percent Get threshold, in percent, for disk space utilization Percent = int() @@ -148,7 +148,7 @@ - set_almost_full_threshold(Float) -> ok + set_almost_full_threshold(Float) -> ok Set threshold, as percentage represented by a float, for disk space utilization Float = float(), 0=<Float=<1 diff --git a/lib/os_mon/doc/src/memsup.xml b/lib/os_mon/doc/src/memsup.xml index c669e4670a..51c78b07c2 100644 --- a/lib/os_mon/doc/src/memsup.xml +++ b/lib/os_mon/doc/src/memsup.xml @@ -28,7 +28,7 @@ - memsup + memsup A Memory Supervisor Process

memsup is a process which supervises the memory usage for @@ -127,7 +127,7 @@ - get_memory_data() -> {Total,Allocated,Worst} + get_memory_data() -> {Total,Allocated,Worst} Get data for the memory in the system Total = Allocated = int() @@ -155,7 +155,7 @@ - get_system_memory_data() -> MemDataList + get_system_memory_data() -> MemDataList Get system dependent memory data MemDataList = [{Tag, Size}] @@ -216,7 +216,7 @@ - get_os_wordsize() -> Wordsize + get_os_wordsize() -> Wordsize Get the wordsize of running os. Wordsize = 32 | 64 | unsupported_os @@ -226,7 +226,7 @@ - get_check_interval() -> MS + get_check_interval() -> MS Get time interval, in milliseconds, for the periodic memory check MS = int() @@ -237,7 +237,7 @@ - set_check_interval(Minutes) -> ok + set_check_interval(Minutes) -> ok Set time interval, in minutes, for the periodic memory check Minutes = int()>0 @@ -252,7 +252,7 @@ - get_procmem_high_watermark() -> int() + get_procmem_high_watermark() -> int() Get threshold, in percent, for process memory allocation

Returns the threshold, in percent, for process memory @@ -260,7 +260,7 @@ - set_procmem_high_watermark(Float) -> ok + set_procmem_high_watermark(Float) -> ok Set threshold, as percentage represented by a float, for process memory allocation

Changes the threshold, given as a float, for process memory @@ -273,7 +273,7 @@ - get_sysmem_high_watermark() -> int() + get_sysmem_high_watermark() -> int() Get threshold, in percent, for system memory allocation

Returns the threshold, in percent, for system memory @@ -281,7 +281,7 @@ - set_sysmem_high_watermark(Float) -> ok + set_sysmem_high_watermark(Float) -> ok Set threshold, given as a float, for system memory allocation

Changes the threshold, given as a float, for system memory @@ -294,7 +294,7 @@ - get_helper_timeout() -> Seconds + get_helper_timeout() -> Seconds Get the timeout value, in seconds, for memory checks Seconds = int() @@ -304,7 +304,7 @@ - set_helper_timeout(Seconds) -> ok + set_helper_timeout(Seconds) -> ok Set the timeout value, in seconds, for memory checks Seconds = int() (>= 1) diff --git a/lib/os_mon/doc/src/nteventlog.xml b/lib/os_mon/doc/src/nteventlog.xml index d32427227c..08cf165a24 100644 --- a/lib/os_mon/doc/src/nteventlog.xml +++ b/lib/os_mon/doc/src/nteventlog.xml @@ -28,7 +28,7 @@ - nteventlog + nteventlog Interface to Windows Event Log

nteventlog provides a generic interface to the Windows @@ -61,8 +61,8 @@ - start(Identifier, MFA) -> Result - start_link(Identifier, MFA) -> Result + start(Identifier, MFA) -> Result + start_link(Identifier, MFA) -> Result Start the NT eventlog server Identifier = string() | atom() @@ -82,7 +82,7 @@ - stop() -> stopped + stop() -> stopped Stop the NT eventlog server Result = stopped diff --git a/lib/os_mon/doc/src/os_mon_mib.xml b/lib/os_mon/doc/src/os_mon_mib.xml index e995bf3de1..f6d0b20094 100644 --- a/lib/os_mon/doc/src/os_mon_mib.xml +++ b/lib/os_mon/doc/src/os_mon_mib.xml @@ -29,7 +29,7 @@ - os_mon_mib + os_mon_mib Loading and Unloading of OTP-OS-MON-MIB

Functions for loading and unloading the OTP-OS-MON-MIB into/from @@ -42,7 +42,7 @@ - load(Agent) -> ok | {error, Reason} + load(Agent) -> ok | {error, Reason} Load the OTP-OS-MON-MIB Agent = pid() | atom() @@ -53,7 +53,7 @@ - unload(Agent) -> ok | {error, Reason} + unload(Agent) -> ok | {error, Reason} Unload the OTP-OS-MON-MIB Agent = pid() | atom() diff --git a/lib/os_mon/doc/src/os_sup.xml b/lib/os_mon/doc/src/os_sup.xml index d517f387b4..4a84165a6c 100644 --- a/lib/os_mon/doc/src/os_sup.xml +++ b/lib/os_mon/doc/src/os_sup.xml @@ -28,7 +28,7 @@ - os_sup + os_sup Interface to OS System Messages

os_sup is a process providing a message passing service @@ -159,8 +159,8 @@ - enable() -> ok | {error, Res} - enable(Dir, Conf) -> ok | {error, Error} + enable() -> ok | {error, Res} + enable(Dir, Conf) -> ok | {error, Error} Enable the service (Solaris only) Dir = Conf = Res = string() @@ -194,8 +194,8 @@ - disable() -> ok | {error, Res} - disable(Dir, Conf) -> ok | {error, Error} + disable() -> ok | {error, Res} + disable(Dir, Conf) -> ok | {error, Error} Disable the service (Solaris only) Dir = Conf = Res = string() diff --git a/lib/otp_mibs/doc/src/otp_mib.xml b/lib/otp_mibs/doc/src/otp_mib.xml index 530c529c69..e7d338c165 100644 --- a/lib/otp_mibs/doc/src/otp_mib.xml +++ b/lib/otp_mibs/doc/src/otp_mib.xml @@ -28,7 +28,7 @@ - otp_mib + otp_mib Handles the OTP-MIB

The SNMP application should be used to start an SNMP agent. Then @@ -41,7 +41,7 @@ - load(Agent) -> ok | {error, Reason} + load(Agent) -> ok | {error, Reason} Load the OTP-MIB Agent = pid() | atom() @@ -52,7 +52,7 @@ - unload(Agent) -> ok | {error, Reason} + unload(Agent) -> ok | {error, Reason} Unload the OTP-MIB Agent = pid() | atom() diff --git a/lib/parsetools/doc/src/leex.xml b/lib/parsetools/doc/src/leex.xml index 1227625287..2ba1044882 100644 --- a/lib/parsetools/doc/src/leex.xml +++ b/lib/parsetools/doc/src/leex.xml @@ -21,7 +21,7 @@ A leex.xml - leex + leex Lexical analyzer generator for Erlang

A regular expression based lexical analyzer generator for @@ -124,7 +124,7 @@ Token = tuple() - format_error(ErrorInfo) -> Chars + format_error(ErrorInfo) -> Chars Return an English description of a an error tuple. Chars = [char() | Chars] @@ -145,8 +145,8 @@ Token = tuple() - string(String) -> StringRet - string(String, StartLine) -> StringRet + string(String) -> StringRet + string(String, StartLine) -> StringRet Generated by Leex String = string() @@ -163,9 +163,9 @@ Token = tuple() - token(Cont, Chars) -> {more,Cont1} | {done,TokenRet,RestChars} + token(Cont, Chars) -> {more,Cont1} | {done,TokenRet,RestChars} - token(Cont, Chars, StartLine) -> {more,Cont1} + token(Cont, Chars, StartLine) -> {more,Cont1} | {done,TokenRet,RestChars} Generated by Leex @@ -198,9 +198,9 @@ io:request(InFile, {get_until,Prompt,Module,token,[Line]}) - tokens(Cont, Chars) -> {more,Cont1} | {done,TokensRet,RestChars} + tokens(Cont, Chars) -> {more,Cont1} | {done,TokensRet,RestChars} - tokens(Cont, Chars, StartLine) -> + tokens(Cont, Chars, StartLine) -> {more,Cont1} | {done,TokensRet,RestChars} Generated by Leex diff --git a/lib/parsetools/doc/src/yecc.xml b/lib/parsetools/doc/src/yecc.xml index 5f95b5c150..67a2c95c25 100644 --- a/lib/parsetools/doc/src/yecc.xml +++ b/lib/parsetools/doc/src/yecc.xml @@ -32,7 +32,7 @@ B yecc.sgml - yecc + yecc LALR-1 Parser Generator

An LALR-1 parser generator for Erlang, similar to yacc. @@ -46,7 +46,7 @@ - file(Grammarfile [, Options]) -> YeccRet + file(Grammarfile [, Options]) -> YeccRet Give information about resolved and unresolved parse action conflicts. Grammarfile = filename() @@ -137,7 +137,7 @@ - format_error(Reason) -> Chars + format_error(Reason) -> Chars Return an English description of a an error tuple. Reason = - as returned by yecc:file/1,2 - diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 5259cb9dd3..76dbe008ef 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -31,7 +31,7 @@ - public_key + public_key API module for public-key infrastructure.

Provides functions to handle public-key infrastructure, @@ -326,7 +326,7 @@ - + Decodes an ASN.1 DER-encoded PKIX x509 certificate.

Decodes an ASN.1 DER-encoded PKIX certificate. Option otp @@ -889,7 +889,7 @@ end - + Creates a digital signature. diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index 8a269365c9..5afbad0ba8 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -33,7 +33,7 @@ %VSN% - reltool + reltool Main API of the Reltool application

This is an interface module for the Reltool application.

@@ -591,7 +591,7 @@ target_spec() = [target_spec()] - create_target(Server, TargetDir) -> ok | {error, Reason} + create_target(Server, TargetDir) -> ok | {error, Reason} Create a target system Server = server() @@ -604,7 +604,7 @@ target_spec() = [target_spec()] - eval_target_spec(TargetSpec, RootDir, TargetDir) -> ok | {error, Reason} + eval_target_spec(TargetSpec, RootDir, TargetDir) -> ok | {error, Reason} Create a target system TargetSpec = target_spec() @@ -655,7 +655,7 @@ target_spec() = [target_spec()] - get_config(Server) -> {ok, Config} | {error, Reason} + get_config(Server) -> {ok, Config} | {error, Reason} Get reltool configuration Server = server() @@ -667,7 +667,7 @@ target_spec() = [target_spec()] - get_config(Server, InclDefaults, InclDerived) -> {ok, Config} | {error, Reason} + get_config(Server, InclDefaults, InclDerived) -> {ok, Config} | {error, Reason} Get reltool configuration Server = server() @@ -685,7 +685,7 @@ target_spec() = [target_spec()] - get_rel(Server, Relname) -> {ok, RelFile} | {error, Reason} + get_rel(Server, Relname) -> {ok, RelFile} | {error, Reason} Get contents of a release file Server = server() @@ -698,7 +698,7 @@ target_spec() = [target_spec()] - get_script(Server, Relname) -> {ok, ScriptFile | {error, Reason} + get_script(Server, Relname) -> {ok, ScriptFile | {error, Reason} Get contents of a boot script file Server = server() @@ -722,7 +722,7 @@ target_spec() = [target_spec()] - get_server(WindowPid) -> {ok, ServerPid} | {error, Reason} + get_server(WindowPid) -> {ok, ServerPid} | {error, Reason} Start server process with options WindowPid = window_pid() @@ -733,7 +733,7 @@ target_spec() = [target_spec()] - get_target_spec(Server) -> {ok, TargetSpec} | {error, Reason} + get_target_spec(Server) -> {ok, TargetSpec} | {error, Reason} Return a specification of the target system Server = server() @@ -747,7 +747,7 @@ target_spec() = [target_spec()] - install(RelName, TargetDir) -> ok | {error, Reason} + install(RelName, TargetDir) -> ok | {error, Reason} Install a target system RelName = rel_name() @@ -758,7 +758,7 @@ target_spec() = [target_spec()] - start() -> {ok, WindowPid} | {error, Reason} + start() -> {ok, WindowPid} | {error, Reason} Start main window process WindowPid = window_pid() @@ -768,7 +768,7 @@ target_spec() = [target_spec()] - start(Options) -> {ok, WindowPid} | {error, Reason} + start(Options) -> {ok, WindowPid} | {error, Reason} Start main window process with options Options = options() @@ -779,7 +779,7 @@ target_spec() = [target_spec()] - start_link(Options) -> {ok, WindowPid} | {error, Reason} + start_link(Options) -> {ok, WindowPid} | {error, Reason} Start main window process with options Options = options() @@ -790,7 +790,7 @@ target_spec() = [target_spec()] - start_server(Options) -> {ok, ServerPid} | {error, Reason} + start_server(Options) -> {ok, ServerPid} | {error, Reason} Start server process with options Options = options() @@ -803,7 +803,7 @@ target_spec() = [target_spec()] - stop(Pid) -> ok | {error, Reason} + stop(Pid) -> ok | {error, Reason} Stop a server or window process Pid = server_pid() | window_pid() diff --git a/lib/runtime_tools/doc/src/dbg.xml b/lib/runtime_tools/doc/src/dbg.xml index 06701ed5b4..941a880778 100644 --- a/lib/runtime_tools/doc/src/dbg.xml +++ b/lib/runtime_tools/doc/src/dbg.xml @@ -32,7 +32,7 @@ A dbg.sgml - dbg + dbg The Text Based Trace Facility

This module implements a text based interface to the @@ -68,7 +68,7 @@ - fun2ms(LiteralFun) -> MatchSpec + fun2ms(LiteralFun) -> MatchSpec Pseudo function that transforms fun syntax to match_spec. LiteralFun = fun() literal @@ -145,14 +145,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - h() -> ok + h() -> ok Give a list of available help items on standard output.

Gives a list of items for brief online help.

 - h(Item) -> ok + h(Item) -> ok Give brief help for an item. Item = atom() @@ -163,14 +163,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - p(Item) -> {ok, MatchDesc} | {error, term()} + p(Item) -> {ok, MatchDesc} | {error, term()} Trace messages to and from Item.

Equivalent to p(Item, [m]).

 - p(Item, Flags) -> {ok, MatchDesc} | {error, term()} + p(Item, Flags) -> {ok, MatchDesc} | {error, term()} Trace Item according to Flags. MatchDesc = [MatchNum] @@ -303,14 +303,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - c(Mod, Fun, Args) + c(Mod, Fun, Args) Evaluate apply(M,F,Args)with alltrace flags set.

Equivalent to c(Mod, Fun, Args, all).

 - c(Mod, Fun, Args, Flags) + c(Mod, Fun, Args, Flags) Evaluate apply(M,F,Args)with Flagstrace flags set.

Evaluates the expression apply(Mod, Fun, Args) with the trace @@ -319,35 +319,35 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - i() -> ok + i() -> ok Display information about all traced processes and ports.

Displays information about all traced processes and ports.

 - tp(Module,MatchSpec) + tp(Module,MatchSpec) Set pattern for traced global function calls

Same as tp({Module, '_', '_'}, MatchSpec)

 - tp(Module,Function,MatchSpec) + tp(Module,Function,MatchSpec) Set pattern for traced global function calls

Same as tp({Module, Function, '_'}, MatchSpec)

 - tp(Module, Function, Arity, MatchSpec) + tp(Module, Function, Arity, MatchSpec) Set pattern for traced global function calls

Same as tp({Module, Function, Arity}, MatchSpec)

 - tp({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()} + tp({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()} Set pattern for traced global function calls Module = atom() | '_' @@ -410,28 +410,28 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - tpl(Module,MatchSpec) + tpl(Module,MatchSpec) Set pattern for traced local (as well as global) function calls

Same as tpl({Module, '_', '_'}, MatchSpec)

 - tpl(Module,Function,MatchSpec) + tpl(Module,Function,MatchSpec) Set pattern for traced local (as well as global) function calls

Same as tpl({Module, Function, '_'}, MatchSpec)

 - tpl(Module, Function, Arity, MatchSpec) + tpl(Module, Function, Arity, MatchSpec) Set pattern for traced local (as well as global) function calls

Same as tpl({Module, Function, Arity}, MatchSpec)

 - tpl({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()} + tpl({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()} Set pattern for traced local (as well as global) function calls

This function works as tp/2, but enables @@ -484,35 +484,35 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ctp() + ctp() Clear call trace pattern for the specified functions

Same as ctp({'_', '_', '_'})

 - ctp(Module) + ctp(Module) Clear call trace pattern for the specified functions

Same as ctp({Module, '_', '_'})

 - ctp(Module, Function) + ctp(Module, Function) Clear call trace pattern for the specified functions

Same as ctp({Module, Function, '_'})

 - ctp(Module, Function, Arity) + ctp(Module, Function, Arity) Clear call trace pattern for the specified functions

Same as ctp({Module, Function, Arity})

 - ctp({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} + ctp({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} Clear call trace pattern for the specified functions Module = atom() | '_' @@ -533,35 +533,35 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ctpl() + ctpl() Clear call trace pattern for the specified functions

Same as ctpl({'_', '_', '_'})

 - ctpl(Module) + ctpl(Module) Clear call trace pattern for the specified functions

Same as ctpl({Module, '_', '_'})

 - ctpl(Module, Function) + ctpl(Module, Function) Clear call trace pattern for the specified functions

Same as ctpl({Module, Function, '_'})

 - ctpl(Module, Function, Arity) + ctpl(Module, Function, Arity) Clear call trace pattern for the specified functions

Same as ctpl({Module, Function, Arity})

 - ctpl({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} + ctpl({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} Clear call trace pattern for the specified functions

This function works as ctp/1, but only disables @@ -570,35 +570,35 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ctpg() + ctpg() Clear call trace pattern for the specified functions

Same as ctpg({'_', '_', '_'})

 - ctpg(Module) + ctpg(Module) Clear call trace pattern for the specified functions

Same as ctpg({Module, '_', '_'})

 - ctpg(Module, Function) + ctpg(Module, Function) >Clear call trace pattern for the specified functions

Same as ctpg({Module, Function, '_'})

 - ctpg(Module, Function, Arity) + ctpg(Module, Function, Arity) >Clear call trace pattern for the specified functions

Same as ctpg({Module, Function, Arity})

 - ctpg({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} + ctpg({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} Clear call trace pattern for the specified functions

This function works as ctp/1, but only disables @@ -623,7 +623,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ltp() -> ok + ltp() -> ok List saved and built-in match specifications on the console.

Use this function to recall all match specifications previously @@ -654,7 +654,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - dtp() -> ok + dtp() -> ok Delete all saved match specifications.

Use this function to "forget" all match specifications @@ -665,7 +665,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - dtp(N) -> ok + dtp(N) -> ok Delete a specific saved match_spec. N = integer() @@ -676,7 +676,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - wtp(Name) -> ok | {error, IOError} + wtp(Name) -> ok | {error, IOError} Write all saved and built-in match specifications to a file Name = string() @@ -699,7 +699,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - rtp(Name) -> ok | {error, Error} + rtp(Name) -> ok | {error, Error} Read saved match specifications from file. Name = string() @@ -728,7 +728,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - n(Nodename) -> {ok, Nodename} | {error, Reason} + n(Nodename) -> {ok, Nodename} | {error, Reason} Add a remote node to the list of traced nodes Nodename = atom() @@ -767,7 +767,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - cn(Nodename) -> ok + cn(Nodename) -> ok Clear a node from the list of traced nodes. Nodename = atom() @@ -782,14 +782,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ln() -> ok + ln() -> ok Show the list of traced nodes on the console.

Shows the list of traced nodes on the console.

 - tracer() -> {ok, pid()} | {error, already_started} + tracer() -> {ok, pid()} | {error, already_started} Start a tracer server that handles trace messages.

This function starts a server on the local node that will @@ -805,7 +805,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - tracer(Type, Data) -> {ok, pid()} | {error, Error} + tracer(Type, Data) -> {ok, pid()} | {error, Error} Start a tracer server with additional parameters Type = port | process | module @@ -859,7 +859,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - tracer(Nodename, Type, Data) -> {ok, Nodename} | {error, Reason} + tracer(Nodename, Type, Data) -> {ok, Nodename} | {error, Reason} Start a tracer server on given node with additional parameters Nodename = atom() @@ -881,7 +881,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - trace_port(Type, Parameters) -> fun() + trace_port(Type, Parameters) -> fun() Create and returns a trace port generatingfun Type = ip | file @@ -958,28 +958,28 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - flush_trace_port() + flush_trace_port() Equivalent to flush_trace_port(node()).

Equivalent to flush_trace_port(node()).

 - flush_trace_port(Nodename) -> ok | {error, Reason} + flush_trace_port(Nodename) -> ok | {error, Reason} Flush internal data buffers in a trace driver on the given node.

Equivalent to trace_port_control(Nodename,flush).

 - trace_port_control(Operation) + trace_port_control(Operation) Equivalent to trace_port_control(node(),Operation).

Equivalent to trace_port_control(node(),Operation).

 - trace_port_control(Nodename,Operation) -> ok | {ok, Result} | {error, Reason} + trace_port_control(Nodename,Operation) -> ok | {ok, Result} | {error, Reason} Perform a control operation on the active trace port driver on the given node. Nodename = atom() @@ -1013,7 +1013,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - trace_client(Type, Parameters) -> pid() + trace_client(Type, Parameters) -> pid() Start a trace client that reads messages created by a trace port driver Type = ip | file | follow_file @@ -1080,7 +1080,7 @@ hello - trace_client(Type, Parameters, HandlerSpec) -> pid() + trace_client(Type, Parameters, HandlerSpec) -> pid() Start a trace client that reads messages created by a trace port driver, with a user defined handler Type = ip | file | follow_file @@ -1110,7 +1110,7 @@ hello - stop_trace_client(Pid) -> ok + stop_trace_client(Pid) -> ok Stop a trace client gracefully. Pid = pid() @@ -1123,14 +1123,14 @@ hello - get_tracer() + get_tracer() Equivalent to get_tracer(node()).

Equivalent to get_tracer(node()).

 - get_tracer(Nodename) -> {ok, Tracer} + get_tracer(Nodename) -> {ok, Tracer} Return the process or port to which all trace messages are sent. Nodename = atom() @@ -1142,7 +1142,7 @@ hello - stop() -> ok + stop() -> ok Stop the dbgserver and the tracing of all processes.

Stops the dbg server and clears all trace flags for @@ -1153,7 +1153,7 @@ hello - stop_clear() -> ok + stop_clear() -> ok Stop the dbgserver and the tracing of all processes, and clears trace patterns.

Same as stop/0, but also clears all trace patterns on global functions calls.

diff --git a/lib/runtime_tools/doc/src/erts_alloc_config.xml b/lib/runtime_tools/doc/src/erts_alloc_config.xml index ffc4ec5285..5bcce1b5e3 100644 --- a/lib/runtime_tools/doc/src/erts_alloc_config.xml +++ b/lib/runtime_tools/doc/src/erts_alloc_config.xml @@ -29,7 +29,7 @@ 1 erts_alloc_config.sgml - erts_alloc_config + erts_alloc_config Configuration tool for erts_alloc @@ -136,7 +136,7 @@ - save_scenario() -> ok | {error, Error} + save_scenario() -> ok | {error, Error} Saves information about current runtime scenario Error = term() @@ -154,7 +154,7 @@ - make_config() -> ok | {error, Error} + make_config() -> ok | {error, Error} Creates an erts_alloc configuration Error = term() @@ -165,7 +165,7 @@ - make_config(FileNameOrIODev) -> ok | {error, Error} + make_config(FileNameOrIODev) -> ok | {error, Error} Creates an erts_alloc configuration FileNameOrIODev = string() | io_device() @@ -190,7 +190,7 @@ - stop() -> ok | {error, Error} + stop() -> ok | {error, Error} Error = term() diff --git a/lib/sasl/doc/src/alarm_handler.xml b/lib/sasl/doc/src/alarm_handler.xml index 4160757164..6e74f833cd 100644 --- a/lib/sasl/doc/src/alarm_handler.xml +++ b/lib/sasl/doc/src/alarm_handler.xml @@ -34,7 +34,7 @@ A alarm_handler.sgml.t1 - alarm_handler + alarm_handler An Alarm Handling Process

The alarm handler process is a @@ -81,7 +81,7 @@ - clear_alarm(AlarmId) -> void() + clear_alarm(AlarmId) -> void() Clears the specified alarms. AlarmId = term() @@ -94,7 +94,7 @@ - get_alarms() -> [alarm()] + get_alarms() -> [alarm()] Gets all active alarms.

Returns a list of all active alarms. This function can only @@ -103,7 +103,7 @@ - set_alarm(alarm()) + set_alarm(alarm()) Sets an alarm with an id. alarm() = {AlarmId, AlarmDescription} diff --git a/lib/sasl/doc/src/rb.xml b/lib/sasl/doc/src/rb.xml index 6e118e177b..0ed7e91c11 100644 --- a/lib/sasl/doc/src/rb.xml +++ b/lib/sasl/doc/src/rb.xml @@ -32,7 +32,7 @@ A rb.sgml - rb + rb The Report Browser Tool

The Report Browser (RB) tool is used to browse and @@ -86,7 +86,7 @@ - grep(RegExp) + grep(RegExp) Searches the reports for a regular expression. RegExp = string() | {string(), Options} | re:mp() | {re:mp(), Options} @@ -109,8 +109,8 @@ - h() - help() + h() + help() Displays help information.

Displays online help information.

@@ -118,8 +118,8 @@ - list() - list(Type) + list() + list(Type) Lists all reports. Type = type() @@ -157,8 +157,8 @@ - rescan() - rescan(Options) + rescan() + rescan(Options) Rescans the report directory. Options = [opt()] @@ -171,8 +171,8 @@ - show() - show(Report) + show() + show(Report) Displays reports. Report = integer() | type() @@ -186,8 +186,8 @@ - start() - start(Options) + start() + start(Options) Starts the rb_server. Options = [opt()] @@ -256,7 +256,7 @@ - start_log(FileName) + start_log(FileName) Redirects all output to FileName. FileName = string() | atom() | pid() @@ -268,7 +268,7 @@ - stop() + stop() Stops the rb_server.

Stops rb_server.

@@ -276,7 +276,7 @@ - stop_log() + stop_log() Stops logging to file.

Closes the log file. The output from the RB tool is diff --git a/lib/sasl/doc/src/release_handler.xml b/lib/sasl/doc/src/release_handler.xml index a77dace675..f8ee0306d8 100644 --- a/lib/sasl/doc/src/release_handler.xml +++ b/lib/sasl/doc/src/release_handler.xml @@ -28,7 +28,7 @@ - release_handler + release_handler Unpacking and Installation of Release Packages

The release handler process belongs to the SASL @@ -168,7 +168,7 @@ - check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} + check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} check_install_release(Vsn,Opts) -> {ok, OtherVsn, Descr} | {error, Reason} Checks installation of a release in the system. @@ -202,7 +202,7 @@ - create_RELEASES(Root, RelDir, RelFile, AppDirs) -> ok | {error, Reason} + create_RELEASES(Root, RelDir, RelFile, AppDirs) -> ok | {error, Reason} Creates an initial RELEASES file. Root = RelDir = RelFile = string() @@ -233,7 +233,7 @@ - install_file(Vsn, File) -> ok | {error, Reason} + install_file(Vsn, File) -> ok | {error, Reason} Installs a release file in the release structure. Vsn = File = string() @@ -252,8 +252,8 @@ - install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} - install_release(Vsn, [Opt]) -> {ok, OtherVsn, Descr} | {continue_after_restart, OtherVsn, Descr} | {error, Reason} + install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} + install_release(Vsn, [Opt]) -> {ok, OtherVsn, Descr} | {continue_after_restart, OtherVsn, Descr} | {error, Reason} Installs a release in the system. Vsn = OtherVsn = string() @@ -383,7 +383,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - make_permanent(Vsn) -> ok | {error, Reason} + make_permanent(Vsn) -> ok | {error, Reason} Makes the specified release version permanent. Vsn = string() @@ -396,7 +396,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - remove_release(Vsn) -> ok | {error, Reason} + remove_release(Vsn) -> ok | {error, Reason} Removes a release from the system. Vsn = string() @@ -410,7 +410,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - reboot_old_release(Vsn) -> ok | {error, Reason} + reboot_old_release(Vsn) -> ok | {error, Reason} Reboots the system from an old release. Vsn = string() @@ -425,7 +425,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - set_removed(Vsn) -> ok | {error, Reason} + set_removed(Vsn) -> ok | {error, Reason} Marks a release as removed. Vsn = string() @@ -440,7 +440,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - set_unpacked(RelFile, AppDirs) -> {ok, Vsn} | {error, Reason} + set_unpacked(RelFile, AppDirs) -> {ok, Vsn} | {error, Reason} Marks a release as unpacked. RelFile = string() @@ -466,7 +466,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - unpack_release(Name) -> {ok, Vsn} | {error, Reason} + unpack_release(Name) -> {ok, Vsn} | {error, Reason} Unpacks a release package. Name = Vsn = string() @@ -482,7 +482,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - which_releases() -> [{Name, Vsn, Apps, Status}] + which_releases() -> [{Name, Vsn, Apps, Status}] Returns all known releases. Name = Vsn = string() @@ -537,7 +537,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - upgrade_app(App, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} + upgrade_app(App, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} Upgrades to a new application version. App = atom() @@ -586,8 +586,8 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - downgrade_app(App, Dir) -> - downgrade_app(App, OldVsn, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} + downgrade_app(App, Dir) -> + downgrade_app(App, OldVsn, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} Downgrades to a previous application version. App = atom() @@ -633,7 +633,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - upgrade_script(App, Dir) -> {ok, NewVsn, Script} + upgrade_script(App, Dir) -> {ok, NewVsn, Script} Finds an application upgrade script. App = atom() @@ -671,7 +671,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - downgrade_script(App, OldVsn, Dir) -> {ok, Script} + downgrade_script(App, OldVsn, Dir) -> {ok, Script} Finds an application downgrade script. App = atom() @@ -710,7 +710,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - eval_appup_script(App, ToVsn, ToDir, Script) -> {ok, Unpurged} | restart_emulator | {error, Reason} + eval_appup_script(App, ToVsn, ToDir, Script) -> {ok, Unpurged} | restart_emulator | {error, Reason} Evaluates an application upgrade or downgrade script. App = atom() diff --git a/lib/sasl/doc/src/systools.xml b/lib/sasl/doc/src/systools.xml index 4842c732b1..6facb8ddae 100644 --- a/lib/sasl/doc/src/systools.xml +++ b/lib/sasl/doc/src/systools.xml @@ -30,7 +30,7 @@ - systools + systools A Set of Release Handling Tools

This module contains functions to generate boot scripts @@ -40,8 +40,8 @@ - make_relup(Name, UpFrom, DownTo) -> Result - make_relup(Name, UpFrom, DownTo, [Opt]) -> Result + make_relup(Name, UpFrom, DownTo) -> Result + make_relup(Name, UpFrom, DownTo, [Opt]) -> Result Generates a release upgrade file relup. Name = string() @@ -136,8 +136,8 @@ - make_script(Name) -> Result - make_script(Name, [Opt]) -> Result + make_script(Name) -> Result + make_script(Name, [Opt]) -> Result Generates a boot script .script/.boot. Name = string() @@ -263,8 +263,8 @@ - make_tar(Name) -> Result - make_tar(Name, [Opt]) -> Result + make_tar(Name) -> Result + make_tar(Name, [Opt]) -> Result Creates a release package. Name = string() @@ -369,7 +369,7 @@ myapp-1/ebin/myapp.app - script2boot(File) -> ok | error + script2boot(File) -> ok | error Generates a binary version of a boot script. File = string() diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml index bd671bb40e..d20f1a8d06 100644 --- a/lib/snmp/doc/src/snmp.xml +++ b/lib/snmp/doc/src/snmp.xml @@ -32,7 +32,7 @@ snmp.xml - snmp + snmp Interface functions to the SNMP toolkit

The module snmp contains interface functions to the @@ -56,7 +56,7 @@ - config() -> ok | {error, Reason} + config() -> ok | {error, Reason} Configure with a simple interactive tool

A simple interactive configuration tool. Simple @@ -78,8 +78,8 @@ - start() -> ok | {error, Reason} - start(Type) -> ok | {error, Reason} + start() -> ok | {error, Reason} + start(Type) -> ok | {error, Reason} Start the SNMP application Type = start_type() @@ -93,8 +93,8 @@ - start_agent() -> ok | {error, Reason} - start_agent(Type) -> ok | {error, Reason} + start_agent() -> ok | {error, Reason} + start_agent(Type) -> ok | {error, Reason} Start the agent part of the SNMP application Type = start_type() @@ -117,8 +117,8 @@ - start_manager() -> ok | {error, Reason} - start_manager(Type) -> ok | {error, Reason} + start_manager() -> ok | {error, Reason} + start_manager(Type) -> ok | {error, Reason} Start the manager part of the SNMP application Type = start_type() @@ -141,7 +141,7 @@ - date_and_time() -> DateAndTime + date_and_time() -> DateAndTime Return the current date and time as an OCTET STRING DateAndTime = [int()] @@ -155,7 +155,7 @@ - date_and_time_to_universal_time_dst(DateAndTime) -> [utc()] + date_and_time_to_universal_time_dst(DateAndTime) -> [utc()] Convert a DateAndTime value to a list of possible utc() DateAndTime = [int()] @@ -171,8 +171,8 @@ - date_and_time_to_string(DateAndTime) -> string() - date_and_time_to_string(DateAndTime, Validate) -> string() + date_and_time_to_string(DateAndTime) -> string() + date_and_time_to_string(DateAndTime, Validate) -> string() Convert a DateAndTime value to a string DateAndTime = [int()] @@ -194,7 +194,7 @@ - date_and_time_to_string2(DateAndTime) -> string() + date_and_time_to_string2(DateAndTime) -> string() Convert a DateAndTime value to a string DateAndTime = [int()] @@ -210,7 +210,7 @@ - local_time_to_date_and_time_dst(Local) -> [DateAndTime] + local_time_to_date_and_time_dst(Local) -> [DateAndTime] Convert a Local time value to a list of possible DateAndTime(s) Local = {{Y,Mo,D},{H,M,S}} @@ -226,7 +226,7 @@ - universal_time_to_date_and_time(UTC) -> DateAndTime + universal_time_to_date_and_time(UTC) -> DateAndTime Convert a UTC value to DateAndTime UTC = {{Y,Mo,D},{H,M,S}} @@ -241,8 +241,8 @@ - validate_date_and_time(DateAndTime) -> bool() - validate_date_and_time(DateAndTime, Validate) -> bool() + validate_date_and_time(DateAndTime) -> bool() + validate_date_and_time(DateAndTime, Validate) -> bool() Check if a DateAndTime value is correct DateAndTime = term() @@ -279,7 +279,7 @@ - passwd2localized_key(Alg, Passwd, EngineID) -> Key + passwd2localized_key(Alg, Passwd, EngineID) -> Key Generates an localized key Alg = algorithm() @@ -298,7 +298,7 @@ - octet_string_to_bits(S) -> Val + octet_string_to_bits(S) -> Val Convert an OCTET-STRING to BITS Val = bits() @@ -312,7 +312,7 @@ - bits_to_octet_string(B) -> Val + bits_to_octet_string(B) -> Val Convert an OCTET-STRING to BITS Val = octet_string() @@ -326,7 +326,7 @@ - read_mib(FileName) -> {ok, mib()} | {error, Reason} + read_mib(FileName) -> {ok, mib()} | {error, Reason} FileName = string() @@ -341,9 +341,9 @@ - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -440,7 +440,7 @@ - change_log_size(LogName, NewSize) -> ok | {error, Reason} + change_log_size(LogName, NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log LogName = string() @@ -463,8 +463,8 @@ - print_version_info() -> void() - print_version_info(Prefix) -> void() + print_version_info() -> void() + print_version_info(Prefix) -> void() Formatted print of result of the versions functions Prefix = string() | integer() @@ -484,8 +484,8 @@ - versions1() -> {ok, Info} | {error, Reason} - versions2() -> {ok, Info} | {error, Reason} + versions1() -> {ok, Info} | {error, Reason} + versions2() -> {ok, Info} | {error, Reason} Retrieve various system and application info Info = [info()] @@ -504,8 +504,8 @@ - print_versions(VersionInfo) -> void() - print_versions(Prefix, VersionInfo) -> void() + print_versions(VersionInfo) -> void() + print_versions(Prefix, VersionInfo) -> void() Formatted print of result of the versions functions VersionInfo = [version_info()] @@ -527,7 +527,7 @@ - enable_trace() -> void() + enable_trace() -> void() Starts a tracer - backup(BackupDir) -> ok | {error, Reason} - backup(Agent, BackupDir) -> ok | {error, Reason} + backup(BackupDir) -> ok | {error, Reason} + backup(Agent, BackupDir) -> ok | {error, Reason} Backup agent data BackupDir = string() @@ -216,8 +216,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - info() -> [{Key, Value}] - info(Agent) -> [{Key, Value}] + info() -> [{Key, Value}] + info(Agent) -> [{Key, Value}] Return information about the agent Agent = pid() | atom() @@ -236,7 +236,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - old_info_format(NewInfo) -> OldInfo + old_info_format(NewInfo) -> OldInfo Return information about the agent OldInfo = NewInfo = [{Key, Value}] @@ -273,9 +273,9 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - load_mibs(Mibs) -> ok | {error, Reason} - load_mibs(Mibs, Force) -> ok | {error, Reason} - load_mibs(Agent, Mibs) -> ok | {error, Reason} + load_mibs(Mibs) -> ok | {error, Reason} + load_mibs(Mibs, Force) -> ok | {error, Reason} + load_mibs(Agent, Mibs) -> ok | {error, Reason} load_mibs(Agent, Mibs, Force) -> ok | {error, Reason} Load MIBs into the agent @@ -321,9 +321,9 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - unload_mibs(Mibs) -> ok | {error, Reason} - unload_mibs(Mibs, Force) -> ok | {error, Reason} - unload_mibs(Agent, Mibs) -> ok | {error, Reason} + unload_mibs(Mibs) -> ok | {error, Reason} + unload_mibs(Mibs, Force) -> ok | {error, Reason} + unload_mibs(Agent, Mibs) -> ok | {error, Reason} unload_mibs(Agent, Mibs, Force) -> ok | {error, Reason} Unload MIBs from the agent @@ -347,8 +347,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_mibs() -> Mibs - which_mibs(Agent) -> Mibs + which_mibs() -> Mibs + which_mibs(Agent) -> Mibs Get a list of all the loaded mibs Agent = pid() | atom() @@ -365,8 +365,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - whereis_mib(MibName) -> {ok, MibFile} | {error, Reason} - whereis_mib(Agent, MibName) -> {ok, MibFile} | {error, Reason} + whereis_mib(MibName) -> {ok, MibFile} | {error, Reason} + whereis_mib(Agent, MibName) -> {ok, MibFile} | {error, Reason} Get the path to the mib file Agent = pid() | atom() @@ -385,10 +385,10 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - current_request_id() -> {value, RequestId} | false - current_context() -> {value, Context} | false - current_community() -> {value, Community} | false - current_address() -> {value, Address} | false + current_request_id() -> {value, RequestId} | false + current_context() -> {value, Context} | false + current_community() -> {value, Community} | false + current_address() -> {value, Address} | false Get the request-id, context, community and address of the current request RequestId = integer() @@ -409,8 +409,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enum_to_int(Name, Enum) -> {value, Int} | false - enum_to_int(Db, Name, Enum) -> {value, Int} | false + enum_to_int(Name, Enum) -> {value, Int} | false + enum_to_int(Db, Name, Enum) -> {value, Int} | false Convert an enum value to an integer Db = term() @@ -435,8 +435,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - int_to_enum(Name, Int) -> {value, Enum} | false - int_to_enum(Db, Name, Int) -> {value, Enum} | false + int_to_enum(Name, Int) -> {value, Enum} | false + int_to_enum(Db, Name, Int) -> {value, Enum} | false Convert an integer to an enum value Db = term() @@ -461,8 +461,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - name_to_oid(Name) -> {value, oid()} | false - name_to_oid(Db, Name) -> {value, oid()} | false + name_to_oid(Name) -> {value, oid()} | false + name_to_oid(Db, Name) -> {value, oid()} | false Convert a symbolic name to an OID Db = term() @@ -482,8 +482,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - oid_to_name(OID) -> {value, Name} | false - oid_to_name(Db, OID) -> {value, Name} | false + oid_to_name(OID) -> {value, Name} | false + oid_to_name(Db, OID) -> {value, Name} | false Convert an OID to a symbolic name Db = term() @@ -503,7 +503,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_aliasnames() -> Result + which_aliasnames() -> Result Get all alias-names known to the agent Result = [atom()] @@ -515,7 +515,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_tables() -> Result + which_tables() -> Result Get all tables known to the agent Result = [atom()] @@ -528,7 +528,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_variables() -> Result + which_variables() -> Result Get all variables known to the agent Result = [atom()] @@ -541,7 +541,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_notifications() -> Result + which_notifications() -> Result Get all notifications known to the agent Result = [{Name, MibName, Info}] @@ -558,13 +558,13 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} log_to_txt(LogDir) - log_to_txt(LogDir, Block | Mibs) - log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Block | Mibs) + log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -641,7 +641,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - change_log_size(NewSize) -> ok | {error, Reason} + change_log_size(NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log NewSize = {MaxBytes, MaxFiles} @@ -662,8 +662,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - set_log_type(NewType) -> {ok, OldType} | {error, Reason} - set_log_type(Agent, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Agent, NewType) -> {ok, OldType} | {error, Reason} Change the type of the Audit Trail Log NewType = OldType = atl_type() @@ -684,8 +684,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - mib_of(Oid) -> {ok, MibName} | {error, Reason} - mib_of(Agent, Oid) -> {ok, MibName} | {error, Reason} + mib_of(Oid) -> {ok, MibName} | {error, Reason} + mib_of(Agent, Oid) -> {ok, MibName} | {error, Reason} Which mib an Oid belongs to Agent = pid() | atom() @@ -704,8 +704,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - me_of(Oid) -> {ok, Me} | {error, Reason} - me_of(Agent, Oid) -> {ok, Me} | {error, Reason} + me_of(Oid) -> {ok, Me} | {error, Reason} + me_of(Agent, Oid) -> {ok, Me} | {error, Reason} Retrieve the mib-entry of an Oid Agent = pid() | atom() @@ -724,8 +724,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - invalidate_mibs_cache() -> void() - invalidate_mibs_cache(Agent) -> void() + invalidate_mibs_cache() -> void() + invalidate_mibs_cache(Agent) -> void() Invalidate the mib server cache Agent = pid() | atom() @@ -739,8 +739,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enable_mibs_cache() -> void() - enable_mibs_cache(Agent) -> void() + enable_mibs_cache() -> void() + enable_mibs_cache(Agent) -> void() Enable the mib server cache Agent = pid() | atom() @@ -753,8 +753,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - disable_mibs_cache() -> void() - disable_mibs_cache(Agent) -> void() + disable_mibs_cache() -> void() + disable_mibs_cache(Agent) -> void() Disable the mib server cache Agent = pid() | atom() @@ -781,12 +781,12 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - gc_mibs_cache() -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Age) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent, Age) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent, Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache() -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Age) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent, Age) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent, Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} Perform mib server cache gc Agent = pid() | atom() @@ -808,8 +808,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enable_mibs_cache_autogc() -> void() - enable_mibs_cache_autogc(Agent) -> void() + enable_mibs_cache_autogc() -> void() + enable_mibs_cache_autogc(Agent) -> void() Enable automatic gc of the mib server cache Agent = pid() | atom() @@ -822,8 +822,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - disable_mibs_cache_autogc() -> void() - disable_mibs_cache_autogc(Agent) -> void() + disable_mibs_cache_autogc() -> void() + disable_mibs_cache_autogc(Agent) -> void() Disable automatic gc of the mib server cache Agent = pid() | atom() @@ -836,8 +836,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - update_mibs_cache_age(NewAge) -> ok | {error, Reason} - update_mibs_cache_age(Agent, NewAge) -> ok | {error, Reason} + update_mibs_cache_age(NewAge) -> ok | {error, Reason} + update_mibs_cache_age(Agent, NewAge) -> ok | {error, Reason} Change the mib server cache age property Agent = pid() | atom() @@ -852,8 +852,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - update_mibs_cache_gclimit(NewGcLimit) -> ok | {error, Reason} - update_mibs_cache_gclimit(Agent, NewGCLimit) -> ok | {error, Reason} + update_mibs_cache_gclimit(NewGcLimit) -> ok | {error, Reason} + update_mibs_cache_gclimit(Agent, NewGCLimit) -> ok | {error, Reason} Change the mib server cache gclimit property Agent = pid() | atom() @@ -869,10 +869,10 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - register_notification_filter(Id, Mod, Data) -> ok | {error, Reason} - register_notification_filter(Agent, Id, Mod, Data) -> ok | {error, Reason} - register_notification_filter(Id, Mod, Data, Where) -> ok | {error, Reason} - register_notification_filter(Agent, Id, Mod, Data, Where) -> ok | {error, Reason} + register_notification_filter(Id, Mod, Data) -> ok | {error, Reason} + register_notification_filter(Agent, Id, Mod, Data) -> ok | {error, Reason} + register_notification_filter(Id, Mod, Data, Where) -> ok | {error, Reason} + register_notification_filter(Agent, Id, Mod, Data, Where) -> ok | {error, Reason} Register a notification filter Agent = pid() | atom() @@ -897,8 +897,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - unregister_notification_filter(Id) -> ok | {error, Reason} - unregister_notification_filter(Agent, Id) -> ok | {error, Reason} + unregister_notification_filter(Id) -> ok | {error, Reason} + unregister_notification_filter(Agent, Id) -> ok | {error, Reason} Unregister a notification filter Agent = pid() | atom() @@ -913,8 +913,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_notification_filter() -> Filters - which_notification_filter(Agent) -> Filters + which_notification_filter() -> Filters + which_notification_filter(Agent) -> Filters Which notification filter Agent = pid() | atom() @@ -929,8 +929,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - set_request_limit(NewLimit) -> {ok, OldLimit} | {error, Reason} - set_request_limit(Agent, NewLimit) -> {ok, OldLimit} | {error, Reason} + set_request_limit(NewLimit) -> {ok, OldLimit} | {error, Reason} + set_request_limit(Agent, NewLimit) -> {ok, OldLimit} | {error, Reason} Change the request limit NewLimit = OldLimit = infinity | integer() >= 0 @@ -950,7 +950,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - register_subagent(Agent, SubTreeOid, Subagent) -> ok | {error, Reason} + register_subagent(Agent, SubTreeOid, Subagent) -> ok | {error, Reason} Register a sub-agent under a sub-tree Agent = pid() | atom() @@ -975,7 +975,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - unregister_subagent(Agent, SubagentOidOrPid) -> ok | {ok, SubAgentPid} | {error, Reason} + unregister_subagent(Agent, SubagentOidOrPid) -> ok | {ok, SubAgentPid} | {error, Reason} Unregister a sub-agent Agent = pid() | atom() @@ -1119,10 +1119,10 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - send_notification(Agent, Notification, Receiver) - send_notification(Agent, Notification, Receiver, Varbinds) - send_notification(Agent, Notification, Receiver, NotifyName, Varbinds) - send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() + send_notification(Agent, Notification, Receiver) + send_notification(Agent, Notification, Receiver, Varbinds) + send_notification(Agent, Notification, Receiver, NotifyName, Varbinds) + send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds, LocalEngineID) -> void() Send a notification @@ -1324,13 +1324,13 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - discovery(TargetName, Notification) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler, ExtraInfo) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler, ExtraInfo) -> {ok, ManagerEngineID} | {error, Reason} Initiate the discovery process with a manager TargetName = string() @@ -1379,7 +1379,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - convert_config(OldConfig) -> AgentConfig + convert_config(OldConfig) -> AgentConfig Convert old snmp config to new agent config OldConfig = list() @@ -1403,8 +1403,8 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - restart_worker() -> void() - restart_worker(Agent) -> void() + restart_worker() -> void() + restart_worker(Agent) -> void() Restart the worker process of a multi-threaded agent Agent = pid() | atom() @@ -1419,8 +1419,8 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - restart_set_worker() -> void() - restart_set_worker(Agent) -> void() + restart_set_worker() -> void() + restart_set_worker(Agent) -> void() Restart the set worker process of a multi-threaded agent Agent = pid() | atom() @@ -1468,7 +1468,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - verbosity(Ref,Verbosity) -> void() + verbosity(Ref,Verbosity) -> void() Assign a new verbosity for the process Ref = pid() | sub_agents | master_agent | net_if | mib_server | symbolic_store | note_store | local_db diff --git a/lib/snmp/doc/src/snmpa_conf.xml b/lib/snmp/doc/src/snmpa_conf.xml index 01c52c3c8a..4134a81c0c 100644 --- a/lib/snmp/doc/src/snmpa_conf.xml +++ b/lib/snmp/doc/src/snmpa_conf.xml @@ -32,7 +32,7 @@ snmpa_conf.xml - snmpa_conf + snmpa_conf Utility functions for handling the agent config files.

The module snmpa_conf contains various utility functions to @@ -92,7 +92,7 @@ word() = 0..65535 - agent_entry(Tag, Val) -> agent_entry() + agent_entry(Tag, Val) -> agent_entry() Create an agent entry Tag = intAgentTransports | intAgentUDPPort | intAgentMaxPacketSize | snmpEngineMaxMessageSize | snmpEngineID @@ -111,8 +111,8 @@ word() = 0..65535 - write_agent_config(Dir, Conf) -> ok - write_agent_config(Dir, Hdr, Conf) -> ok + write_agent_config(Dir, Conf) -> ok + write_agent_config(Dir, Hdr, Conf) -> ok Write the agent config to the config file Dir = string() @@ -134,7 +134,7 @@ word() = 0..65535 - append_agent_config(Dir, Conf) -> ok + append_agent_config(Dir, Conf) -> ok Append the agent config to the config file Dir = string() @@ -153,7 +153,7 @@ word() = 0..65535 - read_agent_config(Dir) -> Conf + read_agent_config(Dir) -> Conf Read the agent config from the config file Dir = string() @@ -172,7 +172,7 @@ word() = 0..65535 - standard_entry(Tag, Val) -> standard_entry() + standard_entry(Tag, Val) -> standard_entry() Create an standard entry Tag = sysDescr | sysObjectID | sysContact | sysName | sysLocation | sysServices | snmpEnableAuthenTraps @@ -192,8 +192,8 @@ word() = 0..65535 - write_standard_config(Dir, Conf) -> ok - write_standard_config(Dir, Hdr, Conf) -> ok + write_standard_config(Dir, Conf) -> ok + write_standard_config(Dir, Hdr, Conf) -> ok Write the agent standard config to the config file Dir = string() @@ -216,7 +216,7 @@ word() = 0..65535 - append_standard_config(Dir, Conf) -> ok + append_standard_config(Dir, Conf) -> ok Append the agent standard config to the config file Dir = string() @@ -236,7 +236,7 @@ word() = 0..65535 - read_standard_config(Dir) -> Conf + read_standard_config(Dir) -> Conf Read the agent standard config from the config file Dir = string() @@ -255,7 +255,7 @@ word() = 0..65535 - context_entry(Context) -> context_entry() + context_entry(Context) -> context_entry() Create an context entry Context = string() @@ -273,8 +273,8 @@ word() = 0..65535 - write_context_config(Dir, Conf) -> ok - write_context_config(Dir, Hdr, Conf) -> ok + write_context_config(Dir, Conf) -> ok + write_context_config(Dir, Hdr, Conf) -> ok Write the agent context(s) to the config file Dir = string() @@ -297,7 +297,7 @@ word() = 0..65535 - append_context_config(Dir, Conf) -> ok + append_context_config(Dir, Conf) -> ok Append the agent context(s) to the config file Dir = string() @@ -317,7 +317,7 @@ word() = 0..65535 - read_context_config(Dir) -> Conf + read_context_config(Dir) -> Conf Read the agent context config from the config file Dir = string() @@ -336,8 +336,8 @@ word() = 0..65535 - community_entry(CommunityIndex) -> community_entry() - community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry() + community_entry(CommunityIndex) -> community_entry() + community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry() Create an community entry CommunityIndex = string() @@ -364,8 +364,8 @@ word() = 0..65535 - write_community_config(Dir, Conf) -> ok - write_community_config(Dir, Hdr, Conf) -> ok + write_community_config(Dir, Conf) -> ok + write_community_config(Dir, Hdr, Conf) -> ok Write the agent community config to the config file Dir = string() @@ -388,7 +388,7 @@ word() = 0..65535 - append_community_config(Dir, Conf) -> ok + append_community_config(Dir, Conf) -> ok Append the agent community config to the config file Dir = string() @@ -408,7 +408,7 @@ word() = 0..65535 - read_community_config(Dir) -> Conf + read_community_config(Dir) -> Conf Read the agent community config from the config file Dir = string() @@ -427,10 +427,10 @@ word() = 0..65535 - target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId) -> target_addr_entry() + target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId) -> target_addr_entry() target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask) -> target_addr_entry() - target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() - target_addr_entry(Name, Domain, Addr, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() + target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() + target_addr_entry(Name, Domain, Addr, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() Create an target_addr entry Name = string() @@ -464,8 +464,8 @@ word() = 0..65535 - write_target_addr_config(Dir, Conf) -> ok - write_target_addr_config(Dir, Hdr, Conf) -> ok + write_target_addr_config(Dir, Conf) -> ok + write_target_addr_config(Dir, Hdr, Conf) -> ok Write the agent target_addr config to the config file Dir = string() @@ -488,7 +488,7 @@ word() = 0..65535 - append_target_addr_config(Dir, Conf) -> ok + append_target_addr_config(Dir, Conf) -> ok Append the agent target_addr config to the config file Dir = string() @@ -508,7 +508,7 @@ word() = 0..65535 - read_target_addr_config(Dir) -> Conf + read_target_addr_config(Dir) -> Conf Read the agent target_addr config from the config file Dir = string() @@ -527,9 +527,9 @@ word() = 0..65535 - target_params_entry(Name, Vsn) -> target_params_entry() - target_params_entry(Name, Vsn, SecName, SecLevel) -> target_params_entry() - target_params_entry(Name, MPModel, SecModel, SecName, SecLevel) -> target_params_entry() + target_params_entry(Name, Vsn) -> target_params_entry() + target_params_entry(Name, Vsn, SecName, SecLevel) -> target_params_entry() + target_params_entry(Name, MPModel, SecModel, SecName, SecLevel) -> target_params_entry() Create an target_params entry Name = string() @@ -564,8 +564,8 @@ word() = 0..65535 - write_target_params_config(Dir, Conf) -> ok - write_target_params_config(Dir, Hdr, Conf) -> ok + write_target_params_config(Dir, Conf) -> ok + write_target_params_config(Dir, Hdr, Conf) -> ok Write the agent target_params config to the config file Dir = string() @@ -588,7 +588,7 @@ word() = 0..65535 - append_target_params_config(Dir, Conf) -> ok + append_target_params_config(Dir, Conf) -> ok Append the agent target_params config to the config file Dir = string() @@ -608,7 +608,7 @@ word() = 0..65535 - read_target_params_config(Dir) -> Conf + read_target_params_config(Dir) -> Conf Read the agent target_params config from the config file Dir = string() @@ -627,10 +627,10 @@ word() = 0..65535 - vacm_s2g_entry(SecModel, SecName, GroupName) -> vacm_s2g_entry() - vacm_acc_entry(GroupName, Prefix, SecModel, SecLevel, Match, ReadView, WriteView, NotifyView) -> vacm_acc_entry() - vacm_vtf_entry(ViewIndex, ViewSubtree) -> vacm_vtf_entry() - vacm_vtf_entry(ViewIndex, ViewSubtree, ViewStatus, ViewMask) -> vacm_vtf_entry() + vacm_s2g_entry(SecModel, SecName, GroupName) -> vacm_s2g_entry() + vacm_acc_entry(GroupName, Prefix, SecModel, SecLevel, Match, ReadView, WriteView, NotifyView) -> vacm_acc_entry() + vacm_vtf_entry(ViewIndex, ViewSubtree) -> vacm_vtf_entry() + vacm_vtf_entry(ViewIndex, ViewSubtree, ViewStatus, ViewMask) -> vacm_vtf_entry() Create an vacm entry SecModel = v1 | v2c | usm @@ -665,8 +665,8 @@ word() = 0..65535 - write_vacm_config(Dir, Conf) -> ok - write_vacm_config(Dir, Hdr, Conf) -> ok + write_vacm_config(Dir, Conf) -> ok + write_vacm_config(Dir, Hdr, Conf) -> ok Write the agent vacm config to the config file Dir = string() @@ -690,7 +690,7 @@ word() = 0..65535 - append_vacm_config(Dir, Conf) -> ok + append_vacm_config(Dir, Conf) -> ok Append the agent vacm config to the config file Dir = string() @@ -710,7 +710,7 @@ word() = 0..65535 - read_vacm_config(Dir) -> Conf + read_vacm_config(Dir) -> Conf Read the agent vacm config from the config file Dir = string() @@ -729,8 +729,8 @@ word() = 0..65535 - usm_entry(EngineId) -> usm_entry() - usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry() + usm_entry(EngineId) -> usm_entry() + usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry() Create an usm entry EngineId = string() @@ -762,8 +762,8 @@ word() = 0..65535 - write_usm_config(Dir, Conf) -> ok - write_usm_config(Dir, Hdr, Conf) -> ok + write_usm_config(Dir, Conf) -> ok + write_usm_config(Dir, Hdr, Conf) -> ok Write the agent usm config to the config file Dir = string() @@ -786,7 +786,7 @@ word() = 0..65535 - append_usm_config(Dir, Conf) -> ok + append_usm_config(Dir, Conf) -> ok Append the agent usm config to the config file Dir = string() @@ -805,7 +805,7 @@ word() = 0..65535 - read_usm_config(Dir) -> Conf + read_usm_config(Dir) -> Conf Read the agent usm config from the config file Dir = string() @@ -824,7 +824,7 @@ word() = 0..65535 - notify_entry(Name, Tag, Type) -> notify_entry() + notify_entry(Name, Tag, Type) -> notify_entry() Create an notify entry Name = string() @@ -845,8 +845,8 @@ word() = 0..65535 - write_notify_config(Dir, Conf) -> ok - write_notify_config(Dir, Hdr, Conf) -> ok + write_notify_config(Dir, Conf) -> ok + write_notify_config(Dir, Hdr, Conf) -> ok Write the agent notify config to the config file Dir = string() @@ -869,7 +869,7 @@ word() = 0..65535 - append_notify_config(Dir, Conf) -> ok + append_notify_config(Dir, Conf) -> ok Append the agent notify config to the config file Dir = string() @@ -889,7 +889,7 @@ word() = 0..65535 - read_notify_config(Dir) -> Conf + read_notify_config(Dir) -> Conf Read the agent notify config from the config file Dir = string() diff --git a/lib/snmp/doc/src/snmpa_discovery_handler.xml b/lib/snmp/doc/src/snmpa_discovery_handler.xml index 0ea72a880c..21b8746c11 100644 --- a/lib/snmp/doc/src/snmpa_discovery_handler.xml +++ b/lib/snmp/doc/src/snmpa_discovery_handler.xml @@ -32,7 +32,7 @@ snmpa_discovery_handler.xml - snmpa_discovery_handler + snmpa_discovery_handler Behaviour module for the SNMP agent discovery handler.

This module defines the behaviour of the agent discovery @@ -51,7 +51,7 @@ - stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo} + stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo} Discovery stage 1 finish TargetName = string() diff --git a/lib/snmp/doc/src/snmpa_error.xml b/lib/snmp/doc/src/snmpa_error.xml index 7cc4a3513d..6e6761b7a5 100644 --- a/lib/snmp/doc/src/snmpa_error.xml +++ b/lib/snmp/doc/src/snmpa_error.xml @@ -32,7 +32,7 @@ snmpa_error.xml - snmpa_error + snmpa_error Functions for Reporting SNMP Errors @@ -57,7 +57,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -76,7 +76,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_io.xml b/lib/snmp/doc/src/snmpa_error_io.xml index bcb2688646..d78e09ff13 100644 --- a/lib/snmp/doc/src/snmpa_error_io.xml +++ b/lib/snmp/doc/src/snmpa_error_io.xml @@ -32,7 +32,7 @@ snmpa_error_io.xml - snmpa_error_io + snmpa_error_io Functions for Reporting SNMP Errors on stdio

The module snmpa_error_io implements the @@ -52,7 +52,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -68,7 +68,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_logger.xml b/lib/snmp/doc/src/snmpa_error_logger.xml index 4feb2e7f32..b0565a6839 100644 --- a/lib/snmp/doc/src/snmpa_error_logger.xml +++ b/lib/snmp/doc/src/snmpa_error_logger.xml @@ -32,7 +32,7 @@ snmpa_error_logger.xml - snmpa_error_logger + snmpa_error_logger Functions for Reporting SNMP Errors through the error_logger

The module snmpa_error_logger implements the @@ -54,7 +54,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -70,7 +70,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_report.xml b/lib/snmp/doc/src/snmpa_error_report.xml index 282d9b4e59..f08dc1df23 100644 --- a/lib/snmp/doc/src/snmpa_error_report.xml +++ b/lib/snmp/doc/src/snmpa_error_report.xml @@ -32,7 +32,7 @@ snmpa_error_report.xml - snmpa_error_report + snmpa_error_report Behaviour module for reporting SNMP agent errors @@ -52,7 +52,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -68,7 +68,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_local_db.xml b/lib/snmp/doc/src/snmpa_local_db.xml index ac8d466ab3..229f22ab70 100644 --- a/lib/snmp/doc/src/snmpa_local_db.xml +++ b/lib/snmp/doc/src/snmpa_local_db.xml @@ -32,7 +32,7 @@ snmpa_local_db.xml - snmpa_local_db + snmpa_local_db The SNMP built-in database

The module snmpa_local_db contains functions for @@ -86,7 +86,7 @@ - dump() -> ok | {error, Reason} + dump() -> ok | {error, Reason} Dump the database to disk Reason = term() @@ -97,7 +97,7 @@ - match(NameDb, Pattern) + match(NameDb, Pattern) Perform a match on the table

Performs an ets/dets matching on the table. @@ -106,9 +106,9 @@ - print() - print(TableName) - print(TableName, Db) + print() + print(TableName) + print(TableName, Db) Print the database to screen TableName = atom() @@ -124,7 +124,7 @@ - table_create(NameDb) -> bool() + table_create(NameDb) -> bool() Create a table

Creates a table. If the table already exist, the old copy @@ -135,7 +135,7 @@ - table_create_row(NameDb, RowIndex, Row) -> bool() + table_create_row(NameDb, RowIndex, Row) -> bool() Create a row in a table Row = {Val1, Val2, ..., ValN} @@ -147,28 +147,28 @@ - table_delete(NameDb) -> void() + table_delete(NameDb) -> void() Delete a table

Deletes a table.

 - table_delete_row(NameDb, RowIndex) -> bool() + table_delete_row(NameDb, RowIndex) -> bool() Delete the row in the table

Deletes the row in the table.

 - table_exists(NameDb) -> bool() + table_exists(NameDb) -> bool() Check if a table exists

Checks if a table exists.

 - table_get_row(NameDb, RowIndex) -> Row | undefined + table_get_row(NameDb, RowIndex) -> Row | undefined Get a row from the table Row = {Val1, Val2, ..., ValN} diff --git a/lib/snmp/doc/src/snmpa_mpd.xml b/lib/snmp/doc/src/snmpa_mpd.xml index 4a0c5b61d5..d76a9c4a94 100644 --- a/lib/snmp/doc/src/snmpa_mpd.xml +++ b/lib/snmp/doc/src/snmpa_mpd.xml @@ -32,7 +32,7 @@ snmpa_mpd.xml - snmpa_mpd + snmpa_mpd Message Processing and Dispatch module for the SNMP agent

The module snmpa_mpd implements the version independent @@ -52,7 +52,7 @@ - init(Vsns) -> mpd_state() + init(Vsns) -> mpd_state() Initialize the MPD module Vsns = [Vsn] @@ -211,7 +211,7 @@ - discarded_pdu(Variable) -> void() + discarded_pdu(Variable) -> void() Increment the variable associated with a discarded pdu Variable = atom() diff --git a/lib/snmp/doc/src/snmpa_network_interface.xml b/lib/snmp/doc/src/snmpa_network_interface.xml index d4d4989e90..3e79df11b1 100644 --- a/lib/snmp/doc/src/snmpa_network_interface.xml +++ b/lib/snmp/doc/src/snmpa_network_interface.xml @@ -32,7 +32,7 @@ snmpa_network_interface.xml - snmpa_network_interface + snmpa_network_interface Behaviour module for the SNMP agent network interface.

This module defines the behaviour of the agent network @@ -68,7 +68,7 @@ - start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason} + start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason} Start-link the network interface process Prio = priority() @@ -93,7 +93,7 @@ - info(Pid) -> [{Key, Value}] + info(Pid) -> [{Key, Value}] Return information about the running network interface process Pid = pid() @@ -112,7 +112,7 @@ - verbosity(Pid, Verbosity) -> void() + verbosity(Pid, Verbosity) -> void() Change the verbosity of a running network interface process Pid = pid() @@ -126,7 +126,7 @@ - get_log_type(Pid) -> {ok, LogType} | {error, Reason} + get_log_type(Pid) -> {ok, LogType} | {error, Reason} Get the Audit Trail Log type Pid = pid() @@ -147,7 +147,7 @@ - set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type Pid = pid() diff --git a/lib/snmp/doc/src/snmpa_network_interface_filter.xml b/lib/snmp/doc/src/snmpa_network_interface_filter.xml index 7cd08f8935..02c7d291dd 100644 --- a/lib/snmp/doc/src/snmpa_network_interface_filter.xml +++ b/lib/snmp/doc/src/snmpa_network_interface_filter.xml @@ -32,7 +32,7 @@ snmpa_network_interface_filter.xml - snmpa_network_interface_filter + snmpa_network_interface_filter Behaviour module for the SNMP agent network-interface filter.

This module defines the behaviour of the agent network interface @@ -101,7 +101,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv(Domain, Addr) -> boolean() + accept_recv(Domain, Addr) -> boolean() Shall the received message be accepted Domain = transportDomain() @@ -116,7 +116,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send(Domain, Addr) -> boolean() + accept_send(Domain, Addr) -> boolean() Shall the message be sent Domain = transportDomain() @@ -131,7 +131,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv_pdu(Domain, Addr, PduType) -> boolean() + accept_recv_pdu(Domain, Addr, PduType) -> boolean() Shall the received pdu be accepted Domain = transportDomain() @@ -148,7 +148,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send_pdu(Targets, PduType) -> Reply + accept_send_pdu(Targets, PduType) -> Reply Shall the pdu be sent Targets = targets() diff --git a/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml b/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml index cbae158544..5dad372710 100644 --- a/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml +++ b/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml @@ -34,7 +34,7 @@ snmpa_notification_delivery_info_receiver.xml - snmpa_notification_delivery_info_receiver + snmpa_notification_delivery_info_receiver Behaviour module for the SNMP agent notification delivery information receiver. @@ -76,7 +76,7 @@ - delivery_targets(Tag, Targets, Extra) -> void() + delivery_targets(Tag, Targets, Extra) -> void() Inform about target addresses Tag = term() @@ -97,7 +97,7 @@ - delivery_info(Tag, Target, DeliveryResult, Extra) -> void() + delivery_info(Tag, Target, DeliveryResult, Extra) -> void() Inform about delivery result Tag = term() diff --git a/lib/snmp/doc/src/snmpa_notification_filter.xml b/lib/snmp/doc/src/snmpa_notification_filter.xml index 0f16ba4440..902412ccc5 100644 --- a/lib/snmp/doc/src/snmpa_notification_filter.xml +++ b/lib/snmp/doc/src/snmpa_notification_filter.xml @@ -32,7 +32,7 @@ snmpa_notification_filter.xml - snmpa_notification_filter + snmpa_notification_filter Behaviour module for the SNMP agent notification filters.

This module defines the behaviour of the agent notification @@ -51,7 +51,7 @@ - handle_notification(Notif, Data) -> Reply + handle_notification(Notif, Data) -> Reply Handle a notification Reply = send | {send, NewNotif} | dont_send diff --git a/lib/snmp/doc/src/snmpa_supervisor.xml b/lib/snmp/doc/src/snmpa_supervisor.xml index 86c6fbc350..e11cde390f 100644 --- a/lib/snmp/doc/src/snmpa_supervisor.xml +++ b/lib/snmp/doc/src/snmpa_supervisor.xml @@ -32,7 +32,7 @@ snmpa_supervisor.xml - snmpa_supervisor + snmpa_supervisor A supervisor for the SNMP agent Processes

This is the top supervisor for the agent part of the SNMP @@ -42,7 +42,7 @@ - start_sub_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} + start_sub_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} Start the SNMP supervisor for sub-agents only Opts = [opt()] @@ -60,7 +60,7 @@ - start_master_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} + start_master_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} Start the SNMP supervisor for all agents Opts = [opt()] @@ -82,7 +82,7 @@ - start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Reason} + start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Reason} Start a sub-agent ParentAgent = pid() @@ -99,7 +99,7 @@ - stop_sub_agent(SubAgent) -> ok | no_such_child + stop_sub_agent(SubAgent) -> ok | no_such_child Stop a sub-agent SubAgent = pid() diff --git a/lib/snmp/doc/src/snmpc.xml b/lib/snmp/doc/src/snmpc.xml index aba51bb500..b22b32a133 100644 --- a/lib/snmp/doc/src/snmpc.xml +++ b/lib/snmp/doc/src/snmpc.xml @@ -32,7 +32,7 @@ snmpc.xml - snmpc + snmpc Interface Functions to the SNMP toolkit MIB compiler

The module snmpc contains interface functions to the @@ -43,8 +43,8 @@ - compile(File) - compile(File, Options) -> {ok, BinFileName} | {error, Reason} + compile(File) + compile(File, Options) -> {ok, BinFileName} | {error, Reason} Compile the specified MIB File = string() @@ -236,7 +236,7 @@ - is_consistent(Mibs) -> ok | {error, Reason} + is_consistent(Mibs) -> ok | {error, Reason} Check for OID conflicts between MIBs Mibs = [MibName] @@ -252,7 +252,7 @@ - mib_to_hrl(MibName) -> ok | {error, Reason} + mib_to_hrl(MibName) -> ok | {error, Reason} Generate constants for the objects in the MIB MibName = string() diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index 9b8029330e..c45df98ee0 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -32,7 +32,7 @@ snmpm.xml - snmpm + snmpm Interface functions to the SNMP toolkit manager

The module snmpm contains interface functions to the @@ -77,7 +77,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - monitor() -> Ref + monitor() -> Ref Monitor the snmp manager Ref = reference() @@ -92,7 +92,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - demonitor(Ref) -> void() + demonitor(Ref) -> void() Turn off monitoring of the snmp manager Ref = reference() @@ -105,7 +105,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - notify_started(Timeout) -> Pid + notify_started(Timeout) -> Pid Request to be notified when manager started Timeout = integer() @@ -148,7 +148,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - cancel_notify_started(Pid) -> void() + cancel_notify_started(Pid) -> void() Cancel request to be notified when manager started Pid = pid() @@ -161,8 +161,8 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - register_user(Id, Module, Data) -> ok | {error, Reason} - register_user(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} + register_user(Id, Module, Data) -> ok | {error, Reason} + register_user(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} Register a user of the manager Id = term() @@ -204,8 +204,8 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_user_monitor(Id, Module, Data) -> ok | {error, Reason} - register_user_monitor(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} + register_user_monitor(Id, Module, Data) -> ok | {error, Reason} + register_user_monitor(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} Register a monitored user of the manager Id = term() @@ -252,7 +252,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - unregister_user(Id) -> ok | {error, Reason} + unregister_user(Id) -> ok | {error, Reason} Unregister the user Id = term() @@ -265,7 +265,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - which_users() -> Users + which_users() -> Users Get a list of all users Users = [UserId] @@ -279,7 +279,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_agent(UserId, TargetName, Config) -> ok | {error, Reason} + register_agent(UserId, TargetName, Config) -> ok | {error, Reason} Register this agent UserId = term() @@ -325,7 +325,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - unregister_agent(UserId, TargetName) -> ok | {error, Reason} + unregister_agent(UserId, TargetName) -> ok | {error, Reason} Unregister the user UserId = term() @@ -339,7 +339,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - agent_info(TargetName, Item) -> {ok, Val} | {error, Reason} + agent_info(TargetName, Item) -> {ok, Val} | {error, Reason} Retrieve agent config TargetName = target_name() @@ -355,7 +355,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv update_agent_info(UserId, TargetName, Info) -> ok | {error, Reason} - update_agent_info(UserId, TargetName, Item, Val) -> ok | {error, Reason} + update_agent_info(UserId, TargetName, Item, Val) -> ok | {error, Reason} Update agent config UserId = term() @@ -379,8 +379,8 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - which_agents() -> Agents - which_agents(UserId) -> Agents + which_agents() -> Agents + which_agents(UserId) -> Agents List the registered agents UserId = term() @@ -396,7 +396,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_usm_user(EngineID, UserName, Conf) -> ok | {error, Reason} + register_usm_user(EngineID, UserName, Conf) -> ok | {error, Reason} Register this USM user EngineID = string() @@ -427,7 +427,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - unregister_usm_user(EngineID, UserName) -> ok | {error, Reason} + unregister_usm_user(EngineID, UserName) -> ok | {error, Reason} Unregister this USM user EngineID = string() @@ -442,7 +442,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - usm_user_info(EngineID, UserName, Item) -> {ok, Val} | {error, Reason} + usm_user_info(EngineID, UserName, Item) -> {ok, Val} | {error, Reason} Retrieve usm user config EngineID = string() @@ -458,7 +458,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - update_usm_user_info(EngineID, UserName, Item, Val) -> ok | {error, Reason} + update_usm_user_info(EngineID, UserName, Item, Val) -> ok | {error, Reason} Update agent config EngineID = string() @@ -475,7 +475,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_usm_users() -> UsmUsers + which_usm_users() -> UsmUsers List all the registered usm users UsmUsers = [{EngineID,UserName}] @@ -490,7 +490,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_usm_users(EngineID) -> UsmUsers + which_usm_users(EngineID) -> UsmUsers List the registered usm users UsmUsers = [UserName] @@ -559,11 +559,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-request UserId = term() @@ -647,11 +647,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-request UserId = term() @@ -737,11 +737,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get_next(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-next-request UserId = term() @@ -814,11 +814,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get_next(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-next-request UserId = term() @@ -906,11 +906,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_set(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous set-request UserId = term() @@ -990,11 +990,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_set(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous set-request UserId = term() @@ -1082,11 +1082,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-bulk-request UserId = term() @@ -1162,11 +1162,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-bulk-request UserId = term() @@ -1199,7 +1199,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - cancel_async_request(UserId, ReqId) -> ok | {error, Reason} + cancel_async_request(UserId, ReqId) -> ok | {error, Reason} Cancel a asynchronous request UserId = term() @@ -1215,13 +1215,13 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 log_to_txt(LogDir) - log_to_txt(LogDir, Block | Mibs) - log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Block | Mibs) + log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -1299,7 +1299,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - change_log_size(NewSize) -> ok | {error, Reason} + change_log_size(NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log NewSize = {MaxBytes, MaxFiles} @@ -1321,7 +1321,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - set_log_type(NewType) -> {ok, OldType} | {error, Reason} + set_log_type(NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type NewType = OldType = atl_type() @@ -1340,7 +1340,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - load_mib(Mib) -> ok | {error, Reason} + load_mib(Mib) -> ok | {error, Reason} Load a MIB into the manager Mib = MibName @@ -1361,7 +1361,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - unload_mib(Mib) -> ok | {error, Reason} + unload_mib(Mib) -> ok | {error, Reason} Unload a MIB from the manager Mib = MibName @@ -1382,7 +1382,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_mibs() -> Mibs + which_mibs() -> Mibs Which mibs are loaded into the manager Mibs = [{MibName, MibFile}] @@ -1397,7 +1397,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - name_to_oid(Name) -> {ok, Oids} | {error, Reason} + name_to_oid(Name) -> {ok, Oids} | {error, Reason} Get all the possible oid's for an alias-name Name = atom() @@ -1414,7 +1414,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - oid_to_name(Oid) -> {ok, Name} | {error, Reason} + oid_to_name(Oid) -> {ok, Name} | {error, Reason} Get the alias-name of the oid Oid = oid() @@ -1429,7 +1429,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - oid_to_type(Oid) -> {ok, Type} | {error, Reason} + oid_to_type(Oid) -> {ok, Type} | {error, Reason} Get the type of the the oid Oid = oid() @@ -1444,7 +1444,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - backup(BackupDir) -> ok | {error, Reason} + backup(BackupDir) -> ok | {error, Reason} Backup manager data BackupDir = string() @@ -1458,7 +1458,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - info() -> [{Key, Value}] + info() -> [{Key, Value}] Return information about the manager Key = atom() @@ -1475,7 +1475,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - verbosity(Ref, Verbosity) -> void() + verbosity(Ref, Verbosity) -> void() Assign a new verbosity for the process Ref = server | config | net_if | note_store | all @@ -1492,8 +1492,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - format_reason(Reason) -> string() - format_reason(Prefix, Reason) -> string() + format_reason(Reason) -> string() + format_reason(Prefix, Reason) -> string() Assign a new verbosity for the process Reason = term() diff --git a/lib/snmp/doc/src/snmpm_conf.xml b/lib/snmp/doc/src/snmpm_conf.xml index a3097e5f7e..17ecf2df7c 100644 --- a/lib/snmp/doc/src/snmpm_conf.xml +++ b/lib/snmp/doc/src/snmpm_conf.xml @@ -32,7 +32,7 @@ snmpm_conf.xml - snmpm_conf + snmpm_conf Utility functions for handling the manager config files.

The module snmpm_conf contains various utility functions to @@ -42,7 +42,7 @@ - manager_entry(Tag, Val) -> manager_entry() + manager_entry(Tag, Val) -> manager_entry() Create an manager entry Tag = address | port | engine_id | max_message_size @@ -60,8 +60,8 @@ - write_manager_config(Dir, Conf) -> ok - write_manager_config(Dir, Hdr, Conf) -> ok + write_manager_config(Dir, Conf) -> ok + write_manager_config(Dir, Hdr, Conf) -> ok Write the manager config to the config file Dir = string() @@ -81,7 +81,7 @@ - append_manager_config(Dir, Conf) -> ok + append_manager_config(Dir, Conf) -> ok Append the manager config to the config file Dir = string() @@ -98,7 +98,7 @@ - read_manager_config(Dir) -> Conf + read_manager_config(Dir) -> Conf Read the manager config from the config file Dir = string() @@ -115,9 +115,9 @@ - users_entry(UserId) -> users_entry() - users_entry(UserId, UserMod) -> users_entry() - users_entry(UserId, UserMod, UserData) -> users_entry() + users_entry(UserId) -> users_entry() + users_entry(UserId, UserMod) -> users_entry() + users_entry(UserId, UserMod, UserData) -> users_entry() Create an users entry UserId = term() @@ -139,8 +139,8 @@ - write_users_config(Dir, Conf) -> ok - write_users_config(Dir, Hdr, Conf) -> ok + write_users_config(Dir, Conf) -> ok + write_users_config(Dir, Hdr, Conf) -> ok Write the manager users config to the config file Dir = string() @@ -161,7 +161,7 @@ - append_users_config(Dir, Conf) -> ok + append_users_config(Dir, Conf) -> ok Append the manager users config to the config file Dir = string() @@ -179,7 +179,7 @@ - read_users_config(Dir) -> Conf + read_users_config(Dir) -> Conf Read the manager users config from the config file Dir = string() @@ -196,7 +196,7 @@ - agents_entry(UserId, TargetName, Comm, Domain, Addr, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry() + agents_entry(UserId, TargetName, Comm, Domain, Addr, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry() Create an agents entry UserId = term() @@ -223,8 +223,8 @@ - write_agents_config(Dir, Conf) -> ok - write_agents_config(Dir, Hdr, Conf) -> ok + write_agents_config(Dir, Conf) -> ok + write_agents_config(Dir, Hdr, Conf) -> ok Write the manager agents to the config file Dir = string() @@ -245,7 +245,7 @@ - append_agents_config(Dir, Conf) -> ok + append_agents_config(Dir, Conf) -> ok Append the manager agents to the config file Dir = string() @@ -263,7 +263,7 @@ - read_agents_config(Dir) -> Conf + read_agents_config(Dir) -> Conf Read the manager agents config from the config file Dir = string() @@ -280,8 +280,8 @@ - usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() - usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() + usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() + usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() Create an usm entry EngineID = string() @@ -303,8 +303,8 @@ - write_usm_config(Dir, Conf) -> ok - write_usm_config(Dir, Hdr, Conf) -> ok + write_usm_config(Dir, Conf) -> ok + write_usm_config(Dir, Hdr, Conf) -> ok Write the manager usm config to the config file Dir = string() @@ -325,7 +325,7 @@ - append_usm_config(Dir, Conf) -> ok + append_usm_config(Dir, Conf) -> ok Append the manager usm config to the config file Dir = string() @@ -343,7 +343,7 @@ - read_usm_config(Dir) -> Conf + read_usm_config(Dir) -> Conf Read the manager usm config from the config file Dir = string() diff --git a/lib/snmp/doc/src/snmpm_mpd.xml b/lib/snmp/doc/src/snmpm_mpd.xml index c8b2797ea7..b024f8d294 100644 --- a/lib/snmp/doc/src/snmpm_mpd.xml +++ b/lib/snmp/doc/src/snmpm_mpd.xml @@ -32,7 +32,7 @@ snmpm_mpd.xml - snmpm_mpd + snmpm_mpd Message Processing and Dispatch module for the SNMP manager

The module snmpm_mpd implements the version independent @@ -48,7 +48,7 @@ - init_mpd(Vsns) -> mpd_state() + init_mpd(Vsns) -> mpd_state() Initialize the MPD module Vsns = [Vsn] @@ -92,7 +92,7 @@ - generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} + generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} Generate a request message to be sent to the network Vsn = 'version-1' | 'version-2' | 'version-3' @@ -117,7 +117,7 @@ - generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} + generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} Generate a response packet to be sent to the network Vsn = 'version-1' | 'version-2' | 'version-3' diff --git a/lib/snmp/doc/src/snmpm_network_interface.xml b/lib/snmp/doc/src/snmpm_network_interface.xml index 73892aa2e8..e4a66ceef2 100644 --- a/lib/snmp/doc/src/snmpm_network_interface.xml +++ b/lib/snmp/doc/src/snmpm_network_interface.xml @@ -32,7 +32,7 @@ snmpm_network_interface.xml - snmpm_network_interface + snmpm_network_interface Behaviour module for the SNMP manager network interface.

This module defines the behaviour of the manager network @@ -79,7 +79,7 @@ - start_link(Server, NoteStore) -> {ok, Pid} | {error, Reason} + start_link(Server, NoteStore) -> {ok, Pid} | {error, Reason} Start-link the network interface process Server = pid() @@ -95,7 +95,7 @@ - stop(Pid) -> void() + stop(Pid) -> void() Stop the network interface process Pid = pid() @@ -108,7 +108,7 @@ - send_pdu(Pid, Pdu, Vsn, MsgData, Domain, Addr, ExtraInfo) -> void() + send_pdu(Pid, Pdu, Vsn, MsgData, Domain, Addr, ExtraInfo) -> void() Request the network interface process to send this pdu Pid = pid() @@ -142,7 +142,7 @@ - inform_response(Pid, Ref, Addr, Port) -> void() + inform_response(Pid, Ref, Addr, Port) -> void() Send the inform-request ack Pid = pid() @@ -163,7 +163,7 @@ - note_store(Pid, NoteStore) -> void() + note_store(Pid, NoteStore) -> void() Change the verbosity of the network interface process Pid = pid() @@ -179,7 +179,7 @@ - info(Pid) -> [{Key, Value}] + info(Pid) -> [{Key, Value}] Return information about the running network interface process Pid = pid() @@ -198,7 +198,7 @@ - verbosity(Pid, Verbosity) -> void() + verbosity(Pid, Verbosity) -> void() Change the verbosity of the network interface process Pid = pid() @@ -212,7 +212,7 @@ - get_log_type(Pid) -> {ok, LogType} | {error, Reason} + get_log_type(Pid) -> {ok, LogType} | {error, Reason} Get the Audit Trail Log type Pid = pid() @@ -233,7 +233,7 @@ - set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type Pid = pid() diff --git a/lib/snmp/doc/src/snmpm_network_interface_filter.xml b/lib/snmp/doc/src/snmpm_network_interface_filter.xml index 742cd53fc6..a50572da51 100644 --- a/lib/snmp/doc/src/snmpm_network_interface_filter.xml +++ b/lib/snmp/doc/src/snmpm_network_interface_filter.xml @@ -32,7 +32,7 @@ snmpm_network_interface_filter.xml - snmpm_network_interface_filter + snmpm_network_interface_filter Behaviour module for the SNMP manager network-interface filter.

This module defines the behaviour of the manager network interface @@ -100,7 +100,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv(Domain, Addr) -> boolean() + accept_recv(Domain, Addr) -> boolean() Shall the received message be accepted Domain = transportDomain() @@ -116,7 +116,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send(Domain, Addr) -> boolean() + accept_send(Domain, Addr) -> boolean() Shall the message be sent Domain = transportDomain() @@ -132,7 +132,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv_pdu(Domain, Addr, PduType) -> boolean() + accept_recv_pdu(Domain, Addr, PduType) -> boolean() Shall the received pdu be accepted Domain = transportDomain() @@ -150,7 +150,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send_pdu(Domain, Addr, PduType) -> boolean() + accept_send_pdu(Domain, Addr, PduType) -> boolean() Shall the pdu be sent Domain = transportDomain() diff --git a/lib/snmp/doc/src/snmpm_user.xml b/lib/snmp/doc/src/snmpm_user.xml index ef35f0eaaf..9abf596c83 100644 --- a/lib/snmp/doc/src/snmpm_user.xml +++ b/lib/snmp/doc/src/snmpm_user.xml @@ -32,7 +32,7 @@ snmpm_user.xml - snmpm_user + snmpm_user Behaviour module for the SNMP manager user.

This module defines the behaviour of the manager user. @@ -93,7 +93,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_error(ReqId, Reason, UserData) -> void() + handle_error(ReqId, Reason, UserData) -> void() Handle error ReqId = integer() @@ -122,7 +122,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_agent(Domain, Addr, Type, SnmpInfo, UserData) -> Reply + handle_agent(Domain, Addr, Type, SnmpInfo, UserData) -> Reply Handle agent Domain = transportDomainUdpIpv4 | transportDomainUdpIpv6 @@ -181,7 +181,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_pdu(TargetName, ReqId, SnmpPduInfo, UserData) -> void() + handle_pdu(TargetName, ReqId, SnmpPduInfo, UserData) -> void() Handle the reply to an asynchronous request TargetName = target_name() @@ -202,7 +202,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_trap(TargetName, SnmpTrapInfo, UserData) -> Reply + handle_trap(TargetName, SnmpTrapInfo, UserData) -> Reply Handle a trap/notification message TargetName = TargetName2 = target_name() @@ -225,7 +225,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_inform(TargetName, SnmpInformInfo, UserData) -> Reply + handle_inform(TargetName, SnmpInformInfo, UserData) -> Reply Handle a inform message TargetName = TargetName2 = target_name() @@ -253,7 +253,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_report(TargetName, SnmpReportInfo, UserData) -> Reply + handle_report(TargetName, SnmpReportInfo, UserData) -> Reply Handle a report message TargetName = TargetName2 = target_name() diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 759c66d63c..1a53a2ea98 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -28,7 +28,7 @@ 2007-10-06 - ssh + ssh Main API of the ssh application

This is the interface module for the SSH application. @@ -1059,17 +1059,17 @@ - + Closes an SSH connection.

Closes an SSH connection.

 - connect(Host, Port, Options) -> Result - connect(Host, Port, Options, NegotiationTimeout) -> Result + connect(Host, Port, Options) -> Result + connect(Host, Port, Options, NegotiationTimeout) -> Result connect(TcpSocket, Options) -> Result - connect(TcpSocket, Options, NegotiationTimeout) -> Result + connect(TcpSocket, Options, NegotiationTimeout) -> Result Connects to an SSH server. Host = host() @@ -1098,7 +1098,7 @@ - + Retrieves information about a connection.

Retrieves information about a connection. The list Keys defines which information that @@ -1108,9 +1108,9 @@ - daemon(Port | TcpSocket) -> Result - daemon(Port | TcpSocket, Options) -> Result - daemon(HostAddress, Port, Options) -> Result + daemon(Port | TcpSocket) -> Result + daemon(Port | TcpSocket, Options) -> Result + daemon(HostAddress, Port, Options) -> Result Starts a server listening for SSH connections. Port = integer() @@ -1176,9 +1176,9 @@ - shell(Host | TcpSocket) -> Result - shell(Host | TcpSocket, Options) -> Result - shell(Host, Port, Options) -> Result + shell(Host | TcpSocket) -> Result + shell(Host | TcpSocket, Options) -> Result + shell(Host, Port, Options) -> Result Starts an interactive shell on a remote SSH server. Host = host() @@ -1203,8 +1203,8 @@ - - + + Starts the SSH application.

Utility function that starts the applications crypto, public_key, @@ -1215,7 +1215,7 @@ - + Stops the ssh application.

Stops the ssh application. @@ -1225,8 +1225,8 @@ - - + + Stops the listener and all connections started by the listener. @@ -1235,8 +1235,8 @@ - - + + Stops the listener, but leaves existing connections started by the listener operational. diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 7933cff511..2a701929f6 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -30,7 +30,7 @@ - ssh_connection + ssh_connection This module provides API functions to send SSH Connection Protocol events to the other side of an SSH channel. @@ -201,7 +201,7 @@ - adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok + adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok Adjusts the SSH flow control window. ConnectionRef = connection_ref() @@ -221,7 +221,7 @@ - close(ConnectionRef, ChannelId) -> ok + close(ConnectionRef, ChannelId) -> ok Sends a close message on the channel ChannelId. ConnectionRef = connection_ref() @@ -240,7 +240,7 @@ - exec(ConnectionRef, ChannelId, Command, TimeOut) -> ssh_request_status() | + exec(ConnectionRef, ChannelId, Command, TimeOut) -> ssh_request_status() | {error, reason()} Requests that the server starts the execution of the given command. @@ -284,7 +284,7 @@ - exit_status(ConnectionRef, ChannelId, Status) -> ok + exit_status(ConnectionRef, ChannelId, Status) -> ok Sends the exit status of a command to the client. ConnectionRef = connection_ref() @@ -339,7 +339,7 @@ - reply_request(ConnectionRef, WantReply, Status, ChannelId) -> ok + reply_request(ConnectionRef, WantReply, Status, ChannelId) -> ok Sends status replies to requests that want such replies. ConnectionRef = connection_ref() @@ -357,10 +357,10 @@ - send(ConnectionRef, ChannelId, Data) -> - send(ConnectionRef, ChannelId, Data, Timeout) -> - send(ConnectionRef, ChannelId, Type, Data) -> - send(ConnectionRef, ChannelId, Type, Data, TimeOut) -> + send(ConnectionRef, ChannelId, Data) -> + send(ConnectionRef, ChannelId, Data, Timeout) -> + send(ConnectionRef, ChannelId, Type, Data) -> + send(ConnectionRef, ChannelId, Type, Data, TimeOut) -> ok | {error, timeout} | {error, closed} Sends channel data. @@ -380,7 +380,7 @@ - send_eof(ConnectionRef, ChannelId) -> ok | {error, closed} + send_eof(ConnectionRef, ChannelId) -> ok | {error, closed} Sends EOF on channel ChannelId. ConnectionRef = connection_ref() @@ -392,8 +392,8 @@ - session_channel(ConnectionRef, Timeout) -> - session_channel(ConnectionRef, InitialWindowSize, + session_channel(ConnectionRef, Timeout) -> + session_channel(ConnectionRef, InitialWindowSize, MaxPacketSize, Timeout) -> {ok, channel_id()} | {error, reason()} Opens a channel for an SSH session. @@ -410,7 +410,7 @@ - setenv(ConnectionRef, ChannelId, Var, Value, TimeOut) -> ssh_request_status() | + setenv(ConnectionRef, ChannelId, Var, Value, TimeOut) -> ssh_request_status() | {error, reason()} Environment variables can be passed to the shell/command to be started later. @@ -428,7 +428,7 @@ - shell(ConnectionRef, ChannelId) -> ok | failure | {error, closed} + shell(ConnectionRef, ChannelId) -> ok | failure | {error, closed} Requests that the user default shell (typically defined in /etc/passwd in Unix systems) is to be executed at the server end. @@ -448,7 +448,7 @@ - subsystem(ConnectionRef, ChannelId, Subsystem, Timeout) -> ssh_request_status() | + subsystem(ConnectionRef, ChannelId, Subsystem, Timeout) -> ssh_request_status() | {error, reason()} Requests to execute a predefined subsystem on the server. diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 780e132ae2..c89092798d 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -29,7 +29,7 @@ ssh_sftp.sgml - ssh_sftp + ssh_sftp SFTP client.

This module implements an SSH FTP (SFTP) client. SFTP is a @@ -82,7 +82,7 @@ - apread(ChannelPid, Handle, Position, Len) -> {async, N} | {error, reason()} + apread(ChannelPid, Handle, Position, Len) -> {async, N} | {error, reason()} Reads asynchronously from an open file. ChannelPid = pid() @@ -98,7 +98,7 @@ - apwrite(ChannelPid, Handle, Position, Data) -> {async, N} | {error, reason()} + apwrite(ChannelPid, Handle, Position, Data) -> {async, N} | {error, reason()} Writes asynchronously to an open file. ChannelPid = pid() @@ -116,7 +116,7 @@ - aread(ChannelPid, Handle, Len) -> {async, N} | {error, reason()} + aread(ChannelPid, Handle, Len) -> {async, N} | {error, reason()} Reads asynchronously from an open file. ChannelPid = pid() @@ -137,7 +137,7 @@ - awrite(ChannelPid, Handle, Data) -> {async, N} | {error, reason()} + awrite(ChannelPid, Handle, Data) -> {async, N} | {error, reason()} Writes asynchronously to an open file. ChannelPid = pid() @@ -159,8 +159,8 @@ - close(ChannelPid, Handle) -> - close(ChannelPid, Handle, Timeout) -> ok | {error, reason()} + close(ChannelPid, Handle) -> + close(ChannelPid, Handle, Timeout) -> ok | {error, reason()} Closes an open handle. ChannelPid = pid() @@ -173,8 +173,8 @@ - delete(ChannelPid, Name) -> - delete(ChannelPid, Name, Timeout) -> ok | {error, reason()} + delete(ChannelPid, Name) -> + delete(ChannelPid, Name, Timeout) -> ok | {error, reason()} Deletes a file. ChannelPid = pid() @@ -188,8 +188,8 @@ - del_dir(ChannelPid, Name) -> - del_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} + del_dir(ChannelPid, Name) -> + del_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} Deletes an empty directory. ChannelPid = pid() @@ -204,8 +204,8 @@ - list_dir(ChannelPid, Path) -> - list_dir(ChannelPid, Path, Timeout) -> {ok, Filenames} | {error, reason()} + list_dir(ChannelPid, Path) -> + list_dir(ChannelPid, Path, Timeout) -> {ok, Filenames} | {error, reason()} Lists the directory. ChannelPid = pid() @@ -221,8 +221,8 @@ - make_dir(ChannelPid, Name) -> - make_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} + make_dir(ChannelPid, Name) -> + make_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} Creates a directory. ChannelPid = pid() @@ -237,8 +237,8 @@ - make_symlink(ChannelPid, Name, Target) -> - make_symlink(ChannelPid, Name, Target, Timeout) -> ok | {error, reason()} + make_symlink(ChannelPid, Name, Target) -> + make_symlink(ChannelPid, Name, Target, Timeout) -> ok | {error, reason()} Creates a symbolic link. ChannelPid = pid() @@ -253,8 +253,8 @@ - open(ChannelPid, File, Mode) -> - open(ChannelPid, File, Mode, Timeout) -> {ok, Handle} | {error, reason()} + open(ChannelPid, File, Mode) -> + open(ChannelPid, File, Mode, Timeout) -> {ok, Handle} | {error, reason()} Opens a file and returns a handle. ChannelPid = pid() @@ -270,8 +270,8 @@ - opendir(ChannelPid, Path) -> - opendir(ChannelPid, Path, Timeout) -> {ok, Handle} | {error, reason()} + opendir(ChannelPid, Path) -> + opendir(ChannelPid, Path, Timeout) -> {ok, Handle} | {error, reason()} Opens a directory and returns a handle. ChannelPid = pid() @@ -339,8 +339,8 @@ - position(ChannelPid, Handle, Location) -> - position(ChannelPid, Handle, Location, Timeout) -> {ok, NewPosition | {error, reason()} + position(ChannelPid, Handle, Location) -> + position(ChannelPid, Handle, Location, Timeout) -> {ok, NewPosition | {error, reason()} Sets the file position of a file. ChannelPid = pid() @@ -384,8 +384,8 @@ - pread(ChannelPid, Handle, Position, Len) -> - pread(ChannelPid, Handle, Position, Len, Timeout) -> {ok, Data} | eof | {error, reason()} + pread(ChannelPid, Handle, Position, Len) -> + pread(ChannelPid, Handle, Position, Len, Timeout) -> {ok, Data} | eof | {error, reason()} Reads from an open file. ChannelPid = pid() @@ -402,8 +402,8 @@ - pwrite(ChannelPid, Handle, Position, Data) -> ok - pwrite(ChannelPid, Handle, Position, Data, Timeout) -> ok | {error, reason()} + pwrite(ChannelPid, Handle, Position, Data) -> ok + pwrite(ChannelPid, Handle, Position, Data, Timeout) -> ok | {error, reason()} Writes to an open file. ChannelPid = pid() @@ -419,8 +419,8 @@ - read(ChannelPid, Handle, Len) -> - read(ChannelPid, Handle, Len, Timeout) -> {ok, Data} | eof | {error, reason()} + read(ChannelPid, Handle, Len) -> + read(ChannelPid, Handle, Len, Timeout) -> {ok, Data} | eof | {error, reason()} Reads from an open file. ChannelPid = pid() @@ -441,8 +441,8 @@ - read_file(ChannelPid, File) -> - read_file(ChannelPid, File, Timeout) -> {ok, Data} | {error, reason()} + read_file(ChannelPid, File) -> + read_file(ChannelPid, File, Timeout) -> {ok, Data} | {error, reason()} Reads a file. ChannelPid = pid() @@ -456,8 +456,8 @@ - read_file_info(ChannelPid, Name) -> - read_file_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} + read_file_info(ChannelPid, Name) -> + read_file_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} Gets information about a file. ChannelPid = pid() @@ -481,8 +481,8 @@ - read_link(ChannelPid, Name) -> - read_link(ChannelPid, Name, Timeout) -> {ok, Target} | {error, reason()} + read_link(ChannelPid, Name) -> + read_link(ChannelPid, Name, Timeout) -> {ok, Target} | {error, reason()} Reads symbolic link. ChannelPid = pid() @@ -496,8 +496,8 @@ - read_link_info(ChannelPid, Name) -> {ok, FileInfo} | {error, reason()} - read_link_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} + read_link_info(ChannelPid, Name) -> {ok, FileInfo} | {error, reason()} + read_link_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} Gets information about a symbolic link. ChannelPid = pid() @@ -517,8 +517,8 @@ - rename(ChannelPid, OldName, NewName) -> - rename(ChannelPid, OldName, NewName, Timeout) -> ok | {error, reason()} + rename(ChannelPid, OldName, NewName) -> + rename(ChannelPid, OldName, NewName, Timeout) -> ok | {error, reason()} Renames a file. ChannelPid = pid() @@ -534,16 +534,16 @@ - start_channel(ConnectionRef) -> - start_channel(ConnectionRef, Options) -> + start_channel(ConnectionRef) -> + start_channel(ConnectionRef, Options) -> {ok, Pid} | {error, reason()|term()} - start_channel(Host, Options) -> - start_channel(Host, Port, Options) -> + start_channel(Host, Options) -> + start_channel(Host, Port, Options) -> {ok, Pid, ConnectionRef} | {error, reason()|term()} - start_channel(TcpSocket) -> - start_channel(TcpSocket, Options) -> + start_channel(TcpSocket) -> + start_channel(TcpSocket, Options) -> {ok, Pid, ConnectionRef} | {error, reason()|term()} Starts an SFTP client. @@ -594,7 +594,7 @@ - stop_channel(ChannelPid) -> ok + stop_channel(ChannelPid) -> ok Stops the SFTP client channel. ChannelPid = pid() @@ -606,8 +606,8 @@ - write(ChannelPid, Handle, Data) -> - write(ChannelPid, Handle, Data, Timeout) -> ok | {error, reason()} + write(ChannelPid, Handle, Data) -> + write(ChannelPid, Handle, Data, Timeout) -> ok | {error, reason()} Writes to an open file. ChannelPid = pid() @@ -625,8 +625,8 @@ - write_file(ChannelPid, File, Iolist) -> - write_file(ChannelPid, File, Iolist, Timeout) -> ok | {error, reason()} + write_file(ChannelPid, File, Iolist) -> + write_file(ChannelPid, File, Iolist, Timeout) -> ok | {error, reason()} Writes a file. ChannelPid = pid() @@ -641,8 +641,8 @@ - write_file_info(ChannelPid, Name, Info) -> - write_file_info(ChannelPid, Name, Info, Timeout) -> ok | {error, reason()} + write_file_info(ChannelPid, Name, Info) -> + write_file_info(ChannelPid, Name, Info, Timeout) -> ok | {error, reason()} Writes information for a file. ChannelPid = pid() diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml index 3b34150e98..ee72784add 100644 --- a/lib/ssh/doc/src/ssh_sftpd.xml +++ b/lib/ssh/doc/src/ssh_sftpd.xml @@ -29,7 +29,7 @@ ssh_sftpd.sgml - ssh_sftpd + ssh_sftpd Specifies the channel process to handle an SFTP subsystem.

Specifies a channel process to handle an SFTP subsystem.

@@ -51,7 +51,7 @@ - subsystem_spec(Options) -> subsystem_spec() + subsystem_spec(Options) -> subsystem_spec() Returns the subsystem specification that allows an SSH daemon to handle the subsystem "sftp". Options = [{Option, Value}] diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index e13393bf63..b4aa8746f9 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -28,7 +28,7 @@ ssl.xml - ssl + ssl Interface Functions for Secure Socket Layer

@@ -939,7 +939,7 @@ fun(srp, Username :: string(), UserState :: term()) -> connect(Socket, SslOptions) -> - connect(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} + connect(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} Upgrades a gen_tcp, or equivalent, connected socket to an TLS socket. @@ -975,8 +975,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - connect(Host, Port, Options) -> - connect(Host, Port, Options, Timeout) -> + connect(Host, Port, Options) -> + connect(Host, Port, Options, Timeout) -> {ok, SslSocket}| {ok, SslSocket, Ext} | {error, Reason} Opens an TLS/DTLS connection to Host, Port. @@ -1018,7 +1018,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - close(SslSocket) -> ok | {error, Reason} + close(SslSocket) -> ok | {error, Reason} Closes an TLS/DTLS connection. SslSocket = sslsocket() @@ -1044,7 +1044,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - controlling_process(SslSocket, NewOwner) -> + controlling_process(SslSocket, NewOwner) -> ok | {error, Reason} Assigns a new controlling process to the TLS/DTLS socket. @@ -1118,7 +1118,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - format_error(Reason) -> string() + format_error(Reason) -> string() Returns an error string. Reason = term() @@ -1129,7 +1129,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - getopts(SslSocket, OptionNames) -> + getopts(SslSocket, OptionNames) -> {ok, [socketoption()]} | {error, Reason} Gets the values of the specified options. @@ -1240,7 +1240,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - listen(Port, Options) -> + listen(Port, Options) -> {ok, ListenSocket} | {error, Reason} Creates an SSL listen socket. @@ -1268,7 +1268,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - peercert(SslSocket) -> {ok, Cert} | {error, Reason} + peercert(SslSocket) -> {ok, Cert} | {error, Reason} Returns the peer certificate. SslSocket = sslsocket() @@ -1283,7 +1283,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - peername(SslSocket) -> {ok, {Address, Port}} | + peername(SslSocket) -> {ok, {Address, Port}} | {error, Reason} Returns the peer address and port. @@ -1333,8 +1333,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - recv(SslSocket, Length) -> - recv(SslSocket, Length, Timeout) -> {ok, Data} | {error, + recv(SslSocket, Length) -> + recv(SslSocket, Length, Timeout) -> {ok, Data} | {error, Reason} Receives data on a socket. @@ -1373,7 +1373,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - send(SslSocket, Data) -> ok | {error, Reason} + send(SslSocket, Data) -> ok | {error, Reason} Writes data to a socket. SslSocket = sslsocket() @@ -1387,7 +1387,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - setopts(SslSocket, Options) -> ok | {error, Reason} + setopts(SslSocket, Options) -> ok | {error, Reason} Sets socket options. SslSocket = sslsocket() @@ -1418,8 +1418,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - ssl_accept(SslSocket) -> - ssl_accept(SslSocket, Timeout) -> ok | {error, Reason} + ssl_accept(SslSocket) -> + ssl_accept(SslSocket, Timeout) -> ok | {error, Reason} Performs server-side SSL/TLS handshake. SslSocket = sslsocket() @@ -1433,7 +1433,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - ssl_accept(Socket, SslOptions) -> + ssl_accept(Socket, SslOptions) -> ssl_accept(Socket, SslOptions, Timeout) -> {ok, Socket} | ok | {error, Reason} Performs server-side SSL/TLS/DTLS handshake. @@ -1449,7 +1449,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - sockname(SslSocket) -> {ok, {Address, Port}} | + sockname(SslSocket) -> {ok, {Address, Port}} | {error, Reason} Returns the local address and port. @@ -1497,8 +1497,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - transport_accept(ListenSocket) -> - transport_accept(ListenSocket, Timeout) -> + transport_accept(ListenSocket) -> + transport_accept(ListenSocket, Timeout) -> {ok, SslSocket} | {error, Reason} Accepts an incoming connection and prepares for ssl_accept. diff --git a/lib/stdlib/doc/src/array.xml b/lib/stdlib/doc/src/array.xml index db0ab42372..aa1577a067 100644 --- a/lib/stdlib/doc/src/array.xml +++ b/lib/stdlib/doc/src/array.xml @@ -32,7 +32,7 @@ A array.xml - array + array Functional, extendible arrays.

Functional, extendible arrays. Arrays can have fixed size, or can grow @@ -137,7 +137,7 @@ A3 = array:fix(A2). - + Get the value used for uninitialized entries.

Gets the value used for uninitialized entries.

@@ -146,7 +146,7 @@ A3 = array:fix(A2). - + Fix the array size.

Fixes the array size. This prevents it from growing automatically @@ -157,7 +157,7 @@ A3 = array:fix(A2). - + Fold the array elements using the specified function and initial accumulator value. @@ -172,7 +172,7 @@ A3 = array:fix(A2). - + Fold the array elements right-to-left using the specified function and initial accumulator value. @@ -186,7 +186,7 @@ A3 = array:fix(A2). - + Equivalent to from_list(List, undefined).

Equivalent to @@ -195,7 +195,7 @@ A3 = array:fix(A2). - + Convert a list to an extendible array.

Converts a list to an extendible array. Default @@ -208,7 +208,7 @@ A3 = array:fix(A2). - + Equivalent to from_orddict(Orddict, undefined). @@ -218,7 +218,7 @@ A3 = array:fix(A2). - + Convert an ordered list of pairs {Index, Value} to a corresponding extendible array. @@ -234,7 +234,7 @@ A3 = array:fix(A2). - + Get the value of entry I.

Gets the value of entry I. If @@ -249,7 +249,7 @@ A3 = array:fix(A2). - + Returns true if X is an array, otherwise false. @@ -261,7 +261,7 @@ A3 = array:fix(A2). - + Check if the array has fixed size.

Checks if the array has fixed size. Returns true if the array @@ -271,7 +271,7 @@ A3 = array:fix(A2). - + Map the specified function onto each array element.

Maps the specified function onto each array element. The elements are @@ -285,7 +285,7 @@ A3 = array:fix(A2). - + Create a new, extendible array with initial size zero. @@ -296,7 +296,7 @@ A3 = array:fix(A2). - + Create a new array according to the specified options. @@ -346,7 +346,7 @@ array:new([{size,10},{fixed,false},{default,-1}]) - + Create a new array according to the specified size and options. @@ -370,7 +370,7 @@ array:new(100, {default,0}) - + Make the array resizable.

Makes the array resizable. (Reverses the effects of @@ -380,7 +380,7 @@ array:new(100, {default,0}) - + Reset entry I to the default value for the array. @@ -399,7 +399,7 @@ array:new(100, {default,0}) - + Change the array size to that reported by sparse_size/1. @@ -413,7 +413,7 @@ array:new(100, {default,0}) - + Change the array size.

Change the array size. If Size is not a @@ -424,7 +424,7 @@ array:new(100, {default,0}) - + Set entry I of the array to Value.

Sets entry I of the array to @@ -441,7 +441,7 @@ array:new(100, {default,0}) - + Get the number of entries in the array.

Gets the number of entries in the array. Entries are numbered from @@ -454,7 +454,7 @@ array:new(100, {default,0}) - + Fold the array elements using the specified function and initial accumulator value, skipping default-valued entries. @@ -469,7 +469,7 @@ array:new(100, {default,0}) - + Fold the array elements right-to-left using the specified function and initial accumulator value, skipping default-valued entries. @@ -485,7 +485,7 @@ array:new(100, {default,0}) - + Map the specified function onto each array element, skipping default-valued entries. @@ -498,7 +498,7 @@ array:new(100, {default,0}) - + Get the number of entries in the array up until the last non-default-valued entry. @@ -512,7 +512,7 @@ array:new(100, {default,0}) - + Convert the array to a list, skipping default-valued entries. @@ -522,7 +522,7 @@ array:new(100, {default,0}) - + Convert the array to an ordered list of pairs {Index, Value}, skipping default-valued entries. @@ -534,7 +534,7 @@ array:new(100, {default,0}) - + Convert the array to a list.

Converts the array to a list.

@@ -545,7 +545,7 @@ array:new(100, {default,0}) - + Convert the array to an ordered list of pairs {Index, Value}. diff --git a/lib/stdlib/doc/src/base64.xml b/lib/stdlib/doc/src/base64.xml index cfa1ecc006..479072ba4f 100644 --- a/lib/stdlib/doc/src/base64.xml +++ b/lib/stdlib/doc/src/base64.xml @@ -29,7 +29,7 @@ base64.xml - base64 + base64 Provides base64 encode and decode, see RFC 2045. @@ -51,10 +51,10 @@ - - - - + + + + Decode a base64 encoded string to data. @@ -69,8 +69,8 @@ - - + + Encode data into base64. diff --git a/lib/stdlib/doc/src/beam_lib.xml b/lib/stdlib/doc/src/beam_lib.xml index 473170c839..8bb4cf9101 100644 --- a/lib/stdlib/doc/src/beam_lib.xml +++ b/lib/stdlib/doc/src/beam_lib.xml @@ -28,7 +28,7 @@ 1999-10-30 PA1 - beam_lib + beam_lib An interface to the BEAM file format.

This module provides an interface to files created by @@ -283,7 +283,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Read selected chunks from a BEAM file or binary.

Reads chunk data for selected chunks references. The order of @@ -293,7 +293,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Read selected chunks from a BEAM file or binary.

Reads chunk data for selected chunks references. The order of @@ -312,7 +312,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Unregister the current crypto key fun.

Unregisters the crypto key fun and terminates the process @@ -327,7 +327,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Compare two BEAM files. @@ -341,7 +341,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Compare the BEAM files in two directories.

Compares the BEAM files in @@ -359,7 +359,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Register a fun that provides a crypto key. @@ -398,7 +398,7 @@ CryptoKeyFun(clear) -> term() - + Compare the BEAM files in two directories.

Compares the BEAM files in two directories as @@ -409,7 +409,7 @@ CryptoKeyFun(clear) -> term() - + Return an English description of a BEAM read error reply. @@ -422,7 +422,7 @@ CryptoKeyFun(clear) -> term() - + Information about a BEAM file.

Returns a list containing some information about a BEAM file @@ -449,7 +449,7 @@ CryptoKeyFun(clear) -> term() - + Read the module version of the BEAM file.

Calculates an MD5 redundancy check for the code of the module @@ -458,7 +458,7 @@ CryptoKeyFun(clear) -> term() - + Remove chunks not needed by the loader from a BEAM file. @@ -470,7 +470,7 @@ CryptoKeyFun(clear) -> term() - + Removes chunks not needed by the loader from BEAM files. @@ -483,7 +483,7 @@ CryptoKeyFun(clear) -> term() - + Remove chunks not needed by the loader from all BEAM files of a release. @@ -497,7 +497,7 @@ CryptoKeyFun(clear) -> term() - + Read the module version of the BEAM file.

Returns the module version or versions. A version is defined by diff --git a/lib/stdlib/doc/src/c.xml b/lib/stdlib/doc/src/c.xml index 40e6d9d43e..29edc373c7 100644 --- a/lib/stdlib/doc/src/c.xml +++ b/lib/stdlib/doc/src/c.xml @@ -28,7 +28,7 @@ 1996-10-30 B - c + c Command interface module.

This module enables users to enter the short form of @@ -41,7 +41,7 @@ - + Stack backtrace for a process.

Stack backtrace for a process. Equivalent to @@ -50,8 +50,8 @@ - - + + Compile and load a file or module. @@ -80,7 +80,7 @@ - + Change working directory.

Changes working directory to Dir, which can be a @@ -103,7 +103,7 @@ - + Flush any messages sent to the shell.

Flushes any messages sent to the shell.

@@ -111,7 +111,7 @@ - + Help information.

Displays help information: all valid shell internal commands, @@ -120,8 +120,8 @@ - - + + System information.

i/0 displays system information, listing @@ -131,7 +131,7 @@ - + Information about pid <X.Y.Z>.

Displays information about a process, Equivalent to @@ -141,7 +141,7 @@ - + Load or reload a module.

Purges and loads, or reloads, a module by calling @@ -154,7 +154,7 @@ - lc(Files) -> ok + lc(Files) -> ok Compile a list of files. Files = [File] @@ -180,7 +180,7 @@ - + List files in the current directory.

Lists files in the current directory.

@@ -188,7 +188,7 @@ - + List files in a directory or a single file.

Lists files in directory Dir or, if Dir @@ -197,7 +197,7 @@ - + Which modules are loaded.

Displays information about the loaded modules, including @@ -206,7 +206,7 @@ - + Information about a module.

Displays information about Module.

@@ -223,7 +223,7 @@ - + Memory allocation information.

Memory allocation information. Equivalent to @@ -232,8 +232,8 @@ - - + + Memory allocation information.

Memory allocation information. Equivalent to @@ -242,8 +242,8 @@ - - + + Compile and load code in a file on all nodes.

Compiles and then loads the code for a file on all nodes. @@ -255,7 +255,7 @@ compile:file(File, Options ++ [report_errors, report_w - + Load module on all nodes.

Loads Module on all nodes.

@@ -263,7 +263,7 @@ compile:file(File, Options ++ [report_errors, report_w - + Convert X,Y,Z to a pid.

Converts X, Y, @@ -273,7 +273,7 @@ compile:file(File, Options ++ [report_errors, report_w - + Print working directory.

Prints the name of the working directory.

@@ -281,7 +281,7 @@ compile:file(File, Options ++ [report_errors, report_w - + Quit - shorthand for init:stop().

This function is shorthand for init:stop(), that is, @@ -290,8 +290,8 @@ compile:file(File, Options ++ [report_errors, report_w - - + + Information about registered processes.

regs/0 displays information about all registered @@ -310,7 +310,7 @@ compile:file(File, Options ++ [report_errors, report_w - xm(ModSpec) -> void() + xm(ModSpec) -> void() Cross-reference check a module. ModSpec = Module | Filename @@ -325,7 +325,7 @@ compile:file(File, Options ++ [report_errors, report_w - y(File) -> YeccRet + y(File) -> YeccRet Generate an LALR-1 parser. File = name() @@ -344,7 +344,7 @@ yecc:file(File) - y(File, Options) -> YeccRet + y(File, Options) -> YeccRet Generate an LALR-1 parser. File = name() diff --git a/lib/stdlib/doc/src/calendar.xml b/lib/stdlib/doc/src/calendar.xml index 0d2f3ab3d3..518a085c89 100644 --- a/lib/stdlib/doc/src/calendar.xml +++ b/lib/stdlib/doc/src/calendar.xml @@ -28,7 +28,7 @@ 1996-11-05 B - calendar + calendar Local and universal time, day of the week, date and time conversions. @@ -128,8 +128,8 @@ - - + + Compute the number of days from year 0 up to the specified date. @@ -143,7 +143,7 @@ - + Compute the number of seconds from year 0 up to the specified date and time. @@ -153,8 +153,8 @@ - - + + Compute the day of the week. @@ -169,7 +169,7 @@ - + Compute the date from the number of gregorian days.

Computes the date from the specified number of gregorian days.

@@ -177,7 +177,7 @@ - + Compute the date and time from the number of gregorian seconds. @@ -187,7 +187,7 @@ - + Check if the year is a leap year.

Checks if the specified year is a leap year.

@@ -215,7 +215,7 @@ - + Compute the number of days in a month.

Computes the number of days in a month.

@@ -223,7 +223,7 @@ - + Compute local time.

Returns the local time reported by @@ -232,7 +232,7 @@ - + Convert from local time to universal time (deprecated). @@ -253,7 +253,7 @@ - + Convert from local time to universal time(s).

Converts from local time to Universal Coordinated Time (UTC). @@ -285,7 +285,7 @@ - + Convert now to date and time.

Returns Universal Coordinated Time (UTC) @@ -296,7 +296,7 @@ - + Convert now to local date and time.

Returns local date and time converted from the return value from @@ -306,7 +306,7 @@ - + Convert now to date and time.

Returns Universal Coordinated Time (UTC) @@ -343,7 +343,7 @@ - + Compute days and time from seconds.

Converts a specified number of seconds into days, hours, minutes, @@ -354,7 +354,7 @@ - + Compute time from seconds. @@ -434,7 +434,7 @@ - + Compute the difference between two times (deprecated). @@ -449,7 +449,7 @@ - + Compute the number of seconds since midnight up to the specified time. @@ -460,7 +460,7 @@ - + Compute universal time.

Returns the Universal Coordinated Time (UTC) @@ -470,7 +470,7 @@ - + Convert from universal time to local time.

Converts from Universal Coordinated Time (UTC) to local time. @@ -480,8 +480,8 @@ - - + + Check if a date is valid diff --git a/lib/stdlib/doc/src/dets.xml b/lib/stdlib/doc/src/dets.xml index eb6e32aecf..8e4e002000 100644 --- a/lib/stdlib/doc/src/dets.xml +++ b/lib/stdlib/doc/src/dets.xml @@ -32,7 +32,7 @@ B dets.xml - dets + dets A disk-based term storage.

This module provides a term storage on file. The @@ -188,7 +188,7 @@ - + Return a list of the names of all open Dets tables on this node. @@ -197,7 +197,7 @@ - + Return a chunk of objects stored in a Dets table. @@ -227,7 +227,7 @@ - + Close a Dets table.

Closes a table. Only processes that have opened a table are @@ -239,7 +239,7 @@ - + Delete all objects with a specified key from a Dets table. @@ -249,7 +249,7 @@ - + Delete all objects from a Dets table.

Deletes all objects from a table in almost constant time. @@ -259,7 +259,7 @@ - + Delete a specified object from a Dets table.

Deletes all instances of a specified object from a table. If a @@ -270,7 +270,7 @@ - + Return the first key stored in a Dets table.

Returns the first key stored in table Name @@ -295,8 +295,8 @@ - - + + Fold a function over a Dets table.

Calls Function on successive elements of @@ -309,7 +309,7 @@ - + Replace the objects of a Dets table with the objects of an ETS table. @@ -322,7 +322,7 @@ - + Return information about a Dets table.

Returns information about table Name @@ -354,7 +354,7 @@ - + Return the information associated with a specified item for a Dets table. @@ -455,8 +455,8 @@ - - + + Replace all objects of a Dets table.

Replaces the existing objects of table Name @@ -516,7 +516,7 @@ - + Insert one or more objects into a Dets table.

Inserts one or more objects into the table Name. @@ -527,7 +527,7 @@ - + Insert one or more objects into a Dets table.

Inserts one or more objects into table Name. @@ -539,7 +539,7 @@ - + Test compatibility of chunk data of a table.

Returns true if it would be possible to initialize @@ -554,7 +554,7 @@ - + Test for a Dets table.

Returns true if file Filename @@ -563,7 +563,7 @@ - + Return all objects with a specified key stored in a Dets table. @@ -590,7 +590,7 @@ ok - + Match a chunk of objects stored in a Dets table and return a list of variable bindings. @@ -606,7 +606,7 @@ ok - + Match the objects stored in a Dets table and return a list of variable bindings. @@ -622,7 +622,7 @@ ok - + Match the first chunk of objects stored in a Dets table and return a list of variable bindings. @@ -654,7 +654,7 @@ ok - + Delete all objects that match a given pattern from a Dets table. @@ -667,7 +667,7 @@ ok - + Match a chunk of objects stored in a Dets table and return a list of objects. @@ -683,7 +683,7 @@ ok - + Match the objects stored in a Dets table and return a list of objects. @@ -702,7 +702,7 @@ ok - + Match the first chunk of objects stored in a Dets table and return a list of objects. @@ -735,7 +735,7 @@ ok - + Test for occurrence of a key in a Dets table.

Works like lookup/2, @@ -746,7 +746,7 @@ ok - + Return the next key in a Dets table.

Returns either the key following Key1 in table @@ -760,7 +760,7 @@ ok - + Open an existing Dets table.

Opens an existing table. If the table is not properly closed, @@ -770,7 +770,7 @@ ok - + Open a Dets table.

Opens a table. An empty Dets table is created if no file @@ -872,7 +872,7 @@ ok - + Return the name of the Dets table handled by a pid.

Returns the table name given the pid of a process @@ -883,7 +883,7 @@ ok - + Repair a continuation from select/1 or select/3. @@ -917,7 +917,7 @@ ok - + Fix a Dets table for safe traversal.

If Fix is true, table @@ -945,7 +945,7 @@ ok - + Apply a match specification to some objects stored in a Dets table. @@ -962,7 +962,7 @@ ok - + Apply a match specification to all objects stored in a Dets table. @@ -984,7 +984,7 @@ ok - + Apply a match specification to the first chunk of objects stored in a Dets table. @@ -1019,7 +1019,7 @@ ok - + Delete all objects that match a given pattern from a Dets table. @@ -1036,7 +1036,7 @@ ok - + Return the list of objects associated with a slot of a Dets table. @@ -1049,7 +1049,7 @@ ok - + Ensure that all updates made to a Dets table are written to disk. @@ -1064,8 +1064,8 @@ ok - - + + Return a QLC query handle.

Returns a Query List @@ -1140,7 +1140,7 @@ true - + Insert all objects of a Dets table into an ETS table. @@ -1153,7 +1153,7 @@ true - + Apply a function to all or some objects stored in a Dets table. @@ -1192,7 +1192,7 @@ fun(X) -> {continue, X} end. - + Update a counter object stored in a Dets table. diff --git a/lib/stdlib/doc/src/dict.xml b/lib/stdlib/doc/src/dict.xml index e35b64d5e2..95a98cef12 100644 --- a/lib/stdlib/doc/src/dict.xml +++ b/lib/stdlib/doc/src/dict.xml @@ -28,7 +28,7 @@ 1997-01-15 B - dict + dict Key-value dictionary.

This module provides a Key-Value dictionary. @@ -55,7 +55,7 @@ - + Append a value to keys in a dictionary.

Appends a new Value to the current list @@ -65,7 +65,7 @@ - + Append new values to keys in a dictionary.

Appends a list of values ValList to @@ -77,7 +77,7 @@ - + Erase a key from a dictionary.

Erases all items with a given key from a dictionary.

@@ -85,7 +85,7 @@ - + Look up values in a dictionary.

Returns the value associated with Key @@ -98,7 +98,7 @@ - + Return all keys in a dictionary.

Returns a list of all keys in dictionary Dict.

@@ -116,7 +116,7 @@ - + Select elements that satisfy a predicate.

Dict2 is a dictionary of all keys and values in @@ -127,7 +127,7 @@ - + Search for a key in a dictionary.

Searches for a key in dictionary Dict. Returns @@ -139,7 +139,7 @@ - + Fold a function over a dictionary.

Calls Fun on successive keys and values of @@ -153,7 +153,7 @@ - + Convert a list of pairs to a dictionary.

Converts the Key-Value list @@ -171,7 +171,7 @@ - + Test if a key is in a dictionary.

Tests if Key is contained in @@ -180,7 +180,7 @@ - + Map a function over a dictionary.

Calls Fun on successive keys and values @@ -190,7 +190,7 @@ - + Merge two dictionaries.

Merges two dictionaries, Dict1 and @@ -209,7 +209,7 @@ merge(Fun, D1, D2) -> - + Create a dictionary.

Creates a new dictionary.

@@ -217,7 +217,7 @@ merge(Fun, D1, D2) -> - + Return the number of elements in a dictionary.

Returns the number of elements in dictionary @@ -226,7 +226,7 @@ merge(Fun, D1, D2) -> - + Store a value in a dictionary.

Stores a Key-Value pair in @@ -237,7 +237,7 @@ merge(Fun, D1, D2) -> - + Convert a dictionary to a list of pairs.

Converts dictionary Dict to a list representation.

@@ -245,7 +245,7 @@ merge(Fun, D1, D2) -> - + Update a value in a dictionary.

Updates a value in a dictionary by calling Fun on @@ -255,7 +255,7 @@ merge(Fun, D1, D2) -> - + Update a value in a dictionary.

Updates a value in a dictionary by calling Fun on @@ -269,7 +269,7 @@ append(Key, Val, D) -> - + Increment a value in a dictionary.

Adds Increment to the value associated with diff --git a/lib/stdlib/doc/src/digraph.xml b/lib/stdlib/doc/src/digraph.xml index a5252b443b..cf2c0844c9 100644 --- a/lib/stdlib/doc/src/digraph.xml +++ b/lib/stdlib/doc/src/digraph.xml @@ -32,7 +32,7 @@ C digraph.xml - digraph + digraph Directed graphs.

This module provides a version of labeled @@ -144,9 +144,9 @@ - - - + + + Add an edge to a digraph. @@ -183,9 +183,9 @@ - - - + + + Add or modify a vertex of a digraph.

add_vertex/3 creates (or modifies) vertex @@ -204,7 +204,7 @@ - + Delete an edge from a digraph.

Deletes edge E from digraph @@ -213,7 +213,7 @@ - + Delete edges from a digraph.

Deletes the edges in list Edges from digraph @@ -222,7 +222,7 @@ - + Delete paths from a digraph.

Deletes edges from digraph G until there are no @@ -252,7 +252,7 @@ - + Delete a vertex from a digraph.

Deletes vertex V from digraph @@ -265,7 +265,7 @@ - + Delete vertices from a digraph.

Deletes the vertices in list Vertices from @@ -274,7 +274,7 @@ - + Delete a digraph.

Deletes digraph G. This call is important @@ -285,7 +285,7 @@ - + Return the vertices and the label of an edge of a digraph. @@ -303,7 +303,7 @@ - + Return all edges of a digraph.

Returns a list of all edges of digraph G, in @@ -312,7 +312,7 @@ - + Return the edges emanating from or incident on a vertex of a digraph. @@ -324,7 +324,7 @@ - + Find one cycle in a digraph.

If a simple cycle of @@ -341,7 +341,7 @@ - + Find one path in a digraph.

Tries to find @@ -357,7 +357,7 @@ - + Find one short cycle in a digraph.

Tries to find an as short as possible @@ -375,7 +375,7 @@ - + Find one short path in a digraph.

Tries to find an as short as possible @@ -392,7 +392,7 @@ - + Return the in-degree of a vertex of a digraph.

Returns the in-degree of @@ -401,7 +401,7 @@ - + Return all edges incident on a vertex of a digraph.

Returns a list of all @@ -412,7 +412,7 @@ - + Return all in-neighbors of a vertex of a digraph.

Returns a list of @@ -423,7 +423,7 @@ - + Return information about a digraph. @@ -453,7 +453,7 @@ - + Return a protected empty digraph, where cycles are allowed. @@ -462,7 +462,7 @@ - + Create a new empty digraph. @@ -492,7 +492,7 @@ - + Return the number of edges of a digraph.

Returns the number of edges of digraph G.

@@ -500,7 +500,7 @@ - + Return the number of vertices of a digraph.

Returns the number of vertices of digraph G.

@@ -508,7 +508,7 @@ - + Return the out-degree of a vertex of a digraph.

Returns the out-degree of @@ -517,7 +517,7 @@ - + Return all edges emanating from a vertex of a digraph. @@ -529,7 +529,7 @@ - + Return all out-neighbors of a vertex of a digraph.

Returns a list of @@ -540,7 +540,7 @@ - + Return the label of a vertex of a digraph.

Returns {V, Label}, @@ -553,7 +553,7 @@ - + Return all vertices of a digraph.

Returns a list of all vertices of digraph G, in diff --git a/lib/stdlib/doc/src/digraph_utils.xml b/lib/stdlib/doc/src/digraph_utils.xml index cb316e5b93..13b0aaad9e 100644 --- a/lib/stdlib/doc/src/digraph_utils.xml +++ b/lib/stdlib/doc/src/digraph_utils.xml @@ -32,7 +32,7 @@ PA1 digraph_utils.xml - digraph_utils + digraph_utils Algorithms for directed graphs.

This module provides algorithms based on depth-first traversal of @@ -154,7 +154,7 @@ - + Check if a digraph is an arborescence.

Returns {yes, Root} if Root @@ -164,7 +164,7 @@ - + Return the components of a digraph.

Returns a list @@ -177,7 +177,7 @@ - + Return a condensed graph of a digraph.

Creates a digraph where the vertices are @@ -202,7 +202,7 @@ - + Return the cyclic strong components of a digraph.

Returns a list of strongly @@ -218,7 +218,7 @@ - + Check if a digraph is acyclic.

Returns true if and only if digraph @@ -228,7 +228,7 @@ - + Check if a digraph is an arborescence.

Returns true if and only if digraph @@ -238,7 +238,7 @@ - + Check if a digraph is a tree.

Returns true if and only if digraph @@ -248,7 +248,7 @@ - + Return the vertices of a digraph included in some loop. @@ -258,7 +258,7 @@ - + Return the vertices of a digraph in postorder.

Returns all vertices of digraph Digraph. @@ -273,7 +273,7 @@ - + Return the vertices of a digraph in preorder.

Returns all vertices of digraph Digraph. @@ -285,7 +285,7 @@ - + Return the vertices reachable from some vertices of a digraph. @@ -300,7 +300,7 @@ - + Return the neighbors reachable from some vertices of a digraph. @@ -316,7 +316,7 @@ - + Return the vertices that reach some vertices of a digraph. @@ -330,7 +330,7 @@ - + Return the neighbors that reach some vertices of a digraph. @@ -345,7 +345,7 @@ - + Return the strong components of a digraph.

Returns a list of strongly @@ -359,8 +359,8 @@ - - + + Return a subgraph of a digraph.

Creates a maximal subgraph @@ -387,7 +387,7 @@ - + Return a topological sorting of the vertices of a digraph. diff --git a/lib/stdlib/doc/src/epp.xml b/lib/stdlib/doc/src/epp.xml index d9eefc19e0..110c1cea2c 100644 --- a/lib/stdlib/doc/src/epp.xml +++ b/lib/stdlib/doc/src/epp.xml @@ -32,7 +32,7 @@ B epp.xml - epp + epp An Erlang code preprocessor.

The Erlang code preprocessor includes functions that are used by the @@ -76,7 +76,7 @@ - + Close the preprocessing of the file associated with Epp. @@ -136,7 +136,7 @@ - + Open a file for preprocessing.

Equivalent to @@ -145,7 +145,7 @@ - + Open a file for preprocessing.

Equivalent to epp:open([{name, FileName}, {includes, IncludePath}, @@ -154,7 +154,7 @@ - + Return the next Erlang form from the opened Erlang source file. @@ -185,7 +185,7 @@ - + Preprocess and parse an Erlang source file.

Equivalent to epp:parse_file(FileName, [{includes, IncludePath}, diff --git a/lib/stdlib/doc/src/erl_eval.xml b/lib/stdlib/doc/src/erl_eval.xml index 1c0f7f062f..813cbecd89 100644 --- a/lib/stdlib/doc/src/erl_eval.xml +++ b/lib/stdlib/doc/src/erl_eval.xml @@ -32,7 +32,7 @@ B erl_eval.xml - erl_eval + erl_eval The Erlang meta interpreter.

This module provides an interpreter for Erlang expressions. The @@ -96,7 +96,7 @@ - + Add a binding.

Adds binding Name=Value @@ -106,7 +106,7 @@ - + Return bindings.

Returns the binding of Name @@ -115,7 +115,7 @@ - + Return bindings.

Returns the list of bindings contained in the binding @@ -124,7 +124,7 @@ - + Delete a binding.

Removes the binding of Name @@ -134,10 +134,10 @@ - - - - + + + + Evaluate expression.

Evaluates Expression with the set of bindings @@ -157,9 +157,9 @@ - - - + + + Evaluate a list of expressions.

Evaluates a list of expressions in parallel, using the same @@ -174,9 +174,9 @@ - - - + + + Evaluate expressions.

Evaluates Expressions with the set of bindings @@ -197,7 +197,7 @@ - + Return a bindings structure.

Returns an empty binding structure.

diff --git a/lib/stdlib/doc/src/erl_expand_records.xml b/lib/stdlib/doc/src/erl_expand_records.xml index b6aa75ed03..20e5f1960b 100644 --- a/lib/stdlib/doc/src/erl_expand_records.xml +++ b/lib/stdlib/doc/src/erl_expand_records.xml @@ -34,7 +34,7 @@ PA1 erl_expand_records.xml - erl_expand_records + erl_expand_records Expands records in a module.

This module expands records in a module.

@@ -42,7 +42,7 @@ - + Expand all records in a module.

Expands all records in a module to use explicit tuple diff --git a/lib/stdlib/doc/src/erl_id_trans.xml b/lib/stdlib/doc/src/erl_id_trans.xml index 16952a9582..ec66842ac0 100644 --- a/lib/stdlib/doc/src/erl_id_trans.xml +++ b/lib/stdlib/doc/src/erl_id_trans.xml @@ -34,7 +34,7 @@ B erl_id_trans.xml - erl_id_trans + erl_id_trans An identity parse transform.

This module performs an identity parse transformation of Erlang code. @@ -46,7 +46,7 @@ - parse_transform(Forms, Options) -> Forms + parse_transform(Forms, Options) -> Forms Transform Erlang forms. Forms = [erl_parse:abstract_form() diff --git a/lib/stdlib/doc/src/erl_internal.xml b/lib/stdlib/doc/src/erl_internal.xml index 45264e82a8..77551ffed7 100644 --- a/lib/stdlib/doc/src/erl_internal.xml +++ b/lib/stdlib/doc/src/erl_internal.xml @@ -34,7 +34,7 @@ B erl_internal.xml - erl_internal + erl_internal Internal Erlang definitions.

This module defines Erlang BIFs, guard tests, and operators. @@ -54,7 +54,7 @@ - + Test for an arithmetic operator.

Returns true if OpName/Arity @@ -63,7 +63,7 @@ - + Test for an Erlang BIF.

Returns true if Name/Arity @@ -73,7 +73,7 @@ - + Test for a Boolean operator.

Returns true if OpName/Arity @@ -82,7 +82,7 @@ - + Test for a comparison operator.

Returns true if OpName/Arity @@ -91,7 +91,7 @@ - + Test for an Erlang BIF allowed in guards.

Returns true if Name/Arity is @@ -100,7 +100,7 @@ - + Test for a list operator.

Returns true if OpName/Arity @@ -109,7 +109,7 @@ - + Return operator type.

Returns the Type of operator that @@ -120,7 +120,7 @@ - + Test for a send operator.

Returns true if OpName/Arity @@ -129,7 +129,7 @@ - + Test for a valid type test.

Returns true if Name/Arity is diff --git a/lib/stdlib/doc/src/erl_lint.xml b/lib/stdlib/doc/src/erl_lint.xml index 77cb7a9916..12eaafc3a8 100644 --- a/lib/stdlib/doc/src/erl_lint.xml +++ b/lib/stdlib/doc/src/erl_lint.xml @@ -32,7 +32,7 @@ B erl_lint.xml - erl_lint + erl_lint The Erlang code linter.

This module is used to check Erlang code for illegal syntax and @@ -78,7 +78,7 @@ - + Format an error descriptor.

Takes an ErrorDescriptor and returns a string @@ -90,7 +90,7 @@ - + Test for a guard test.

Tests if Expr is a legal guard test. @@ -102,9 +102,9 @@ - - - + + + Check a module for errors.

Checks all the forms in a module for errors. It returns:

diff --git a/lib/stdlib/doc/src/erl_parse.xml b/lib/stdlib/doc/src/erl_parse.xml index dd15d495a4..8142e5c0aa 100644 --- a/lib/stdlib/doc/src/erl_parse.xml +++ b/lib/stdlib/doc/src/erl_parse.xml @@ -32,7 +32,7 @@ B erl_parse.xml - erl_parse + erl_parse The Erlang parser.

This module is the basic Erlang parser that converts tokens into @@ -89,7 +89,7 @@ - + Convert an Erlang term into an abstract form.

Converts the Erlang data structure Data into an @@ -171,7 +171,7 @@ - format_error(ErrorDescriptor) -> Chars + format_error(ErrorDescriptor) -> Chars Format an error descriptor. ErrorDescriptor = - + Convert abstract form to an Erlang term.

Converts the abstract form AbsTerm of a @@ -247,7 +247,7 @@ - + Parse Erlang expressions.

Parses Tokens as if it was a list of expressions. @@ -267,7 +267,7 @@ - + Parse an Erlang form.

Parses Tokens as if it was a form. Returns one @@ -287,7 +287,7 @@ - + Parse an Erlang term.

Parses Tokens as if it was a term. Returns @@ -307,8 +307,8 @@ - - + + Generate a list of tokens for an expression.

Generates a list of tokens representing the abstract diff --git a/lib/stdlib/doc/src/erl_pp.xml b/lib/stdlib/doc/src/erl_pp.xml index 77a7f1e8d1..f1c3aa5a41 100644 --- a/lib/stdlib/doc/src/erl_pp.xml +++ b/lib/stdlib/doc/src/erl_pp.xml @@ -34,7 +34,7 @@ B erl_pp.xml - erl_pp + erl_pp The Erlang pretty printer.

The functions in this module are used to generate @@ -73,8 +73,8 @@ - - + + Pretty print an attribute.

Same as form/1,2, @@ -83,10 +83,10 @@ - - - - + + + + Pretty print one Expression.

Prints one expression. It is useful for implementing hooks (see @@ -96,9 +96,9 @@ - - - + + + Pretty print Expressions.

Same as form/1,2, @@ -108,8 +108,8 @@ - - + + Pretty print a form.

Pretty prints a @@ -120,8 +120,8 @@ - - + + Pretty print a function.

Same as form/1,2, @@ -130,8 +130,8 @@ - - + + Pretty print a guard.

Same as form/1,2, diff --git a/lib/stdlib/doc/src/erl_scan.xml b/lib/stdlib/doc/src/erl_scan.xml index 6507f23dab..38111f73bc 100644 --- a/lib/stdlib/doc/src/erl_scan.xml +++ b/lib/stdlib/doc/src/erl_scan.xml @@ -32,7 +32,7 @@ B erl_scan.xml - erl_scan + erl_scan The Erlang token scanner.

This module contains functions for tokenizing (scanning) characters into @@ -101,7 +101,7 @@ - + Format an error descriptor.

Uses an ErrorDescriptor and returns a string @@ -131,7 +131,7 @@ - + Test for a reserved word.

Returns true if Atom is an @@ -140,9 +140,9 @@ - - - + + + Scan a string and return the Erlang tokens.

Takes the list of characters String and tries to @@ -247,8 +247,8 @@ - - + + Re-entrant scanner. diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index 0a0b5fa115..ea8173748a 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -32,7 +32,7 @@ A erl_tar.xml - erl_tar + erl_tar Unix 'tar' utility for reading and writing tar archives. @@ -127,7 +127,7 @@ - add(TarDescriptor, Filename, Options) -> RetValue + add(TarDescriptor, Filename, Options) -> RetValue Add a file to an open tar file. TarDescriptor = term() @@ -211,7 +211,7 @@ - add(TarDescriptor, FilenameOrBin, NameInArchive, Options) -> + add(TarDescriptor, FilenameOrBin, NameInArchive, Options) -> RetValue Add a file to an open tar file. @@ -233,7 +233,7 @@ - close(TarDescriptor) + close(TarDescriptor) Close an open tar file. TarDescriptor = term() @@ -245,7 +245,7 @@ - create(Name, FileList) ->RetValue + create(Name, FileList) ->RetValue Create a tar archive. Name = filename() @@ -264,7 +264,7 @@ - create(Name, FileList, OptionList) + create(Name, FileList, OptionList) Create a tar archive with options. Name = filename() @@ -315,7 +315,7 @@ - extract(Name) -> RetValue + extract(Name) -> RetValue Extract all files from a tar file. Name = filename() | {binary,binary()} | {file,Fd} @@ -339,7 +339,7 @@ - extract(Name, OptionList) + extract(Name, OptionList) Extract files from a tar file. Name = filename() | {binary,binary()} | {file,Fd} @@ -411,7 +411,7 @@ - format_error(Reason) -> string() + format_error(Reason) -> string() Convert error term to a readable string. Reason = term() @@ -518,7 +518,7 @@ erl_tar:close(TarDesc) - open(Name, OpenModeList) -> RetValue + open(Name, OpenModeList) -> RetValue Open a tar file for writing. Name = filename() @@ -565,7 +565,7 @@ erl_tar:close(TarDesc) - table(Name) -> RetValue + table(Name) -> RetValue Retrieve the name of all files in a tar file. Name = filename()|{binary,binary()}|{file,file_descriptor()} @@ -578,7 +578,7 @@ erl_tar:close(TarDesc) - table(Name, Options) + table(Name, Options) Retrieve name and information of all files in a tar file. @@ -590,7 +590,7 @@ erl_tar:close(TarDesc) - t(Name) + t(Name) Print the name of each file in a tar file. Name = filename()|{binary,binary()}|{file,file_descriptor()} @@ -602,7 +602,7 @@ erl_tar:close(TarDesc) - tt(Name) + tt(Name) Print name and information for each file in a tar file. diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml index 98c5c39f2b..70d1aaa74d 100644 --- a/lib/stdlib/doc/src/ets.xml +++ b/lib/stdlib/doc/src/ets.xml @@ -28,7 +28,7 @@ - ets + ets Built-in term storage.

This module is an interface to the Erlang built-in term storage @@ -207,7 +207,7 @@ - + Return a list of all ETS tables.

Returns a list of all tables at the node. Named tables are @@ -222,7 +222,7 @@ - + Delete an entire ETS table.

Deletes the entire table Tab.

@@ -230,7 +230,7 @@ - + Delete all objects with a specified key from an ETS table. @@ -240,7 +240,7 @@ - + Delete all objects in an ETS table.

Delete all objects in the ETS table Tab. @@ -250,7 +250,7 @@ - + Deletes a specific from an ETS table.

Delete the exact object Object from the @@ -262,7 +262,7 @@ - + Read an ETS table from a file.

Reads a file produced by @@ -274,7 +274,7 @@ - + Read an ETS table from a file.

Reads a file produced by @@ -306,7 +306,7 @@ - + Return the first key in an ETS table.

Returns the first key Key in table @@ -321,7 +321,7 @@ - + Fold a function over an ETS table.

Acc0 is returned if the table is empty. @@ -337,7 +337,7 @@ - + Fold a function over an ETS table.

Acc0 is returned if the table is empty. @@ -353,7 +353,7 @@ - + Fill an ETS table with objects from a Dets table. @@ -367,7 +367,7 @@ - + Pseudo function that transforms fun syntax to a match specification. @@ -436,7 +436,7 @@ Error: fun containing local Erlang function calls - + Change owner of a table.

Make process Pid the new owner of table @@ -454,7 +454,7 @@ Error: fun containing local Erlang function calls - + Display information about all ETS tables on a terminal. @@ -463,7 +463,7 @@ Error: fun containing local Erlang function calls - + Browse an ETS table on a terminal.

Browses table Tab on a terminal.

@@ -471,7 +471,7 @@ Error: fun containing local Erlang function calls - + Return information about an table.

Returns information about table Tab as a list of @@ -547,7 +547,7 @@ Error: fun containing local Erlang function calls - + Return the information associated with the specified item for an ETS table. @@ -619,7 +619,7 @@ Error: fun containing local Erlang function calls - + Replace all objects of an ETS table.

Replaces the existing objects of table Tab with @@ -649,7 +649,7 @@ Error: fun containing local Erlang function calls - + Insert an object into an ETS table.

Inserts the object or all of the objects in list @@ -681,7 +681,7 @@ Error: fun containing local Erlang function calls - + Insert an object into an ETS table if the key is not already present. @@ -700,7 +700,7 @@ Error: fun containing local Erlang function calls - + Check if an Erlang term is the result of match_spec_compile. @@ -732,7 +732,7 @@ ets:is_compiled_ms(Broken). - + Return the last key in an ETS table of type ordered_set. @@ -747,7 +747,7 @@ ets:is_compiled_ms(Broken). - + Return all objects with a specified key in an ETS table. @@ -787,7 +787,7 @@ ets:is_compiled_ms(Broken). - + Return the Pos:th element of all objects with a specified key in an ETS table. @@ -810,7 +810,7 @@ ets:is_compiled_ms(Broken). - + Continues matching objects in an ETS table.

Continues a match started with @@ -824,7 +824,7 @@ ets:is_compiled_ms(Broken). - + Match the objects in an ETS table against a pattern. @@ -856,7 +856,7 @@ ets:is_compiled_ms(Broken). - + Match the objects in an ETS table against a pattern and return part of the answers. @@ -875,7 +875,7 @@ ets:is_compiled_ms(Broken). - + Delete all objects that match a specified pattern from an ETS table. @@ -886,7 +886,7 @@ ets:is_compiled_ms(Broken). - + Continues matching objects in an ETS table.

Continues a match started with @@ -901,7 +901,7 @@ ets:is_compiled_ms(Broken). - + Match the objects in an ETS table against a pattern. @@ -920,7 +920,7 @@ ets:is_compiled_ms(Broken). - + Match the objects in an ETS table against a pattern and return part of the answers. @@ -940,7 +940,7 @@ ets:is_compiled_ms(Broken). - + Compile a match specification into its internal representation. @@ -968,7 +968,7 @@ ets:is_compiled_ms(Broken). - + Perform matching, using a compiled match specification on a list of terms. @@ -1005,7 +1005,7 @@ ets:select(Table, MatchSpec), - + Tests for occurrence of a key in an ETS table.

Works like lookup/2, @@ -1016,7 +1016,7 @@ ets:select(Table, MatchSpec), - + Create a new ETS table.

Creates a new table and returns a table identifier that can @@ -1180,7 +1180,7 @@ ets:select(Table, MatchSpec), - + Return the next key in an ETS table.

Returns the next key Key2, following key @@ -1202,7 +1202,7 @@ ets:select(Table, MatchSpec), - + Return the previous key in an ETS table of type ordered_set. @@ -1218,7 +1218,7 @@ ets:select(Table, MatchSpec), - + Rename a named ETS table.

Renames the named table Tab to the new name @@ -1228,7 +1228,7 @@ ets:select(Table, MatchSpec), - + Repair a continuation from ets:select/1 or ets:select/3 that has passed through external representation. @@ -1283,7 +1283,7 @@ ets:select(ets:repair_continuation(Broken,MS)). - + Fix an ETS table for safe traversal.

Fixes a table of type set, bag, or @@ -1339,7 +1339,7 @@ clean_all_with_value(Tab,X,Key) -> - + Continue matching objects in an ETS table.

Continues a match started with @@ -1353,7 +1353,7 @@ clean_all_with_value(Tab,X,Key) -> - + Match the objects in an ETS table against a match specification. @@ -1448,7 +1448,7 @@ is_integer(X), is_integer(Y), X + Y < 4711]]> - + Match the objects in an ETS table against a match specification and return part of the answers. @@ -1467,7 +1467,7 @@ is_integer(X), is_integer(Y), X + Y < 4711]]> - + Match the objects in an ETS table against a match specification and return the number of objects for which the match specification returned true. @@ -1486,7 +1486,7 @@ is_integer(X), is_integer(Y), X + Y < 4711]]> - + Match the objects in an ETS table against a match specification and delete objects where the match specification returns true. @@ -1612,7 +1612,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Set table options.

Sets table options. The only allowed option to be set after the @@ -1623,7 +1623,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Return all objects in a specified slot of an ETS table. @@ -1648,7 +1648,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Dump an ETS table to a file.

Dumps table Tab to file @@ -1659,7 +1659,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Dump an ETS table to a file.

Dumps table Tab to file @@ -1706,7 +1706,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Return a list of all objects in an ETS table.

Returns a list of all objects in table Tab.

@@ -1714,7 +1714,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Return a list of all objects in an ETS table.

Returns information about the table dumped to file by @@ -1792,8 +1792,8 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - - + + Return a QLC query handle.

Returns a Query List @@ -1884,7 +1884,7 @@ true - + Test a match specification for use in select/2. @@ -1911,7 +1911,7 @@ true - + Fill a Dets table with objects from an ETS table. @@ -1922,11 +1922,11 @@ true - + - + - + Update a counter object in an ETS table. @@ -2006,8 +2006,8 @@ true - - + + Update the Pos:th element of the object with a specified key in an ETS table. diff --git a/lib/stdlib/doc/src/file_sorter.xml b/lib/stdlib/doc/src/file_sorter.xml index e988d58c2f..942d98fe61 100644 --- a/lib/stdlib/doc/src/file_sorter.xml +++ b/lib/stdlib/doc/src/file_sorter.xml @@ -32,7 +32,7 @@ PA1 file_sorter.xml - file_sorter + file_sorter File sorter.

This module contains functions for sorting terms on files, merging @@ -334,8 +334,8 @@ output(L) -> - - + + Check whether terms on files are sorted.

Checks files for sortedness. If a file is not sorted, the @@ -347,8 +347,8 @@ output(L) -> - - + + Check whether terms on files are sorted by key.

Checks files for sortedness. If a file is not sorted, the @@ -360,8 +360,8 @@ output(L) -> - - + + Merge terms on files by key.

Merges tuples on files. Each input file is assumed to be @@ -372,7 +372,7 @@ output(L) -> - + Sort terms on files by key.

Sorts tuples on files.

@@ -382,8 +382,8 @@ output(L) -> - - + + Sort terms on files by key.

Sorts tuples on files. The sort is performed on the @@ -397,8 +397,8 @@ output(L) -> - - + + Merge terms on files.

Merges terms on files. Each input file is assumed to be @@ -409,7 +409,7 @@ output(L) -> - + Sort terms on files.

Sorts terms on files.

@@ -419,8 +419,8 @@ output(L) -> - - + + Sort terms on files.

Sorts terms on files.

diff --git a/lib/stdlib/doc/src/filelib.xml b/lib/stdlib/doc/src/filelib.xml index 790f289ae5..5df415834f 100644 --- a/lib/stdlib/doc/src/filelib.xml +++ b/lib/stdlib/doc/src/filelib.xml @@ -32,7 +32,7 @@ A filelib.xml - filelib + filelib File utilities, such as wildcard matching of filenames. @@ -94,7 +94,7 @@ - + Ensure that all parent directories for a file or directory exist. @@ -108,7 +108,7 @@ - + Return the size in bytes of a file.

Returns the size of the specified file.

@@ -116,7 +116,7 @@ - + Fold over all files matching a regular expression.

Folds function Fun over all (regular) files @@ -142,7 +142,7 @@ - + Test whether Name refers to a directory.

Returns true if Name @@ -151,7 +151,7 @@ - + Test whether Name refers to a file or directory. @@ -161,7 +161,7 @@ - + Test whether Name refers to a (regular) file.

Returns true if Name @@ -170,7 +170,7 @@ - + Return the local date and time when a file was last modified. @@ -180,7 +180,7 @@ - + Match filenames using Unix-style wildcards.

Returns a list of all files that match Unix-style wildcard string @@ -252,7 +252,7 @@ filelib:wildcard("lib/**/*.{erl,hrl}") - + Match filenames using Unix-style wildcards starting at a specified directory. diff --git a/lib/stdlib/doc/src/filename.xml b/lib/stdlib/doc/src/filename.xml index e4cca2074a..ae42846c6b 100644 --- a/lib/stdlib/doc/src/filename.xml +++ b/lib/stdlib/doc/src/filename.xml @@ -28,7 +28,7 @@ 1997-11-13 B - filename + filename Filename manipulation functions.

This module provides functions @@ -87,7 +87,7 @@ - + Convert a filename to an absolute name, relative the working directory. @@ -119,7 +119,7 @@ - + Convert a filename to an absolute name, relative a specified directory. @@ -130,7 +130,7 @@ - + Join an absolute directory with a relative filename.

Joins an absolute directory with a relative filename. Similar to @@ -314,7 +314,7 @@ true - + Return the last component of a filename.

Returns the last component of Filename, or @@ -332,7 +332,7 @@ true - + Return the last component of a filename, stripped of the specified extension. @@ -357,7 +357,7 @@ true - + Return the directory part of a path name.

Returns the directory part of Filename.

@@ -374,7 +374,7 @@ true - + Return the file extension.

Returns the file extension of Filename, @@ -390,8 +390,8 @@ true - - + + Find the filename and compiler options for a module.

Finds the source filename and compiler options for a module. @@ -438,7 +438,7 @@ true - + Convert a filename to a flat string.

Converts a possibly deep list filename consisting of @@ -448,7 +448,7 @@ true - + Join a list of filename components with directory separators. @@ -476,7 +476,7 @@ true - + Join two filename components with directory separators. @@ -487,7 +487,7 @@ true - + Return the native form of a file path.

Converts Path to a form accepted by the command @@ -506,7 +506,7 @@ true - + Return the path type.

Returns the path type, which is one of the following:

@@ -536,8 +536,8 @@ true - - + + Remove a filename extension.

Removes a filename extension. rootname/2 works as @@ -584,7 +584,7 @@ unsafe - + Split a filename into its path components.

Returns a list whose elements are the path components of diff --git a/lib/stdlib/doc/src/gb_sets.xml b/lib/stdlib/doc/src/gb_sets.xml index 16db0906f5..a9596c6e4d 100644 --- a/lib/stdlib/doc/src/gb_sets.xml +++ b/lib/stdlib/doc/src/gb_sets.xml @@ -28,7 +28,7 @@ - gb_sets + gb_sets General balanced trees.

This module provides ordered sets using Prof. Arne Andersson's @@ -123,8 +123,8 @@ - - + + Add a (possibly existing) element to a set.

Returns a new set formed from Set1 with @@ -135,7 +135,7 @@ - + Rebalance tree representation of a set.

Rebalances the tree representation of Set1. @@ -149,7 +149,7 @@ - + Remove a (possibly non-existing) element from a set.

Returns a new set formed from Set1 with @@ -160,7 +160,7 @@ - + Remove an element from a set.

Returns a new set formed from Set1 with @@ -171,7 +171,7 @@ - + Remove a (possibly non-existing) element from a set.

Returns a new set formed from Set1 with @@ -182,7 +182,7 @@ - + Return the difference of two sets.

Returns only the elements of Set1 that are not @@ -191,7 +191,7 @@ - + Return an empty set.

Returns a new empty set.

@@ -199,7 +199,7 @@ - + Filter set elements.

Filters elements in Set1 using predicate function @@ -208,7 +208,7 @@ - + Fold over set elements.

Folds Function over every element in @@ -218,7 +218,7 @@ - + Convert a list into a set.

Returns a set of the elements in List, where @@ -227,7 +227,7 @@ - + Make a set from an ordset list.

Turns an ordered-set list List into a set. @@ -236,7 +236,7 @@ - + Add a new element to a set.

Returns a new set formed from Set1 with @@ -247,7 +247,7 @@ - + Return the intersection of a list of sets.

Returns the intersection of the non-empty list of sets.

@@ -255,7 +255,7 @@ - + Return the intersection of two sets.

Returns the intersection of Set1 and @@ -264,7 +264,7 @@ - + Check whether two sets are disjoint.

Returns true if Set1 and @@ -274,7 +274,7 @@ - + Test for membership of a set.

Returns true if Element is an element of @@ -283,7 +283,7 @@ - + Test for empty set.

Returns true if Set is an empty set, @@ -292,7 +292,7 @@ - + Test for membership of a set.

Returns true if Element is an element of @@ -301,7 +301,7 @@ - + Test for a set.

Returns true if Term appears to be a set, @@ -310,7 +310,7 @@ - + Test for subset.

Returns true when every element of Set1 is @@ -319,7 +319,7 @@ - + Return an iterator for a set.

Returns an iterator that can be used for traversing the entries of @@ -351,7 +351,7 @@ - + Return largest element.

Returns the largest element in Set. Assumes that @@ -360,7 +360,7 @@ - + Return an empty set.

Returns a new empty set.

@@ -368,7 +368,7 @@ - + Traverse a set with an iterator.

Returns {Element, Iter2}, where @@ -381,7 +381,7 @@ - + Return a set with one element.

Returns a set containing only element Element. @@ -390,7 +390,7 @@ - + Return the number of elements in a set.

Returns the number of elements in Set.

@@ -398,7 +398,7 @@ - + Return smallest element.

Returns the smallest element in Set. Assumes that @@ -407,7 +407,7 @@ - + Return the difference of two sets.

Returns only the elements of Set1 that are not @@ -416,7 +416,7 @@ - + Extract largest element.

Returns {Element, Set2}, where @@ -428,7 +428,7 @@ - + Extract smallest element.

Returns {Element, Set2}, where @@ -440,7 +440,7 @@ - + Convert a set into a list.

Returns the elements of Set as a list.

@@ -448,7 +448,7 @@ - + Return the union of a list of sets.

Returns the merged (union) set of the list of sets.

@@ -456,7 +456,7 @@ - + Return the union of two sets.

Returns the merged (union) set of Set1 and diff --git a/lib/stdlib/doc/src/gb_trees.xml b/lib/stdlib/doc/src/gb_trees.xml index 3b55c2c75d..570c9c7cb6 100644 --- a/lib/stdlib/doc/src/gb_trees.xml +++ b/lib/stdlib/doc/src/gb_trees.xml @@ -28,7 +28,7 @@ - gb_trees + gb_trees General balanced trees.

This module provides Prof. Arne Andersson's General @@ -75,7 +75,7 @@ - + Rebalance a tree.

Rebalances Tree1. Notice that this is @@ -88,7 +88,7 @@ - + Remove a node from a tree.

Removes the node with key Key from @@ -98,7 +98,7 @@ - + Remove a (possibly non-existing) node from a tree.

Removes the node with key Key from @@ -131,7 +131,7 @@ - + Return an empty tree.

Returns a new empty tree.

@@ -139,7 +139,7 @@ - + Insert or update key with value in a tree.

Inserts Key with value Value @@ -151,7 +151,7 @@ - + Make a tree from an orddict.

Turns an ordered list List of key-value tuples @@ -160,7 +160,7 @@ - + Look up a key in a tree, if present.

Retrieves the value stored with Key in @@ -171,7 +171,7 @@ - + Insert a new key and value in a tree.

Inserts Key with value Value @@ -182,7 +182,7 @@ - + Test for membership of a tree.

Returns true if Key is present in @@ -191,7 +191,7 @@ - + Test for empty tree.

Returns true if Tree is an empty tree, @@ -200,7 +200,7 @@ - + Return an iterator for a tree.

Returns an iterator that can be used for traversing the @@ -233,7 +233,7 @@ - + Return a list of the keys in a tree.

Returns the keys in Tree as an ordered list.

@@ -241,7 +241,7 @@ - + Return largest key and value.

Returns {Key, Value}, where @@ -253,7 +253,7 @@ - + Look up a key in a tree.

Looks up Key in Tree. @@ -263,7 +263,7 @@ - + Return largest key and value.

Maps function F(K, V1) -> V2 @@ -275,7 +275,7 @@ - + Traverse a tree with an iterator.

Returns {Key, Value, @@ -288,7 +288,7 @@ - + Return the number of nodes in a tree.

Returns the number of nodes in Tree.

@@ -296,7 +296,7 @@ - + Return smallest key and value.

Returns {Key, Value}, where @@ -308,7 +308,7 @@ - + Extract largest key and value.

Returns {Key, Value, @@ -321,7 +321,7 @@ - + Extract smallest key and value.

Returns {Key, Value, @@ -334,7 +334,7 @@ - + Convert a tree into a list.

Converts a tree into an ordered list of key-value tuples.

@@ -342,7 +342,7 @@ - + Update a key to new value in a tree.

Updates Key to value Value @@ -352,7 +352,7 @@ - + Return a list of the values in a tree.

Returns the values in Tree as an ordered list, diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml index ff7da620c7..2915c4f507 100644 --- a/lib/stdlib/doc/src/gen_event.xml +++ b/lib/stdlib/doc/src/gen_event.xml @@ -28,7 +28,7 @@ - gen_event + gen_event Generic event handling behavior.

This behavior module provides event handling functionality. It @@ -130,7 +130,7 @@ gen_event:stop -----> Module:terminate/2 - add_handler(EventMgrRef, Handler, Args) -> Result + add_handler(EventMgrRef, Handler, Args) -> Result Add an event handler to a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -178,7 +178,7 @@ gen_event:stop -----> Module:terminate/2 - add_sup_handler(EventMgrRef, Handler, Args) -> Result + add_sup_handler(EventMgrRef, Handler, Args) -> Result Add a supervised event handler to a generic event manager. @@ -241,8 +241,8 @@ gen_event:stop -----> Module:terminate/2 - call(EventMgrRef, Handler, Request) -> Result - call(EventMgrRef, Handler, Request, Timeout) -> Result + call(EventMgrRef, Handler, Request) -> Result + call(EventMgrRef, Handler, Request, Timeout) -> Result Make a synchronous call to a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -285,7 +285,7 @@ gen_event:stop -----> Module:terminate/2 - delete_handler(EventMgrRef, Handler, Args) -> Result + delete_handler(EventMgrRef, Handler, Args) -> Result Delete an event handler from a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -318,8 +318,8 @@ gen_event:stop -----> Module:terminate/2 - notify(EventMgrRef, Event) -> ok - sync_notify(EventMgrRef, Event) -> ok + notify(EventMgrRef, Event) -> ok + sync_notify(EventMgrRef, Event) -> ok Notify an event manager about an event. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -349,8 +349,8 @@ gen_event:stop -----> Module:terminate/2 - start() -> Result - start(EventMgrName | Options) -> Result + start() -> Result + start(EventMgrName | Options) -> Result start(EventMgrName, Options) -> Result Create a stand-alone event manager process. @@ -375,8 +375,8 @@ gen_event:stop -----> Module:terminate/2 - start_link() -> Result - start_link(EventMgrName | Options) -> Result + start_link() -> Result + start_link(EventMgrName | Options) -> Result start_link(EventMgrName, Options) -> Result Create a generic event manager process in a supervision tree. @@ -436,7 +436,7 @@ gen_event:stop -----> Module:terminate/2 - stop(EventMgrRef) -> ok + stop(EventMgrRef) -> ok stop(EventMgrRef, Reason, Timeout) -> ok Terminate a generic event manager. @@ -474,7 +474,7 @@ gen_event:stop -----> Module:terminate/2 - swap_handler(EventMgrRef, {Handler1,Args1}, {Handler2,Args2}) -> Result + swap_handler(EventMgrRef, {Handler1,Args1}, {Handler2,Args2}) -> Result Replace an event handler in a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -521,7 +521,7 @@ gen_event:stop -----> Module:terminate/2 - swap_sup_handler(EventMgrRef, {Handler1,Args1}, {Handler2,Args2}) -> Result + swap_sup_handler(EventMgrRef, {Handler1,Args1}, {Handler2,Args2}) -> Result Replace an event handler in a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -546,7 +546,7 @@ gen_event:stop -----> Module:terminate/2 - which_handlers(EventMgrRef) -> [Handler] + which_handlers(EventMgrRef) -> [Handler] Return all event handlers installed in a generic event manager. @@ -575,7 +575,7 @@ gen_event:stop -----> Module:terminate/2 - Module:code_change(OldVsn, State, Extra) -> {ok, NewState} + Module:code_change(OldVsn, State, Extra) -> {ok, NewState} Update the internal state during upgrade/downgrade. OldVsn = Vsn | {down, Vsn} @@ -667,7 +667,7 @@ gen_event:stop -----> Module:terminate/2 - Module:handle_call(Request, State) -> Result + Module:handle_call(Request, State) -> Result Handle a synchronous request. Request = term() @@ -698,7 +698,7 @@ gen_event:stop -----> Module:terminate/2 - Module:handle_event(Event, State) -> Result + Module:handle_event(Event, State) -> Result Handle an event. Event = term() @@ -756,7 +756,7 @@ gen_event:stop -----> Module:terminate/2 - Module:handle_info(Info, State) -> Result + Module:handle_info(Info, State) -> Result Handle an incoming message. Info = term() @@ -788,7 +788,7 @@ gen_event:stop -----> Module:terminate/2 - Module:init(InitArgs) -> {ok,State} | {ok,State,hibernate} | {error,Reason} + Module:init(InitArgs) -> {ok,State} | {ok,State,hibernate} | {error,Reason} Initialize an event handler. InitArgs = Args | {Args,Term} @@ -825,7 +825,7 @@ gen_event:stop -----> Module:terminate/2 - Module:terminate(Arg, State) -> term() + Module:terminate(Arg, State) -> term() Clean up before deletion. Arg = Args | {stop,Reason} | stop | remove_handler diff --git a/lib/stdlib/doc/src/gen_server.xml b/lib/stdlib/doc/src/gen_server.xml index f3742fb8fb..a4554d7657 100644 --- a/lib/stdlib/doc/src/gen_server.xml +++ b/lib/stdlib/doc/src/gen_server.xml @@ -28,7 +28,7 @@ - gen_server + gen_server Generic server behavior.

This behavior module provides the server of a client-server @@ -101,8 +101,8 @@ gen_server:abcast -----> Module:handle_cast/2 - abcast(Name, Request) -> abcast - abcast(Nodes, Name, Request) -> abcast + abcast(Name, Request) -> abcast + abcast(Nodes, Name, Request) -> abcast Send an asynchronous request to many generic servers. Nodes = [Node] @@ -124,8 +124,8 @@ gen_server:abcast -----> Module:handle_cast/2 - call(ServerRef, Request) -> Reply - call(ServerRef, Request, Timeout) -> Reply + call(ServerRef, Request) -> Reply + call(ServerRef, Request, Timeout) -> Reply Make a synchronous call to a generic server. ServerRef = Name | {Name,Node} | {global,GlobalName} @@ -175,7 +175,7 @@ gen_server:abcast -----> Module:handle_cast/2 - cast(ServerRef, Request) -> ok + cast(ServerRef, Request) -> ok Send an asynchronous request to a generic server. ServerRef = Name | {Name,Node} | {global,GlobalName} @@ -200,10 +200,10 @@ gen_server:abcast -----> Module:handle_cast/2 - enter_loop(Module, Options, State) - enter_loop(Module, Options, State, ServerName) - enter_loop(Module, Options, State, Timeout) - enter_loop(Module, Options, State, ServerName, Timeout) + enter_loop(Module, Options, State) + enter_loop(Module, Options, State, ServerName) + enter_loop(Module, Options, State, Timeout) + enter_loop(Module, Options, State, ServerName, Timeout) Enter the gen_server receive loop. Module = atom() @@ -248,9 +248,9 @@ gen_server:abcast -----> Module:handle_cast/2 - multi_call(Name, Request) -> Result - multi_call(Nodes, Name, Request) -> Result - multi_call(Nodes, Name, Request, Timeout) -> Result + multi_call(Name, Request) -> Result + multi_call(Nodes, Name, Request) -> Result + multi_call(Nodes, Name, Request, Timeout) -> Result Make a synchronous call to many generic servers. Nodes = [Node] @@ -307,7 +307,7 @@ gen_server:abcast -----> Module:handle_cast/2 - reply(Client, Reply) -> Result + reply(Client, Reply) -> Result Send a reply to a client. Client - see below @@ -332,8 +332,8 @@ gen_server:abcast -----> Module:handle_cast/2 - start(Module, Args, Options) -> Result - start(ServerName, Module, Args, Options) -> Result + start(Module, Args, Options) -> Result + start(ServerName, Module, Args, Options) -> Result Create a standalone gen_server process. ServerName = {local,Name} | {global,GlobalName} @@ -361,8 +361,8 @@ gen_server:abcast -----> Module:handle_cast/2 - start_link(Module, Args, Options) -> Result - start_link(ServerName, Module, Args, Options) -> Result + start_link(Module, Args, Options) -> Result + start_link(ServerName, Module, Args, Options) -> Result Create a gen_server process in a supervision tree. @@ -508,7 +508,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:code_change(OldVsn, State, Extra) -> {ok, NewState} | {error, Reason} + Module:code_change(OldVsn, State, Extra) -> {ok, NewState} | {error, Reason} Update the internal state during upgrade/downgrade. OldVsn = Vsn | {down, Vsn} @@ -610,7 +610,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:handle_call(Request, From, State) -> Result + Module:handle_call(Request, From, State) -> Result Handle a synchronous request. Request = term() @@ -677,7 +677,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:handle_cast(Request, State) -> Result + Module:handle_cast(Request, State) -> Result Handle an asynchronous request. Request = term() @@ -738,7 +738,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:handle_info(Info, State) -> Result + Module:handle_info(Info, State) -> Result Handle an incoming message. Info = timeout | term() @@ -770,7 +770,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:init(Args) -> Result + Module:init(Args) -> Result Initialize process and internal state. Args = term() @@ -811,7 +811,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:terminate(Reason, State) + Module:terminate(Reason, State) Clean up before termination. Reason = normal | shutdown | {shutdown,term()} | term() diff --git a/lib/stdlib/doc/src/io.xml b/lib/stdlib/doc/src/io.xml index 943b3479ca..d69e808586 100644 --- a/lib/stdlib/doc/src/io.xml +++ b/lib/stdlib/doc/src/io.xml @@ -28,7 +28,7 @@ - io + io Standard I/O server interface functions.

This module provides an interface to standard Erlang I/O servers. @@ -104,8 +104,8 @@ - - + + Get the number of columns of an I/O device.

Retrieves the number of columns of the @@ -116,12 +116,12 @@ - - - - - - + + + + + + Write formatted output.

Writes the items in Data ([]) on the @@ -523,8 +523,8 @@ ok - - + + Read formatted input. @@ -690,8 +690,8 @@ enter>: alan : joe - - + + Read a specified number of characters. @@ -722,8 +722,8 @@ enter>: alan : joe - - + + Read a line. @@ -754,8 +754,8 @@ enter>: alan : joe - - + + Get the supported options and values from an I/O server. @@ -781,8 +781,8 @@ enter>: alan : joe - - + + Write a newline.

Writes new line to the standard output @@ -791,9 +791,9 @@ enter>: alan : joe - - - + + + Read, tokenize, and parse Erlang expressions. @@ -844,9 +844,9 @@ enter>abc("hey". - - - + + + Read, tokenize, and parse an Erlang form. @@ -918,8 +918,8 @@ enter>abc("hey". - - + + Write a list of characters.

Writes the characters of CharData to the I/O @@ -928,8 +928,8 @@ enter>abc("hey". - - + + Read a term. @@ -960,7 +960,7 @@ enter>abc("hey". - + Read a term. @@ -997,8 +997,8 @@ enter>abc("hey". - - + + Get the number of rows of an I/O device.

Retrieves the number of rows of IoDevice @@ -1009,9 +1009,9 @@ enter>abc("hey". - - - + + + Read and tokenize Erlang expressions. @@ -1060,9 +1060,9 @@ enter>1.0er. - - - + + + Read and tokenize an Erlang form. @@ -1083,8 +1083,8 @@ enter>1.0er. - - + + Set options.

Set options for the standard I/O device @@ -1198,8 +1198,8 @@ fun("") -> {yes, "quit", []}; - - + + Write a term.

Writes term Term to the standard output diff --git a/lib/stdlib/doc/src/io_lib.xml b/lib/stdlib/doc/src/io_lib.xml index 8a0b674126..cd4ca0a3a7 100644 --- a/lib/stdlib/doc/src/io_lib.xml +++ b/lib/stdlib/doc/src/io_lib.xml @@ -28,7 +28,7 @@ - io_lib + io_lib I/O library functions.

This module contains functions for converting to and from @@ -108,7 +108,7 @@ - + Test for a list of characters.

Returns true if Term is a flat list of @@ -117,7 +117,7 @@ - + Test for a deep list of characters.

Returns true if Term is a, possibly deep, @@ -136,8 +136,8 @@ - - + + Write formatted output.

Returns a character list that represents Data @@ -181,7 +181,7 @@ - + Read formatted input.

Tries to read String in accordance with the @@ -222,7 +222,7 @@ - + Re-entrant formatted reader

This is the re-entrant formatted reader. The continuation of @@ -268,7 +268,7 @@ - + Indentation after printing string.

Returns the indentation if String has been @@ -286,7 +286,7 @@ - + Write a newline.

Returns a character list that represents a new line character.

@@ -294,8 +294,8 @@ - - + + Pretty print a term.

Returns a list of characters that represents @@ -324,7 +324,7 @@ - + Test for a list of printable characters.

Returns true if Term is a flat list of @@ -383,9 +383,9 @@ - - - + + + Write a term.

Returns a character list that represents Term. @@ -411,7 +411,7 @@ - + Write an atom.

Returns the list of characters needed to print atom @@ -430,7 +430,7 @@ - + Write a character.

Returns the list of characters needed to print a character @@ -467,7 +467,7 @@ - + Write a string.

Returns the list of characters needed to print diff --git a/lib/stdlib/doc/src/lists.xml b/lib/stdlib/doc/src/lists.xml index f126326b09..66146e9258 100644 --- a/lib/stdlib/doc/src/lists.xml +++ b/lib/stdlib/doc/src/lists.xml @@ -28,7 +28,7 @@ 1996-09-28 A - lists + lists List processing functions.

This module contains functions for list processing.

@@ -63,7 +63,7 @@ - + Return true if all elements in a list satisfy Pred. @@ -74,7 +74,7 @@ - + Return true if any of the elements in a list satisfies Pred. @@ -85,7 +85,7 @@ - + Append a list of lists.

Returns a list in which all the sublists of @@ -98,7 +98,7 @@ - + Append two lists.

Returns a new list List3, which is made from @@ -113,7 +113,7 @@ - + Concatenate a list of atoms.

Concatenates the text representation of the elements of @@ -127,7 +127,7 @@ - + Delete an element from a list.

Returns a copy of List1 where the first element @@ -147,7 +147,7 @@ - + Drop elements from a list while a predicate is true. @@ -159,7 +159,7 @@ - + Make N copies of element.

Returns a list containing N copies of term @@ -172,7 +172,7 @@ - + Select elements that satisfy a predicate.

List2 is a list of all elements @@ -211,7 +211,7 @@ filtermap(Fun, List1) -> - + Length of flattened deep list.

Equivalent to length(flatten(DeepList)), but @@ -220,7 +220,7 @@ filtermap(Fun, List1) -> - + Map and flatten in one pass.

Takes a function from As to lists of @@ -241,7 +241,7 @@ flatmap(Fun, List1) -> - + Flatten a deep list.

Returns a flattened version of DeepList.

@@ -249,7 +249,7 @@ flatmap(Fun, List1) -> - + Flatten a deep list.

Returns a flattened version of DeepList with tail @@ -258,7 +258,7 @@ flatmap(Fun, List1) -> - + Fold a function over a list.

Calls Fun(Elem, AccIn) @@ -278,7 +278,7 @@ flatmap(Fun, List1) -> - + Fold a function over a list.

Like foldl/3, but the @@ -312,7 +312,7 @@ flatmap(Fun, List1) -> - + Apply a function to each element of a list.

Calls Fun(Elem) for each element @@ -324,7 +324,7 @@ flatmap(Fun, List1) -> - + Delete an element from a list of tuples. 1..tuple_size(Tuple) @@ -336,7 +336,7 @@ flatmap(Fun, List1) -> - + Search for an element in a list of tuples. 1..tuple_size(Tuple) @@ -349,7 +349,7 @@ flatmap(Fun, List1) -> - + Map a function over a list of tuples. 1..tuple_size(Tuple) @@ -368,7 +368,7 @@ flatmap(Fun, List1) -> - + Test for membership of a list of tuples. 1..tuple_size(Tuple) @@ -379,7 +379,7 @@ flatmap(Fun, List1) -> - + Merge two key-sorted lists of tuples. 1..tuple_size(Tuple) @@ -395,7 +395,7 @@ flatmap(Fun, List1) -> - + Replace an element in a list of tuples. 1..tuple_size(Tuple) @@ -407,7 +407,7 @@ flatmap(Fun, List1) -> - + Search for an element in a list of tuples. 1..tuple_size(Tuple) @@ -425,7 +425,7 @@ flatmap(Fun, List1) -> - + Sort a list of tuples. 1..tuple_size(Tuple) @@ -436,7 +436,7 @@ flatmap(Fun, List1) -> - + Store an element in a list of tuples. 1..tuple_size(Tuple) @@ -452,7 +452,7 @@ flatmap(Fun, List1) -> - + Extract an element from a list of tuples. 1..tuple_size(Tuple) @@ -467,7 +467,7 @@ flatmap(Fun, List1) -> - + Return last element in a list.

Returns the last element in List.

@@ -475,7 +475,7 @@ flatmap(Fun, List1) -> - + Map a function over a list.

Takes a function from As to @@ -488,7 +488,7 @@ flatmap(Fun, List1) -> - + Map and fold in one pass.

Combines the operations of @@ -504,7 +504,7 @@ flatmap(Fun, List1) -> - + Map and fold in one pass.

Combines the operations of @@ -514,7 +514,7 @@ flatmap(Fun, List1) -> - + Return maximum element of a list.

Returns the first element of List that compares @@ -524,7 +524,7 @@ flatmap(Fun, List1) -> - + Test for membership of a list.

Returns true if Elem matches some element @@ -533,7 +533,7 @@ flatmap(Fun, List1) -> - + Merge a list of sorted lists.

Returns the sorted list formed by merging all the sublists of @@ -546,7 +546,7 @@ flatmap(Fun, List1) -> - + Merge two sorted lists.

Returns the sorted list formed by merging List1 @@ -559,7 +559,7 @@ flatmap(Fun, List1) -> - + Merge two sorted list.

Returns the sorted list formed by merging List1 @@ -577,7 +577,7 @@ flatmap(Fun, List1) -> - + Merge three sorted lists.

Returns the sorted list formed by merging List1, @@ -593,7 +593,7 @@ flatmap(Fun, List1) -> - + Return minimum element of a list.

Returns the first element of List that compares @@ -603,7 +603,7 @@ flatmap(Fun, List1) -> - + Return the Nth element of a list. 1..length(List) @@ -617,7 +617,7 @@ c - + Return the Nth tail of a list. 0..length(List) @@ -638,7 +638,7 @@ c - + Partition a list into two lists based on a predicate.

Partitions List into two lists, where the first @@ -658,7 +658,7 @@ c - + Test for list prefix.

Returns true if List1 is a prefix of @@ -667,7 +667,7 @@ c - + Reverse a list.

Returns a list with the elements in List1 @@ -676,7 +676,7 @@ c - + Reverse a list appending a tail.

Returns a list with the elements in List1 @@ -689,8 +689,8 @@ c - - + + Generate a sequence of integers.

Returns a sequence of integers that starts with @@ -736,7 +736,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Sort a list.

Returns a list containing the sorted elements of @@ -745,7 +745,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Sort a list.

Returns a list containing the sorted elements of @@ -759,7 +759,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Split a list into two lists. 0..length(List1) @@ -783,7 +783,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Split a list into two lists based on a predicate.

Partitions List into two lists according to @@ -804,7 +804,7 @@ splitwith(Pred, List) -> - + Return a sublist of a certain length, starting at the first position. @@ -816,7 +816,7 @@ splitwith(Pred, List) -> - + Return a sublist starting at a specified position and with a specified number of elements. 1..(length(List1)+1) @@ -838,7 +838,7 @@ splitwith(Pred, List) -> - + Subtract the element in one list from another list.

Returns a new list List3 that is a copy of @@ -854,7 +854,7 @@ splitwith(Pred, List) -> - + Test for list suffix.

Returns true if List1 is a suffix of @@ -863,7 +863,7 @@ splitwith(Pred, List) -> - + Return the sum of elements in a list.

Returns the sum of the elements in List.

@@ -871,7 +871,7 @@ splitwith(Pred, List) -> - + Take elements from a list while a predicate is true. @@ -884,7 +884,7 @@ splitwith(Pred, List) -> - + Merge two key-sorted lists of tuples, removing duplicates. 1..tuple_size(Tuple) @@ -902,7 +902,7 @@ splitwith(Pred, List) -> - + Sort a list of tuples, removing duplicates. 1..tuple_size(Tuple) @@ -914,7 +914,7 @@ splitwith(Pred, List) -> - + Merge a list of sorted lists, removing duplicates.

Returns the sorted list formed by merging all the sublists @@ -927,7 +927,7 @@ splitwith(Pred, List) -> - + Merge two sorted lists, removing duplicates.

Returns the sorted list formed by merging List1 @@ -941,7 +941,7 @@ splitwith(Pred, List) -> - + Merge two sorted lists, removing duplicates.

Returns the sorted list formed by merging List1 @@ -958,7 +958,7 @@ splitwith(Pred, List) -> - + Merge three sorted lists, removing duplicates.

Returns the sorted list formed by merging List1, @@ -973,7 +973,7 @@ splitwith(Pred, List) -> - + Unzip a list of two-tuples into two lists.

"Unzips" a list of two-tuples into two lists, where the first @@ -983,7 +983,7 @@ splitwith(Pred, List) -> - + Unzip a list of three-tuples into three lists.

"Unzips" a list of three-tuples into three lists, where @@ -994,7 +994,7 @@ splitwith(Pred, List) -> - + Sort a list, removing duplicates.

Returns a list containing the sorted elements of @@ -1004,7 +1004,7 @@ splitwith(Pred, List) -> - + Sort a list, removing duplicates.

Returns a list containing the sorted elements of @@ -1019,7 +1019,7 @@ splitwith(Pred, List) -> - + Zip two lists into a list of two-tuples.

"Zips" two lists of equal length into one list of two-tuples, @@ -1030,7 +1030,7 @@ splitwith(Pred, List) -> - + Zip three lists into a list of three-tuples.

"Zips" three lists of equal length into one list of @@ -1042,7 +1042,7 @@ splitwith(Pred, List) -> - + Zip two lists into one list according to a fun.

Combines the elements of two lists of equal length into one list. @@ -1059,7 +1059,7 @@ splitwith(Pred, List) -> - + Zip three lists into one list according to a fun.

Combines the elements of three lists of equal length into one diff --git a/lib/stdlib/doc/src/log_mf_h.xml b/lib/stdlib/doc/src/log_mf_h.xml index edc3d31025..b922006cc0 100644 --- a/lib/stdlib/doc/src/log_mf_h.xml +++ b/lib/stdlib/doc/src/log_mf_h.xml @@ -34,7 +34,7 @@ A log_mf_h.xml - log_mf_h + log_mf_h An event handler that logs events to disk.

This module is a gen_event handler module that can be installed @@ -60,8 +60,8 @@ - - + + Initiate the event handler.

Initiates the event handler. Returns Args, which diff --git a/lib/stdlib/doc/src/math.xml b/lib/stdlib/doc/src/math.xml index 0672da88b9..d89310e2c8 100644 --- a/lib/stdlib/doc/src/math.xml +++ b/lib/stdlib/doc/src/math.xml @@ -34,7 +34,7 @@ B math.xml - math + math Mathematical functions.

This module provides an interface to a number of mathematical @@ -50,28 +50,28 @@ - - - - - - - + + + + + + + - - - + + + - - + + - - - - - - + + + + + + Diverse math functions. @@ -82,7 +82,7 @@ - + Error function.

Returns the error function of X, where:

@@ -92,7 +92,7 @@ erf(X) = 2/sqrt(pi)*integral from 0 to X of exp(-t*t) dt. - + Another error function.

erfc(X) returns 1.0 - erf(X), computed by @@ -101,7 +101,7 @@ erf(X) = 2/sqrt(pi)*integral from 0 to X of exp(-t*t) dt. - + A useful number.

A useful number.

diff --git a/lib/stdlib/doc/src/ms_transform.xml b/lib/stdlib/doc/src/ms_transform.xml index 0a05fa37c5..65cc150507 100644 --- a/lib/stdlib/doc/src/ms_transform.xml +++ b/lib/stdlib/doc/src/ms_transform.xml @@ -32,7 +32,7 @@ C ms_transform.xml - ms_transform + ms_transform A parse transformation that translates fun syntax into match specifications. @@ -731,7 +731,7 @@ ets:select(Table, [{{'$1',test,'$2'},[],['$_']}]). - + Error formatting function as required by the parse transformation interface.

Takes an error code returned by one of the other functions @@ -741,7 +741,7 @@ ets:select(Table, [{{'$1',test,'$2'},[],['$_']}]). - + Transforms Erlang abstract format containing calls to ets/dbg:fun2ms/1 into literal match specifications. Option list, required but not used. @@ -762,7 +762,7 @@ ets:select(Table, [{{'$1',test,'$2'},[],['$_']}]). - + Used when transforming funs created in the shell into match_specifications. List of variable bindings in the diff --git a/lib/stdlib/doc/src/orddict.xml b/lib/stdlib/doc/src/orddict.xml index e4dae4104d..27ccccee7e 100644 --- a/lib/stdlib/doc/src/orddict.xml +++ b/lib/stdlib/doc/src/orddict.xml @@ -32,7 +32,7 @@ B orddict.xml - orddict + orddict Key-value dictionary as ordered list.

This module provides a Key-Value dictionary. @@ -61,7 +61,7 @@ - + Append a value to keys in a dictionary.

Appends a new Value to the current list @@ -73,7 +73,7 @@ - + Append new values to keys in a dictionary.

Appends a list of values ValList to @@ -85,7 +85,7 @@ - + Erase a key from a dictionary.

Erases all items with a specified key from a dictionary.

@@ -93,7 +93,7 @@ - + Look up values in a dictionary.

Returns the value associated with Key @@ -105,7 +105,7 @@ - + Return all keys in a dictionary.

Returns a list of all keys in a dictionary.

@@ -122,7 +122,7 @@ - + Select elements that satisfy a predicate.

Orddict2 is a dictionary of all keys and values @@ -133,7 +133,7 @@ - + Search for a key in a dictionary.

Searches for a key in a dictionary. Returns @@ -145,7 +145,7 @@ - + Fold a function over a dictionary.

Calls Fun on successive keys and values of @@ -157,7 +157,7 @@ - + Convert a list of pairs to a dictionary.

Converts the Key-Value list @@ -175,7 +175,7 @@ - + Test if a key is in a dictionary.

Tests if Key is contained in @@ -184,7 +184,7 @@ - + Map a function over a dictionary.

Calls Fun on successive keys and values of @@ -193,7 +193,7 @@ - + Merge two dictionaries.

Merges two dictionaries, Orddict1 and @@ -212,7 +212,7 @@ merge(Fun, D1, D2) -> - + Create a dictionary.

Creates a new dictionary.

@@ -220,7 +220,7 @@ merge(Fun, D1, D2) -> - + Return the number of elements in an ordered dictionary. @@ -229,7 +229,7 @@ merge(Fun, D1, D2) -> - + Store a value in a dictionary.

Stores a Key-Value pair in a @@ -240,7 +240,7 @@ merge(Fun, D1, D2) -> - + Convert a dictionary to a list of pairs.

Converts a dictionary to a list representation.

@@ -248,7 +248,7 @@ merge(Fun, D1, D2) -> - + Update a value in a dictionary.

Updates a value in a dictionary by calling Fun @@ -258,7 +258,7 @@ merge(Fun, D1, D2) -> - + Update a value in a dictionary.

Updates a value in a dictionary by calling Fun @@ -273,7 +273,7 @@ append(Key, Val, D) -> - + Increment a value in a dictionary.

Adds Increment to the value associated with diff --git a/lib/stdlib/doc/src/ordsets.xml b/lib/stdlib/doc/src/ordsets.xml index d1e24facef..fbe334c009 100644 --- a/lib/stdlib/doc/src/ordsets.xml +++ b/lib/stdlib/doc/src/ordsets.xml @@ -32,7 +32,7 @@ A ordsets.xml - ordsets + ordsets Functions for manipulating sets as ordered lists. @@ -60,7 +60,7 @@ - + Add an element to an Ordset.

Returns a new ordered set formed from Ordset1 @@ -69,7 +69,7 @@ - + Remove an element from an Ordset.

Returns Ordset1, but with @@ -78,7 +78,7 @@ - + Filter set elements.

Filters elements in Ordset1 with boolean function @@ -87,7 +87,7 @@ - + Fold over set elements.

Folds Function over every element in @@ -97,7 +97,7 @@ - + Convert a list into an Ordset.

Returns an ordered set of the elements in List. @@ -106,7 +106,7 @@ - + Return the intersection of a list of Ordsets

Returns the intersection of the non-empty list of sets.

@@ -114,7 +114,7 @@ - + Return the intersection of two Ordsets.

Returns the intersection of Ordset1 and @@ -123,7 +123,7 @@ - + Check whether two Ordsets are disjoint.

Returns true if Ordset1 and @@ -133,7 +133,7 @@ - + Test for membership of an Ordset.

Returns true if Element is an element of @@ -151,7 +151,7 @@ - + Test for an Ordset.

Returns true if Ordset is an ordered set @@ -160,7 +160,7 @@ - + Test for subset.

Returns true when every element of Ordset1 @@ -170,7 +170,7 @@ - + Return an empty set.

Returns a new empty ordered set.

@@ -178,7 +178,7 @@ - + Return the number of elements in a set.

Returns the number of elements in Ordset.

@@ -186,7 +186,7 @@ - + Return the difference of two Ordsets.

Returns only the elements of Ordset1 that are not @@ -195,7 +195,7 @@ - + Convert an Ordset into a list.

Returns the elements of Ordset as a list.

@@ -203,7 +203,7 @@ - + Return the union of a list of Ordsets.

Returns the merged (union) set of the list of sets.

@@ -211,7 +211,7 @@ - + Return the union of two Ordsets.

Returns the merged (union) set of Ordset1 and diff --git a/lib/stdlib/doc/src/pool.xml b/lib/stdlib/doc/src/pool.xml index 05d12ade28..675ee08bfb 100644 --- a/lib/stdlib/doc/src/pool.xml +++ b/lib/stdlib/doc/src/pool.xml @@ -28,7 +28,7 @@ - pool + pool Load distribution facility.

This module can be used to run a set of Erlang nodes as a pool @@ -54,7 +54,7 @@ - + Ensure that a pool master is running.

Ensures that a pool master is running and includes @@ -63,7 +63,7 @@ - + Return the node with the expected lowest future load.

Returns the node with the expected lowest future load.

@@ -71,7 +71,7 @@ - + Return a list of the current member nodes of the pool. @@ -80,7 +80,7 @@ - + Spawn a process on the pool node with expected lowest future load. @@ -90,7 +90,7 @@ - + Spawn and link to a process on the pool node with expected lowest future load. @@ -100,8 +100,8 @@ - - + + >Start a new pool.

Starts a new pool. The file .hosts.erlang is read to @@ -122,7 +122,7 @@ - + Stop the pool and kill all the slave nodes.

Stops the pool and kills all the slave nodes.

diff --git a/lib/stdlib/doc/src/proc_lib.xml b/lib/stdlib/doc/src/proc_lib.xml index 8e7308ca74..aeb9f48735 100644 --- a/lib/stdlib/doc/src/proc_lib.xml +++ b/lib/stdlib/doc/src/proc_lib.xml @@ -28,7 +28,7 @@ - proc_lib + proc_lib Functions for asynchronous and synchronous start of processes adhering to the OTP design principles. @@ -102,7 +102,7 @@ - + Format a crash report.

Equivalent to @@ -162,7 +162,7 @@ - + Hibernate a process until a message is sent to it.

This function does the same as (and does call) the @@ -176,8 +176,8 @@ - - + + Used by a process when it has started.

This function must be used by a process that has been started by @@ -214,7 +214,7 @@ init(Parent) -> - + Extract the initial call of a proc_libspawned process. @@ -244,10 +244,10 @@ init(Parent) -> - - - - + + + + Spawn a new process. @@ -262,10 +262,10 @@ init(Parent) -> - - - - + + + + Spawn and link to a new process. @@ -281,10 +281,10 @@ init(Parent) -> - - - - + + + + Spawn a new process with specified options. @@ -306,12 +306,12 @@ init(Parent) -> - - - - - - + + + + + + Start a new process synchronously.

Starts a new process synchronously. Spawns the process and @@ -375,7 +375,7 @@ init(Parent) -> - + Extract and translate the initial call of a proc_libspawned process. diff --git a/lib/stdlib/doc/src/proplists.xml b/lib/stdlib/doc/src/proplists.xml index f9a54bf804..9d7eb55a7e 100644 --- a/lib/stdlib/doc/src/proplists.xml +++ b/lib/stdlib/doc/src/proplists.xml @@ -32,7 +32,7 @@ A proplists.xml - proplists + proplists Support functions for property lists.

Property lists are ordinary lists containing entries in the form @@ -61,7 +61,7 @@ - +

Similar to @@ -79,7 +79,7 @@ append_values(a, [{a, [1,2]}, {b, 0}, {a, 3}, {c, -1}, {a, [4]}]) - +

Minimizes the representation of all entries in the list. This is @@ -91,7 +91,7 @@ append_values(a, [{a, [1,2]}, {b, 0}, {a, 3}, {c, -1}, {a, [4]}]) - +

Deletes all entries associated with Key from @@ -100,7 +100,7 @@ append_values(a, [{a, [1,2]}, {b, 0}, {a, 3}, {c, -1}, {a, [4]}]) - +

Expands particular properties to corresponding sets of @@ -133,7 +133,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Similar to @@ -145,7 +145,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns the value of a boolean key/value option. If @@ -159,7 +159,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns an unordered list of the keys used in @@ -168,7 +168,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Equivalent to @@ -177,7 +177,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns the value of a simple key/value property in @@ -194,7 +194,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns true if List contains at least @@ -204,7 +204,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns the first entry associated with Key in @@ -219,7 +219,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns the list of all entries associated with @@ -231,7 +231,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Passes ListIn through a sequence of @@ -263,7 +263,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Creates a normal form (minimal) representation of a property. If @@ -276,7 +276,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Creates a normal form (minimal) representation of a simple key/value @@ -289,7 +289,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Partitions List into a list of sublists and a @@ -310,7 +310,7 @@ split([{c, 2}, {e, 1}, a, {c, 3, 4}, d, {b, 5}, b], [a, b, c]) - +

Substitutes keys of properties. For each entry in @@ -332,7 +332,7 @@ split([{c, 2}, {e, 1}, a, {c, 3, 4}, d, {b, 5}, b], [a, b, c]) - +

Substitutes keys of boolean-valued properties and @@ -360,7 +360,7 @@ split([{c, 2}, {e, 1}, a, {c, 3, 4}, d, {b, 5}, b], [a, b, c]) - +

Unfolds all occurrences of atoms in ListIn to diff --git a/lib/stdlib/doc/src/qlc.xml b/lib/stdlib/doc/src/qlc.xml index fe14a6334c..fe60c2e9bb 100644 --- a/lib/stdlib/doc/src/qlc.xml +++ b/lib/stdlib/doc/src/qlc.xml @@ -32,7 +32,7 @@ PA1 qlc.xml - qlc + qlc Query interface to Mnesia, ETS, Dets, and so on. @@ -720,7 +720,7 @@ ets:match_spec_run(ets:lookup(86033, {2,2}), - + Return a query handle.

Returns a query handle. When evaluating query handle @@ -731,7 +731,7 @@ ets:match_spec_run(ets:lookup(86033, {2,2}), - + Return a query handle.

Returns a query handle. When evaluating query handle @@ -744,8 +744,8 @@ ets:match_spec_run(ets:lookup(86033, {2,2}), - - + + Create a query cursor.

Creates a query cursor and @@ -777,7 +777,7 @@ ok - + Delete a query cursor.

Deletes a query cursor. Only the owner of the cursor can @@ -786,10 +786,10 @@ ok - - - - + + + + Return all answers to a query.

Evaluates a query handle in the @@ -805,8 +805,8 @@ ok - - + + Fold a function over the answers to a query.

Calls Function on successive answers to @@ -830,7 +830,7 @@ ok - + Return an English description of a an error tuple.

Returns a descriptive string in English of an error tuple @@ -841,8 +841,8 @@ ok - - + + Return code describing a query handle.

Returns information about a @@ -946,8 +946,8 @@ end - - + + Return a query handle.

Returns a query handle. When evaluating query handle @@ -967,8 +967,8 @@ end - - + + Return some or all answers to a query.

Returns some or all of the remaining answers to a query @@ -983,8 +983,8 @@ end - - + + Return a handle for a query list comprehension.

Returns a query handle for a QLC. @@ -1188,8 +1188,8 @@ ets:match_spec_run( - - + + Return a query handle.

Returns a query handle. When evaluating query handle @@ -1208,9 +1208,9 @@ ets:match_spec_run( - - - + + + Return a handle for a query list comprehension.

A string version of q/1,2. @@ -1238,7 +1238,7 @@ ets:match_spec_run( - + Return a query handle for a table.

Returns a query handle for a QLC table. diff --git a/lib/stdlib/doc/src/queue.xml b/lib/stdlib/doc/src/queue.xml index 9f3aff03a3..83a8afea81 100644 --- a/lib/stdlib/doc/src/queue.xml +++ b/lib/stdlib/doc/src/queue.xml @@ -32,7 +32,7 @@ B queue.xml - queue + queue Abstract data type for FIFO queues.

This module provides (double-ended) FIFO queues @@ -113,7 +113,7 @@ - + Filter a queue.

Returns a queue Q2 that is the result of calling @@ -134,7 +134,7 @@ - + Convert a list to a queue.

Returns a queue containing the items in L in the @@ -144,7 +144,7 @@ - + Insert an item at the rear of a queue.

Inserts Item at the rear of queue @@ -154,7 +154,7 @@ - + Insert an item at the front of a queue.

Inserts Item at the front of queue @@ -164,7 +164,7 @@ - + Test if a queue is empty.

Tests if Q is empty and returns true if @@ -173,7 +173,7 @@ - + Test if a term is a queue.

Tests if Term is a queue and returns true @@ -182,7 +182,7 @@ - + Join two queues.

Returns a queue Q3 that is the result of joining @@ -192,7 +192,7 @@ - + Get the length of a queue.

Calculates and returns the length of queue Q.

@@ -200,7 +200,7 @@ - + Test if an item is in a queue.

Returns true if Item matches some element @@ -209,7 +209,7 @@ - + Create an empty queue.

Returns an empty queue.

@@ -217,7 +217,7 @@ - + Remove the front item from a queue.

Removes the item at the front of queue Q1. @@ -230,7 +230,7 @@ - + Remove the rear item from a queue.

Removes the item at the rear of queue Q1. @@ -242,7 +242,7 @@ - + Reverse a queue.

Returns a queue Q2 containing the items of @@ -251,7 +251,7 @@ - + Split a queue in two.

Splits Q1 in two. The N @@ -261,7 +261,7 @@ - + Convert a queue to a list.

Returns a list of the items in the queue in the same order; @@ -276,7 +276,7 @@ - + Remove the front item from a queue.

Returns a queue Q2 that is the result of removing @@ -286,7 +286,7 @@ - + Remove the rear item from a queue.

Returns a queue Q2 that is the result of removing @@ -296,7 +296,7 @@ - + Return the front item of a queue.

Returns Item at the front of queue @@ -306,7 +306,7 @@ - + Return the rear item of a queue.

Returns Item at the rear of queue @@ -316,7 +316,7 @@ - + Return the front item of a queue.

Returns tuple {value, Item}, where @@ -326,7 +326,7 @@ - + Return the rear item of a queue.

Returns tuple {value, Item}, where @@ -342,7 +342,7 @@ - + Insert an item at the head of a queue.

Inserts Item at the head of queue @@ -352,7 +352,7 @@ - + Return the tail item of a queue.

Returns the tail item of queue Q.

@@ -361,7 +361,7 @@ - + Return the item at the head of a queue.

Returns Item from the head of queue @@ -371,7 +371,7 @@ - + Remove the tail item from a queue.

Returns a queue Q2 that is the result of removing @@ -381,7 +381,7 @@ - + Remove the tail item from a queue.

Returns a queue Q2 that is the result of removing @@ -392,7 +392,7 @@ - + Return the tail item of a queue.

Returns the tail item of queue Q.

@@ -401,7 +401,7 @@ - + Remove the tail item from a queue.

Returns a queue Q2 that is the result of removing @@ -411,7 +411,7 @@ - + Insert an item at the tail of a queue.

Inserts Item as the tail item of queue @@ -421,7 +421,7 @@ - + Remove the head item from a queue.

Returns a queue Q2 that is the result of removing diff --git a/lib/stdlib/doc/src/random.xml b/lib/stdlib/doc/src/random.xml index 8d090d20b3..f0261ed009 100644 --- a/lib/stdlib/doc/src/random.xml +++ b/lib/stdlib/doc/src/random.xml @@ -32,7 +32,7 @@ A random.xml - random + random Pseudo-random number generation.

This module provides a random number generator. The method is attributed @@ -73,7 +73,7 @@ - + Seed random number generation with default values.

Seeds random number generation with default (fixed) values @@ -82,7 +82,7 @@ - + Seed random number generator.

seed({A1, A2, A3}) @@ -92,7 +92,7 @@ - + Seed random number generator.

Seeds random number generation with integer values in the process @@ -116,7 +116,7 @@ random:seed(erlang:phash2([node()]), - + Return default state for random number generation.

Returns the default state.

@@ -124,7 +124,7 @@ random:seed(erlang:phash2([node()]), - + Return a random float.

Returns a random float uniformly distributed between 0.0 @@ -133,7 +133,7 @@ random:seed(erlang:phash2([node()]), - + Return a random integer.

Returns, for a specified integer N >= 1, @@ -144,7 +144,7 @@ random:seed(erlang:phash2([node()]), - + Return a random float.

Returns, for a specified state, a random float uniformly @@ -153,7 +153,7 @@ random:seed(erlang:phash2([node()]), - + Return a random integer.

Returns, for a specified integer N >= 1 and a diff --git a/lib/stdlib/doc/src/re.xml b/lib/stdlib/doc/src/re.xml index 71f49cb640..b04434492d 100644 --- a/lib/stdlib/doc/src/re.xml +++ b/lib/stdlib/doc/src/re.xml @@ -34,7 +34,7 @@ A re.xml - re + re Perl-like regular expressions for Erlang.

This module contains regular expression matching functions for @@ -87,7 +87,7 @@ - + Compile a regular expression into a match program

The same as compile(Regexp,[])

@@ -95,7 +95,7 @@ - + Compile a regular expression into a match program.

Compiles a regular expression, with the syntax @@ -348,7 +348,7 @@ - + Match a subject against regular expression and replace matching elements with Replacement. @@ -358,7 +358,7 @@ - + Match a subject against regular expression and replace matching elements with Replacement. @@ -408,7 +408,7 @@ re:replace("abcd","c","[\\&]",[{return,list}]). - + Match a subject against regular expression and capture subpatterns. @@ -417,7 +417,7 @@ re:replace("abcd","c","[\\&]",[{return,list}]). - + Match a subject against regular expression and capture subpatterns. See @@ -992,7 +992,7 @@ re:run("cacb","c(a|b)",[global,{capture,[1],list}]). - + Split a string by tokens specified as a regular expression. @@ -1001,7 +1001,7 @@ re:run("cacb","c(a|b)",[global,{capture,[1],list}]). - + Split a string by tokens specified as a regular expression See compile/2. diff --git a/lib/stdlib/doc/src/sets.xml b/lib/stdlib/doc/src/sets.xml index e076b9a5ec..07ce41b7a7 100644 --- a/lib/stdlib/doc/src/sets.xml +++ b/lib/stdlib/doc/src/sets.xml @@ -32,7 +32,7 @@ A sets.xml - sets + sets Functions for set manipulation.

Sets are collections of elements with no duplicate elements. @@ -59,7 +59,7 @@ - + Add an element to a Set.

Returns a new set formed from Set1 with @@ -68,7 +68,7 @@ - + Remove an element from a Set.

Returns Set1, but with @@ -77,7 +77,7 @@ - + Filter set elements.

Filters elements in Set1 with boolean function @@ -86,7 +86,7 @@ - + Fold over set elements.

Folds Function over every element in @@ -96,7 +96,7 @@ - + Convert a list into a Set.

Returns a set of the elements in List.

@@ -104,7 +104,7 @@ - + Return the intersection of a list of Sets.

Returns the intersection of the non-empty list of sets.

@@ -112,7 +112,7 @@ - + Return the intersection of two Sets.

Returns the intersection of Set1 and @@ -121,7 +121,7 @@ - + Check whether two Sets are disjoint.

Returns true if Set1 and @@ -131,7 +131,7 @@ - + Test for membership of a Set.

Returns true if Element is an element of @@ -149,7 +149,7 @@ - + Test for a Set.

Returns true if Set is a set of @@ -158,7 +158,7 @@ - + Test for subset.

Returns true when every element of Set1 is @@ -167,7 +167,7 @@ - + Return an empty set.

Returns a new empty set.

@@ -175,7 +175,7 @@ - + Return the number of elements in a set.

Returns the number of elements in Set.

@@ -183,7 +183,7 @@ - + Return the difference of two Sets.

Returns only the elements of Set1 that are not @@ -192,7 +192,7 @@ - + Convert a Setinto a list.

Returns the elements of Set as a list. @@ -201,7 +201,7 @@ - + Return the union of a list of Sets.

Returns the merged (union) set of the list of sets.

@@ -209,7 +209,7 @@ - + Return the union of two Sets.

Returns the merged (union) set of Set1 and diff --git a/lib/stdlib/doc/src/shell.xml b/lib/stdlib/doc/src/shell.xml index 892bb64daf..50a0968531 100644 --- a/lib/stdlib/doc/src/shell.xml +++ b/lib/stdlib/doc/src/shell.xml @@ -32,7 +32,7 @@ A shell.xml - shell + shell The Erlang shell.

This module provides an Erlang shell.

@@ -874,7 +874,7 @@ q - quit erlang - catch_exception(Bool) -> boolean() + catch_exception(Bool) -> boolean() Set the exception handling of the shell. Bool = boolean() @@ -892,7 +892,7 @@ q - quit erlang - + Set the number of previous commands to keep.

Sets the number of previous commands to keep in the @@ -911,7 +911,7 @@ q - quit erlang - + Set the number of previous results to keep.

Sets the number of results from previous commands to keep in @@ -921,7 +921,7 @@ q - quit erlang - + Exit a normal shell and starts a restricted shell.

Exits a normal shell and starts a restricted shell. @@ -936,7 +936,7 @@ q - quit erlang - + Exit a restricted shell and starts a normal shell.

Exits a restricted shell and starts a normal shell. The function diff --git a/lib/stdlib/doc/src/slave.xml b/lib/stdlib/doc/src/slave.xml index e53ec8231b..80fb28b548 100644 --- a/lib/stdlib/doc/src/slave.xml +++ b/lib/stdlib/doc/src/slave.xml @@ -28,7 +28,7 @@ - slave + slave Functions for starting and controlling slave nodes. @@ -68,7 +68,7 @@ - pseudo([Master | ServerList]) -> ok + pseudo([Master | ServerList]) -> ok Start a number of pseudo servers. Master = node() @@ -84,7 +84,7 @@ - + Start a number of pseudo servers.

Starts a number of pseudo servers. A pseudo server is a @@ -102,7 +102,7 @@ rpc:call(N, slave, pseudo, [node(), [pxw_server]]). - + Run a pseudo server.

Runs a pseudo server. This function never returns any value @@ -113,9 +113,9 @@ rpc:call(N, slave, pseudo, [node(), [pxw_server]]). - - - + + + Start a slave node on a host.

Starts a slave node on host Host. Host names @@ -178,9 +178,9 @@ slave:start(H, Name, Arg). - - - + + + Start and link to a slave node on a host.

Starts a slave node in the same way as start/1,2,3, @@ -193,7 +193,7 @@ slave:start(H, Name, Arg). - + Stop (kill) a node.

Stops (kills) a node.

diff --git a/lib/stdlib/doc/src/sofs.xml b/lib/stdlib/doc/src/sofs.xml index 4cf1984d46..a0759d2f52 100644 --- a/lib/stdlib/doc/src/sofs.xml +++ b/lib/stdlib/doc/src/sofs.xml @@ -32,7 +32,7 @@ PA1 sofs.xml - sofs + sofs Functions for manipulating sets of sets.

This module provides operations on finite sets and @@ -456,8 +456,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a function.

Creates a function. @@ -470,7 +470,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the canonical map.

Returns the binary relation containing the elements @@ -490,7 +490,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the composite of two functions.

Returns the composite of @@ -506,7 +506,7 @@ fun(S) -> sofs:partition(1, S) end - + Create the function that maps each element of a set onto another set. @@ -522,7 +522,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the converse of a binary relation.

Returns the converse @@ -536,7 +536,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the difference of two sets.

Returns the difference of @@ -545,8 +545,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a family from a directed graph.

Creates a family from @@ -565,7 +565,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the domain of a binary relation.

Returns the domain of @@ -579,7 +579,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a restriction of a binary relation.

Returns the difference between the binary relation @@ -598,7 +598,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a restriction of a relation.

Returns a subset of Set1 containing those @@ -618,7 +618,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the untyped empty set.

Returns the untyped empty @@ -628,7 +628,7 @@ fun(S) -> sofs:partition(1, S) end - + Extend the domain of a binary relation.

Returns the extension of @@ -648,8 +648,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a family of subsets.

Creates a family of subsets. @@ -662,7 +662,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the difference of two families.

If Family1 and Family2 @@ -683,7 +683,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a family of domains.

If Family1 is @@ -704,7 +704,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a family of fields.

If Family1 is @@ -728,7 +728,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of a family of sets of sets. @@ -752,7 +752,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of two families.

If Family1 and Family2 @@ -772,7 +772,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a family of modified subsets.

If Family1 is @@ -791,7 +791,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a family of ranges.

If Family1 is @@ -812,7 +812,7 @@ fun(S) -> sofs:partition(1, S) end - + Select a subset of a family using a predicate.

If Family1 is @@ -837,8 +837,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a directed graph from a family.

Creates a directed graph from @@ -863,7 +863,7 @@ fun(S) -> sofs:partition(1, S) end - + Create a binary relation from a family.

If Family is @@ -881,7 +881,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the union of a family of sets of sets.

If Family1 is @@ -904,7 +904,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the union of two families.

If Family1 and Family2 @@ -926,7 +926,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the field of a binary relation.

Returns the field of the @@ -942,7 +942,7 @@ fun(S) -> sofs:partition(1, S) end - + Create a set.

Creates a set from the external @@ -955,7 +955,7 @@ fun(S) -> sofs:partition(1, S) end - + Create a set out of a list of sets.

Returns the unordered @@ -971,7 +971,7 @@ fun(S) -> sofs:partition(1, S) end - + Create an ordered set out of a tuple of sets.

Returns the ordered @@ -981,8 +981,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a set.

Creates an element @@ -1031,7 +1031,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the image of a set under a binary relation.

Returns the image of @@ -1047,7 +1047,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of a set of sets.

Returns @@ -1059,7 +1059,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of two sets.

Returns @@ -1069,7 +1069,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of a family.

Returns the intersection of @@ -1086,7 +1086,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the inverse of a function.

Returns the inverse @@ -1100,7 +1100,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the inverse image of a set under a binary relation. @@ -1117,7 +1117,7 @@ fun(S) -> sofs:partition(1, S) end - + Test for a function.

Returns true if the binary relation BinRel @@ -1127,7 +1127,7 @@ fun(S) -> sofs:partition(1, S) end - + Test for disjoint sets.

Returns true if Set1 @@ -1138,7 +1138,7 @@ fun(S) -> sofs:partition(1, S) end - + Test for an empty set.

Returns true if AnySet is an empty @@ -1147,7 +1147,7 @@ fun(S) -> sofs:partition(1, S) end - + Test two sets for equality.

Returns true if AnySet1 @@ -1164,7 +1164,7 @@ true - + Test for an unordered set.

Returns true if AnySet is @@ -1175,7 +1175,7 @@ true - + Test for an unordered set.

Returns true if Term is @@ -1185,7 +1185,7 @@ true - + Test two sets for subset.

Returns true if Set1 is @@ -1195,7 +1195,7 @@ true - + Test for a type.

Returns true if term Term is @@ -1204,7 +1204,7 @@ true - + Return the join of two relations.

Returns the natural @@ -1221,7 +1221,7 @@ true - + Return the multiple relative product of a tuple of binary relations and a relation. @@ -1242,7 +1242,7 @@ true - + Return the number of elements of a set.

Returns the number of elements of the ordered or unordered @@ -1251,7 +1251,7 @@ true - + Return the coarsest partition given a set of sets.

Returns the partition of @@ -1268,7 +1268,7 @@ true - + Return a partition of a set.

Returns the partition of @@ -1284,7 +1284,7 @@ true - + Return a partition of a set.

Returns a pair of sets that, regarded as constituting a @@ -1307,7 +1307,7 @@ true - + Return a family indexing a partition.

Returns family @@ -1328,7 +1328,7 @@ true - + Return the Cartesian product of a tuple of sets.

Returns the Cartesian @@ -1347,7 +1347,7 @@ true - + Return the Cartesian product of two sets.

Returns the Cartesian @@ -1365,7 +1365,7 @@ true - + Return a set of substituted elements.

Returns the set created by substituting each element of @@ -1384,7 +1384,7 @@ true - + Return the range of a binary relation.

Returns the range of the @@ -1398,8 +1398,8 @@ true - - + + Create a relation.

Creates a relation. @@ -1417,7 +1417,7 @@ true - + Create a family from a binary relation.

Returns family @@ -1435,8 +1435,8 @@ true - - + + Return the relative product of a list of binary relations and a binary relation. @@ -1466,7 +1466,7 @@ true - + Return the relative product of two binary relations. @@ -1477,7 +1477,7 @@ true - + Return the relative_product of two binary relations. @@ -1498,7 +1498,7 @@ true - + Return a restriction of a binary relation.

Returns the restriction of @@ -1514,7 +1514,7 @@ true - + Return a restriction of a set.

Returns a subset of Set1 containing those @@ -1530,8 +1530,8 @@ true - - + + Create a set of atoms or any type of sets.

Creates an unordered @@ -1543,7 +1543,7 @@ true - + Select a subset using a predicate.

Returns the set containing every element @@ -1564,7 +1564,7 @@ true - + Return the strict relation corresponding to a given relation. @@ -1580,7 +1580,7 @@ true - + Return a function with a given set as domain.

Returns a function, the domain of which @@ -1629,7 +1629,7 @@ images2(SetOfSets, BinRel) -> - + Return the symmetric difference of two sets.

Returns the symmetric @@ -1645,7 +1645,7 @@ images2(SetOfSets, BinRel) -> - + Return a partition of two sets.

Returns a triple of sets:

@@ -1666,7 +1666,7 @@ images2(SetOfSets, BinRel) -> - + Return the elements of a set.

Returns the external @@ -1675,7 +1675,7 @@ images2(SetOfSets, BinRel) -> - + Return a list or a tuple of the elements of a set.

Returns the elements of the ordered set ASet @@ -1686,7 +1686,7 @@ images2(SetOfSets, BinRel) -> - + Return the type of a set.

Returns the type of an @@ -1695,7 +1695,7 @@ images2(SetOfSets, BinRel) -> - + Return the union of a set of sets.

Returns the union of the @@ -1704,7 +1704,7 @@ images2(SetOfSets, BinRel) -> - + Return the union of two sets.

Returns the union of @@ -1713,7 +1713,7 @@ images2(SetOfSets, BinRel) -> - + Return the union of a family.

Returns the union of family @@ -1727,7 +1727,7 @@ images2(SetOfSets, BinRel) -> - + Return the weak relation corresponding to a given relation. diff --git a/lib/stdlib/doc/src/string.xml b/lib/stdlib/doc/src/string.xml index d3b0175d69..d102191a57 100644 --- a/lib/stdlib/doc/src/string.xml +++ b/lib/stdlib/doc/src/string.xml @@ -32,7 +32,7 @@ A string.xml - string + string String processing functions.

This module provides functions for string processing.

@@ -164,7 +164,7 @@ - + Test string equality. @@ -522,7 +522,7 @@ ÖÄÅ - + Return a float whose text representation is the integers (ASCII values) of a string. @@ -544,7 +544,7 @@ ÖÄÅ - + Return an integer whose text representation is the integers (ASCII values) of a string. @@ -649,8 +649,8 @@ ÖÄÅ - - + + Center a string.

Returns a string, where String is centered in the @@ -664,8 +664,8 @@ ÖÄÅ - - + + Return a string consisting of numbers of characters.

Returns a string consisting of Number characters @@ -678,7 +678,7 @@ ÖÄÅ - + Return the index of the first occurrence of a character in a string. @@ -692,7 +692,7 @@ ÖÄÅ - + Concatenate two strings.

Concatenates String1 and @@ -712,7 +712,7 @@ ÖÄÅ - + Copy a string.

Returns a string containing String repeated @@ -724,7 +724,7 @@ ÖÄÅ - + Span characters at start of a string.

Returns the length of the maximum initial segment of @@ -741,7 +741,7 @@ ÖÄÅ - + Join a list of strings with separator.

Returns a string with the elements of StringList @@ -757,8 +757,8 @@ ÖÄÅ - - + + Adjust left end of a string.

Returns String with the length adjusted in @@ -778,7 +778,7 @@ ÖÄÅ - + Return the length of a string.

Returns the number of characters in String.

@@ -789,7 +789,7 @@ ÖÄÅ - + Return the index of the last occurrence of a character in a string. @@ -803,8 +803,8 @@ ÖÄÅ - - + + Adjust right end of a string.

Returns String with the length adjusted in @@ -823,7 +823,7 @@ ÖÄÅ - + Find the index of a substring.

Returns the position where the last occurrence of @@ -841,7 +841,7 @@ ÖÄÅ - + Span characters at start of a string.

Returns the length of the maximum initial segment of @@ -858,7 +858,7 @@ ÖÄÅ - + Find the index of a substring.

Returns the position where the first occurrence of @@ -876,9 +876,9 @@ ÖÄÅ - - - + + + Strip leading or trailing characters.

Returns a string, where leading or trailing, or both, blanks or a @@ -898,8 +898,8 @@ ÖÄÅ - - + + Extract a substring.

Returns a substring of String, starting at @@ -916,8 +916,8 @@ sub_string("Hello World", 4, 8). - - + + Return a substring of a string.

Returns a substring of String, starting at @@ -934,8 +934,8 @@ sub_string("Hello World", 4, 8). - - + + Extract subword.

Returns the word in position Number of @@ -952,10 +952,10 @@ sub_string("Hello World", 4, 8). - - - - + + + + Convert case of string (ISO/IEC 8859-1). @@ -974,7 +974,7 @@ sub_string("Hello World", 4, 8). - + Split string into tokens.

Returns a list of tokens in String, separated @@ -994,8 +994,8 @@ sub_string("Hello World", 4, 8). - - + + Count blank separated words.

Returns the number of words in String, separated diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml index eb6168c002..f15b1a2dd3 100644 --- a/lib/stdlib/doc/src/supervisor.xml +++ b/lib/stdlib/doc/src/supervisor.xml @@ -28,7 +28,7 @@ - supervisor + supervisor Generic supervisor behavior.

This behavior module provides a supervisor, a process that @@ -318,7 +318,7 @@ child_spec() = #{id => child_id(), % mandatory - + Check if children specifications are syntactically correct. @@ -366,7 +366,7 @@ child_spec() = #{id => child_id(), % mandatory - + Delete a child specification from a supervisor.

Tells supervisor SupRef to delete the child @@ -400,7 +400,7 @@ child_spec() = #{id => child_id(), % mandatory - + Restart a terminated child process belonging to a supervisor. @@ -436,7 +436,7 @@ child_spec() = #{id => child_id(), % mandatory - + Dynamically add a child process to a supervisor. @@ -503,8 +503,8 @@ child_spec() = #{id => child_id(), % mandatory - - + + Create a supervisor process. @@ -584,7 +584,7 @@ child_spec() = #{id => child_id(), % mandatory - + Terminate a child process belonging to a supervisor.

Tells supervisor SupRef to terminate the @@ -621,7 +621,7 @@ child_spec() = #{id => child_id(), % mandatory - + Return information about all children specifications and child processes belonging to a supervisor. @@ -666,7 +666,7 @@ child_spec() = #{id => child_id(), % mandatory - Module:init(Args) -> Result + Module:init(Args) -> Result Return a supervisor specification. Args = term() diff --git a/lib/stdlib/doc/src/supervisor_bridge.xml b/lib/stdlib/doc/src/supervisor_bridge.xml index c4c1b37548..ee5d97fea1 100644 --- a/lib/stdlib/doc/src/supervisor_bridge.xml +++ b/lib/stdlib/doc/src/supervisor_bridge.xml @@ -30,7 +30,7 @@ - supervisor_bridge + supervisor_bridge Generic supervisor bridge behavior.

This behavior module provides a supervisor bridge, a process @@ -57,8 +57,8 @@ - - + + Create a supervisor bridge process.

Creates a supervisor bridge process, linked to the calling process, @@ -133,7 +133,7 @@ - Module:init(Args) -> Result + Module:init(Args) -> Result Initialize process and start subsystem. Args = term() @@ -164,7 +164,7 @@ - Module:terminate(Reason, State) + Module:terminate(Reason, State) Clean up and stop subsystem. Reason = shutdown | term() diff --git a/lib/stdlib/doc/src/sys.xml b/lib/stdlib/doc/src/sys.xml index 040f6587ec..6fc508b853 100644 --- a/lib/stdlib/doc/src/sys.xml +++ b/lib/stdlib/doc/src/sys.xml @@ -32,7 +32,7 @@ sys.xml - sys + sys A functional interface to system messages.

This module contains functions for sending system messages used by @@ -129,8 +129,8 @@ - - + + Send the code change system message to the process.

Tells the process to change code. The process must be @@ -227,8 +227,8 @@ - - + + Get the status of the process.

Gets the status of the process.

@@ -265,8 +265,8 @@ - - + + Install a debug function in the process.

Enables installation of alternative debug functions. An example of @@ -283,8 +283,8 @@ - - + + Log system events in memory.

Turns the logging of system events on or off. If on, a @@ -302,8 +302,8 @@ - - + + Log system events to the specified file.

Enables or disables the logging of all system events in text @@ -315,8 +315,8 @@ - - + + Turn off debugging.

Turns off all debugging for the process. This includes @@ -327,8 +327,8 @@ - - + + Remove a debug function from the process.

Removes an installed debug function from the @@ -451,8 +451,8 @@ - - + + Resume a suspended process.

Resumes a suspended process.

@@ -460,8 +460,8 @@ - - + + Enable or disable the collections of statistics.

Enables or disables the collection of statistics. If @@ -471,8 +471,8 @@ - - + + Suspend the process.

Suspends the process. When the process is suspended, it @@ -494,8 +494,8 @@ - - + + Print all system events on standard_io.

Prints all system events on standard_io. The events are @@ -518,7 +518,7 @@ - + Convert a list of options to a debug structure.

Can be used by a process that initiates a debug @@ -529,7 +529,7 @@ - + Get the data associated with a debug option.

Gets the data associated with a debug option. @@ -541,7 +541,7 @@ - + Generate a system event.

This function is called by a process when it generates a @@ -556,7 +556,7 @@ - + Take care of system messages.

This function is used by a process module to take care of system @@ -594,7 +594,7 @@ - + Print the logged events in the debug structure.

Prints the logged system events in the debug structure, @@ -605,7 +605,7 @@ - Module:system_code_change(Misc, Module, OldVsn, Extra) -> + Module:system_code_change(Misc, Module, OldVsn, Extra) -> {ok, NMisc} Called when the process is to perform a code change. @@ -628,7 +628,7 @@ - Module:system_continue(Parent, Debug, Misc) -> none() + Module:system_continue(Parent, Debug, Misc) -> none() Called when the process is to continue its execution. Parent = pid() @@ -681,7 +681,7 @@ - Module:system_terminate(Reason, Parent, Debug, Misc) -> none() + Module:system_terminate(Reason, Parent, Debug, Misc) -> none() Called when the process is to terminate. Reason = term() diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml index 885bb89b1a..165eecfbb0 100644 --- a/lib/stdlib/doc/src/timer.xml +++ b/lib/stdlib/doc/src/timer.xml @@ -32,7 +32,7 @@ D timer.xml - timer + timer Timer functions.

This module provides useful functions related to time. Unless otherwise @@ -62,7 +62,7 @@ - + Apply Module:Function(Arguments) after a specified Time. @@ -75,7 +75,7 @@ - + Evaluate Module:Function(Arguments) repeatedly at intervals of Time. @@ -88,7 +88,7 @@ - + Cancel a previously requested time-out identified by TRef. @@ -101,8 +101,8 @@ - - + + Send an exit signal with Reason after a specified Time. @@ -117,7 +117,7 @@ - + Convert Hours+Minutes+Seconds to Milliseconds. @@ -127,7 +127,7 @@ - + Convert Hours to Milliseconds.

Returns the number of milliseconds in Hours.

@@ -135,8 +135,8 @@ - - + + Send an exit signal with Reason after a specified Time. @@ -148,7 +148,7 @@ - + Converts Minutes to Milliseconds.

Returns the number of milliseconds in @@ -157,7 +157,7 @@ - + Calculate time difference between time stamps. In microseconds @@ -173,7 +173,7 @@ - + Convert Seconds to Milliseconds.

Returns the number of milliseconds in @@ -182,8 +182,8 @@ - - + + Send Message to Pid after a specified Time. @@ -206,8 +206,8 @@ - - + + Send Message repeatedly at intervals of Time. @@ -231,7 +231,7 @@ - + Suspend the calling process for Time milliseconds. @@ -244,7 +244,7 @@ - + Start a global timer server (named timer_server). @@ -260,7 +260,7 @@ - + Measure the real time it takes to evaluate apply(Module, Function, Arguments) or apply(Fun, Arguments). In microseconds diff --git a/lib/stdlib/doc/src/unicode.xml b/lib/stdlib/doc/src/unicode.xml index 2451006564..b7696a4b7e 100644 --- a/lib/stdlib/doc/src/unicode.xml +++ b/lib/stdlib/doc/src/unicode.xml @@ -30,7 +30,7 @@ - unicode + unicode Functions for converting Unicode characters.

This module contains functions for converting between different character @@ -139,7 +139,7 @@ - + Identify UTF byte order marks in a binary. @@ -156,7 +156,7 @@ - + Convert a collection of characters to a UTF-8 binary.

Same as characters_to_binary(Data, unicode, @@ -165,7 +165,7 @@ - + Convert a collection of characters to a UTF-8 binary.

Same as characters_to_binary(Data, @@ -174,7 +174,7 @@ - + Convert a collection of characters to a UTF-8 binary.

Behaves as @@ -211,7 +211,7 @@ - + Convert a collection of characters to a list of Unicode characters. @@ -220,7 +220,7 @@ - + Convert a collection of characters to a list of Unicode characters. @@ -515,7 +515,7 @@ decode_data(Data) -> - + Create a binary UTF byte order mark from encoding. A binary() such that byte_size(Bin) >= 4. diff --git a/lib/stdlib/doc/src/win32reg.xml b/lib/stdlib/doc/src/win32reg.xml index f4a4fa1626..5e2aed6062 100644 --- a/lib/stdlib/doc/src/win32reg.xml +++ b/lib/stdlib/doc/src/win32reg.xml @@ -32,7 +32,7 @@ PA1 win32reg.xml - win32reg + win32reg Provides access to the registry on Windows.

This module provides read and write access to the @@ -112,7 +112,7 @@ hkdd HKEY_DYN_DATA - + Move to a key in the registry.

Changes the current key to another key. Works like cd. @@ -122,7 +122,7 @@ hkdd HKEY_DYN_DATA - + Move to a key, create it if it is not there.

Creates a key, or just changes to it, if it is already there. Works @@ -133,7 +133,7 @@ hkdd HKEY_DYN_DATA - + Close the registry.

Closes the registry. After that, the RegHandle @@ -142,7 +142,7 @@ hkdd HKEY_DYN_DATA - + Return the path to the current key.

Returns the path to the current key. This is the equivalent of @@ -153,7 +153,7 @@ hkdd HKEY_DYN_DATA - + Delete the current key.

Deletes the current key, if it is valid. Calls the Win32 API @@ -166,7 +166,7 @@ hkdd HKEY_DYN_DATA - + Delete the named value on the current key.

Deletes a named value on the current key. The atom default is @@ -176,7 +176,7 @@ hkdd HKEY_DYN_DATA - + Expand a string with environment variables.

Expands a string containing environment variables between percent @@ -189,7 +189,7 @@ hkdd HKEY_DYN_DATA - + Convert a POSIX error code to a string.

Converts a POSIX error code to a string @@ -198,7 +198,7 @@ hkdd HKEY_DYN_DATA - + Open the registry for reading or writing.

Opens the registry for reading or writing. The current key is the @@ -211,7 +211,7 @@ hkdd HKEY_DYN_DATA - + Set value at the current registry key with specified name. @@ -230,7 +230,7 @@ hkdd HKEY_DYN_DATA - + Get subkeys to the current key.

Returns a list of subkeys to the current key. Calls the Win32 @@ -240,7 +240,7 @@ hkdd HKEY_DYN_DATA - + Get the named value on the current key.

Retrieves the named value (or default) on the current key. @@ -251,7 +251,7 @@ hkdd HKEY_DYN_DATA - + Get all values on the current key.

Retrieves a list of all values on the current key. The values diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml index aaa25952c2..bb2ed7727a 100644 --- a/lib/stdlib/doc/src/zip.xml +++ b/lib/stdlib/doc/src/zip.xml @@ -32,7 +32,7 @@ PA1 zip.xml - zip + zip Utility for reading and creating 'zip' archives. @@ -234,10 +234,10 @@ - - - - + + + + Retrieve the name of all files in a zip archive.

list_dir/1 retrieves all filenames in the zip archive @@ -263,7 +263,7 @@ - + Print the name of each file in a zip archive.

Prints all filenames in the zip archive Archive @@ -272,7 +272,7 @@ - + Print name and information for each file in a zip archive. @@ -283,10 +283,10 @@ - - - - + + + + Extract files from a zip archive.

unzip/1 extracts all files from a zip archive.

@@ -353,10 +353,10 @@ - - - - + + + + Create a zip archive with options.

Creates a zip archive containing the files specified in @@ -481,7 +481,7 @@ - + Close an open archive.

Closes a zip archive, previously opened with @@ -492,8 +492,8 @@ - - + + Extract files from an open archive.

Extracts one or all files from an open archive.

@@ -505,7 +505,7 @@ - + Return a table of files in open zip archive.

Returns the file list of an open zip archive. The first returned @@ -514,8 +514,8 @@ - - + + Open an archive and return a handle to it.

Opens a zip archive, and reads and saves its directory. This diff --git a/lib/tftp/doc/src/tftp.xml b/lib/tftp/doc/src/tftp.xml index e72a4ec985..57d64b7379 100644 --- a/lib/tftp/doc/src/tftp.xml +++ b/lib/tftp/doc/src/tftp.xml @@ -28,7 +28,7 @@ - tftp + tftp Trivial FTP.

Interface module for the tftp application.

@@ -172,7 +172,7 @@ - change_config(daemons, Options) -> [{Pid, Result}] + change_config(daemons, Options) -> [{Pid, Result}] Changes configuration for all daemons. @@ -187,7 +187,7 @@ - change_config(servers, Options) -> [{Pid, Result}] + change_config(servers, Options) -> [{Pid, Result}] Changes configuration for all servers. @@ -202,7 +202,7 @@ - change_config(Pid, Options) -> Result + change_config(Pid, Options) -> Result Changes configuration for a TFTP daemon, server, or client process. @@ -217,7 +217,7 @@ - info(daemons) -> [{Pid, Options}] + info(daemons) -> [{Pid, Options}] Returns information about all daemons. Pid = [pid()] @@ -230,7 +230,7 @@ - info(servers) -> [{Pid, Options}] + info(servers) -> [{Pid, Options}] Returns information about all servers. Pid = [pid()] @@ -243,7 +243,7 @@ - info(Pid) -> {ok, Options} | {error, Reason} + info(Pid) -> {ok, Options} | {error, Reason} Returns information about a daemon, server, or client process. Options = [option()] @@ -255,7 +255,7 @@ - read_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason} + read_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason} Reads a (virtual) file from a TFTP server. RemoteFilename = string() @@ -285,7 +285,7 @@ - start(Options) -> {ok, Pid} | {error, Reason} + start(Options) -> {ok, Pid} | {error, Reason} Starts a daemon process. Options = [option()] @@ -301,7 +301,7 @@ - write_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason} + write_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason} Writes a (virtual) file to a TFTP server. RemoteFilename = string() diff --git a/lib/tools/doc/src/cover.xml b/lib/tools/doc/src/cover.xml index ac49be4652..64c24cea2a 100644 --- a/lib/tools/doc/src/cover.xml +++ b/lib/tools/doc/src/cover.xml @@ -30,7 +30,7 @@ - cover + cover A Coverage Analysis Tool for Erlang

The module cover provides a set of functions for coverage @@ -115,7 +115,7 @@ - start() -> {ok,Pid} | {error,Reason} + start() -> {ok,Pid} | {error,Reason} Start Cover. Pid = pid() @@ -128,7 +128,7 @@ - start(Nodes) -> {ok,StartedNodes} | {error,not_main_node} + start(Nodes) -> {ok,StartedNodes} | {error,not_main_node} Start Cover on remote nodes. Nodes = StartedNodes = [atom()] @@ -139,10 +139,10 @@ - compile(ModFiles) -> Result | [Result] - compile(ModFiles, Options) -> Result | [Result] - compile_module(ModFiles) -> Result | [Result] - compile_module(ModFiles, Options) -> Result | [Result] + compile(ModFiles) -> Result | [Result] + compile(ModFiles, Options) -> Result | [Result] + compile_module(ModFiles) -> Result | [Result] + compile_module(ModFiles, Options) -> Result | [Result] Compile one or more modules for Cover analysis. ModFiles = ModFile | [ModFile] @@ -176,9 +176,9 @@ - compile_directory() -> [Result] | {error,Reason} - compile_directory(Dir) -> [Result] | {error,Reason} - compile_directory(Dir, Options) -> [Result] | {error,Reason} + compile_directory() -> [Result] | {error,Reason} + compile_directory(Dir) -> [Result] | {error,Reason} + compile_directory(Dir, Options) -> [Result] | {error,Reason} Compile all modules in a directory for Cover analysis. Dir = string() @@ -199,7 +199,7 @@ - compile_beam(ModFiles) -> Result | [Result] + compile_beam(ModFiles) -> Result | [Result] Compile one or more modules for Cover analysis, using existing beam(s). ModFiles = ModFile | [ModFile] @@ -241,8 +241,8 @@ - compile_beam_directory() -> [Result] | {error,Reason} - compile_beam_directory(Dir) -> [Result] | {error,Reason} + compile_beam_directory() -> [Result] | {error,Reason} + compile_beam_directory(Dir) -> [Result] | {error,Reason} Compile all .beam files in a directory for Cover analysis. Dir = string() @@ -261,13 +261,13 @@ analyse() -> {result,Ok,Fail} | {error,not_main_node} - analyse(Modules) -> OneResult | {result,Ok,Fail} | {error,not_main_node} - analyse(Analysis) -> {result,Ok,Fail} | {error,not_main_node} - analyse(Level) -> {result,Ok,Fail} | {error,not_main_node} - analyse(Modules, Analysis) -> OneResult | {result,Ok,Fail} | {error,not_main_node} - analyse(Modules, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} - analyse(Analysis, Level) -> {result,Ok,Fail} | {error,not_main_node} - analyse(Modules, Analysis, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Modules) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Analysis) -> {result,Ok,Fail} | {error,not_main_node} + analyse(Level) -> {result,Ok,Fail} | {error,not_main_node} + analyse(Modules, Analysis) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Modules, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Analysis, Level) -> {result,Ok,Fail} | {error,not_main_node} + analyse(Modules, Analysis, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} Analyse one or more Cover compiled modules. Modules = Module | [Module] @@ -306,9 +306,9 @@ analyse_to_file() -> {result,Ok,Fail} | {error,not_main_node} - analyse_to_file(Modules) -> Answer | {result,Ok,Fail} | {error,not_main_node} - analyse_to_file(Options) -> {result,Ok,Fail} | {error,not_main_node} - analyse_to_file(Modules,Options) -> Answer | {result,Ok,Fail} | {error,not_main_node} + analyse_to_file(Modules) -> Answer | {result,Ok,Fail} | {error,not_main_node} + analyse_to_file(Options) -> {result,Ok,Fail} | {error,not_main_node} + analyse_to_file(Modules,Options) -> Answer | {result,Ok,Fail} | {error,not_main_node} Detailed coverage analysis of one or more Cover compiled modules. Modules = Module | [Module] @@ -384,7 +384,7 @@ - modules() -> [Module] | {error,not_main_node} + modules() -> [Module] | {error,not_main_node} Return all Cover compiled modules. Module = atom() @@ -395,7 +395,7 @@ - imported_modules() -> [Module] | {error,not_main_node} + imported_modules() -> [Module] | {error,not_main_node} Return all modules for which there are imported data. Module = atom() @@ -406,7 +406,7 @@ - imported() -> [File] | {error,not_main_node} + imported() -> [File] | {error,not_main_node} Return all imported files. File = string() @@ -416,7 +416,7 @@ - which_nodes() -> [Node] | {error,not_main_node} + which_nodes() -> [Node] | {error,not_main_node} Return all nodes that are part of the coverage analysis. Node = atom() @@ -428,7 +428,7 @@ - is_compiled(Module) -> {file,File} | false | {error,not_main_node} + is_compiled(Module) -> {file,File} | false | {error,not_main_node} Check if a module is Cover compiled. Module = atom() @@ -442,8 +442,8 @@ - reset(Module) -> - reset() -> ok | {error,not_main_node} + reset(Module) -> + reset() -> ok | {error,not_main_node} Reset coverage data for Cover compiled modules. Module = atom() @@ -458,8 +458,8 @@ - export(ExportFile) - export(ExportFile,Module) -> ok | {error,Reason} + export(ExportFile) + export(ExportFile,Module) -> ok | {error,Reason} Reset coverage data for Cover compiled modules. ExportFile = string() @@ -480,7 +480,7 @@ - import(ExportFile) -> ok | {error,Reason} + import(ExportFile) -> ok | {error,Reason} Reset coverage data for Cover compiled modules. ExportFile = string() @@ -504,14 +504,14 @@ - stop() -> ok | {error,not_main_node} + stop() -> ok | {error,not_main_node} Stop Cover.

Stops the Cover server and unloads all Cover compiled code.

 - stop(Nodes) -> ok | {error,not_main_node} + stop(Nodes) -> ok | {error,not_main_node} Stop Cover on remote nodes. Nodes = [atom()] diff --git a/lib/tools/doc/src/cprof.xml b/lib/tools/doc/src/cprof.xml index df0acbe617..b6af8b6d28 100644 --- a/lib/tools/doc/src/cprof.xml +++ b/lib/tools/doc/src/cprof.xml @@ -34,7 +34,7 @@ PA1 cprof.sgml - cprof + cprof A simple Call Count Profiling Tool using breakpoints for minimal runtime performance impact.

The cprof module is used to profile a program @@ -65,10 +65,10 @@ - analyse() -> {AllCallCount, ModAnalysisList} - analyse(Limit) -> {AllCallCount, ModAnalysisList} - analyse(Mod) -> ModAnalysis - analyse(Mod, Limit) -> ModAnalysis + analyse() -> {AllCallCount, ModAnalysisList} + analyse(Limit) -> {AllCallCount, ModAnalysisList} + analyse(Mod) -> ModAnalysis + analyse(Mod, Limit) -> ModAnalysis Collect and analyse call counters. Limit = integer() @@ -122,7 +122,7 @@ - pause() -> integer() + pause() -> integer() Pause running call count trace for all functions.

Pause call count tracing for all functions in all modules @@ -137,9 +137,9 @@ - pause(FuncSpec) -> integer() - pause(Mod, Func) -> integer() - pause(Mod, Func, Arity) -> integer() + pause(FuncSpec) -> integer() + pause(Mod, Func) -> integer() + pause(Mod, Func, Arity) -> integer() Pause running call count trace for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -167,10 +167,10 @@ - restart() -> integer() - restart(FuncSpec) -> integer() - restart(Mod, Func) -> integer() - restart(Mod, Func, Arity) -> integer() + restart() -> integer() + restart(FuncSpec) -> integer() + restart(Mod, Func) -> integer() + restart(Mod, Func, Arity) -> integer() Restart existing call counters for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -197,7 +197,7 @@ - start() -> integer() + start() -> integer() Start call count tracing for all functions.

Start call count tracing for all functions in all modules, @@ -212,9 +212,9 @@ - start(FuncSpec) -> integer() - start(Mod, Func) -> integer() - start(Mod, Func, Arity) -> integer() + start(FuncSpec) -> integer() + start(Mod, Func) -> integer() + start(Mod, Func, Arity) -> integer() Start call count tracing for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -240,7 +240,7 @@ - stop() -> integer() + stop() -> integer() Stop call count tracing for all functions.

Stop call count tracing for all functions in all modules, @@ -255,9 +255,9 @@ - stop(FuncSpec) -> integer() - stop(Mod, Func) -> integer() - stop(Mod, Func, Arity) -> integer() + stop(FuncSpec) -> integer() + stop(Mod, Func) -> integer() + stop(Mod, Func, Arity) -> integer() Stop call count tracing for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} diff --git a/lib/tools/doc/src/eprof.xml b/lib/tools/doc/src/eprof.xml index 158f61d9e9..c9e4edd991 100644 --- a/lib/tools/doc/src/eprof.xml +++ b/lib/tools/doc/src/eprof.xml @@ -28,7 +28,7 @@ - eprof + eprof A Time Profiling Tool for Erlang

The module eprof provides a set of functions for time @@ -40,7 +40,7 @@ - start() -> {ok,Pid} | {error,Reason} + start() -> {ok,Pid} | {error,Reason} Start Eprof. Pid = pid() @@ -51,7 +51,7 @@ - start_profiling(Rootset) -> profiling | {error, Reason} + start_profiling(Rootset) -> profiling | {error, Reason} start_profiling(Rootset,Pattern) -> profiling | {error, Reason} start_profiling(Rootset,Pattern,Options) -> profiling | {error, Reason} Start profiling. @@ -79,7 +79,7 @@ - stop_profiling() -> profiling_stopped | profiling_already_stopped + stop_profiling() -> profiling_stopped | profiling_already_stopped Stop profiling.

Stops profiling started with start_profiling/1 or @@ -87,12 +87,12 @@ - profile(Fun) -> profiling | {error, Reason} - profile(Fun, Options) -> profiling | {error, Reason} - profile(Rootset) -> profiling | {error, Reason} - profile(Rootset,Fun) -> {ok, Value} | {error,Reason} + profile(Fun) -> profiling | {error, Reason} + profile(Fun, Options) -> profiling | {error, Reason} + profile(Rootset) -> profiling | {error, Reason} + profile(Rootset,Fun) -> {ok, Value} | {error,Reason} profile(Rootset,Fun,Pattern) -> {ok, Value} | {error, Reason} - profile(Rootset,Module,Function,Args) -> {ok, Value} | {error, Reason} + profile(Rootset,Module,Function,Args) -> {ok, Value} | {error, Reason} profile(Rootset,Module,Function,Args,Pattern) -> {ok, Value} | {error, Reason} profile(Rootset,Module,Function,Args,Pattern,Options) -> {ok, Value} | {error, Reason} Start profiling. @@ -152,7 +152,7 @@ - log(File) -> ok + log(File) -> ok Activate logging of eprofprintouts. File = atom() | string() @@ -164,7 +164,7 @@ - stop() -> stopped + stop() -> stopped Stop Eprof.

Stops the Eprof server.

diff --git a/lib/tools/doc/src/fprof.xml b/lib/tools/doc/src/fprof.xml index 1fd828d127..4bb8862016 100644 --- a/lib/tools/doc/src/fprof.xml +++ b/lib/tools/doc/src/fprof.xml @@ -32,7 +32,7 @@ PA1 fprof.sgml - fprof + fprof A Time Profiling Tool using trace to file for minimal runtime performance impact.

This module is used to profile a program @@ -101,7 +101,7 @@ - start() -> {ok, Pid} | {error, {already_started, Pid}} + start() -> {ok, Pid} | {error, {already_started, Pid}} Starts the fprof server. Pid = pid() @@ -117,14 +117,14 @@ - stop() -> ok + stop() -> ok Same as stop(normal).

Same as stop(normal).

 - stop(Reason) -> ok + stop(Reason) -> ok Stops the fprof server. Reason = term() @@ -149,7 +149,7 @@ - apply(Func, Args) -> term() + apply(Func, Args) -> term() Same as apply(Func, Args, []). Func = function() | {Module, Function} @@ -162,7 +162,7 @@ - apply(Module, Function, Args) -> term() + apply(Module, Function, Args) -> term() Same as apply({Module, Function}, Args, []). Args = [term()] @@ -174,7 +174,7 @@ - apply(Func, Args, OptionList) -> term() + apply(Func, Args, OptionList) -> term() Calls erlang:apply(Func, Args)surrounded bytrace([start | OptionList])andtrace(stop). Func = function() | {Module, Function} @@ -210,7 +210,7 @@ - apply(Module, Function, Args, OptionList) -> term() + apply(Module, Function, Args, OptionList) -> term() Same as apply({Module, Function}, Args, OptionList). Module = atom() @@ -228,7 +228,7 @@ - trace(start, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(start, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, {file, Filename}]). Reason = term() @@ -238,7 +238,7 @@ - trace(verbose, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(verbose, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, verbose, {file, Filename}]). Reason = term() @@ -249,7 +249,7 @@ - trace(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([{OptionName, OptionValue}]). OptionName = atom() @@ -262,7 +262,7 @@ - trace(verbose) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(verbose) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, verbose]). Reason = term() @@ -272,7 +272,7 @@ - trace(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([OptionName]). OptionName = atom() @@ -283,7 +283,7 @@ - trace({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([{OptionName, OptionValue}]). OptionName = atom() @@ -296,7 +296,7 @@ - trace([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Starts or stops tracing. Option = start | stop | {procs, PidSpec} | {procs, [PidSpec]} | verbose | {verbose, bool()} | file | {file, Filename} | {tracer, Tracer} @@ -360,7 +360,7 @@ - profile() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([]). Reason = term() @@ -370,7 +370,7 @@ - profile(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([{OptionName, OptionValue}]). OptionName = atom() @@ -383,7 +383,7 @@ - profile(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([OptionName]). OptionName = atom() @@ -394,7 +394,7 @@ - profile({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([{OptionName, OptionValue}]). OptionName = atom() @@ -407,7 +407,7 @@ - profile([Option]) -> ok | {ok, Tracer} | {error, Reason} | {'EXIT', ServerPid, Reason} + profile([Option]) -> ok | {ok, Tracer} | {error, Reason} | {'EXIT', ServerPid, Reason} Compiles a trace into raw profile data held by the fprof server. Option = file | {file, Filename} | dump | {dump, Dump} | append | start | stop @@ -465,7 +465,7 @@ - analyse() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([]). Reason = term() @@ -475,7 +475,7 @@ - analyse(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([{OptionName, OptionValue}]). OptionName = atom() @@ -488,7 +488,7 @@ - analyse(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([OptionName]). OptionName = atom() @@ -499,7 +499,7 @@ - analyse({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([{OptionName, OptionValue}]). OptionName = atom() @@ -512,7 +512,7 @@ - analyse([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Analyses raw profile data in the fprof server. Option = dest | {dest, Dest} | append | {cols, Cols} | callers | {callers, bool()} | no_callers | {sort, SortSpec} | totals | {totals, bool()} | details | {details, bool()} | no_details diff --git a/lib/tools/doc/src/instrument.xml b/lib/tools/doc/src/instrument.xml index bc1276bdd5..75be22de9b 100644 --- a/lib/tools/doc/src/instrument.xml +++ b/lib/tools/doc/src/instrument.xml @@ -32,7 +32,7 @@ PA1 instrument.sgml - instrument + instrument Analysis and Utility Functions for Instrumentation

The module instrument contains support for studying the resource diff --git a/lib/tools/doc/src/make.xml b/lib/tools/doc/src/make.xml index 123fcd4afc..af2404707f 100644 --- a/lib/tools/doc/src/make.xml +++ b/lib/tools/doc/src/make.xml @@ -30,7 +30,7 @@ - make + make A Make Utility for Erlang

The module make provides a set of functions similar to @@ -38,8 +38,8 @@ - all() -> up_to_date | error - all(Options) -> up_to_date | error + all() -> up_to_date | error + all(Options) -> up_to_date | error Compile a set of modules. Options = [Option] @@ -87,8 +87,8 @@ - files(ModFiles) -> up_to_date | error - files(ModFiles, Options) -> up_to_date | error + files(ModFiles) -> up_to_date | error + files(ModFiles, Options) -> up_to_date | error Compile a set of modules. ModFiles = [Module | File] diff --git a/lib/tools/doc/src/tags.xml b/lib/tools/doc/src/tags.xml index ea0ae5cc4d..90a8b28177 100644 --- a/lib/tools/doc/src/tags.xml +++ b/lib/tools/doc/src/tags.xml @@ -32,7 +32,7 @@ A tags.sgml - tags + tags Generate Emacs TAGS file from Erlang source files

A TAGS file is used by Emacs to find function and variable @@ -42,14 +42,14 @@ - file(File [, Options]) + file(File [, Options]) Create a TAGSfile for the file File.

Create a TAGS file for the file File.

 - files(FileList [, Options]) + files(FileList [, Options]) Create a TAGS file for the files in the listFileList.

Create a TAGS file for the files in the list @@ -57,7 +57,7 @@ - dir(Dir [, Options]) + dir(Dir [, Options]) Create a TAGS file for all files in directoryDir.

Create a TAGS file for all files in directory @@ -65,7 +65,7 @@ - dirs(DirList [, Options]) + dirs(DirList [, Options]) Create a TAGS file for all files in any directory inDirList.

Create a TAGS file for all files in any directory in @@ -73,7 +73,7 @@ - subdir(Dir [, Options]) + subdir(Dir [, Options]) Descend recursively down the directory Dirand create a TAGSfile based on all files found.

Descend recursively down the directory Dir and @@ -81,7 +81,7 @@ - subdirs(DirList [, Options]) + subdirs(DirList [, Options]) Descend recursively down all the directories inDirListand create a TAGSfile based on all files found.

Descend recursively down all the directories in @@ -90,7 +90,7 @@ - root([Options]) + root([Options]) Create a TAGSfile covering all files in the Erlang distribution.

Create a TAGS file covering all files in diff --git a/lib/tools/doc/src/xref.xml b/lib/tools/doc/src/xref.xml index 6f833246ad..ab3641a52f 100644 --- a/lib/tools/doc/src/xref.xml +++ b/lib/tools/doc/src/xref.xml @@ -32,7 +32,7 @@ PA1 xref.sgml - xref + xref A Cross Reference Tool for analyzing dependencies between functions, modules, applications and releases.

Xref is a cross reference tool that can be used for finding @@ -729,7 +729,7 @@ xref() = atom() | pid() - add_application(Xref, Directory [, Options]) -> {ok, application()} | Error + add_application(Xref, Directory [, Options]) -> {ok, application()} | Error Add the modules of an application. Directory = directory() @@ -761,7 +761,7 @@ xref() = atom() | pid() - add_directory(Xref, Directory [, Options]) -> {ok, Modules} | Error + add_directory(Xref, Directory [, Options]) -> {ok, Modules} | Error Add the modules in a directory. Directory = directory() @@ -791,7 +791,7 @@ xref() = atom() | pid() - add_module(Xref, File [, Options]) -> {ok, module()} | Error + add_module(Xref, File [, Options]) -> {ok, module()} | Error Add a module. Error = {error, module(), Reason} @@ -814,7 +814,7 @@ xref() = atom() | pid() - add_release(Xref, Directory [, Options]) -> {ok, release()} | Error + add_release(Xref, Directory [, Options]) -> {ok, release()} | Error Add the modules of a release. Directory = directory() @@ -849,7 +849,7 @@ xref() = atom() | pid() - analyze(Xref, Analysis [, Options]) -> {ok, Answer} | Error + analyze(Xref, Analysis [, Options]) -> {ok, Answer} | Error Evaluate a predefined analysis. Analysis = undefined_function_calls | undefined_functions | locals_not_used | exports_not_used | deprecated_function_calls | {deprecated_function_calls, DeprFlag} | deprecated_functions | {deprecated_functions, DeprFlag} | {call, FuncSpec} | {use, FuncSpec} | {module_call, ModSpec} | {module_use, ModSpec} | {application_call, AppSpec} | {application_use, AppSpec} | {release_call, RelSpec} | {release_use, RelSpec} @@ -939,7 +939,7 @@ Evaluates a predefined analysis. - d(Directory) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + d(Directory) -> [DebugInfoResult] | [NoDebugInfoResult] | Error Check the modules in a directory using the code path. Directory = directory() @@ -979,8 +979,8 @@ Evaluates a predefined analysis. - forget(Xref) -> ok - forget(Xref, Variables) -> ok | Error + forget(Xref) -> ok + forget(Xref, Variables) -> ok | Error Remove user variables and their values. Error = {error, module(), Reason} @@ -994,7 +994,7 @@ Evaluates a predefined analysis. - format_error(Error) -> Chars + format_error(Error) -> Chars Return an English description of an Xref error reply. Error = {error, module(), term()} @@ -1008,8 +1008,8 @@ Evaluates a predefined analysis. - get_default(Xref) -> [{Option, Value}] - get_default(Xref, Option) -> {ok, Value} | Error + get_default(Xref) -> [{Option, Value}] + get_default(Xref, Option) -> {ok, Value} | Error Return the default values of options. Error = {error, module(), Reason} @@ -1023,7 +1023,7 @@ Evaluates a predefined analysis. - get_library_path(Xref) -> {ok, LibraryPath} + get_library_path(Xref) -> {ok, LibraryPath} Return the library path. LibraryPath = library_path() @@ -1034,9 +1034,9 @@ Evaluates a predefined analysis. - info(Xref) -> [Info] - info(Xref, Category) -> [{Item, [Info]}] - info(Xref, Category, Items) -> [{Item, [Info]}] + info(Xref) -> [Info] + info(Xref, Category) -> [{Item, [Info]}] + info(Xref, Category, Items) -> [{Item, [Info]}] Return information about an Xref server. Application = [] | [application()] @@ -1220,8 +1220,8 @@ Evaluates a predefined analysis. - m(Module) -> [DebugInfoResult] | [NoDebugInfoResult] | Error - m(File) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + m(Module) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + m(File) -> [DebugInfoResult] | [NoDebugInfoResult] | Error Check a module using the code path. DebugInfoResult = {deprecated, [funcall()]} | {undefined, [funcall()]} | {unused, [mfa()]} @@ -1263,7 +1263,7 @@ Evaluates a predefined analysis. - q(Xref, Query [, Options]) -> {ok, Answer} | Error + q(Xref, Query [, Options]) -> {ok, Answer} | Error Evaluate a query. Answer = false | [constant()] | [Call] | [Component] | int() | [DefineAt] | [CallAt] | [AllLines] @@ -1322,7 +1322,7 @@ Evaluates a predefined analysis. - remove_application(Xref, Applications) -> ok | Error + remove_application(Xref, Applications) -> ok | Error Remove applications and their modules. Applications = application() | [application()] @@ -1335,7 +1335,7 @@ Evaluates a predefined analysis. - remove_module(Xref, Modules) -> ok | Error + remove_module(Xref, Modules) -> ok | Error Remove analyzed modules. Error = {error, module(), Reason} @@ -1348,7 +1348,7 @@ Evaluates a predefined analysis. - remove_release(Xref, Releases) -> ok | Error + remove_release(Xref, Releases) -> ok | Error Remove releases and their applications and modules. Error = {error, module(), Reason} @@ -1363,7 +1363,7 @@ Evaluates a predefined analysis. - replace_application(Xref, Application, Directory [, Options]) -> {ok, application()} | Error + replace_application(Xref, Application, Directory [, Options]) -> {ok, application()} | Error Replace an application's modules. Application = application() @@ -1384,7 +1384,7 @@ Evaluates a predefined analysis. - replace_module(Xref, Module, File [, Options]) -> {ok, module()} | Error + replace_module(Xref, Module, File [, Options]) -> {ok, module()} | Error Replace an analyzed module. Error = {error, module(), Reason} @@ -1409,8 +1409,8 @@ Evaluates a predefined analysis. - set_default(Xref, Option, Value) -> {ok, OldValue} | Error - set_default(Xref, OptionValues) -> ok | Error + set_default(Xref, Option, Value) -> {ok, OldValue} | Error + set_default(Xref, OptionValues) -> ok | Error Set the default values of options. Error = {error, module(), Reason} @@ -1435,7 +1435,7 @@ Evaluates a predefined analysis. - set_library_path(Xref, LibraryPath [, Options]) -> ok | Error + set_library_path(Xref, LibraryPath [, Options]) -> ok | Error Set the library path and finds the library modules. Error = {error, module(), Reason} @@ -1469,7 +1469,7 @@ Evaluates a predefined analysis. - start(NameOrOptions) -> Return + start(NameOrOptions) -> Return Create an Xref server. NameOrOptions = Name | Options @@ -1487,7 +1487,7 @@ Evaluates a predefined analysis. - start(Name, Options) -> Return + start(Name, Options) -> Return Create an Xref server. Name = atom() @@ -1504,7 +1504,7 @@ Evaluates a predefined analysis. - stop(Xref) + stop(Xref) Delete an Xref server. Xref = xref() @@ -1514,7 +1514,7 @@ Evaluates a predefined analysis. - update(Xref [, Options]) -> {ok, Modules} | Error + update(Xref [, Options]) -> {ok, Modules} | Error Replace newly compiled analyzed modules. Error = {error, module(), Reason} @@ -1534,7 +1534,7 @@ Evaluates a predefined analysis. - variables(Xref [, Options]) -> {ok, [VariableInfo]} + variables(Xref [, Options]) -> {ok, [VariableInfo]} Return the names of variables. Options = [Option] | Option diff --git a/lib/xmerl/doc/src/xmerl_sax_parser.xml b/lib/xmerl/doc/src/xmerl_sax_parser.xml index 8ea197e209..2390779028 100644 --- a/lib/xmerl/doc/src/xmerl_sax_parser.xml +++ b/lib/xmerl/doc/src/xmerl_sax_parser.xml @@ -31,7 +31,7 @@ - xmerl_sax_parser + xmerl_sax_parser XML SAX parser API @@ -325,7 +325,7 @@ - file(Filename, Options) -> Result + file(Filename, Options) -> Result Parse file containing an XML document. Filename = string() @@ -347,7 +347,7 @@ - stream(Xml, Options) -> Result + stream(Xml, Options) -> Result Parse a stream containing an XML document. Xml = unicode_binary() | latin1_binary() | [unicode_char()] @@ -381,7 +381,7 @@ - ContinuationFun(State) -> {NewBytes, NewState} + ContinuationFun(State) -> {NewBytes, NewState} Continuation call back function. State = NewState = term() @@ -402,7 +402,7 @@ - EventFun(Event, Location, State) -> NewState + EventFun(Event, Location, State) -> NewState Event call back function. Event = event() -- cgit v1.2.3