File: configuration.html

package info (click to toggle)
emil 2.1.0-beta9-5
  • links: PTS
  • area: main
  • in suites: slink
  • size: 1,160 kB
  • ctags: 587
  • sloc: ansic: 10,358; yacc: 412; makefile: 329; sh: 182
file content (181 lines) | stat: -rwxr-xr-x 5,932 bytes parent folder | download | duplicates (6)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<HEAD>
<TITLE>EMIL version 2 TUTORIAL</TITLE>
</HEAD>
<BODY>

                                             
<H1>TUTORIAL FOR EMIL VERSION 2.1
</H1>
<EM>Written by Martin Wendel, ITS, Uppsala university.
Martin.Wendel@its.uu.se
</EM>
<HR>
<A HREF=details.html><IMG ALIGN=MIDDLE SRC=arrow_right3.gif></A><A HREF=main.html><IMG ALIGN=MIDDLE SRC=arrow_up2.gif></A><A HREF=arguments.html><IMG ALIGN=MIDDLE SRC=arrow_left3.gif></A>

<H2>THE CONFIGURATION FILE EMIL.CF</H2>
<P>
Emil uses a configuration file for multiple purposes. One purpose
is to retreive the conversion profile for the specified message
addresses. Another purpose is to retreive information about file
type marking among other things.
<P>
The configuration file consists of four parts or functions:
<OL>
<LI>group - Specifies a conversion profile.
<LI>mailer - Defines a mailer (program) with arguments.
<LI>match - Specifies file type information.
<LI>member - Binds addresses to a conversion profile.
</OL>
<H3>group</H3>
<P>

The group command is used to define a conversion profile, a named
method for conversion. The conversion profile contains a specification
of what format, charset and encodings to be used and when Emil has
selected a conversion profile, the information within that will be
used when undertaking conversion. 
<P>

The syntax of the group command is the <B>group</B> keyword followed by
a name, a colon and a comma separeted list of options, as follows:
<blockquote>
<B>	group</B> <I>Group_name</I> <B>: </B>[<B>charset=</B><I>CHARSET</I>] [<B>format=</B><I>FORMAT</I>]
	[<B>bin=</B><I>ENCODING</I>] [<B>textenc=</B><I>ENCODING</I>] [<B>henc=</B><I>ENCODING</I>]<B>  ;</B>

<UL>
<LI>
<I>Group_name</I> - The name of the group.
<LI>
<I>CHARSET</I> - The charset to use for text, according to RFC1345.
<LI>
<I>FORMAT</I> - The message format, pick one of MIME, MAILTOOL, RFC822 or
TRANSPARENT.
<LI>
<B>bin</B> - The encoding to use for binary attachments. Choose one of
BAse64, BInHex or Uuencode.
<LI>
<B>textenc</B> - Specifies the encoding to be used for text.
Pick one of BAse64, BInhex, Uuencode, Quoted-printable, 8bit
or 7bit. 7bit is default. When 7bit is chosen the text is
first converted to ISO-8859-1 and then the 8bit characters
are replaced by the appropriate characters as specified by
some national variants of ISO-646. This special conversion
is suited to work in Sweden but works probably also for other
european languages.
<LI>
<B>henc</B> - Specifies the encoding to be used for header lines.
Pick one of BAse64, Quoted-printable, 8bit or 7bit.
7bit is default. If BAse64 or Quoted-Printable is selected
headers are converted according to RFC1522 (MIME-II).
If 7bit is selected headers are first converted to ISO-8859-1
and then 8bit characters are converted to the US-ASCII
characters of closest resemblance.

</UL>

<BR>
<H3>mailer</H3>
<P>
The mailer command is used to define a mailer, or program, to be
used as an execv vector that will be forked off and will receive the
output of the conversion. The mailer name is referred when using the
"-m" command line flag and will thus result in the execv specified
by the mailer definition will be executed in a child and the output
of the conversion will be sent to the stdin of the child.
<P>
The syntax of the mailer command is as follows:
<P>
<blockquote>
	<B>mailer</B> <I>Mailer_name</I><B> :</B> <I>PATH</I><B>, </B><I>PROGRAM</I><B>, </B><I>ARGUMENTS</I><B>,</B> ... <B>;
</B>
</blockquote>
<UL>
<LI>
<I>Mailer_name</I> - Name of the mailer.
<LI>
<I>Path</I> - Path of the program.
<LI>
<I>Program</I> - Name of the program.
<LI>
<I>Arguments</I> - A list of each command line argument to use when invoking the program.
To be suitable for mail programs you can specify variables representing
sender and recipient. These are specified by $s and $r respectively.
</UL>
<BR>
<H3>match</H3>
<P>
The match command is used to define file type information such as
X-Sun-Data-Type of Sun Mailtool messages, Content-Type of MIME messages, 
file name extensions for UUencoded
files and Type&Creator for Applefiles. What kind of type information
is specified by the <I>CONTEXT</I>
<P>
The syntax of the match command is as follows:
<P>
<blockquote>
<B>	match</B> <I>CONTEXT</I> <I>Match_String</I> <I>OUT</I><B> ;
</B>
</blockquote>
<UL>
<LI>
<I>CONTEXT</I> - One of MAILTOOL, MIME, BINHEX or UUENCODE.
<LI>
<I>Match_String</I> - A quoted string that corresponds to the 
<I>Context</I>
of the field. For MIME
<I>Match_String</I> - 
defines the content-type to be used. For UUENCODE 
<I>Match_String</I>
defines the file name extension to be used.
For BINHEX
<I> Match_String</I>
defines the merged two 4byte strings Type and Auth info.
<LI>
<I>OUT</I> - The generic type of the field

</UL>
<H3>member</H3>
<P>
The member command is used to bind the address information, given as
command line arguments to Emil, to a
conversion profile. Address information is given as the triple of
<I>Recipient</I>, <I>Sender</I>, and <I>Recipient_host</I>. Several
triples may be bound to one conversion profile, in wich case the
triples are specified as a comma separated list.
<P>
The syntax of the member command is as follows:
<P>
<blockquote>
	<B>member</B> <I>Group_name</I> <B>: </B><I>Recipient Sender Recipient_host</I><B>, </B>...<B> ;
</B>
</blockquote>
<BR>

<HR>
<A HREF=details.html><IMG ALIGN=MIDDLE SRC=arrow_right3.gif></A><A HREF=main.html><IMG ALIGN=MIDDLE SRC=arrow_up2.gif></A><A HREF=arguments.html><IMG ALIGN=MIDDLE SRC=arrow_left3.gif></A>


<hr size="4" noshade>
<ADDRESS>
<table WIDTH="95%">
<td>
March 1996<p>
<B>ITS Uppsala university</B><BR>
Box 887<BR>
751 08 Uppsala<BR>
SWEDEN<P>
</td>
<td ALIGN="right" VALIGN="middle">
<a href="mailto:Martin.Wendel@its.uu.se">Martin Wendel</a>
</td>
<td ALIGN="left" VALIGN="middle">
<a href="mailto:Martin.Wendel@its.uu.se">
<IMG border="0" SRC="binpobox.gif" ALT="E-Mail: "></a>
</td>
</table>
</ADDRESS>
</body>
</html>