[amateur-radio-guide] Add ax25-tools documentation
John J. McDonough
jjmcd at fedoraproject.org
Sun Mar 23 15:57:22 UTC 2014
commit 26fb1788861c8f5cc229fc35f7b8cd1285957069
Author: John J. McDonough <jjmcd at fedoraproject.org>
Date: Sun Mar 23 11:57:14 2014 -0400
Add ax25-tools documentation
en-US/images/packet-ax25/ax25-axcall-connected.png | Bin 0 -> 70264 bytes
.../images/packet-ax25/ax25-axcall-connecting.png | Bin 0 -> 29658 bytes
en-US/images/packet-ax25/ax25-axports.png | Bin 0 -> 4068 bytes
en-US/images/packet-ax25/ax25-ifconfig.png | Bin 0 -> 26811 bytes
en-US/images/packet-ax25/ax25-ip.png | Bin 0 -> 79350 bytes
en-US/images/packet-ax25/ax25-listen-root.png | Bin 0 -> 58786 bytes
en-US/images/packet-ax25/ax25-start.png | Bin 0 -> 25263 bytes
en-US/images/packet-ax25/ax25-stop.png | Bin 0 -> 10984 bytes
en-US/images/packet-ax25/ax25-telnet-1.png | Bin 0 -> 24189 bytes
en-US/images/packet-ax25/ax25-telnet.png | Bin 0 -> 37019 bytes
en-US/images/packet-ax25/ax25-web-1.png | Bin 0 -> 52098 bytes
en-US/images/packet-ax25/ax25-web.png | Bin 0 -> 97376 bytes
en-US/packet-ax25-tools.xml | 163 +++++++++++++++++++-
en-US/packet.xml | 4 +-
14 files changed, 162 insertions(+), 5 deletions(-)
---
diff --git a/en-US/images/packet-ax25/ax25-axcall-connected.png b/en-US/images/packet-ax25/ax25-axcall-connected.png
new file mode 100644
index 0000000..fcf4d03
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-axcall-connected.png differ
diff --git a/en-US/images/packet-ax25/ax25-axcall-connecting.png b/en-US/images/packet-ax25/ax25-axcall-connecting.png
new file mode 100644
index 0000000..f42e2e9
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-axcall-connecting.png differ
diff --git a/en-US/images/packet-ax25/ax25-axports.png b/en-US/images/packet-ax25/ax25-axports.png
new file mode 100644
index 0000000..d2bf9b2
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-axports.png differ
diff --git a/en-US/images/packet-ax25/ax25-ifconfig.png b/en-US/images/packet-ax25/ax25-ifconfig.png
new file mode 100644
index 0000000..eb932a4
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-ifconfig.png differ
diff --git a/en-US/images/packet-ax25/ax25-ip.png b/en-US/images/packet-ax25/ax25-ip.png
new file mode 100644
index 0000000..c124e49
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-ip.png differ
diff --git a/en-US/images/packet-ax25/ax25-listen-root.png b/en-US/images/packet-ax25/ax25-listen-root.png
new file mode 100644
index 0000000..de87a51
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-listen-root.png differ
diff --git a/en-US/images/packet-ax25/ax25-start.png b/en-US/images/packet-ax25/ax25-start.png
new file mode 100644
index 0000000..28bbe3f
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-start.png differ
diff --git a/en-US/images/packet-ax25/ax25-stop.png b/en-US/images/packet-ax25/ax25-stop.png
new file mode 100644
index 0000000..50380aa
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-stop.png differ
diff --git a/en-US/images/packet-ax25/ax25-telnet-1.png b/en-US/images/packet-ax25/ax25-telnet-1.png
new file mode 100644
index 0000000..725fc41
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-telnet-1.png differ
diff --git a/en-US/images/packet-ax25/ax25-telnet.png b/en-US/images/packet-ax25/ax25-telnet.png
new file mode 100644
index 0000000..e5e7d5e
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-telnet.png differ
diff --git a/en-US/images/packet-ax25/ax25-web-1.png b/en-US/images/packet-ax25/ax25-web-1.png
new file mode 100644
index 0000000..d5fdeaf
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-web-1.png differ
diff --git a/en-US/images/packet-ax25/ax25-web.png b/en-US/images/packet-ax25/ax25-web.png
new file mode 100644
index 0000000..d056bd4
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-web.png differ
diff --git a/en-US/packet-ax25-tools.xml b/en-US/packet-ax25-tools.xml
index f2160b7..98b015f 100644
--- a/en-US/packet-ax25-tools.xml
+++ b/en-US/packet-ax25-tools.xml
@@ -4,7 +4,164 @@
<section id="packet-ax25-tools">
<title>ax25-tools</title>
- <para>
- .
- </para>
+ <section>
+ <title>Setting up ax25-tools</title>
+ <para>
+ Before starting <application>ax25-tools</application> you must
+ first edit <filename>/etc/ax25/axports</filename> to reflect
+ your particular TNC.
+ </para>
+ <para>
+ <figure float="0"><title>/etc/ax25/axports</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="99" scalefit="1"
+ fileref="images/packet-ax25/ax25-axports.png"
+ format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>
+ axports
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ <para>
+ The file consists of a single line containing six fields. The
+ fields are described in <command>man axports</command>. The
+ file may also contain comment lines identified by a
+ <command>#</command> character at the beginning of the line.
+ </para>
+ </section>
+ <section>
+ <title>Starting ax25-tools</title>
+ <para>
+ <application>ax25-tools</application> are started with the
+ <command>kissattach</command> command. The arguments required
+ are 1) the port to which your TNC is attached, 2) the name to be
+ given to the port that <application>ax25-tools</application>
+ will attach, and 3) the IP address to be assigned to the
+ interface. The interface names will begin with
+ <filename>ax0</filename> and increase as additional TNCs are
+ connected.
+ </para>
+ <para>
+ <figure float="0"><title>Starting AX25</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="99" scalefit="1"
+ fileref="images/packet-ax25/ax25-start.png"
+ format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>
+ Starting AX25
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ <para>
+ In the example above, the TNC is attached to
+ <filename>/dev/ttyAMA0</filename>, the port will be the
+ <filename>145.09</filename> port as described in
+ <filename>axports</filename> above, and the interface will be assigned
+ the IP address of <filename>44.102.200.17</filename>.
+ </para>
+ <para>
+ As shown above, you will also want to establish one or more
+ routes. As a minimum, you will want to route the 44/8 network
+ (the amateur radio packet network) to your newly created
+ interface. Typically, some node will be designated as a router
+ for your local radio network and you will want to designate that
+ node as your router for 44/8 traffic. Your routes may be
+ different depending on your local resources and your own RF
+ footprint. If there is no router in your area, you may wish to
+ simply route all 44/8 traffic to your ax0 interface.
+ </para>
+ </section>
+ <section>
+ <title>Using ax25-tools</title>
+ <para>
+ <application>ax25-tools</application> creates a network
+ interface which may be viewed with <command>ifconfig</command>
+ like any other interface.
+ </para>
+ <para>
+ <figure float="0"><title>ifconfig</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="99" scalefit="1"
+ fileref="images/packet-ax25/ax25-ifconfig.png"
+ format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>
+ ifconfig
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ <para>
+ Since the interface has an IP address, it may be used with any
+ application expecting to use an Internet port, assuming, of
+ course, that an appropriate server exists within radio range.
+ Thus, if an IP BBS is nearby, tools such as
+ <application>telnet</application>,
+ <application>ftp</application>, or a web browser may be used.
+ </para>
+ <para>
+ <figure float="0"><title>Using AX25</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="99" scalefit="1"
+ fileref="images/packet-ax25/ax25-ip.png"
+ format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>
+ Using AX25
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ <para>
+ Note that the packet connection tends to be quite a bit slower
+ than wired Internet, so the connections will take much longer
+ than you might expect.
+ </para>
+ <para>
+ <application>ax25-tools</application> only provides the
+ interface. The package <package>ax25-apps</package> (<xref
+ linkend="packet-ax25-apps" />) provides a number of simple
+ AX.25-only applications that may be used in the event that IP
+ packet is not available in your area.
+ </para>
+ </section>
+ <section>
+ <title>Stopping ax25-tools</title>
+ <para>
+ <application>ax25-tools</application> is stopped by merely
+ killing the <command>kissattach</command> process. Do this by
+ identifying the PID for the process and
+ <command>kill</command>ing that process:
+ <figure float="0"><title>Stopping AX25</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="99" scalefit="1"
+ fileref="images/packet-ax25/ax25-stop.png"
+ format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>
+ Stopping AX25
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </section>
</section>
diff --git a/en-US/packet.xml b/en-US/packet.xml
index 51c7d4f..5ea94b5 100644
--- a/en-US/packet.xml
+++ b/en-US/packet.xml
@@ -7,9 +7,9 @@
<para>
</para>
-<!--
- <xi:include href="packet-ax25-apps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="packet-ax25-tools.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="packet-ax25-apps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!--
<xi:include href="packet-libax25.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-->
More information about the docs-commits
mailing list