File: arguments.html

package info (click to toggle)
emil 2.1.0-beta9-14
links: PTS
area: main
in suites: sarge
size: 1,164 kB
ctags: 592
sloc: ansic: 10,377; yacc: 411; makefile: 331; sh: 172
file content (203 lines) | stat: -rwxr-xr-x 6,143 bytes
parent folder | download | duplicates (6)
<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=configuration.html><IMG ALIGN=MIDDLE SRC=arrow_right3.gif></A><A HREF=main.html><IMG ALIGN=MIDDLE SRC=arrow_up2.gif></A><A HREF=control.html><IMG ALIGN=MIDDLE SRC=arrow_left3.gif></A>

<H2>COMMAND LINE ARGUMENTS
</H2>
	<H3>Address specification arguments:
</H3>
<DIR>

<LI>	-r &lt;address&gt;		The address of the recipient.
<LI>	-s &lt;address&gt;		The address of the sender.
<LI>	-x &lt;hostname&gt;		The name of the recipient host.

</DIR>
<P>
The address specifications are used when you want to redirect output
to a program such as /bin/mail or sendmail. The usage of these addresses 
is as arguments to the execv of the program. They are also used to
lookup sender and recipient information such as format and encoding etc.
Emil does not rewrite addresses, so beware the address format you use.

<H3>	Target Group specification
</H3>
<DIR>
<LI>	-G &lt;group&gt;		The target conversion group.
</DIR>
<p>
The target group specification is used when you want Emil to act according
to a conversion profile specified in emil.cf. The conversion profile should be 
specified in emil.cf using the group command (see the documentation of
emil.cf).

<H3>	Format, Encodings and Charsets
</H3>
<DIR>
<LI>	-A &lt;appletype&gt;		The target applefile encoding style.
<LI>	-B &lt;encoding&gt;		The target binary encoding style.
<LI>	-C &lt;charset&gt;		The target charset.
<LI>	-F &lt;format&gt;		The target format.
<LI>	-H &lt;encoding&gt;		The target header encoding style.
<LI>	-S &lt;charset&gt;		The sender's charset.
<LI>	-T &lt;encoding&gt;		The target text encoding style.
</DIR>
<H4>Legal values</H4>
<UL>
<LI>&lt;appletype&gt;	One of:
<UL>
<LI>	(s)	AppleSingle
<LI>	(d)	AppleDouble
<LI>	(b)	BinHex
</UL>
<LI>&lt;format&gt;	One of:
<UL>
<LI>		(MIME)	MIME	- MIME message format.
<LI>		(MAILTOOL)	Mailtool	- SUN Mailtool message format.
<LI>		(RFC822)	RFC822	- Plain old style RFC822 message format.
<LI>		(TRANSPARENT)	Pass through the message as it is, without conversion.
</UL>
<LI>&lt;encoding&gt;	Choose between:

<UL>
<LI>		(7)  7bit - 7bit encoding (if text or header, converts to US-ASCII).
<LI>		(8)  8bit - 8bit encoding.
<LI>		(s)  se - convert to national variant of ASCII (for type text and header only).
<LI>		(bi) binhex - BinHex encoding.
<LI>		(u)  uuencode - UUencode encoding.
<LI>		(ba) base64 - Base64 encoding.
<LI>		(q)  quoted-printable - Quoted-Printable.
</UL>
		
<LI>&lt;charset&gt;	Any charset name as defined in rfc1345.
</UL>
<P>
It is possible to explicitly specify the format, encoding or charset of the
target message on the command line. If done, the lookup for this
information in the configuration file is disabled. Therefore, make sure
to <EM>apply a complete specification of the format and encoding features</EM> using 
these arguments, if one of them is omitted the value of that feature will 
be set to the default value.
<P><EM>The specification of the sender's charset will not override the charset
specification of a MIME or Mailtool message.</EM> Therefore this is really only
used when converting an old style RFC822 message.


<H3>	Logging and Debug
</H3>
<DIR>
<LI>	-d			Debug output on stderr.
<LI>	-f &lt;facility&gt;		The log facility of syslog logging.
<LI>	-h &lt;level&gt;		The log level of header logging.
<LI>	-l &lt;level&gt;		The log level of syslog logging.

</DIR>
<H4>Legal values</H4>
<UL>
<LI>&lt;facility&gt;	Choose between:
<UL>
<LI>		m - LOG_MAIL
<LI>		d - LOG_DAEMON
<LI>		0 - LOG_LOCAL0
<LI>		1 - LOG_LOCAL1
<LI>		2 - LOG_LOCAL2
<LI>		3 - LOG_LOCAL3
<LI>		4 - LOG_LOCAL4
<LI>		5 - LOG_LOCAL5
<LI>		6 - LOG_LOCAL6
<LI>		7 - LOG_LOCAL7
</UL>

<LI>&lt;level&gt;		Choose between:
<UL>
<LI>		1 - LOG_ERR
<LI>		2 - LOG_NOTICE
<LI>		3 - LOG_INFO
<LI>		4 - LOG_DEBUG
</UL>
</UL>
<P>Logging and debug is controlled using the above command line arguments.


<H4>	Configuration files
</H4>
<DIR>
<LI>	-c &lt;path&gt;		Path of charsets file.
<LI>	-e &lt;path&gt;		Path of configuration file.

</DIR>
<P>It is possible to explicitly specify the path of the configuration
or charsets files. If not specified, the default paths will be used.


<H4>	I/O Specifications
</H4>
<DIR>
<LI>	-i &lt;path&gt;		Path of input file.
<LI>	-m &lt;mailer&gt;	The program to which to pipe output (see the configuration file).
<LI>	-n			Pipe output to the builtin SMTP client.
<LI>	-o &lt;path&gt;		Path to output file.
<LI>	-p			Add pseudo route to recipient address.
<LI>	-u			Wants UNIX style from line.

</DIR>
<P>Input/Output is controlled by command line arguments and this applies for
the SMTP client and the redirect of output to arbitrary programs aswell. When
using the builtin SMTP client, an SMTP connection to the <EM>recipient host</EM> (as 
specified by the command line arguments) will be opened. In the SMTP
conversation, the specified <EM>sender</EM> and <EM>recipient</EM> addresses will be used.
<B>Therefore, make sure (when using this) that you have specified all three of
these arguments.</B>


<H4>	Miscellaneous
</H4>
<DIR>
<LI>	-g			Return group match.
<LI>	-v			Print out version.

</DIR>
<P>It is possible the get information from Emil using the above flags.
These arguments disables all other activities and should be used
for testing purposes only. Emil will print the desired information and then exit.


<HR>
<A HREF=configuration.html><IMG ALIGN=MIDDLE SRC=arrow_right3.gif></A><A HREF=main.html><IMG ALIGN=MIDDLE SRC=arrow_up2.gif></A><A HREF=control.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>