]> git.ipfire.org Git - people/ms/network.git/blobdiff - man/network-zone.xml
hostapd: Always qoute SSID
[people/ms/network.git] / man / network-zone.xml
index 15908dba92e02bca9e85b198902e99cd8e3cc8cf..99fa8b83174ec7972c7844cd23c21aac81b11e13 100644 (file)
 
        <refsynopsisdiv>
                <cmdsynopsis>
-                       <command>network zone <arg choice="plain">[create|remove]</arg> <replaceable>ZONE</replaceable> ...</command>
-               </cmdsynopsis>
-
-               <cmdsynopsis>
-                       <command>network zone <arg choice="plain">list-hooks</arg></command>
+                       <command>network zone <arg choice="plain">[new|destroy]</arg> <replaceable>ZONE</replaceable> ...</command>
                </cmdsynopsis>
 
                <cmdsynopsis>
@@ -65,7 +61,7 @@
                <variablelist>
                        <varlistentry>
                                <term>
-                                       <command>create <replaceable>ZONE</replaceable> <replaceable>HOOK</replaceable> <arg choice="opt" rep="repeat">OPTIONS</arg></command>
+                                       <command>new <replaceable>ZONE</replaceable> <replaceable>HOOK</replaceable> <arg choice="opt" rep="repeat">OPTIONS</arg></command>
                                </term>
 
                                <listitem>
 
                        <varlistentry>
                                <term>
-                                       <command>remove <replaceable>ZONE</replaceable></command>
+                                       <command>destroy <replaceable>ZONE</replaceable></command>
                                </term>
 
                                <listitem>
                                        <para>
-                                               A zone can be simple removed with this command.
+                                               A zone can be destroyed with this command.
                                        </para>
                                        <para>
                                                There are two possible ways to remove a zone. The case
                                        </para>
                                </listitem>
                        </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <command>list-hooks</command>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               Outputs a list of all eligible hooks for the zones.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
                </variablelist>
 
                <para>
                                </listitem>
                        </varlistentry>
 
+                       <varlistentry>
+                               <term>
+                                       <command><replaceable>ZONE</replaceable> [enable|disable]</command>
+                               </term>
+
+                               <listitem>
+                                       <para>
+                                               These commands will enable or disable the zone. An enabled
+                                               zone will automatically be started either during the boot process
+                                               or a hotplug event of an associated port or other device.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
+
                        <varlistentry>
                                <term>
                                        <command><replaceable>ZONE</replaceable> status</command>
                                        </para>
                                </listitem>
                        </varlistentry>
+                       <varlistentry>
+                               <term>
+                                       <command><replaceable>ZONE</replaceable> color</command>
+                               </term>
+
+                               <listitem>
+                                       <para>
+                                               This command allows settings a color for a zone.
+                                               See
+                                               <citerefentry>
+                                               <refentrytitle>network-color</refentrytitle>
+                                               <manvolnum>8</manvolnum>
+                                               </citerefentry>
+                                               for more information.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
+                       <varlistentry>
+                               <term>
+                                       <command><replaceable>ZONE</replaceable>description</command>
+                               </term>
+
+                               <listitem>
+                                       <para>
+                                               This command make is possible to add a description to a zone.
+                                               See
+                                               <citerefentry>
+                                               <refentrytitle>network-description</refentrytitle>
+                                               <manvolnum>8</manvolnum>,
+                                               </citerefentry>
+                                               for more information.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
+                       <varlistentry>
+                               <term>
+                                       <command><replaceable>ZONE</replaceable> identify</command>
+                               </term>
+
+                               <listitem>
+                                       <para>
+                                               This command will make all ports of the zone flash for
+                                               a few seconds so that you can identify the correct network
+                                               adapters in the system.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
+
+                       <varlistentry>
+                               <term>
+                                       <command><replaceable>ZONE</replaceable> rename <replaceable>NAME</replaceable></command>
+                               </term>
+
+                               <listitem>
+                                       <para>
+                                               Renames the zone to <replaceable>NAME</replaceable>.
+                                       </para>
+                                       <para>
+                                               The command will shut down the zone if it is up and
+                                               start it again with the new name. If the zone is not
+                                               up it won't be started.
+                                       </para>
+                                       <para>
+                                               Zones that are marked to be destroyed cannot be renamed.
+                                       </para>
+                               </listitem>
+                       </varlistentry>
                </variablelist>
        </refsect1>