summaryrefslogtreecommitdiff
path: root/fml/doc/en/tutorial/command/module.sgml
blob: 912fdc4d5fc9844caa113b6c74fe3ffe0b053c2c (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
<!--
   $FML: module.sgml,v 1.3 2005/07/20 10:37:42 fukachan Exp $
   $jaFML: module.sgml,v 1.4 2003/04/15 14:51:36 fukachan Exp $
-->


<sect1 id="fml.command.module.hierarchy">
	<title>
	Modules for commands
	</title>

<para>
In &fmldevel;, all command modules are shared among command mail, CUI
(makefml, fml) and GUI (CGI). Commands are caregorized into user and
administrative ones by the priviledge.
</para>

<para>
FML::Command class consists of the following classes:
<screen>
FML::Command		entrance into FML::Command. command dispatcher.
FML::Command::User	command for general ML users.
FML::Command::Admin	command for remote administrators.
</screen>
For example, a user command in a command mail kicks off FML::Command
firstly, after some steps, calls FML::Command::User::$command where
$command is the specified command name.
</para>


<sect2>
	<title>
	User Command In Command Mail
	</title>

<para>
FML::Process::Command call FML::Command::User::$command for $command
via FML::Command.  
</para>

<para>
FYI: some module calls FML::Command::Admin::$command for real work
even if it is a user command. For example,
FML::Command::Admin::subscribe works for subscription. In this case,
FML::Command::User::subscribe module is a wrapper/entrance for
confirmation before the real subscription process runs.
</para>

</sect2>

<sect2>
	<title>
	Admin Command (Administrative Command In Command Mail)
	</title>

<para>
It calles FML::Command::Admin::$command for $command via FML::Command
via FML::Process::Command.
</para>

</sect2>


<sect2>
	<title>
	CUI (makefml/fml)
	</title>

<para>
FML::Process::Configure calls 
FML::Command::Admin::$command via FML::Command.
</para>

</sect2>


<sect2>
	<title>
	GUI (CGI)
	</title>


<para>
FML::Process::CGI calls
FML::Command::Admin::$command via FML::Command.
</para>

</sect2>


</sect1>