From 68d53c01b0b8e9a007a6a30158c19e34b2d2a34e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Wed, 18 May 2016 15:53:35 +0200 Subject: Update STDLIB documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Language cleaned up by the technical writers xsipewe and tmanevik from Combitech. Proofreading and corrections by Björn Gustavsson and Hans Bolinder. --- lib/stdlib/doc/src/log_mf_h.xml | 46 ++++++++++++++++++++++++----------------- 1 file changed, 27 insertions(+), 19 deletions(-) (limited to 'lib/stdlib/doc/src/log_mf_h.xml') 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 @@ Martin Björklund 1996-10-31 A - log_mf_h.sgml + log_mf_h.xml log_mf_h - An Event Handler which Logs Events to Disk + An event handler that logs events to disk. -

The log_mf_h is a gen_event handler module which - can be installed in any gen_event 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 Report Browser (rb) 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 index, and - report files 1, 2, ..... -

+

This module is a gen_event handler module that can be installed + in any gen_event 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 + (rb(3)) 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 index, and report files + 1, 2, ....

+

Term to be sent to - gen_event:add_handler/3.

+ gen_event:add_handler/3.

+
+ - Initiate the event handler + Initiate the event handler. -

Initiates the event handler. This function returns - Args, which should be used in a call to +

Initiates the event handler. Returns Args, which + is to be used in a call to gen_event:add_handler(EventMgr, log_mf_h, Args). -

+

Dir specifies which directory to use for the log - files. MaxBytes specifies the size of each individual - file. MaxFiles specifies how many files are - used. Pred is a predicate function used to filter the - events. If no predicate function is specified, all events are - logged.

+ files. MaxBytes specifies the size of each + individual file. MaxFiles specifies how many + files are used. Pred is a predicate function used + to filter the events. If no predicate function is specified, all + events are logged.

See Also -

gen_event(3), rb(3)

+

gen_event(3), + rb(3)

-- cgit v1.2.3