[people/ms/network.git] / man / network-route.xml

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="network-route">
	<refentryinfo>
		<title>network-route</title>
		<productname>network</productname>

		<authorgroup>
			<author>
				<contrib>Developer</contrib>
				<firstname>Michael</firstname>
				<surname>Tremer</surname>
				<email>michael.tremer@ipfire.org</email>
			</author>
		</authorgroup>
	</refentryinfo>

	<refmeta>
		<refentrytitle>network-route</refentrytitle>
		<manvolnum>8</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>network-route</refname>
		<refpurpose>Network Configuration Control Program</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>network route <arg choice="plain">COMMAND</arg></command>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1>
		<title>Description</title>

		<para>
			The <command>route</command> helps to manage routes.
		</para>
	</refsect1>

	<refsect1>
		<title>Commands</title>

		<para>
			The following commands are understood:
		</para>

		<variablelist>
			<varlistentry>
				<term>
					<command>static</command>
				</term>

				<listitem>
					<para>
						Static routes are managed by the <command>static</command> command
						followed by the options for static routes which are described in:
						<citerefentry>
							<refentrytitle>network-route-static</refentrytitle>
							<manvolnum>8</manvolnum>
						</citerefentry>
					</para>
				</listitem>
			</varlistentry>
	</variablelist>
	</refsect1>

	<refsect1>
		<title>Route Types</title>

		<refsect2>
			<title>static</title>

			<para>
				A static route is a route which does not change when the network changes.
			</para>
		</refsect2>
</refsect1>

	<refsect1>
		<title>See Also</title>

		<para>
			<citerefentry>
				<refentrytitle>network</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>,
			<citerefentry>
				<refentrytitle>network-route-static</refentrytitle>
				<manvolnum>8</manvolnum>
			</citerefentry>
		</para>
	</refsect1>
</refentry>
Commit	Line	Data
a2a6f759 MT	1	<?xml version="1.0"?>
	2	<!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
	3	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	4
	5	<refentry id="network-route">
	6	<refentryinfo>
	7	<title>network-route</title>
	8	<productname>network</productname>
	9
	10	<authorgroup>
	11	<author>
	12	<contrib>Developer</contrib>
	13	<firstname>Michael</firstname>
	14	<surname>Tremer</surname>
	15	<email>michael.tremer@ipfire.org</email>
	16	</author>
	17	</authorgroup>
	18	</refentryinfo>
	19
	20	<refmeta>
	21	<refentrytitle>network-route</refentrytitle>
	22	<manvolnum>8</manvolnum>
	23	</refmeta>
	24
	25	<refnamediv>
	26	<refname>network-route</refname>
	27	<refpurpose>Network Configuration Control Program</refpurpose>
	28	</refnamediv>
	29
	30	<refsynopsisdiv>
	31	<cmdsynopsis>
	32	<command>network route <arg choice="plain">COMMAND</arg></command>
	33	</cmdsynopsis>
	34	</refsynopsisdiv>
	35
	36	<refsect1>
	37	<title>Description</title>
	38
	39	<para>
19331e5f	40	The <command>route</command> helps to manage routes.
a2a6f759 MT	41	</para>
	42	</refsect1>
	43
	44	<refsect1>
	45	<title>Commands</title>
	46
	47	<para>
	48	The following commands are understood:
	49	</para>
	50
	51	<variablelist>
	52	<varlistentry>
	53	<term>
19331e5f	54	<command>static</command>
a2a6f759 MT	55	</term>
	56
	57	<listitem>
	58	<para>
19331e5f JS	59	Static routes are managed by the <command>static</command> command
	60	followed by the options for static routes which are described in:
	61	<citerefentry>
	62	<refentrytitle>network-route-static</refentrytitle>
	63	<manvolnum>8</manvolnum>
	64	</citerefentry>
a2a6f759 MT	65	</para>
	66	</listitem>
	67	</varlistentry>
19331e5f	68	</variablelist>
a2a6f759 MT	69	</refsect1>
	70
	71	<refsect1>
	72	<title>Route Types</title>
	73
	74	<refsect2>
19331e5f	75	<title>static</title>
a2a6f759 MT	76
a2a6f759 MT	77	<para>
19331e5f	78	A static route is a route which does not change when the network changes.
a2a6f759 MT	79	</para>
a2a6f759 MT	80	</refsect2>
19331e5f	81	</refsect1>
a2a6f759 MT	82
	83	<refsect1>
	84	<title>See Also</title>
	85
	86	<para>
	87	<citerefentry>
	88	<refentrytitle>network</refentrytitle>
	89	<manvolnum>8</manvolnum>
	90	</citerefentry>,
	91	<citerefentry>
19331e5f	92	<refentrytitle>network-route-static</refentrytitle>
a2a6f759 MT	93	<manvolnum>8</manvolnum>
	94	</citerefentry>
	95	</para>
	96	</refsect1>
	97	</refentry>