summaryrefslogtreecommitdiff
path: root/fml/doc/en/tutorial/operations/log.sgml
blob: daf9e820f713842ce7e839756bff321ce9d0050a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<!--
   $FML: log.sgml,v 1.2 2005/09/25 04:27:20 fukachan Exp $
   $jaFML: log.sgml,v 1.2 2004/10/06 09:07:41 fukachan Exp $
-->


<chapter id="operations.log">
	<title>
	Logging
	</title>


<sect1 id="operations.log.see">
	<title>
	See Log
	</title>

<para>
<screen>
% makefml log ML_NAME
% fml     ML_NAME log
</screen>
shows the latest 30 lines of log.
</para>

<para>
GUI uses log command.
</para>

</sect1>


<sect1 id="operations.log.computeroutput">
	<title>
	Show Computer Oriented Log
	</title>

<para>
When not fml program or CGI calls &fml8; CUI and such program wants to
analyze the output, you can use use the following option.
<screen>
% makefml --log-computer-output COMMAND ML_NAME
% fml --log-computer-output     ML_NAME COMMAND
</screen>
It shows the computer oriented log into STDERR channel.
</para>

<para>
For example
<screen>
% fml --log-computer-output elena@fml.org list
rudo@nuinui.net
1070109341  info lock channel=recipient_map_modify
1070109342  info unlock channel=recipient_map_modify
</screen>
This example shows "TIME LOG_LEVEL MESSAGE" style log.
It is suitable for computer proceessing.
</para>

<para>
The command line option --log-computer-output is same effect as
<screen>
use_log_computer_output = yes
</screen>
in config.cf file.
</para>

<para>
When "use_log_computer_output = yes" specified in config.cf, all
programs are affected. All programs shows the computer oriented log to
STDERR. So use of command line option is recommended.
</para>

<para>
We should use perl module which holds a set of functions. In this
case, the print out engine is the class called as
FML::Log::Print::Simple. The output style is contolled by
$log_computer_output_engine in config.cf file.
</para>

</sect1>


<sect1 id="operations.log.recipes">
	<title>
	Recipes
	</title>

&sect.op.log.recipes;

</sect1>


</chapter>