man: Convert network-zone-pppoe(8) to asciidoc
authorMichael Tremer <michael.tremer@ipfire.org>
Sun, 31 Mar 2019 15:42:10 +0000 (17:42 +0200)
committerMichael Tremer <michael.tremer@ipfire.org>
Sun, 31 Mar 2019 15:42:10 +0000 (17:42 +0200)
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
man/network-zone-pppoe.txt [new file with mode: 0644]
man/network-zone-pppoe.xml [deleted file]

diff --git a/man/network-zone-pppoe.txt b/man/network-zone-pppoe.txt
new file mode 100644 (file)
index 0000000..93b55f2
--- /dev/null
@@ -0,0 +1,52 @@
+= network-zone-pppoe(8)
+Michael Tremer <michael.tremer@ipfire.org>
+
+== NAME
+network-zone-pppoe - PPP over Ethernet
+
+== SYNOPSIS
+[verse]
+`network zone new ZONE pppoe ...`
+
+== DESCRIPTION
+The `pppoe` hook creates a PPPoE connection to your ISP.
+
+== OPTIONS
+The following options are understood:
+
+`--username=USERNAME`::
+       Sets the username for authentication.
+
+`--password=PASSWORD`::
+       Sets the password for authentication.
+       +
+       Use the `--auth=` option to transmit it in a secure manner to the provider.
+
+`--mtu=N`::
+       Sets the default MTU of the PPP connection.
+
+`--auth=[chap|pap]`::
+       Define the authentication method that is used to authenticate against your
+       provider. The default is to use the provider's preference.
+
+       * _Challange-Handshake Authentication Protocol_ (`chap`) is the preferred,
+       secure method.
+       * _Password Authentication Protocol_ (`pap`) sends the plaintext password
+       to the authentication server which is the reason why it should be avoided.
+
+`--access-concentrator=STRING`::
+       By this option, you may define the name of the access concentrator.
+
+`--service-name=STRING`::
+       By this option, you may define the service name.
+
+`--ipv6=[on|off]`::
+       By this option, you may enable or disable IPv6.
+
+`--prefix-delegation=[on|off]`::
+       By this option, you may enable or disable the delegation through your
+       provider of one IPv6 prefix to your system.
+
+== SEE ALSO
+link:network[8],
+link:network-zone[8]
diff --git a/man/network-zone-pppoe.xml b/man/network-zone-pppoe.xml
deleted file mode 100644 (file)
index 36c4d0e..0000000
+++ /dev/null
@@ -1,186 +0,0 @@
-<?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-zone-pppoe">
-       <refentryinfo>
-               <title>network-zone-pppoe</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-zone-pppoe</refentrytitle>
-               <manvolnum>8</manvolnum>
-       </refmeta>
-
-       <refnamediv>
-               <refname>network-zone-pppoe</refname>
-               <refpurpose>Network Configuration Control Program</refpurpose>
-       </refnamediv>
-
-       <refsynopsisdiv>
-               <cmdsynopsis>
-                       <command>network zone new <replaceable>ZONE</replaceable> pppoe ...</command>
-               </cmdsynopsis>
-       </refsynopsisdiv>
-
-       <refsect1>
-               <title>Description</title>
-
-               <para>
-                       The pppoe hook creates a PPPoE connection to your ISP.
-               </para>
-       </refsect1>
-
-       <refsect1>
-               <title>Options</title>
-
-               <para>
-                       The following options are understood:
-               </para>
-
-               <variablelist>
-
-                       <varlistentry>
-                               <term>
-                                       <option>--username=<replaceable>USERNAME</replaceable></option>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               Sets the username for authentication.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <option>--password=<replaceable>PASSWORD</replaceable></option>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               Sets the password for authentication.
-                                       </para>
-                                       <para>
-                                               Use the <option>--auth=</option> option to transmit it
-                                               in a secure manner to the provider.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <option>--mtu=<emphasis>N</emphasis></option>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               Sets the default MTU of the PPP connection.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <option>--auth=[chap|pap]</option>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               Define the authentication method that is used to
-                                               authenticate against your provider.
-                                               The default is to use the provider's preference.
-                                       </para>
-                                       <itemizedlist>
-                                               <listitem>
-                                                       <para>
-                                                               <emphasis>Challange-Handshake Authentication Protocol</emphasis>
-                                                               (chap) is the preferred secure method.
-                                                       </para>
-                                               </listitem>
-                                               <listitem>
-                                                       <para>
-                                                               <emphasis>Password Authentication Protocol</emphasis>
-                                                               (pap) sends the plaintext password to the authentication
-                                                               server which is the reason why it should be avoided to use PAP.
-                                                       </para>
-                                               </listitem>
-                                       </itemizedlist>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <option>--access-concentrator=<replaceable>STRING</replaceable></option>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               By this option, you may define the name of the access concentrator.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <option>--service-name=<replaceable>STRING</replaceable></option>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               By this option, you may define the service name.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <option>--ipv6=[<emphasis>on</emphasis>|off]</option>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                               By this option, you may enable or disable IPv6
-                                       </para>                         </listitem>
-                       </varlistentry>
-
-                       <varlistentry>
-                               <term>
-                                       <option>--prefix-delegation=[<emphasis>on</emphasis>|off]</option>
-                               </term>
-
-                               <listitem>
-                                       <para>
-                                                By this option, you may enable or disable the delegation through your provider of one IPv6 prefix to your system.
-                                       </para>
-                               </listitem>
-                       </varlistentry>
-
-               </variablelist>
-       </refsect1>
-
-       <refsect1>
-               <title>See Also</title>
-
-               <para>
-                       <citerefentry>
-                               <refentrytitle>network</refentrytitle>
-                               <manvolnum>8</manvolnum>
-                       </citerefentry>,
-                       <citerefentry>
-                               <refentrytitle>network-zone</refentrytitle>
-                               <manvolnum>8</manvolnum>
-                       </citerefentry>
-               </para>
-       </refsect1>
-</refentry>