[amateur-radio-guide] Improve grig documentation

John J. McDonough jjmcd at fedoraproject.org
Sat Mar 22 20:34:08 UTC 2014


commit c7c0bf41d1ae4378165d2f28f92230b267ba8e1b
Author: John J. McDonough <jjmcd at fedoraproject.org>
Date:   Sat Mar 22 16:34:01 2014 -0400

    Improve grig documentation

 en-US/rig-grig.xml |   44 ++++++++++++++++++++++++++++++++++++++++----
 1 files changed, 40 insertions(+), 4 deletions(-)
---
diff --git a/en-US/rig-grig.xml b/en-US/rig-grig.xml
index 035e4d3..35588f2 100644
--- a/en-US/rig-grig.xml
+++ b/en-US/rig-grig.xml
@@ -17,10 +17,7 @@
     <primary>front panel</primary>
   </indexterm>
   <para>
-    <package>grig</package> is a simple front panel for a radio
-    controlled by <package>hamlib</package>. Before using
-    <package>grig</package> the user should first configure
-    <package>hamlib</package>.
+    <package>grig</package> is a simple front panel for a radio.
   </para>
 
   <para>
@@ -42,6 +39,11 @@
     </figure>
   </para>
   <para>
+    When started from the menu, <package>grig</package> uses a dummy
+    back end, so you may explore the capability, but your radio will
+    not be affected.
+  </para>
+  <para>
     The main window allows for control over most of the actions
     accessible from a typical radio front panel.  Frequency may be
     increased or decreased by left or right clicking the appropriate
@@ -63,4 +65,38 @@
       </mediaobject>
     </figure>
   </para>
+  <para>
+    To control the radio, you should start <package>grig</package>
+    from the command line.  You must first have your radio connected
+    using the appropriate hardware, which most commonly will be a
+    serial port.
+  </para>
+  <para>
+    You must provide <package>grig</package> with the model code for
+    your radio, the port and speed, and in some cases, a radio
+    address.  You can find the model code by typing <command>rigctl
+    -l</command>. Use <command>man grig</command> or <command>info
+    grig</command> for all the possible switches, but most commonly
+    you will use <command>-m</command> for the model,
+    <command>-r</command> for the port, <command>-s</command> for the
+    speed, and most often, <command>-c</command> for the address.
+  </para>
+  <para>
+    For example, for an Icom 7000 on
+    <filename>/dev/ttyUSB0</filename>, the command would be:
+<screen>
+grig -m 360 -r /dev/ttyUSB0 -s 9600 -c 0x70 
+</screen>
+    The <command>-m 360</command> is the model code for an Icom 7000,
+    the <command>-r /dev/ttyUSB0</command> is the port to which the
+    radio is attached, the <command>-s 9600</command> is the baud
+    rate, and <command>-c 0x70</command> is the default CIV address
+    for an Icom 7000.
+  </para>
+  <para>
+    Since you typically will have only a few radios, it may be
+    preferable to create a script, or perhaps edit&nbsp;
+    <filename>/usr/share/applications/fedora-grig.desktop</filename> to
+    reflect your particular hardware.
+  </para>
 </section>


More information about the docs-commits mailing list