[amateur-radio-guide] Add documentation for ax25-apps

John J. McDonough jjmcd at fedoraproject.org
Sun Mar 23 17:56:09 UTC 2014


commit 75e5e521704299315ac0be8b3b2762aa490cc8f5
Author: John J. McDonough <jjmcd at fedoraproject.org>
Date:   Sun Mar 23 13:56:01 2014 -0400

    Add documentation for ax25-apps

 en-US/images/packet-ax25/ax25-axcall-connected.png |  Bin 70264 -> 52209 bytes
 .../images/packet-ax25/ax25-axcall-connecting.png  |  Bin 29658 -> 12080 bytes
 en-US/images/packet-ax25/ax25-axlisten-color.png   |  Bin 0 -> 96987 bytes
 en-US/images/packet-ax25/ax25-listen-root.png      |  Bin 58786 -> 59353 bytes
 en-US/packet-ax25-apps.xml                         |  105 +++++++++++++++++++-
 5 files changed, 104 insertions(+), 1 deletions(-)
---
diff --git a/en-US/images/packet-ax25/ax25-axcall-connected.png b/en-US/images/packet-ax25/ax25-axcall-connected.png
index fcf4d03..1d0a7e1 100644
Binary files a/en-US/images/packet-ax25/ax25-axcall-connected.png 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
index f42e2e9..8e83078 100644
Binary files a/en-US/images/packet-ax25/ax25-axcall-connecting.png and b/en-US/images/packet-ax25/ax25-axcall-connecting.png differ
diff --git a/en-US/images/packet-ax25/ax25-axlisten-color.png b/en-US/images/packet-ax25/ax25-axlisten-color.png
new file mode 100644
index 0000000..7930194
Binary files /dev/null and b/en-US/images/packet-ax25/ax25-axlisten-color.png differ
diff --git a/en-US/images/packet-ax25/ax25-listen-root.png b/en-US/images/packet-ax25/ax25-listen-root.png
index de87a51..554e67b 100644
Binary files a/en-US/images/packet-ax25/ax25-listen-root.png and b/en-US/images/packet-ax25/ax25-listen-root.png differ
diff --git a/en-US/packet-ax25-apps.xml b/en-US/packet-ax25-apps.xml
index fb65e5f..baf39f0 100644
--- a/en-US/packet-ax25-apps.xml
+++ b/en-US/packet-ax25-apps.xml
@@ -5,6 +5,109 @@
 <section id="packet-ax25-apps">
   <title>ax25-apps</title>
   <para>
-    .
+    <package>ax25-apps</package> provides a number of AX.@%-only
+    applications for use with <package>ax25-tools</package> in
+    environments where there is no packet IP infrastructure.  Of
+    particular interest are <application>axlisten</application> and
+    <application>axcall</application>. 
   </para>
+  <section>
+    <title>axlisten</title>
+    <para>
+      <application>axlisten</application> allows the user to monitor
+      packets on the AX.25 port.  If invoked with the
+      <command>-a</command> switch, both incoming and outgoing packets
+      are displayed.
+    </para>
+    <para>
+      <figure float="0"><title>axlisten</title>
+        <mediaobject>
+          <imageobject>
+	    <imagedata scale="99" scalefit="1" 
+		       fileref="images/packet-ax25/ax25-listen-root.png" 
+		       format="PNG"/>
+	  </imageobject>
+          <textobject>
+	    <para>
+              axlisten
+            </para>
+          </textobject>
+        </mediaobject>
+      </figure>
+    </para>
+    <para>
+      Note that the packets are each identified with the port, and
+      that IP, UDP and ARP packets are also identified.
+    </para>
+    <para>
+      Should <application>axlisten</application> be started with the
+      <command>-c</command> switch, the screen is cleared and parts of
+      the packets are color coded:
+      <figure float="0"><title>axlisten</title>
+        <mediaobject>
+          <imageobject>
+	    <imagedata scale="99" scalefit="1" 
+		       fileref="images/packet-ax25/ax25-axlisten-color.png" 
+		       format="PNG"/>
+	  </imageobject>
+          <textobject>
+	    <para>
+              axlisten
+            </para>
+          </textobject>
+        </mediaobject>
+      </figure>
+    </para>
+  </section>
+  <section>
+    <title>axcall</title>
+    <para>
+      <application>axcall</application> attempts to make an AX.25
+      connection to a remote node.  Call
+      <application>axcall</application> with the name of the port and
+      the SSID of the node to which you wish to connect.
+    </para>
+    <para>
+      For several seconds the connection attempt will display:
+      <figure float="0"><title>axcall, connecting</title>
+        <mediaobject>
+          <imageobject>
+	    <imagedata scale="99" scalefit="1" 
+		       fileref="images/packet-ax25/ax25-axcall-connecting.png" 
+		       format="PNG"/>
+	  </imageobject>
+          <textobject>
+	    <para>
+              axcall, connecting
+            </para>
+          </textobject>
+        </mediaobject>
+      </figure>
+    </para>
+    <para>
+      Once connected, the screen will clear and be divided into two
+      parts.  The larger, upper part, displays input from the remote
+      node.  The smaller, lower part will accept typing to be sent to
+      the remote node.
+    </para>
+    <para>
+      <figure float="0"><title>axcall, connected</title>
+        <mediaobject>
+          <imageobject>
+	    <imagedata scale="99" scalefit="1" 
+		       fileref="images/packet-ax25/ax25-axcall-connected.png " 
+		       format="PNG"/>
+	  </imageobject>
+          <textobject>
+	    <para>
+              axcall, connected
+            </para>
+          </textobject>
+        </mediaobject>
+      </figure>
+    </para>
+    <para>
+      When the remote node disconnects, the window will be cleared.
+    </para>
+  </section>
 </section>


More information about the docs-commits mailing list