diff options
Diffstat (limited to 'metis/documentation/manpage/metis_daemon.1.html')
| -rw-r--r-- | metis/documentation/manpage/metis_daemon.1.html | 405 |
1 files changed, 405 insertions, 0 deletions
diff --git a/metis/documentation/manpage/metis_daemon.1.html b/metis/documentation/manpage/metis_daemon.1.html new file mode 100644 index 00000000..75d8c24b --- /dev/null +++ b/metis/documentation/manpage/metis_daemon.1.html @@ -0,0 +1,405 @@ +<!-- Creator : groff version 1.22.2 --> +<!-- CreationDate: Tue May 26 01:54:12 2015 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>metis_daemon</title> + +</head> +<body> + +<h1 align="center">metis_daemon</h1> + +<a href="#NAME">NAME</a><br> +<a href="#SYNOPSIS">SYNOPSIS</a><br> +<a href="#DESCRIPTION">DESCRIPTION</a><br> +<a href="#OPTIONS">OPTIONS</a><br> +<a href="#USAGE">USAGE</a><br> +<a href="#SEE ALSO">SEE ALSO</a><br> +<a href="#CAVEATS">CAVEATS</a><br> +<a href="#BUGS">BUGS</a><br> +<a href="#AUTHOR">AUTHOR</a><br> + +<hr> + + +<h2>NAME +<a name="NAME"></a> +</h2> + + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="-3%"> + + +<p><b>metis_daemon</b></p></td> +<td width="15%"></td> +<td width="8%"></td> +<td width="69%"> + + +<p>— Metis is the CCNx 1.0 forwarder, which runs on +each end system and as a software forwarder on intermediate +systems.</p> </td></tr> +</table> + +<h2>SYNOPSIS +<a name="SYNOPSIS"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>metis_daemon</b> +[<b>−−port</b> <i>port</i>] +[<b>−−daemon</b>] [<b>−−capacity</b> +<i>contentStoreSize</i>] [<b>−−log</b> +<i>facility=level</i> ...] [<b>−−log-file</b> +<i>logfile</i>] [<b>−−config</b> +<i>configfile</i>]</p> + +<h2>DESCRIPTION +<a name="DESCRIPTION"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>metis_daemon</b> +is the CCNx 1.0 forwarder, which runs on each end system and +as a software forwarder on intermediate systems. +metis_daemon is the program to launch Metis, either as a +console program or a background daemon (detatched from +console). Once running, use the program <b>metis_control</b> +to configure Metis.</p> + +<p style="margin-left:11%; margin-top: 1em">Metis is +structured as a set of Listeners, each of which handles a +specific method of listening for packets. For example, a TCP +listener will accept connections on a specific TCP port on a +specific local IP address. An Ethernet listener will accept +frames of a specific EtherType on a specific Interface.</p> + +<p style="margin-left:11%; margin-top: 1em">When Metis +accepts a connection, it will create a Connection entry in +the ConnectionTable to represent that peer. For Ethernet, a +Connection is the tuple {dmac, smac, ethertype}. For TCP and +UDP, it is the tuple {source IP, source port, destination +IP, destination port}. The connid (connection ID) becomes +the reverse route index in the Pending Interest Table.</p> + +<h2>OPTIONS +<a name="OPTIONS"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em">−−config +<i>configfile</i></p> + +<p style="margin-left:26%;">Reads configuration parameters +from <i>configfile</i>. The <i>−−port</i> option +has no effect in this mode and Metis will not listen to any +ports. This means that <b>metis_control</b> will not be able +to connect to Metis to configure it further unless one +includes at least a listener for TCP localhost or a unix +domain socket.</p> + +<p style="margin-left:11%;">−−capacity +<i>contentStoreSize</i></p> + +<p style="margin-left:26%;">Sets the capacity of the +Content Store to <i>contentStoreSize</i> content objects. +Metis uses a least-recently-used eviction policy. A size of +0 will disable the Content Store.</p> + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="12%"> +</td> +<td width="3%"></td> +<td width="74%"> + + +<p>The Content Store sits on the fast path of the +forwarder, so there is a cost associated with adding and +removing items to the Content Store tables.</p></td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="12%"> + + +<p>−−daemon</p></td> +<td width="3%"></td> +<td width="74%"> + + +<p>Runs Metis in daemon mode, detaching from the console. +It must be run with the <i>−−log-file</i> +option.</p> </td></tr> +</table> + +<p style="margin-left:11%;">−−log +<i>facility</i>=<i>level</i></p> + +<p style="margin-left:26%;">Sets the log level of the given +<i>facility</i> to the given <i>level</i>. The +<i>−−log</i> option may be repeated several +times setting the log level of different facilities. If the +same facility is listed twice, only the last occurance takes +effect. The default log level is Error for all +facilities.</p> + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="26%"></td> +<td width="17%"> + + +<p>Facilities:</p></td> +<td width="57%"> +</td></tr> +</table> + +<p style="margin-left:26%;">•</p> + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="31%"></td> +<td width="1%"></td> +<td width="3%"></td> +<td width="65%"> + + +<p style="margin-top: 1em">all: All facilities.</p></td></tr> +<tr valign="top" align="left"> +<td width="31%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="65%"> + + +<p>config: Configuration activies.</p></td></tr> +<tr valign="top" align="left"> +<td width="31%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="65%"> + + +<p>core: Core forwarder, such as startup and shutdown.</p></td></tr> +<tr valign="top" align="left"> +<td width="31%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="65%"> + + +<p>io: Listeners, connections, and all I/O related +activities.</p> </td></tr> +<tr valign="top" align="left"> +<td width="31%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="65%"> + + +<p>message: CCNx messages, such as parsing.</p></td></tr> +<tr valign="top" align="left"> +<td width="31%"></td> +<td width="1%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="65%"> + + +<p>processor: Forwarding processor, such as CS, FIB, and +PIT activities.</p></td></tr> +</table> + +<p style="margin-left:26%; margin-top: 1em">The log levels +are: debug, info, notice, warning, error, critical, alert, +off.</p> + +<p style="margin-left:11%;">−−log-file +<i>logfile</i></p> + +<p style="margin-left:26%;">Specifies the <i>logfile</i> to +write all log messages. This parameter is required with +<i>−−daemon</i> mode.</p> + +<p style="margin-left:11%;">−−port +<i>port</i></p> + +<p style="margin-left:26%;">The UDP and TCP port to listen +on. If no <i>configfile</i> is specified, Metis will listen +on this port on all interfaces including localhost.</p> + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="26%"></td> +<td width="74%"> + + +<p>If this parameter is not given, Metis uses the default +port 9695.</p></td></tr> +</table> + +<h2>USAGE +<a name="USAGE"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>metis_daemon</b> +−−config metis.cfg −−log all=info +−−log config=debug −−log-file +metis.log</p> + +<h2>SEE ALSO +<a name="SEE ALSO"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">See +<b>metis_control(1)</b> for a description of how to +configure <b>metis_daemon</b>.</p> + +<p style="margin-left:11%; margin-top: 1em">For a list of +all configuration lines that may be used with +<b>metis_control</b> and by <i>−−config</i> +configuration file, see <b>metis.cfg(5)</b>.</p> + +<h2>CAVEATS +<a name="CAVEATS"></a> +</h2> + + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="15%"></td> +<td width="2%"> + + +<p style="margin-top: 1em">•</p></td> +<td width="3%"></td> +<td width="80%"> + + +<p style="margin-top: 1em">A given interface may only have +one Ethernet listener on one EtherType.</p></td></tr> +<tr valign="top" align="left"> +<td width="15%"></td> +<td width="2%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="80%"> + + +<p>If there are multiple longest matching prefix entries +that match an Interest, it will be forwarded to all those +routes (i.e. multicast).</p></td></tr> +<tr valign="top" align="left"> +<td width="15%"></td> +<td width="2%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="80%"> + + +<p>Ethernet fragmentation will only use the interface MTU +and there is not MTU discovery. If Metis is used in a +bridged environment, this may lead to errors if the MTU +changes on different segments, such as a 10G link at 9000 +bytes and a 100 Mbps link at 1500 bytes.</p></td></tr> +</table> + +<h2>BUGS +<a name="BUGS"></a> +</h2> + + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="15%"></td> +<td width="2%"> + + +<p style="margin-top: 1em">•</p></td> +<td width="3%"></td> +<td width="80%"> + + +<p style="margin-top: 1em">Adding the same listener twice +will cause Metis to crash.</p></td></tr> +<tr valign="top" align="left"> +<td width="15%"></td> +<td width="2%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="80%"> + + +<p>Errors in the configuration file may cause Metis to +crash.</p> </td></tr> +<tr valign="top" align="left"> +<td width="15%"></td> +<td width="2%"> + + +<p>•</p></td> +<td width="3%"></td> +<td width="80%"> + + +<p>The command ’list connections’ will display +all connections as TCP encapsulation.</p></td></tr> +</table> + +<h2>AUTHOR +<a name="AUTHOR"></a> +</h2> + + +<p>Marc Mosko Palo Alto Research Center</p></table> +<hr> +</body> +</html> |