diff options
author | Björn Gustavsson <[email protected]> | 2016-06-13 12:33:50 +0200 |
---|---|---|
committer | Björn Gustavsson <[email protected]> | 2016-06-13 12:33:50 +0200 |
commit | 1280c70da91b90592ae4be88f1f045956e716de7 (patch) | |
tree | 42a0b48e54a9b5c982ce606b8c7e7ff9c564ade6 /lib/stdlib/doc/src/log_mf_h.xml | |
parent | 3873cb650711342aced0036e3c2d640df8a73c4b (diff) | |
parent | 68d53c01b0b8e9a007a6a30158c19e34b2d2a34e (diff) | |
download | otp-1280c70da91b90592ae4be88f1f045956e716de7.tar.gz otp-1280c70da91b90592ae4be88f1f045956e716de7.tar.bz2 otp-1280c70da91b90592ae4be88f1f045956e716de7.zip |
Merge branch 'bjorn/stdlib/doc'
* bjorn/stdlib/doc:
Update STDLIB documentation
Diffstat (limited to 'lib/stdlib/doc/src/log_mf_h.xml')
-rw-r--r-- | lib/stdlib/doc/src/log_mf_h.xml | 46 |
1 files changed, 27 insertions, 19 deletions
diff --git a/lib/stdlib/doc/src/log_mf_h.xml b/lib/stdlib/doc/src/log_mf_h.xml index 65622e52f5..edc3d31025 100644 --- a/lib/stdlib/doc/src/log_mf_h.xml +++ b/lib/stdlib/doc/src/log_mf_h.xml @@ -32,48 +32,56 @@ <checked>Martin Björklund</checked> <date>1996-10-31</date> <rev>A</rev> - <file>log_mf_h.sgml</file> + <file>log_mf_h.xml</file> </header> <module>log_mf_h</module> - <modulesummary>An Event Handler which Logs Events to Disk</modulesummary> + <modulesummary>An event handler that logs events to disk.</modulesummary> <description> - <p>The <c>log_mf_h</c> is a <c>gen_event</c> handler module which - can be installed in any <c>gen_event</c> process. It logs onto disk all events - which are sent to an event manager. Each event is written as a - binary which makes the logging very fast. However, a tool such as the <c>Report Browser</c> (<c>rb</c>) must be used in order to read the files. The events are written to multiple files. When all files have been used, the first one is re-used and overwritten. The directory location, the number of files, and the size of each file are configurable. The directory will include one file called <c>index</c>, and - report files <c>1, 2, ....</c>. - </p> + <p>This module is a <c>gen_event</c> handler module that can be installed + in any <c>gen_event</c> process. It logs onto disk all events that are + sent to an event manager. Each event is written as a binary, which makes + the logging very fast. However, a tool such as the Report Browser + (<seealso marker="sasl:rb"><c>rb(3)</c></seealso>) must be used to read + the files. The events are written to multiple files. When all files have + been used, the first one is reused and overwritten. The directory + location, the number of files, and the size of each file are configurable. + The directory will include one file called <c>index</c>, and report files + <c>1, 2, ...</c>.</p> </description> + <datatypes> <datatype> <name name="args"/> <desc><p>Term to be sent to <seealso marker="gen_event#add_handler/3"> - gen_event:add_handler/3</seealso>.</p></desc> + <c>gen_event:add_handler/3</c></seealso>.</p> + </desc> </datatype> </datatypes> + <funcs> <func> <name name="init" arity="3"/> <name name="init" arity="4"/> - <fsummary>Initiate the event handler</fsummary> + <fsummary>Initiate the event handler.</fsummary> <desc> - <p>Initiates the event handler. This function returns - <c><anno>Args</anno></c>, which should be used in a call to + <p>Initiates the event handler. Returns <c><anno>Args</anno></c>, which + is to be used in a call to <c>gen_event:add_handler(EventMgr, log_mf_h, <anno>Args</anno>)</c>. - </p> + </p> <p><c><anno>Dir</anno></c> specifies which directory to use for the log - files. <c><anno>MaxBytes</anno></c> specifies the size of each individual - file. <c><anno>MaxFiles</anno></c> specifies how many files are - used. <c><anno>Pred</anno></c> is a predicate function used to filter the - events. If no predicate function is specified, all events are - logged.</p> + files. <c><anno>MaxBytes</anno></c> specifies the size of each + individual file. <c><anno>MaxFiles</anno></c> specifies how many + files are used. <c><anno>Pred</anno></c> is a predicate function used + to filter the events. If no predicate function is specified, all + events are logged.</p> </desc> </func> </funcs> <section> <title>See Also</title> - <p><seealso marker="gen_event">gen_event(3)</seealso>, rb(3) </p> + <p><seealso marker="gen_event"><c>gen_event(3)</c></seealso>, + <seealso marker="sasl:rb"><c>rb(3)</c></seealso></p> </section> </erlref> |