File: hamlib.html

package info (click to toggle)
hamlib 3.3-5
links: PTS, VCS
area: main
in suites: buster
size: 11,952 kB
sloc: ansic: 136,360; sh: 12,250; cpp: 944; perl: 877; makefile: 607; python: 148; awk: 58
file content (2249 lines) | stat: -rw-r--r-- 118,304 bytes
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for the Ham Radio Control Libraries (version 3.3
updated 20 August 2018), which is a development effort to provide a
consistent programming interface for programmers wanting to incorporate
radio and rotor control into their programs.

Copyright (C) 2013,2018 Nate Bargmann

Permission is granted to copy, distribute and/or modify this document under
the terms of the GNU Free Documentation License, Version 1.3 or any later
version published by the Free Software Foundation; with no Invariant
Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the
license is included in the section entitled "GNU Free Documentation
License". -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Ham Radio Control Libraries 3.3</title>

<meta name="description" content="Ham Radio Control Libraries 3.3">
<meta name="keywords" content="Ham Radio Control Libraries 3.3">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="#Top" rel="start" title="Top">
<link href="#Concept-Index" rel="index" title="Concept Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="dir.html#Top" rel="up" title="(dir)">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<h1 class="settitle" align="center">Ham Radio Control Libraries 3.3</h1>




<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>

<div class="contents">

<ul class="no-bullet">
  <li><a name="toc-Copying-and-Redistribution-1" href="#Copying-and-Redistribution">Copying and Redistribution</a></li>
  <li><a name="toc-Hamlib-in-a-Nutshell-1" href="#Hamlib-in-a-Nutshell">1 Hamlib in a Nutshell</a>
  <ul class="no-bullet">
    <li><a name="toc-A-view-from-the-top-of-the-tower" href="#Overview">1.1 A view from the top of the tower</a></li>
    <li><a name="toc-Hamlib-project-information" href="#The-Hamlib-project">1.2 Hamlib project information</a></li>
    <li><a name="toc-Applications-using-Hamlib-1" href="#Applications-using-Hamlib">1.3 Applications using Hamlib</a></li>
    <li><a name="toc-Using-Hamlib-with-your-program" href="#Licensing-implications">1.4 Using Hamlib with your program</a></li>
    <li><a name="toc-Radios-with-a-clone-capability" href="#Radio-cloning">1.5 Radios with a clone capability</a></li>
    <li><a name="toc-Pronouncing-Hamlib" href="#Pronunciation">1.6 Pronouncing Hamlib</a></li>
  </ul></li>
  <li><a name="toc-Getting-started-1" href="#Getting-started">2 Getting started</a>
  <ul class="no-bullet">
    <li><a name="toc-Installing-binary-packages-on-Linux-and-BSD" href="#Unix-binary-packages">2.1 Installing binary packages on Linux and BSD</a></li>
    <li><a name="toc-A-variety-of-Hamlib-sources" href="#Source-options">2.2 A variety of Hamlib sources</a>
    <ul class="no-bullet">
      <li><a name="toc-Getting-released-source" href="#Source-releases">2.2.1 Getting released source</a></li>
      <li><a name="toc-Getting-source-snapshots" href="#Source-snapshots">2.2.2 Getting source snapshots</a></li>
      <li><a name="toc-Git-repository" href="#Git-clone">2.2.3 Git repository</a></li>
    </ul></li>
    <li><a name="toc-Building-from-source-1" href="#Building-from-source">2.3 Building from source</a>
    <ul class="no-bullet">
      <li><a name="toc-Compiling-source-tarballs-1" href="#Compiling-source-tarballs">2.3.1 Compiling source tarballs</a>
      <ul class="no-bullet">
        <li><a name="toc-configure-1" href="#configure">2.3.1.1 <code>configure</code></a></li>
        <li><a name="toc-make-1" href="#make">2.3.1.2 <code>make</code></a></li>
        <li><a name="toc-make-install-1" href="#make-install">2.3.1.3 <code>make install</code></a></li>
        <li><a name="toc-ldconfig-1" href="#ldconfig">2.3.1.4 <code>ldconfig</code></a></li>
      </ul></li>
      <li><a name="toc-Bootstrapping-from-a-git-clone" href="#Bootstrapping-from-a-Git-clone">2.3.2 Bootstrapping from a <code>git clone</code></a></li>
      <li><a name="toc-Other-make-targets-1" href="#Other-make-targets">2.3.3 Other <code>make</code> targets</a></li>
      <li><a name="toc-Parallel-build-trees-1" href="#Parallel-build-trees">2.3.4 Parallel build trees</a></li>
      <li><a name="toc-Adding-debugging-symbols-1" href="#Adding-debugging-symbols">2.3.5 Adding debugging symbols</a></li>
      <li><a name="toc-Compiling-for-Microsoft-Windows" href="#Compiling-Microsoft-Windows">2.3.6 Compiling for Microsoft Windows</a></li>
    </ul></li>
    <li><a name="toc-Pre_002dcompiled-binaries-for-Microsoft-Windows" href="#Microsft-Windows-binaries">2.4 Pre-compiled binaries for Microsoft Windows</a></li>
  </ul></li>
  <li><a name="toc-Utility-programs-reference" href="#Utility-programs">3 Utility programs reference</a>
  <ul class="no-bullet">
    <li><a name="toc-rigctl-1" href="#rigctl">3.1 <code>rigctl</code></a>
    <ul class="no-bullet">
      <li><a name="toc-Introduction-to-rigctl-1" href="#Introduction-to-rigctl">3.1.1 Introduction to <code>rigctl</code></a></li>
      <li><a name="toc-rigctl-reference-1" href="#rigctl-reference">3.1.2 <code>rigctl</code> reference</a></li>
    </ul></li>
    <li><a name="toc-rotctl-1" href="#rotctl">3.2 <code>rotctl</code></a>
    <ul class="no-bullet">
      <li><a name="toc-Introduction-to-rotctl-1" href="#Introduction-to-rotctl">3.2.1 Introduction to <code>rotctl</code></a></li>
      <li><a name="toc-rotctl-reference-1" href="#rotctl-reference">3.2.2 <code>rotctl</code> reference</a></li>
    </ul></li>
    <li><a name="toc-rigctld-1" href="#rigctld">3.3 <code>rigctld</code></a>
    <ul class="no-bullet">
      <li><a name="toc-Introduction-to-rigctld-1" href="#Introduction-to-rigctld">3.3.1 Introduction to <code>rigctld</code></a></li>
      <li><a name="toc-rigctld-reference-1" href="#rigctld-reference">3.3.2 <code>rigctld</code> reference</a></li>
    </ul></li>
    <li><a name="toc-rotctld-1" href="#rotctld">3.4 <code>rotctld</code></a>
    <ul class="no-bullet">
      <li><a name="toc-Introduction-to-rotctld-1" href="#Introduction-to-rotctld">3.4.1 Introduction to <code>rotctld</code></a></li>
      <li><a name="toc-rotctld-reference-1" href="#rotctld-reference">3.4.2 <code>rotctld</code> reference</a></li>
    </ul></li>
    <li><a name="toc-rigmem-1" href="#rigmem">3.5 <code>rigmem</code></a>
    <ul class="no-bullet">
      <li><a name="toc-Introduction-to-rigmem-1" href="#Introduction-to-rigmem">3.5.1 Introduction to <code>rigmem</code></a></li>
      <li><a name="toc-rigmem-reference-1" href="#rigmem-reference">3.5.2 <code>rigmem</code> reference</a></li>
    </ul></li>
    <li><a name="toc-rigsmtr-1" href="#rigsmtr">3.6 <code>rigsmtr</code></a>
    <ul class="no-bullet">
      <li><a name="toc-Introduction-to-rigsmtr-1" href="#Introduction-to-rigsmtr">3.6.1 Introduction to <code>rigsmtr</code></a></li>
      <li><a name="toc-rigsmtr-reference-1" href="#rigsmtr-reference">3.6.2 <code>rigsmtr</code> reference</a></li>
    </ul></li>
    <li><a name="toc-rigswr-1" href="#rigswr">3.7 <code>rigswr</code></a>
    <ul class="no-bullet">
      <li><a name="toc-Introduction-to-rigswr-1" href="#Introduction-to-rigswr">3.7.1 Introduction to <code>rigswr</code></a></li>
      <li><a name="toc-rigswr-reference-1" href="#rigswr-reference">3.7.2 <code>rigswr</code> reference</a></li>
    </ul></li>
  </ul></li>
  <li><a name="toc-GNU-Free-Documentation-License-1" href="#GNU-Free-Documentation-License">Appendix A GNU Free Documentation License</a></li>
  <li><a name="toc-Working-with-Git-1" href="#Working-with-Git">Appendix B Working with Git</a></li>
  <li><a name="toc-List-of-Figures-1" href="#List-of-Figures">List of Figures</a></li>
  <li><a name="toc-Concept-Index-1" href="#Concept-Index">Concept Index</a></li>
</ul>
</div>


<a name="Top"></a>
<a name="Ham-Radio-Control-Libraries"></a>
<h1 class="top">Ham Radio Control Libraries</h1>

<p>This manual is for Ham Radio Control Libraries (Hamlib) (version 3.3,
20 August 2018).
</p>


<hr>
<a name="Copying-and-Redistribution"></a>
<a name="Copying-and-Redistribution-1"></a>
<h2 class="unnumbered">Copying and Redistribution</h2>
<a name="index-Copying_002c-redistribution"></a>
<a name="index-Redistribution_002c-copying"></a>
<a name="index-Copyleft"></a>

<p>This manual documents Hamlib, a programming library and various supplied
programs, which is
<a href="http://en.wikipedia.org/wiki/Free_Software_Definition">Free Software</a>.  Besides often being distributed at no cost to
you, Free in this context means that the copyright holders to Hamlib
have agreed to offer their collective work under terms that give you
certain rights that allow you to modify and/or redistribute Hamlib under
the same terms that you received it from them.
</p>
<p>Such licensing is often termed
<a href="http://en.wikipedia.org/wiki/Copyleft">copyleft</a> as a
play against the common &ldquo;all rights reserved&rdquo; terms of normal
<a href="http://en.wikipedia.org/wiki/Copyright">copyright</a>.  In
general, copyleft provides everyone with a license to modify and
distribute the modified work or to simply distribute a copyrighted work
under certain terms.  Hamlib source code is copyrighted by its authors
and is licensed by them under two common licenses&mdash;the
<a href="http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License">GNU Lesser General Public License</a>
<acronym>LGPL</acronym> for the &ldquo;front end&rdquo; and &ldquo;back end&rdquo; library source
code files, and the
<a href="http://en.wikipedia.org/wiki/GNU_General_Public_License">GNU General Public License</a> <acronym>GPL</acronym> for
the supplied programs source code files.  The full text of the LGPL and
the GPL can be found in the files COPYING.LIB and COPYING in the root
directory of the Hamlib source archive.
</p>
<p>This manual is covered by the
<a href="http://en.wikipedia.org/wiki/GNU_Free_Documentation_License">GNU Free Documentation License</a>
<acronym>GFDL</acronym> with no Invariant Sections, no Front-Cover Texts, and no
Back-Cover Texts.  Source code examples in this manual are parallel
licensed under the GPL unless otherwise noted.
</p>
<p>As part of the Copyleft nature of the licenses, the authors of Hamlib
must forbid you from distributing Hamlib under terms that forbid others
from exercising the same rights you received.  You must give anyone you
distribute Hamlib to the same rights to obtain, modify, and distribute
the Hamlib source code that you received nor may you license Hamlib
under other terms than those you received.  Any recipients of Hamlib
must be informed of the rights to the source code that they have
received.
</p>
<a name="index-NO-WARRANTY"></a>
<p>Finally, the authors of Hamlib require that it be understood that NO
WARRANTY of any kind is offered to anyone receiving the Hamlib source
code distribution.  Anyone distributing modified versions of Hamlib has
the responsibility to inform any recipients that what they have is not
the official release of Hamlib by its authors and should be prepared to
support the modified version(s).  This is to preserve the reputations of
the Hamlib authors and the Hamlib Project.  While it is not a
requirement of the licenses, it is courteous to offer modifications back
to the Hamlib authors for possible incorporation into their official
release(s).
</p>

<hr>
<a name="Hamlib-in-a-Nutshell"></a>
<a name="Hamlib-in-a-Nutshell-1"></a>
<h2 class="chapter">1 Hamlib in a Nutshell</h2>
<a name="index-Nutshell"></a>

<p>The <em>Ham Radio Control Libraries</em>, <em>Hamlib</em> for short, is a
development effort to provide a consistent interface for programmers
wanting to incorporate radio and rotator control in their programs.
</p>
<p>Hamlib is not a complete user application, rather, it is a software
layer intended to make controlling various radios and other amateur
radio station (shack) hardware much easier.  Hamlib will allow authors
of software such as logging programs, digital communications programs,
or those wanting to develop the ultimate radio control software to
concentrate on the user interface and the basic function of the
program rather than radio control.  Hamlib consists of several parts,
the programming library, utility programs, and library interfaces to
other programming languages.
</p>
<p>Most recent amateur radio transceivers allow external control of their
functions through a serial interface.  Unfortunately, control commands
are not always consistent across a manufacturer&rsquo;s product line and
each manufacturer&rsquo;s product line differs greatly from its competitors.
</p>
<p>Hamlib attempts to solve this problem by presenting a &quot;virtual radio&quot;
to the programmer by providing an interface to actions such as setting
a given Variable Frequency Oscillator&rsquo;s (VFO) frequency, setting the
operating mode, querying the radio of its current status and settings,
and giving the application a list of a given radio&rsquo;s capabilities.
Unfortunately, what can be accomplished by Hamlib is limited by the
radios themselves and some offer very limited capability.
</p>
<p>Other devices, such as antenna rotators, can be placed into the Hamlib
control scheme.  Other recent developments include network interface
servers and a USB interface capability.  Language bindings are
provided for C, C++, Perl, Python, Lua and TCL (more to come).
</p>

<hr>
<a name="Overview"></a>
<a name="A-view-from-the-top-of-the-tower"></a>
<h3 class="section">1.1 A view from the top of the tower</h3>
<a name="index-Overview"></a>

<a name="index-Front-end-library"></a>
<a name="index-Virtual-radio"></a>
<a name="index-Virtual-rotator"></a>
<p>Hamlib is a <em>front end</em> library providing a <em>C</em> language
Application Programming Interface <acronym>API</acronym> to programmers wishing
to integrate radio or rotator control in their applications.  Hamlib
presents a <em>virtual radio</em> or <em>virtual rotator</em> that is a
consistent interface to an application despite wide differences in
radio and rotator interfaces and capabilities.
</p>
<a name="index-Back-end-library"></a>
<p>The front end library uses a number of <em>back end</em> libraries to
translate from the front end to the various individual radio and
rotator models.  A back end library handles conversion of the front
end variables to the format needed by the radio or rotator device it
controls.  The back end libraries are generally grouped by
manufacturer and in some cases by a common control protocol.
</p>
<blockquote>
<p>Since a picture is worth quite a few words, here is a visual representation
of Hamlib&rsquo;s design.
<br><br>
</p><div class="float"><a name="fig_003aimg1"></a>
<img src="Hamlib_design.png" alt="Hamlib Design">


<div class="float-caption"><p><strong>Figure 1.1: </strong>Hamlib design&mdash;<i>courtesy of Martin Ewing, AA6E</i>.</p></div></div><br>
</blockquote>

<a name="index-Scripting-languages"></a>
<a name="index-Languages_002c-scripting"></a>
<a name="index-Interface_002c-languages"></a>
<p>Hamlib also provides an interface library for each of several common
<em>scripting</em> languages such as <a href="http://www.perl.org">Perl</a>, <a href="http://www.python.org">Python</a>,
<a href="https://www.lua.org">Lua</a> and <a href="http://www.tcl.tk">TCL</a>.  These language <em>bindings</em> are generated through the use of
<a href="http://www.swig.org">SWIG</a> a parser/generator for multiple
language interfaces to a C library.  A native generated <em>C++</em>
language interface is also provided.
</p>
<a name="index-Daemon_002c-network"></a>
<a name="index-Network_002c-daemon"></a>
<p>Besides the C and supplemental APIs, Hamlib also provides a pair of
network daemons that provide a text command based API for controlling
an attached radio or rotator through a <em>TCP/IP</em> network
connection.  The daemons then handle the interface to the Hamlib C
API.
</p>
<p>More than one type of device, radio or rotator, may be controlled at a
time, however, there is generally a limit of one device per serial
port or other port.
</p>
<hr>
<a name="The-Hamlib-project"></a>
<a name="Hamlib-project-information"></a>
<h3 class="section">1.2 Hamlib project information</h3>
<a name="index-Hamlib-project"></a>
<a name="index-Project_002c-Hamlib"></a>

<p>The Hamlib Project was founded by Frank Singleton,VK3FCS/KM5WS in July
2000.  Shortly after Stephane Fillod, F8CFE, joined Frank on the
Hamlib project and the API and implementation development led to a
reasonable level of maturity in a few years.  A major milestone was
reached when Hamlib 1.2.0 was released in March 2004.  The API and
Application Binary Interface (<acronym>ABI</acronym>) interfaces have remained
stable since that time up to the latest release of 3.2 in early 2018.
</p>
<p>Development continues through the major version number 3.x and beyond.
While some API tweaks are planned, ABI compatibility with the prior
1.2.<i>x</i> releases remains a priority.  Other goals include
streamlining the build system (done), improving the SWIG generated
language bindings (done), improving the overall documentation (this
manual, in progress), and other updates as warranted.
</p>
<p>The Project is hosted by <a href="https://sourceforge.net/">SourceForge.net</a> at the <a href="https://sourceforge.net/projects/hamlib/">Hamlib project page</a>.  As <a href="https://github.com/">GitHub</a> has become
a very popular project hosting site, Hamlib also has a dedicated
<a href="https://github.com/Hamlib/Hamlib">GitHub project page</a>.  GitHub
also hosts the <a href="http://www.hamlib.org">hamlib.org</a> Web site and
the <a href="https://github.com/Hamlib/Hamlib/wiki">Hamlib Wiki</a>.
</p>
<p>Development discussion and most user support take place on the
<a href="https://sourceforge.net/p/hamlib/mailman/">hamlib-developer
mailing list</a>.  While there are
<a href="https://sourceforge.net/p/hamlib/discussion/">SourceForge.net
discussion forums</a>, they are rarely used and not as closely read by
the developers as the mailing list.
</p>
<p>For <em>source code management</em>, the project uses
<a href="http://git-scm.com/">Git</a>, a fast, distributed content tracker.
Among its features is that every developer has the complete Hamlib
development history available locally.  For more information on using
Git, see <a href="#Working-with-Git">Working with Git</a>.
</p>
<blockquote>
<p><b>Note:</b> While a canonical Git repository is hosted as SourceForge, its
availability is not essential to continued development, although
development work flows would change temporarily.  Several developers
find the GitHub Web interface easier to use and lately development has
centered around GitHub rather than SourceForge.
</p></blockquote>

<hr>
<a name="Applications-using-Hamlib"></a>
<a name="Applications-using-Hamlib-1"></a>
<h3 class="section">1.3 Applications using Hamlib</h3>
<a name="index-Hamlib-applications"></a>
<a name="index-Applications_002c-using-Hamlib"></a>

<p>A number of application developers have taken advantage of Hamlib&rsquo;s
capabilities to implement radio and/or rotator control.  While not
exhaustive, a list is maintained at the Hamlib Wiki,
<a href="https://github.com/Hamlib/Hamlib/wiki/Applications-and-Screen-Shots">Applications/Screenshots</a>.  Developers are encouraged to request their
applications be added to the gallery by way of the hamlib-developer
mailing list.
</p>
<hr>
<a name="Licensing-implications"></a>
<a name="Using-Hamlib-with-your-program"></a>
<h3 class="section">1.4 Using Hamlib with your program</h3>
<a name="index-Hamlib-licensing"></a>
<a name="index-Licensing_002c-Hamlib"></a>

<p>As with other Free Software projects, Hamlib relies heavily on
copyleft licensing to encourage development contributions and provide
an open atmosphere for development.  Hamlib&rsquo;s source code is released
under two licenses, the Lesser General Public License (<acronym>LGPL</acronym>)
for the library portion, and the General Public License
(<acronym>GPL</acronym>) for the utility programs.
</p>
<p>The LGPL allows the library to be used (linked) by programs regardless
of their individual license.  However, any contributions to the
library source remain under copyleft which means that the library
source code may not be used in violation of the terms of the LGPL.
</p>
<p>The utility program source files are released under the GPL.  Any direct
use of these sources must be in a form that complies with the terms of
the GPL.  Concepts learned by studying these sources for the purpose of
understanding the Hamlib API is not covered nor prohibited by the GPL,
however, directly copying GPL sources into any work that is incompatible
with the terms of the GPL is prohibited.
</p>
<p>See <a href="#Copying-and-Redistribution">Copying and Redistribution</a>.
</p>
<hr>
<a name="Radio-cloning"></a>
<a name="Radios-with-a-clone-capability"></a>
<h3 class="section">1.5 Radios with a clone capability</h3>
<a name="index-Radio-cloning"></a>
<a name="index-Cloning_002c-radio"></a>

<p>Hamlib&rsquo;s focus is on controlling rigs that employ a port and command
protocol for setting frequency, mode, VFO, PTT, etc.  Most VHF/UHF
transceivers do not employ such control capability but do provide for
cloning the memory contents from radio to another of the same model.
A related project, <a href="http://chirp.danplanet.com/">CHIRP</a>, aims to
support radios with such a clone capability.  Please contact the CHIRP
project for support of such radios.
</p>
<hr>
<a name="Pronunciation"></a>
<a name="Pronouncing-Hamlib"></a>
<h3 class="section">1.6 Pronouncing Hamlib</h3>
<a name="index-Pronouncing-Hamlib"></a>
<a name="index-Hamlib_002c-pronouncing"></a>

<p>English speakers seem to have two alternate pronunciations for our
project:
</p>
<ul>
<li> Hamlib (Ham - lib, long &quot;i&quot;, as in library.) IPA style: /&rsquo;ham læb/
</li><li> Hamlib (Ham - lib, short &quot;i&quot;, as in liberty.) IPA style: /&rsquo;ham lɪb/
</li></ul>

<p>Then again, we have people who say Linux &quot;L-eye-nux&quot; and those who say
&quot;L-in-nux&quot;...
</p>
<p>If you&rsquo;re French, the above does not apply! :-)
</p>
<hr>
<a name="Getting-started"></a>
<a name="Getting-started-1"></a>
<h2 class="chapter">2 Getting started</h2>

<p>There are several ways to obtain a working installation of Hamlib.
The following sections discuss installing from a package manager,
building from source, and installing Hamlib project supplied binaries
on Microsoft Windows&reg;.
</p>

<hr>
<a name="Unix-binary-packages"></a>
<a name="Installing-binary-packages-on-Linux-and-BSD"></a>
<h3 class="section">2.1 Installing binary packages on Linux and BSD</h3>
<a name="index-Binary-packages_002c-Linux_002c-BSD"></a>
<a name="index-Linux-binary-packages"></a>
<a name="index-BSD-binary-packages"></a>

<p>The easiest way to install a released version of Hamlib on a Linux
based distribution or a BSD variant is through the provided
<em>package manager</em>.  While package managers vary according to the
distribution (it&rsquo;s easy to lump BSD variants in this group too) their
end goal is to provide ready to use software packages.  Since such a
wide variety of package managers exist, it is best to recommend that
the documentation for your chosen distribution be your guide.
</p>

<hr>
<a name="Source-options"></a>
<a name="A-variety-of-Hamlib-sources"></a>
<h3 class="section">2.2 A variety of Hamlib sources</h3>
<a name="index-Source-options"></a>

<p>Distribution packages are most often official Hamlib releases and in
some cases could be quite old and lacking support for newer radios or
rotators.  In some cases support is improved in existing radio or
rotator back ends and bugs are fixed in newer releases.  Often times
to get the improved support/bug fixes, building from source will be
required.  Relax, it&rsquo;s not hard.  :-)
</p>
<p>Source code is available as official releases, testing snapshots,
daily development snapshots, and the bleeding edge of development
directly from the <a href="https://github.com/Hamlib/Hamlib">Git
repository</a>.  As a rule, even the bleeding edge tarballs should
configure and compile without error even though certain implementation
work may be in progress and may be incomplete or have errors.
</p>

<hr>
<a name="Source-releases"></a>
<a name="Getting-released-source"></a>
<h4 class="subsection">2.2.1 Getting released source</h4>
<a name="index-Getting-released-source"></a>
<a name="index-Source_002c-getting-released"></a>
<a name="index-Source_002c-obtaining-releases"></a>

<p>Official Hamlib source releases, commonly called <em>tarballs</em> can be
found on the
<a href="http://sourceforge.net/projects/hamlib/files/hamlib/">SourceForge.net Hamlib files</a> Web page.  As a convenience, release
archives are also mirrored at the
<a href="https://github.com/Hamlib/Hamlib/releases">GitHub Hamlib
releases</a> page.  The most recent release is listed first.
</p>
<hr>
<a name="Source-snapshots"></a>
<a name="Getting-source-snapshots"></a>
<h4 class="subsection">2.2.2 Getting source snapshots</h4>
<a name="index-Getting-source-snapshots"></a>
<a name="index-Source_002c-getting-snapshots"></a>
<a name="index-Source_002c-obtaining-snapshots"></a>
<a name="index-Source_002c-daily-snapshots"></a>
<a name="index-Source_002c-release-candidates"></a>
<a name="index-Source_002c-RC"></a>

<p>Testing release candidates (RCs) are posted during the period (often a
few weeks) before a planned release.  Beginning with the 3.2 release,
RCs are hosted by the <a href="https://github.com/Hamlib/Hamlib/releases">GitHub release archive</a>.  RCs are identifed by having a <i>~rc</i>
suffix.
</p>
<p>Daily snapshots of the development repository are available via the
World Wide Web from <a href="http://n0nb.users.sourceforge.net/">Hamlib
Git daily snapshots</a>.  These are not official releases but are
provided for testing new features and bug fixes.
</p>
<p>The daily development snapshot is made and posted each day by around
1030 UTC.  Daily snapshots <i>should</i> compile but sometimes a bug
creeps in that prevents compilation.  If that should happen, please
report it to the <a href="mailto:hamlib-developer@lists.sourceforge.net">hamlib-developer mailing list</a>.
</p>
<hr>
<a name="Git-clone"></a>
<a name="Git-repository"></a>
<h4 class="subsection">2.2.3 Git repository</h4>
<a name="index-Git-repository"></a>
<a name="index-Git-clone"></a>

<p>The source repository can be <em>cloned</em> which copies the repository
to your computer including its entire history, branches, and release
tag information.  In other words, once the <code>git</code>
<samp>clone</samp> command is finished a complete copy of the Hamlib
development will be on your computer.  You can do quite a lot with
this as nothing is hidden from view since the entire
history of Hamlib is right there all the way from the very first
commit to the present.  None of the meta-data is hidden away on
some central server.
</p>
<p>To clone the repository use the following command:
</p>
<div class="example">
<pre class="example">git clone git://git.code.sf.net/p/hamlib/code hamlib
</pre></div>

<p>or:
</p>
<div class="example">
<pre class="example">git clone https://github.com/Hamlib/Hamlib.git
</pre></div>

<p>Odds are that you will want to run the above command in a sub
directory of your home directory.  The <samp>hamlib</samp> directory will be
created by Git and the <em>master</em> branch will be checked out for you
as the <em>working copy</em>.  The master branch is one of several
branches used in Hamlib development.  It is the main branch of new
features and bug fixes.  The working copy will be the latest revision
of every file at the time of the clone.  Later updates from the
developers will require using another Git command to update your local
repository.
</p>
<p>See <a href="#Working-with-Git">Working with Git</a>.
</p>
<hr>
<a name="Building-from-source"></a>
<a name="Building-from-source-1"></a>
<h3 class="section">2.3 Building from source</h3>
<a name="index-Building-from-source"></a>
<a name="index-Source_002c-building-from"></a>

<p>Building from source will be required for various reasons.  Perhaps
only an older release is provided by your distribution, or you would
like to test recent changes to Hamlib&mdash;either a specific back end or
API changes&mdash;and offer a report to the developers, or you&rsquo;d like to
take part in development and offer your contribution to the project,
or you&rsquo;d just like to learn how to build a relatively comprehensive
package from source.  Any is a good reason to build from the source
code archive.
</p>
<p>Before going further, this manual assumes familiarity with working
from the command prompt in a Linux/BSD/Unix like system&rsquo;s <em>shell</em>
environment, either in a <em>virtual console</em> (a text only screen
with no graphics) or in a <em>terminal</em> in a desktop environment
(<code>xterm</code>, <code>rxvt</code>, <code>konsole</code>,
<code>gnome-terminal</code>, <code>xfce4-terminal</code>,
<code>terminal</code>, etc.).  If this is new to you, take some time and
read up on using the shell.  A good tutorial can be found at
<a href="http://linuxcommand.org/">LinuxCommand.org</a> which also offers an
in-depth book that can be purchased or downloaded for no cost (the
Hamlib project is not associated with nor has any interest in the sale
of this book, it just looks like a very good effort on the part of its
author).
</p>
<p>Let&rsquo;s get started.
</p>

<hr>
<a name="Compiling-source-tarballs"></a>
<a name="Compiling-source-tarballs-1"></a>
<h4 class="subsection">2.3.1 Compiling source tarballs</h4>
<a name="index-Compiling-source-tarballs"></a>
<a name="index-Source-tarballs_002c-compiling"></a>

<p>Before proceeding, it is essential to read the information in the
files, <samp>README</samp>, <samp>INSTALL</samp>, and <samp>README.betatester</samp>
supplied in the Hamlib <em>top-level</em> directory which will be named
something like <samp>hamlib-3.3~git</samp> where the latter part is the
release version.  In this case the &lsquo;<samp>3.3~git</samp>&rsquo; indicates this is a
development snapshot of the Git master branch.  These files provide
detailed information for compiling Hamlib and will vary some from
release to release.
</p>
<p>Compiling from a source tarball whether it is an official release or a
testing or daily development snapshot follows the same set of
commands, known as the <em>three step</em> which are each run from the
top-level directory:
</p>
<div class="example">
<pre class="example">./configure
make
sudo make install
</pre></div>


<hr>
<a name="configure"></a>
<a name="configure-1"></a>
<h4 class="subsubsection">2.3.1.1 <code>configure</code></h4>
<a name="index-configure"></a>

<p>The <code>./configure</code> command examines your system and checks it
for any packages that are required or good to have options for
compiling Hamlib.  The leading <samp>./</samp> tells the shell to only run
the <code>configure</code> command found in the current directory.  It is
always possible that a <code>configure</code> command could be lurking
elsewhere and we don&rsquo;t want to run that!
</p>
<p>Run:
</p>
<div class="example">
<pre class="example"><code>./configure</code>
</pre></div>

<p>from the top-level directory.
</p>
<blockquote>
<p><b>Note:</b> Some distributions are configured so commands can only be run from
directories listed in the <code>PATH</code> environment variable.  The
<samp>./</samp> is necessary or the <code>configure</code> command will not be
run as the <em>current directory</em> (defined as <samp>.</samp>) is not in the
<code>PATH</code>.  This is considered a default security feature so that
only programs provided by the distribution are run.  <code>PATH</code> can be
modified for your own session, but that is a topic for the
LinuxCommand.org reference above.
</p></blockquote>

<p>Of course, things are usually complicated a bit by options and Hamlib
is no exception.  The good news is that the defaults, i.e., no
options, work well in most situations.  Options are needed to enable
the compilation of certain portions of Hamlib such as the language
bindings.  Optional features usually require that more development
tools are installed.  The <samp>INSTALL</samp>, and <samp>README.betatester</samp>
files in the Hamlib top-level directory will have details on the
options available for that release.
</p>
<p>A useful option is &lsquo;<samp>--prefix</samp>&rsquo; which tells <code>configure</code>
where in the file system hierarchy Hamlib should be installed.  If it
is not given, Hamlib will be installed in the <samp>/usr/local</samp> file
system hierarchy.  Perhaps you want to install to your home directory
instead:
</p>
<div class="example">
<pre class="example"><code>./configure --prefix=$HOME/local</code>
</pre></div>

<blockquote>
<p><b>Note:</b> For practice you may wish to start out using the
&lsquo;<samp>--prefix=$HOME/local</samp>&rsquo; option to install the Hamlib files into
your home directory and avoid overwriting any version of Hamlib
installed into the system directories.  The code examples in the
remainder of this manual will assume Hamlib has been installed to
&lsquo;<samp>$HOME/local</samp>&rsquo;.
</p></blockquote>

<p>All of the files will be installed in the <samp>local</samp> directory of
your home directory.  <samp>local</samp> will be created if it does not
exist during installation as will several other directories in it.
Installing in your home directory means that <em>root</em>, or superuser
(administrator) privileges are not required when running <code>make
install</code>.  On the other hand, some extra work will need to be done so
other programs can use the library.
</p>

<p>Another useful option is &lsquo;<samp>--help</samp>&rsquo; which will give a few screens
full of options for <code>configure</code>.  If in a desktop environment
the scroll bar can be used to scroll back up through the output.  In
either a terminal or a virtual console Linux supports the
<tt class="key">Shift-PageUp</tt> key combination to scroll back up.  Converesely
<tt class="key">Shift-PageDown</tt> can be used to scroll down toward the end of the
output and the shell prompt (Shift-UpArrow/Shift-DownArrow may also
work to scroll one line at a time).
</p>
<p>After a fair amount of time, depending on your computer, and a lot of
screen output, <code>configure</code> will finish its job.  So long as
the few lines previous to the shell prompt don&rsquo;t say &ldquo;error&rdquo; or some
such failure message Hamlib is ready to be compiled.  If there is an
error and all of the required packages listed in
<samp>README.betatester</samp> have been installed, please ask for help on
the <a href="mailto:hamlib-developer@lists.sourceforge.net">hamlib-developer
mailing list</a>.
</p>
<hr>
<a name="make"></a>
<a name="make-1"></a>
<h4 class="subsubsection">2.3.1.2 <code>make</code></h4>
<a name="index-make"></a>

<p>The <code>make</code> command is responsible for running the
<em>compiler</em> which reads the source files and from the instructions
it finds in them writes <em>object</em> files which are the binary
instructions the <acronym>CPU</acronym> of a computer can execute.
<code>make</code> then calls the <em>linker</em> which puts the object files
together in the correct order to create the Hamlib library files and
its executable programs.
</p>
<p>Run:
</p>
<div class="example">
<pre class="example"><code>make</code>
</pre></div>

<p>from the top-level directory.
</p>
<p>Any error that causes <code>make</code> to stop early is cause for a
question to the <a href="mailto:hamlib-developer@lists.sourceforge.net">hamlib-developer mailing list</a>.
</p>
<p>In general <code>make</code> will take longer than <code>configure</code> to
complete its run.  As it is a system command and therefore found in
the <code>PATH</code>, prefixing <code>make</code> with <samp>./</samp> will cause a
&lsquo;<samp>command not found</samp>&rsquo; error from the shell.
</p>
<hr>
<a name="make-install"></a>
<a name="make-install-1"></a>
<h4 class="subsubsection">2.3.1.3 <code>make install</code></h4>
<a name="index-make-install"></a>

<p>Assuming that you have not set the installation prefix to your home
directory, root (administrator) privileges will be required to install
Hamlib to the system directories.  Two popular methods exist for
gaining root privileges, <code>su</code> and <code>sudo</code>.
<code>sudo</code> is probably the most popular these days, particularly
when using the <a href="http://www.ubuntu.com">Ubuntu</a> family of
distributions.
</p>
<p>Run:
</p>
<div class="example">
<pre class="example"><code>sudo make install</code>
</pre></div>

<p>as root from the top-level directory.
</p>
<p>Running <code>make install</code> will call the installer to put all of
the newly compiled files and other files (such as this document) in
predetermined places set by the &lsquo;<samp>--prefix</samp>&rsquo; option to
<code>configure</code> in the directory hierarchy (yes, this is by design
and <code>make</code> is not just flinging files any old place!).
</p>
<p>A lot of screen output will be generated.  Any errors will probably be
rather early in the process and will likely be related to your
<var>username</var> not having write permissions in the system directory
structure.
</p>
<hr>
<a name="ldconfig"></a>
<a name="ldconfig-1"></a>
<h4 class="subsubsection">2.3.1.4 <code>ldconfig</code></h4>
<a name="index-ldconfig"></a>

<p>Once the installation is complete one more step is required if Hamlib
has never been installed from a local build before.  The
<code>ldconfig</code> command tells the system library loader where to
find the newly installed Hamlib libraries.  It too will need to be run
with root privileges:
</p>
<p>Run:
</p>
<div class="example">
<pre class="example"><code>sudo ldconfig</code>
</pre></div>

<p>as root from any directory.
</p>
<blockquote>
<p><b>Note:</b> Subsequent installations of Hamlib will not need to have
<code>ldconfig</code> run after each installation if a newer major
version of Hamlib was not installed, i.e. when recompiling the same
version during development.
</p></blockquote>

<p>On some distributions a bit of configuration will be needed before
<code>ldconfig</code> will add locally compiled software to its database.
Please consult your distribution&rsquo;s documentation.
</p>
<hr>
<a name="Bootstrapping-from-a-Git-clone"></a>
<a name="Bootstrapping-from-a-git-clone"></a>
<h4 class="subsection">2.3.2 Bootstrapping from a <code>git clone</code></h4>
<a name="index-Bootstrapping-from-a-Git-clone"></a>
<a name="index-Git-clone_002c-bootsrapping"></a>

<p>Choosing to build from from a <code>git clone</code> requires a few more
development tools (notice a theme here?) as detailed in
<samp>README.developer</samp>.  The most critical will be the GNU Autotools
(<code>autoconf</code>, <code>automake</code>, <code>libtool</code>, and more)
from which the build system consisting of <samp>configure</samp>, the
various <samp>Makefile.in</samp>s throughout the directory structure, and
the final <samp>Makefile</samp>s are generated.
</p>
<p>In the top-level directory is the <code>bootstrap</code> script from
which the build system is <em>bootsrapped</em>&mdash;the process of
generating the Hamlib build system from <samp>configure.ac</samp> and the
various <samp>Makefile.am</samp>s.  At its completion the
<code>configure</code> script will be present to configure the build
system.
</p>
<p>Next <code>configure</code> is run with any needed build options
(<code>configure --help</code> is useful) to enable certain features or
provide paths for locating needed build dependencies, etc.
Environment variables intended for the preprocessor and/or compiler
may also be set on the <code>configure</code> command line.
</p>
<p>After the configuration is complete, the build may proceed with the
<code>make</code> step as for the source tarballs above.  Or
<code>configure --help</code> may be run, and <code>configure</code> run
again with specific options in which case the <samp>Makefile</samp>s will be
regenerated and the build can proceed with the new configuration.
</p>
<p>See <a href="#configure">configure</a>.
</p>
<hr>
<a name="Other-make-targets"></a>
<a name="Other-make-targets-1"></a>
<h4 class="subsection">2.3.3 Other <code>make</code> targets</h4>
<a name="index-Other-make-targets"></a>
<a name="index-make_002c-other-targets"></a>

<p>Besides <code>make install</code>, other <em>targets</em> exist when running
<code>make</code>.  Running <code>make clean</code> from the top-level
directory removes all of the generated object and executable files
generated by running <code>make</code> freeing up considerable disk
space.
</p>
<blockquote>
<p><b>Note:</b> During development of individual source files, it is not necessary to
run <code>make clean</code> each time before <code>make</code>.  Simply run
<code>make</code> and only the modified file(s) and any objects that
depend on them will be recompiled.  This speeds up development time
considerably.
</p></blockquote>

<p>To remove even the generated <samp>Makefile</samp>s, run <code>make
distclean</code> from the top-level directory.  After this target is run,
<code>configure</code> will need to be run again to regenerate the
<samp>Makefile</samp>s.  This command may not be as useful as the
<samp>Makefile</samp>s do not take up much space, however it can be useful
for rebuilding the <samp>Makefile</samp>s when modifying a
<samp>Makefile.am</samp> or <samp>confgure.ac</samp> during build system
development.
</p>
<hr>
<a name="Parallel-build-trees"></a>
<a name="Parallel-build-trees-1"></a>
<h4 class="subsection">2.3.4 Parallel build trees</h4>
<a name="index-Parallel-build-trees"></a>
<a name="index-Build_002c-parallel-trees"></a>

<p>One feature of the GNU build system used by Hamlib is that the object
files can be kept in a directory structure separate from the source
files.  While this has no effect on the <code>make</code> targets
described above, it does help the developer find files in the source
tree!  One such way of using parallel builds is described in
<samp>README.developer</samp>.
</p>
<p>Parallel builds can be very useful as one build directory can be
configured for a release and another build directory can be configured
for debugging with different options passed to <code>configure</code>
from each directory.  The generated <samp>Makefile</samp>s are unique to
each build directory and will not interfere with each other.
</p>
<hr>
<a name="Adding-debugging-symbols"></a>
<a name="Adding-debugging-symbols-1"></a>
<h4 class="subsection">2.3.5 Adding debugging symbols</h4>
<a name="index-Adding-debugging-symbols"></a>

<p>When additional debugging symbols are needed with, for example, the
GNU Debugger, <code>gdb</code>, the needed compiler and linker options
are passed as environment variables.
</p>
<p>Run:
</p><div class="example">
<pre class="example"><code>../hamlib/configure CFLAGS=&quot;-ggdb3 -O0&quot; CXXFLAGS=&quot;-ggdb3 -O0&quot;</code>
</pre></div>

<p>from a sibling build directory intended for a debugging build.
</p>
<p>The &lsquo;<samp>-ggdb3</samp>&rsquo; option tells the C compiler, this case the GNU C
Compiler, <code>gcc</code>, to add special symbols useful for GDB, the
GNU debugger.  The &lsquo;<samp>-O0</samp>&rsquo; option tells <code>gcc</code> to turn off
all optimizations which will make it easier to follow some variables
that might otherwise be optimized away.  &lsquo;<samp>CFLAGS</samp>&rsquo; and
&lsquo;<samp>CXXFLAGS</samp>&rsquo; may be set independently for each compiler.
</p>
<blockquote>
<p><b>Note:</b> There are a number compiler options available for controlling debugging
symbols and setting optimization levels.  Please consult the compiler&rsquo;s
manual for all the details.
</p></blockquote>

<hr>
<a name="Compiling-Microsoft-Windows"></a>
<a name="Compiling-for-Microsoft-Windows"></a>
<h4 class="subsection">2.3.6 Compiling for Microsoft Windows</h4>
<a name="index-Compiling-for-Microsoft-Windows"></a>
<a name="index-Microsoft-Windows_002c-compiling"></a>

<p>Currently compiling is done on a Debian 8 (Jessie) virtual machine
using <a href="http://www.mingw.org/">MinGW</a>.  <samp>README.build-win32</samp>
in the <samp>scripts</samp> directory has details on how this is
accomplished.
</p>
<p>Work is ongoing to correct build issues in the
<a href="http://www.cygwin.com/">Cygwin</a> environment running on MS
Windows.
</p>
<hr>
<a name="Microsft-Windows-binaries"></a>
<a name="Pre_002dcompiled-binaries-for-Microsoft-Windows"></a>
<h3 class="section">2.4 Pre-compiled binaries for Microsoft Windows</h3>
<a name="index-Pre_002dcompiled-binaries-for-Microsoft-Windows"></a>
<a name="index-Microsoft-Windows_002c-compiled-binaries"></a>
<a name="index-Microsoft-Windows_002c-pre_002dcompiled-binaries"></a>

<p>Pre-compiled binaries for Microsoft Windows 32 and 64 bit
architectures (Windows NT and newer) are available for both official
releases and daily development snapshots.  Official releases are
available through the
<a href="http://sourceforge.net/projects/hamlib/files/hamlib/">SourceForge.net file download service</a>.  As an alternative, official
releases are also available though the
<a href="https://github.com/Hamlib/Hamlib/releases">Hamlib archive at
GitHub</a>.  Daily development snapshots are available from
<a href="http://n0nb.users.sourceforge.net/">http://n0nb.users.sourceforge.net/</a>.
</p>
<p>Beginning with the Hamlib 1.2.15.3 release a self-extracting installer
is available.  Among its features are selecting which portions of
Hamlib are installed.  The <code>PATH</code> environment variable will need
to be set manually per the included <samp>README.w32-bin</samp> or
<samp>README.w64-bin</samp> file.
</p>
<p>Daily development snapshots feature both a .ZIP archive and the self
extracting installer.
</p>
<p>Bug reports and questions about these archives should be sent to the
<a href="mailto:hamlib-developer@lists.sourceforge.net">hamlib-developer
mailing list</a>.
</p>
<hr>
<a name="Utility-programs"></a>
<a name="Utility-programs-reference"></a>
<h2 class="chapter">3 Utility programs reference</h2>

<p>Included with the Hamlib distribution are several utility programs.
Besides providing a way for developers to test new code and bug fixes,
the programs also offer a reference implementation for interfacing to
the Hamlib library functions both through the C API (Application
Programming Interface) and offering a network accessible API.
</p>
<p>This chapter focuses on the two test programs, <code>rigctl</code> for
testing radio back ends and <code>rotctl</code> for testing rotator back
ends and the two network daemons, <code>rigctld</code> and
<code>rotcltd</code> for radio and rotator access via network sockets.
Also included are three demonstation utilities, <code>rigmem</code>,
<code>rigsmtr</code>, and <code>rigswr</code> which provide functional
examples of how Hamlib may be used to accomplish various tasks.
</p>


<hr>
<a name="rigctl"></a>
<a name="rigctl-1"></a>
<h3 class="section">3.1 <code>rigctl</code></h3>
<a name="index-rigctl"></a>

<p><code>rigctl</code> is the most frequently used Hamlib utility.  As the
other ctl utilities share many of the same characteristics, much of
the introductory information presented in this section is applicable
to the other utility programs.
</p>

<hr>
<a name="Introduction-to-rigctl"></a>
<a name="Introduction-to-rigctl-1"></a>
<h4 class="subsection">3.1.1 Introduction to <code>rigctl</code></h4>
<a name="index-Introduction-to-rigctl"></a>
<a name="index-rigctl_002c-introduction-to"></a>

<p>Most likely the first of the Hamlib utility programs that is used is
<code>rigctl</code>.  <code>rigctl</code> is a character based interactive
program and a command line program able to set or query a radio&rsquo;s
value with a single command.  <code>rigctl</code> is invoked from a shell
command prompt with various options and additional commands.
</p>
<p>In its most simple use as a <em>command line</em> program,
<code>rigctl</code> is used to set frequency and mode by typing commands
after any <code>rigctl</code> options:
</p>
<div class="example">
<pre class="example"><kbd>rigctl F 14205000</kbd>
<kbd>rigctl M USB 2400</kbd>
</pre></div>

<p>and then query those values:
</p>
<div class="example">
<pre class="example"><kbd>rigctl f</kbd>
<kbd>rigctl m</kbd>
</pre></div>

<p>Entering interactive mode is a simple matter of not placing any
commands after any <code>rigctl</code> options:
</p>
<div class="example">
<pre class="example"><kbd>rigctl</kbd>
</pre></div>

<p>Entering <em>interactive mode</em> allows successive commands to be
entered without exiting <code>rigctl</code>.  Recent additions to
<code>rigctl</code> allow command editing and history recall through use
of the <a href="https://tiswww.case.edu/php/chet/readline/rltop.html">Readline</a> library.
</p>
<p>Interactive mode is indicated by the spartan prompt:
</p>
<div class="example">
<pre class="example">Rig command:
</pre></div>

<p>Commands are given at the prompt and follow the general rule that
upper case letters set a value and lower case letters query a value:
</p>
<div class="example">
<pre class="example">Rig command: <kbd>M</kbd>
Mode: <kbd>USB</kbd>
Passband: <kbd>2500</kbd>

Rig command: <kbd>m</kbd>
Mode: USB
Passband: 2500

Rig command:
</pre></div>

<p>An additional prompt is printed when more information is required by
the command.  For <kbd>M</kbd> above, <code>rigctl</code> prompted for the
&ldquo;Mode&rdquo; and &ldquo;Passband&rdquo; values.  For <kbd>m</kbd> above, <code>rigctl</code>
returned the &ldquo;Mode&rdquo; and &ldquo;Passband&rdquo; values without further prompts.
The command prompt is returned after each command invocation.
</p>
<p>The above examples invoked <code>rigctl</code> without specifying a radio
model.  This is a feature where the Hamlib internal radio <em>dummy</em> is
used instead.  The dummy radio provides a way to test Hamlib functions
with out the need for actual radio hardware.  However, to develop back
end capability for a given radio, having the actual radio connected to
the computer is necessary for debugging.
</p>
<p>For example, to quickly set frequency on an Elecraft K3:
</p>
<div class="example">
<pre class="example"><kbd>rigctl -m 229 -r /dev/rig F 3900000</kbd>
</pre></div>

<p>and to query the frequency and then mode:
</p>
<div class="example">
<pre class="example"><kbd>rigctl -m 229 -r /dev/rig f</kbd>
3900000

<kbd>rigctl -m 229 -r /dev/rig m</kbd>
LSB
2000
</pre></div>

<p>The returned values do not have the prompt strings associated with
interactive mode as shown above.
</p>
<p>The <samp>-m</samp> option takes a numeric value that corresponds to a
given radio back end model.  The <samp>-r</samp> option takes the path to
the port device on <acronym>POSIX</acronym> and the device name on Microsoft
Windows.
</p>
<blockquote>
<p><b>Note:</b> A complete list of supported radio models may be seen by use of the
<samp>-l</samp> option:
</p>
<div class="example">
<pre class="example"><kbd>rigctl -l</kbd>
 Rig #  Mfg              Model         Version    Status
     1  Hamlib           Dummy         0.5        Beta
     2  Hamlib           NET rigctl    0.3        Beta
   101  Yaesu            FT-847        0.5        Beta
   103  Yaesu            FT-1000D      0.0.6      Alpha
.
.
.
  2702  Rohde&amp;Schwarz    EB200         0.1        Untested
  2801  Philips/Simoco   PRM8060       0.1        Alpha
  2901  ADAT www.adat.ch ADT-200A      1.36       Beta
</pre></div>

<p>The list is long so use <kbd><span class="key">SHIFT</span>-PageUp</kbd>/
<kbd><span class="key">SHIFT</span>-PageDown</kbd> on Linux, <kbd><span class="key">ScrollLock</span></kbd> then
<kbd><span class="key">PageUp</span></kbd>/<kbd><span class="key">PageDown</span></kbd> on Free BSD, or use the
scrollbar to the virtual terminal window (<code>cmd</code> window on
Microsoft Windows) or the output can be piped to &rsquo;<code>more</code>&rsquo; or
&rsquo;<code>less</code>&rsquo;, e.g. &rsquo;<kbd>rigctl -l | more</kbd>&rsquo; to scroll back up
the list.  The list is sorted numerically by model number since Hamlib
1.2.15.1.  Model numbers of a manufacturer/protocol family are
grouped together.
</p></blockquote>

<hr>
<a name="rigctl-reference"></a>
<a name="rigctl-reference-1"></a>
<h4 class="subsection">3.1.2 <code>rigctl</code> reference</h4>
<a name="index-rigctl-reference"></a>
<a name="index-reference_002c-rigctl"></a>

<p>The complete reference for <code>rigctl</code> can be found in the
<kbd>rigctl</kbd>(1) Unix manual page.
</p>

<hr>
<a name="rotctl"></a>
<a name="rotctl-1"></a>
<h3 class="section">3.2 <code>rotctl</code></h3>
<a name="index-rotctl"></a>

<p>Identical in function to <code>rigctl</code>, <code>rotctl</code> provides a
means for testing Hamlib functions useful for rotator control and
<acronym>QTH</acronym> (Maidenhead gridsquare system, see
<a href="https://en.wikipedia.org/wiki/Maidenhead_Locator_System">Maidenhead Locator System</a>) locator computations.  As rotators have a
much narrower scope than radios, there are fewer command line options
and commands for <code>rotctl</code>.
</p>

<hr>
<a name="Introduction-to-rotctl"></a>
<a name="Introduction-to-rotctl-1"></a>
<h4 class="subsection">3.2.1 Introduction to <code>rotctl</code></h4>
<a name="index-Introduction-to-rotctl"></a>
<a name="index-rotctl_002c-introduction-to"></a>

<p><code>rotctl</code> is a character based interactive program and a
command line program able to set or query a rotator&rsquo;s value with a
single command.  <code>rotctl</code> is invoked from a shell command
prompt with various options and additional commands.
</p>
<p>In its most simple use as a command line program, <code>rotctl</code> is
used to set frequency and mode by typing commands after any
<code>rotctl</code> options:
</p>
<div class="example">
<pre class="example"><kbd>rotctl P 145.0 23.0</kbd>
<kbd>rotctl M 8 25</kbd>
</pre></div>

<p>and then query those values:
</p>
<div class="example">
<pre class="example"><kbd>rotctl p</kbd>
</pre></div>

<p>Entering interactive mode is a simple matter of not placing any
commands after any <code>rotctl</code> options:
</p>
<div class="example">
<pre class="example"><kbd>rotctl</kbd>
</pre></div>

<p>Entering interactive mode allows successive commands to be entered
without exiting <code>rotctl</code>.  Interactive mode allows for command
editing and history recall through the use of the <a href="https://tiswww.case.edu/php/chet/readline/rltop.html">Readline</a>
library.
</p>
<p>Interactive mode is indicated by the spartan prompt:
</p>
<div class="example">
<pre class="example">Rotator command:
</pre></div>

<p>Commands are given at the prompt:
</p>
<div class="example">
<pre class="example">Rotator command: <kbd>M</kbd>
Direction: 16
Speed: 60

Rotator command: <kbd>p</kbd>
Azimuth: 11.352000
Elevation: 0.000000

Rotator command: <kbd>p</kbd>
Azimuth: 27.594000
Elevation: 0.000000

Rotator command:
</pre></div>

<p>An additional prompt is printed when more information is required by
the command.  For <kbd>M</kbd> above, <code>rotctl</code> prompted for the
&ldquo;Direction&rdquo; and &ldquo;Speed&rdquo; values.  For <kbd>p</kbd> above,
<code>rotctl</code> returned the &ldquo;Azimuth&rdquo; and &ldquo;Elevation&rdquo; values
without further prompts.  The command prompt is returned after each
command invocation.
</p>
<p>The above examples invoked <code>rotctl</code> without specifying a
rotator model.  This is a feature where the Hamlib internal rotator
dummy is used instead.  The dummy rotator provides a way to test
Hamlib functions with out the need for actual rotator hardware.
However, to develop back end capability for a given rotator, having
the actual controller connected to the computer is necessary for
debugging.
</p>
<p>For example, to quickly set position for RotorEZ:
</p>
<div class="example">
<pre class="example"><kbd>rotctl -m 401 -r /dev/rotor P 100.0 0.0</kbd>
</pre></div>

<p>and to query the position:
</p>
<div class="example">
<pre class="example"><kbd>rotctl -m 401 -r /dev/rotor p</kbd>
100.000000
0.000000

</pre></div>

<p>The returned values do not have the prompt strings associated with
interactive mode as shown above.
</p>
<p>The <samp>-m</samp> option takes a numeric value that corresponds to a
given rotator back end model.  The <samp>-r</samp> option takes the path to
the port device on <acronym>POSIX</acronym> or the device name on MS Windows.
</p>
<blockquote>
<p><b>Note:</b> A complete list of supported radio models may be seen by use of the
<samp>-l</samp> option:
</p>
<div class="example">
<pre class="example"><kbd>rotctl -l</kbd>
 Rot #  Mfg              Model         Version    Status
     1  Hamlib           Dummy         0.5        Beta
     2  Hamlib           NET rotctl    0.3        Beta
   201  Hamlib           EasycommI     0.3        Beta
   202  Hamlib           EasycommII    0.3        Beta
.
.
.
  1201  AMSAT            IF-100        0.1        Untested
  1301  LA7LKA           ts7400        0.1        Beta
  1401  Celestron        NexStar       0.1        Untested
</pre></div>

<p>The list is long so use <kbd><span class="key">SHIFT</span>-PageUp</kbd>/
<kbd><span class="key">SHIFT</span>-PageDown</kbd> on Linux, <kbd><span class="key">ScrollLock</span></kbd> then
<kbd><span class="key">PageUp</span></kbd>/<kbd><span class="key">PageDown</span></kbd> on Free BSD, or use the
scrollbar to the virtual terminal window (<code>cmd</code> window on MS
Windows) or the output can be piped to &rsquo;<code>more</code>&rsquo; or
&rsquo;<code>less</code>&rsquo;, e.g. &rsquo;<kbd>rotctl -l | more</kbd>&rsquo; to scroll back up
the list.  The list is sorted numerically by model number since Hamlib
1.2.15.1.  Model numbers of a manufacturer/protocol family are grouped
together.
</p></blockquote>


<hr>
<a name="rotctl-reference"></a>
<a name="rotctl-reference-1"></a>
<h4 class="subsection">3.2.2 <code>rotctl</code> reference</h4>
<a name="index-rotctl-reference"></a>
<a name="index-reference_002c-rotctl"></a>

<p>The complete reference for <code>rotctl</code> can be found in the
<kbd>rotctl</kbd>(1) Unix manual page.
</p>

<hr>
<a name="rigctld"></a>
<a name="rigctld-1"></a>
<h3 class="section">3.3 <code>rigctld</code></h3>
<a name="index-rigctld"></a>

<p>The <code>rigctld</code> program is a network server that accepts the
familiar commands of <code>rigctl</code> and provides the response data
over a <acronym>TCP/IP</acronym> network socket to an application.  In this
manner an application can access a <code>rigctld</code> instance from
nearly anywhere (caveat, no security is currently provided by
<code>rigctld</code>).  Applications using <code>rigctld</code> do not link
directly to Hamlib nor use its C API.
</p>

<hr>
<a name="Introduction-to-rigctld"></a>
<a name="Introduction-to-rigctld-1"></a>
<h4 class="subsection">3.3.1 Introduction to <code>rigctld</code></h4>
<a name="index-Introduction-to-rigctld"></a>
<a name="index-rigctld_002c-introduction-to"></a>

<p><code>rigctld</code> communicates to a client through a <acronym>TCP</acronym>
network socket using text commands shared with <code>rigctl</code>. The
protocol is simple; commands are sent to <code>rigctld</code> on one line
and <code>rigctld</code> responds to &ldquo;get&rdquo; commands with the requested
values, one per line, when successful, otherwise, it responds with one
line &lsquo;<samp>RPRT x</samp>&rsquo;, where &lsquo;<samp>x</samp>&rsquo; is a negative number indicating the
Hamlib error code.  Commands that do not return values respond with
the line &lsquo;<samp>RPRT x</samp>&rsquo;, where &lsquo;<samp>x</samp>&rsquo; is zero when successful,
otherwise a negative number indicating the Hamlib error code.  Each
line is terminated with a newline <code>\n</code> character.  This protocol
is primarily for use by the <code>NET rigctl</code> (radio model 2) backend.
</p>
<p>A separate Extended Response protocol extends the above behavior by
echoing the received command string as a header, any returned values
as a key: value pair, and the &lsquo;<samp>RPRT x</samp>&rsquo; string as the end of
response marker which includes the Hamlib success or failure value.
Consider using this protocol for clients that will interact with
<code>rigctld</code> directly through a <acronym>TCP</acronym> network socket.
</p>
<p>Multiple radios can be controlled on different <acronym>TCP</acronym> ports by
use of multiple <code>rigctld</code> processes each listening on a unique
<acronym>TCP</acronym> port. It is hoped that <code>rigctld</code> will be
especially useful for client authors using languages such as
<a href="http://www.perl.org/">Perl</a>, <a href="http://www.python.org/">Python</a>, <a href="http://php.net/">PHP</a>,
<a href="http://www.ruby-lang.org/en/">Ruby</a>, <a href="http://www.tcl.tk/">TCL</a>, and others.
</p>
<hr>
<a name="rigctld-reference"></a>
<a name="rigctld-reference-1"></a>
<h4 class="subsection">3.3.2 <code>rigctld</code> reference</h4>
<a name="index-rigctld-reference"></a>
<a name="index-reference_002c-rigctld"></a>

<p>The complete reference for <code>rigctld</code> can be found in the
<kbd>rigctld</kbd>(1) Unix manual page.
</p>

<hr>
<a name="rotctld"></a>
<a name="rotctld-1"></a>
<h3 class="section">3.4 <code>rotctld</code></h3>
<a name="index-rotctld"></a>

<p>The <code>rotctld</code> program is a network server that accepts the
familiar commands of <code>rotctl</code> and provides the response data
over a <acronym>TCP/IP</acronym> network socket to an application.  In this
manner an application can access a <code>rotctld</code> instance from
nearly anywhere (caveat, no security is currently provided by
<code>rotctld</code>).  Applications using <code>rotctld</code> do not link
directly to Hamlib nor use its C API.
</p>

<hr>
<a name="Introduction-to-rotctld"></a>
<a name="Introduction-to-rotctld-1"></a>
<h4 class="subsection">3.4.1 Introduction to <code>rotctld</code></h4>
<a name="index-Introduction-to-rotctld"></a>
<a name="index-rotctld_002c-introduction-to"></a>

<p><code>rotctld</code> communicates to a client through a <acronym>TCP</acronym>
network socket using text commands shared with <code>rotctl</code>. The
protocol is simple, commands are sent to <code>rotctld</code> on one line
and <code>rotctld</code> responds to &ldquo;get&rdquo; commands with the requested
values, one per line, when successful, otherwise, it responds with one
line &lsquo;<samp>RPRT x</samp>&rsquo;, where &lsquo;<samp>x</samp>&rsquo; is a negative number indicating the
Hamlib error code.  Commands that do not return values respond with
the line &lsquo;<samp>RPRT x</samp>&rsquo;, where &lsquo;<samp>x</samp>&rsquo; is zero when successful,
otherwise a negative number indicating the Hamlib error code.  Each
line is terminated with a newline <code>\n</code> character.  This protocol
is primarily for use by the <code>NET rotctl</code> (rot model 2) backend.
</p>
<p>A separate Extended Response protocol extends the above behavior by
echoing the received command string as a header, any returned values
as a key: value pair, and the &lsquo;<samp>RPRT x</samp>&rsquo; string as the end of
response marker which includes the Hamlib success or failure value.
Consider using this protocol for clients that will interact with
<code>rotctld</code> directly through a <acronym>TCP</acronym> network socket.
</p>
<p>Multiple rotators can be controlled on different <acronym>TCP</acronym> ports by
use of multiple <code>rotctld</code> processes each listening on a unique
<acronym>TCP</acronym> port. It is hoped that <code>rotctld</code> will be
especially useful for client authors using languages such as
<a href="http://www.perl.org/">Perl</a>, <a href="http://www.python.org/">Python</a>, <a href="http://php.net/">PHP</a>,
<a href="http://www.ruby-lang.org/en/">Ruby</a>, <a href="http://www.tcl.tk/">TCL</a>, and others.
</p>
<hr>
<a name="rotctld-reference"></a>
<a name="rotctld-reference-1"></a>
<h4 class="subsection">3.4.2 <code>rotctld</code> reference</h4>
<a name="index-rotctld-reference"></a>
<a name="index-reference_002c-rotctld"></a>

<p>The complete reference for <code>rotctld</code> can be found in the
<kbd>rotctld</kbd>(1) Unix manual page.
</p>

<hr>
<a name="rigmem"></a>
<a name="rigmem-1"></a>
<h3 class="section">3.5 <code>rigmem</code></h3>
<a name="index-rigmem"></a>

<p><code>rigmem</code> may be used to backup and restore memory of radio
transceivers and receivers.
</p>

<hr>
<a name="Introduction-to-rigmem"></a>
<a name="Introduction-to-rigmem-1"></a>
<h4 class="subsection">3.5.1 Introduction to <code>rigmem</code></h4>
<a name="index-Introduction-to-rigmem"></a>
<a name="index-rigmem_002c-introduction-to"></a>

<p>Backup and restore memory of radio transceivers and receivers.
<code>rigmem</code> accepts &lsquo;<samp>command</samp>&rsquo;s from the command line only.
</p>
<hr>
<a name="rigmem-reference"></a>
<a name="rigmem-reference-1"></a>
<h4 class="subsection">3.5.2 <code>rigmem</code> reference</h4>
<a name="index-rigmem-reference"></a>
<a name="index-reference_002c-rigmem"></a>

<p>The complete reference for <code>rigmem</code> can be found in the
<kbd>rigmem</kbd>(1) Unix manual page.
</p>
<hr>
<a name="rigsmtr"></a>
<a name="rigsmtr-1"></a>
<h3 class="section">3.6 <code>rigsmtr</code></h3>
<a name="index-rigsmtr"></a>

<p><code>rigsmtr</code> uses Hamlib to control a radio to measure S-Meter
value versus antenna azimuth.
</p>

<hr>
<a name="Introduction-to-rigsmtr"></a>
<a name="Introduction-to-rigsmtr-1"></a>
<h4 class="subsection">3.6.1 Introduction to <code>rigsmtr</code></h4>
<a name="index-Introduction-to-rigsmtr"></a>
<a name="index-rigsmtr_002c-introduction-to"></a>

<p><code>rigsmtr</code> rotates the antenna from minimum azimuth to maximum
azimuth.  Every second, or time_step if specified in seconds, it
retrieves the signal strength.  Azimuth in degrees and the
corresponding S-Meter level in dB relative to S9 are then printed on
stdout.
</p>
<p>To work correctly, <code>rigsmtr</code> needs a radio that could measure
S-Meter and a Hamlib backend that is able to retrieve it, connected to
a Hamlib supported rotator.
</p>
<hr>
<a name="rigsmtr-reference"></a>
<a name="rigsmtr-reference-1"></a>
<h4 class="subsection">3.6.2 <code>rigsmtr</code> reference</h4>
<a name="index-rigsmtr-reference"></a>
<a name="index-reference_002c-rigsmtr"></a>

<p>The complete reference for <code>rigsmtr</code> can be found in the
<kbd>rigsmtr</kbd>(1) Unix manual page.
</p>
<hr>
<a name="rigswr"></a>
<a name="rigswr-1"></a>
<h3 class="section">3.7 <code>rigswr</code></h3>
<a name="index-rigswr"></a>

<p><code>rigswr</code> may be used to measure VSWR vs frequency.
</p>

<hr>
<a name="Introduction-to-rigswr"></a>
<a name="Introduction-to-rigswr-1"></a>
<h4 class="subsection">3.7.1 Introduction to <code>rigswr</code></h4>
<a name="index-Introduction-to-rigswr"></a>
<a name="index-rigswr_002c-introduction-to"></a>

<p><code>rigswr</code> uses Hamlib to control a radio to measure
<acronym>VSWR</acronym> (Voltage Standing Wave Ratio) over a frequency range.
It scans frequencies from <var>start_freq</var> to <var>stop_freq</var> with an
optional increment of <var>freq_step</var> (default step is 100 kHz).  All
values must be entered as an integer in Hertz (cycles per second).
</p>
<blockquote>
<p><b>Note:</b> <code>rigswr</code> assumes that <var>start_freq</var> is less than or equal
to <var>stop_freq</var>.  If it is greater, <code>rigswr</code> will exit
without doing anything.
</p></blockquote>

<p>For each frequency, <code>rigswr</code> transmits at 25% of total POWER
during 0.5 second in CW mode and reads <acronym>VSWR</acronym>.
</p>
<p>Frequency and the corresponding <acronym>VSWR</acronym> are then printed on
<samp>stdout</samp>.
</p>
<p>To work correctly, <code>rigswr</code> needs a radio that can measure
<acronym>VSWR</acronym> and a Hamlib backend that supports reading
<acronym>VSWR</acronym> from the radio.
</p>
<hr>
<a name="rigswr-reference"></a>
<a name="rigswr-reference-1"></a>
<h4 class="subsection">3.7.2 <code>rigswr</code> reference</h4>
<a name="index-rigswr-reference"></a>
<a name="index-reference_002c-rigswr"></a>

<p>The complete reference for <code>rigswr</code> can be found in the
<kbd>rigswr</kbd>(1) Unix manual page.
</p>


<hr>
<a name="GNU-Free-Documentation-License"></a>
<a name="GNU-Free-Documentation-License-1"></a>
<h2 class="appendix">Appendix A GNU Free Documentation License</h2>

<div align="center">Version 1.3, 3 November 2008
</div>

<div class="display">
<pre class="display">Copyright &copy; 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
<a href="http://fsf.org/">http://fsf.org/</a>

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre></div>

<ol>
<li> PREAMBLE

<p>The purpose of this License is to make a manual, textbook, or other
functional and useful document <em>free</em> in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
</p>
<p>This License is a kind of &ldquo;copyleft&rdquo;, which means that derivative
works of the document must themselves be free in the same sense.  It
complements the GNU General Public License, which is a copyleft
license designed for free software.
</p>
<p>We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does.  But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book.  We recommend this License
principally for works whose purpose is instruction or reference.
</p>
</li><li> APPLICABILITY AND DEFINITIONS

<p>This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License.  Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein.  The &ldquo;Document&rdquo;, below,
refers to any such manual or work.  Any member of the public is a
licensee, and is addressed as &ldquo;you&rdquo;.  You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
</p>
<p>A &ldquo;Modified Version&rdquo; of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
</p>
<p>A &ldquo;Secondary Section&rdquo; is a named appendix or a front-matter section
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document&rsquo;s overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject.  (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
any mathematics.)  The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
</p>
<p>The &ldquo;Invariant Sections&rdquo; are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License.  If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant.  The Document may contain zero
Invariant Sections.  If the Document does not identify any Invariant
Sections then there are none.
</p>
<p>The &ldquo;Cover Texts&rdquo; are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License.  A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
</p>
<p>A &ldquo;Transparent&rdquo; copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters.  A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text.  A copy that is not &ldquo;Transparent&rdquo; is called &ldquo;Opaque&rdquo;.
</p>
<p>Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input
format, SGML or XML using a publicly available
DTD, and standard-conforming simple HTML,
PostScript or PDF designed for human modification.  Examples
of transparent image formats include PNG, XCF and
JPG.  Opaque formats include proprietary formats that can be
read and edited only by proprietary word processors, SGML or
XML for which the DTD and/or processing tools are
not generally available, and the machine-generated HTML,
PostScript or PDF produced by some word processors for
output purposes only.
</p>
<p>The &ldquo;Title Page&rdquo; means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page.  For works in
formats which do not have any title page as such, &ldquo;Title Page&rdquo; means
the text near the most prominent appearance of the work&rsquo;s title,
preceding the beginning of the body of the text.
</p>
<p>The &ldquo;publisher&rdquo; means any person or entity that distributes copies
of the Document to the public.
</p>
<p>A section &ldquo;Entitled XYZ&rdquo; means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language.  (Here XYZ stands for a
specific section name mentioned below, such as &ldquo;Acknowledgements&rdquo;,
&ldquo;Dedications&rdquo;, &ldquo;Endorsements&rdquo;, or &ldquo;History&rdquo;.)  To &ldquo;Preserve the Title&rdquo;
of such a section when you modify the Document means that it remains a
section &ldquo;Entitled XYZ&rdquo; according to this definition.
</p>
<p>The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document.  These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
</p>
</li><li> VERBATIM COPYING

<p>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License.  You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute.  However, you may accept
compensation in exchange for copies.  If you distribute a large enough
number of copies you must also follow the conditions in section 3.
</p>
<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
</p>
</li><li> COPYING IN QUANTITY

<p>If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document&rsquo;s license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover.  Both covers must also clearly and legibly identify
you as the publisher of these copies.  The front cover must present
the full title with all words of the title equally prominent and
visible.  You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
</p>
<p>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
</p>
<p>If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
</p>
<p>It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
</p>
</li><li> MODIFICATIONS

<p>You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it.  In addition, you must do these things in the Modified Version:
</p>
<ol>
<li> Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document).  You may use the same title as a previous version
if the original publisher of that version gives permission.

</li><li> List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.

</li><li> State on the Title page the name of the publisher of the
Modified Version, as the publisher.

</li><li> Preserve all the copyright notices of the Document.

</li><li> Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.

</li><li> Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.

</li><li> Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document&rsquo;s license notice.

</li><li> Include an unaltered copy of this License.

</li><li> Preserve the section Entitled &ldquo;History&rdquo;, Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page.  If
there is no section Entitled &ldquo;History&rdquo; in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.

</li><li> Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on.  These may be placed in the &ldquo;History&rdquo; section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.

</li><li> For any section Entitled &ldquo;Acknowledgements&rdquo; or &ldquo;Dedications&rdquo;, Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.

</li><li> Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles.  Section numbers
or the equivalent are not considered part of the section titles.

</li><li> Delete any section Entitled &ldquo;Endorsements&rdquo;.  Such a section
may not be included in the Modified Version.

</li><li> Do not retitle any existing section to be Entitled &ldquo;Endorsements&rdquo; or
to conflict in title with any Invariant Section.

</li><li> Preserve any Warranty Disclaimers.
</li></ol>

<p>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant.  To do this, add their titles to the
list of Invariant Sections in the Modified Version&rsquo;s license notice.
These titles must be distinct from any other section titles.
</p>
<p>You may add a section Entitled &ldquo;Endorsements&rdquo;, provided it contains
nothing but endorsements of your Modified Version by various
parties&mdash;for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
</p>
<p>You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version.  Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity.  If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
</p>
<p>The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
</p>
</li><li> COMBINING DOCUMENTS

<p>You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
</p>
<p>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy.  If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
</p>
<p>In the combination, you must combine any sections Entitled &ldquo;History&rdquo;
in the various original documents, forming one section Entitled
&ldquo;History&rdquo;; likewise combine any sections Entitled &ldquo;Acknowledgements&rdquo;,
and any sections Entitled &ldquo;Dedications&rdquo;.  You must delete all
sections Entitled &ldquo;Endorsements.&rdquo;
</p>
</li><li> COLLECTIONS OF DOCUMENTS

<p>You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
</p>
<p>You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
</p>
</li><li> AGGREGATION WITH INDEPENDENT WORKS

<p>A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an &ldquo;aggregate&rdquo; if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation&rsquo;s users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
</p>
<p>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document&rsquo;s Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
</p>
</li><li> TRANSLATION

<p>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections.  You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers.  In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
</p>
<p>If a section in the Document is Entitled &ldquo;Acknowledgements&rdquo;,
&ldquo;Dedications&rdquo;, or &ldquo;History&rdquo;, the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
</p>
</li><li> TERMINATION

<p>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided under this License.  Any attempt
otherwise to copy, modify, sublicense, or distribute it is void, and
will automatically terminate your rights under this License.
</p>
<p>However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
</p>
<p>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
</p>
<p>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License.  If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
</p>
</li><li> FUTURE REVISIONS OF THIS LICENSE

<p>The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time.  Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.  See
<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>.
</p>
<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License &ldquo;or any later version&rdquo; applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation.  If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.  If the Document
specifies that a proxy can decide which future versions of this
License can be used, that proxy&rsquo;s public statement of acceptance of a
version permanently authorizes you to choose that version for the
Document.
</p>
</li><li> RELICENSING

<p>&ldquo;Massive Multiauthor Collaboration Site&rdquo; (or &ldquo;MMC Site&rdquo;) means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works.  A
public wiki that anybody can edit is an example of such a server.  A
&ldquo;Massive Multiauthor Collaboration&rdquo; (or &ldquo;MMC&rdquo;) contained in the
site means any set of copyrightable works thus published on the MMC
site.
</p>
<p>&ldquo;CC-BY-SA&rdquo; means the Creative Commons Attribution-Share Alike 3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
</p>
<p>&ldquo;Incorporate&rdquo; means to publish or republish a Document, in whole or
in part, as part of another Document.
</p>
<p>An MMC is &ldquo;eligible for relicensing&rdquo; if it is licensed under this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole
or in part into the MMC, (1) had no cover texts or invariant sections,
and (2) were thus incorporated prior to November 1, 2008.
</p>
<p>The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
</p>
</li></ol>

<a name="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></a>
<h3 class="heading">ADDENDUM: How to use this License for your documents</h3>

<p>To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
</p>
<div class="smallexample">
<pre class="smallexample">  Copyright (C)  <var>year</var>  <var>your name</var>.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.3
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled ``GNU
  Free Documentation License''.
</pre></div>

<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the &ldquo;with&hellip;Texts.&rdquo; line with this:
</p>
<div class="smallexample">
<pre class="smallexample">    with the Invariant Sections being <var>list their titles</var>, with
    the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts
    being <var>list</var>.
</pre></div>

<p>If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
</p>
<p>If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
</p>


<hr>
<a name="Working-with-Git"></a>
<a name="Working-with-Git-1"></a>
<h2 class="appendix">Appendix B Working with Git</h2>

<p>Git offers a myriad of commands and options.  Fortunately, only a few
are needed for Hamlib development.
</p>

<hr>
<a name="List-of-Figures"></a>
<a name="List-of-Figures-1"></a>
<h2 class="unnumbered">List of Figures</h2>
<dl class="listoffloats">
<dt><a href="#fig_003aimg1">Figure 1.1</a></dt><dd><p>Hamlib design</p></dd>
</dl>


<hr>
<a name="Concept-Index"></a>
<a name="Concept-Index-1"></a>
<h2 class="unnumbered">Concept Index</h2>

<table><tr><th valign="top">Jump to: &nbsp; </th><td><a class="summary-letter" href="#Concept-Index_cp_letter-A"><b>A</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-B"><b>B</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-C"><b>C</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-D"><b>D</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-F"><b>F</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-G"><b>G</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-H"><b>H</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-I"><b>I</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-L"><b>L</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-M"><b>M</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-N"><b>N</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-O"><b>O</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-P"><b>P</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-R"><b>R</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-S"><b>S</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-V"><b>V</b></a>
 &nbsp; 
</td></tr></table>
<table class="index-cp" border="0">
<tr><td></td><th align="left">Index Entry</th><td>&nbsp;</td><th align="left"> Section</th></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-A">A</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Adding-debugging-symbols">Adding debugging symbols</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Adding-debugging-symbols">Adding debugging symbols</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Applications_002c-using-Hamlib">Applications, using Hamlib</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Applications-using-Hamlib">Applications using Hamlib</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Back-end-library">Back end library</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Binary-packages_002c-Linux_002c-BSD">Binary packages, Linux, BSD</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Unix-binary-packages">Unix binary packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Bootstrapping-from-a-Git-clone">Bootstrapping from a Git clone</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Bootstrapping-from-a-Git-clone">Bootstrapping from a Git clone</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-BSD-binary-packages">BSD binary packages</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Unix-binary-packages">Unix binary packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Build_002c-parallel-trees">Build, parallel trees</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Parallel-build-trees">Parallel build trees</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Building-from-source">Building from source</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Building-from-source">Building from source</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Cloning_002c-radio">Cloning, radio</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Radio-cloning">Radio cloning</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Compiling-for-Microsoft-Windows">Compiling for Microsoft Windows</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Compiling-Microsoft-Windows">Compiling Microsoft Windows</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Compiling-source-tarballs">Compiling source tarballs</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Compiling-source-tarballs">Compiling source tarballs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-configure">configure</a>:</td><td>&nbsp;</td><td valign="top"><a href="#configure">configure</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Copying_002c-redistribution">Copying, redistribution</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Copying-and-Redistribution">Copying and Redistribution</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Copyleft">Copyleft</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Copying-and-Redistribution">Copying and Redistribution</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-D">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Daemon_002c-network">Daemon, network</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Front-end-library">Front end library</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-G">G</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Getting-released-source">Getting released source</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-releases">Source releases</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Getting-source-snapshots">Getting source snapshots</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-snapshots">Source snapshots</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Git-clone">Git clone</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Git-clone">Git clone</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Git-clone_002c-bootsrapping">Git clone, bootsrapping</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Bootstrapping-from-a-Git-clone">Bootstrapping from a Git clone</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Git-repository">Git repository</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Git-clone">Git clone</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-H">H</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hamlib-applications">Hamlib applications</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Applications-using-Hamlib">Applications using Hamlib</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hamlib-licensing">Hamlib licensing</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Licensing-implications">Licensing implications</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hamlib-project">Hamlib project</a>:</td><td>&nbsp;</td><td valign="top"><a href="#The-Hamlib-project">The Hamlib project</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hamlib_002c-pronouncing">Hamlib, pronouncing</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Pronunciation">Pronunciation</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-I">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Interface_002c-languages">Interface, languages</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Introduction-to-rigctl">Introduction to <code>rigctl</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigctl">Introduction to rigctl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Introduction-to-rigctld">Introduction to <code>rigctld</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigctld">Introduction to rigctld</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Introduction-to-rigmem">Introduction to <code>rigmem</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigmem">Introduction to rigmem</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Introduction-to-rigsmtr">Introduction to <code>rigsmtr</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigsmtr">Introduction to rigsmtr</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Introduction-to-rigswr">Introduction to <code>rigswr</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigswr">Introduction to rigswr</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Introduction-to-rotctl">Introduction to <code>rotctl</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rotctl">Introduction to rotctl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Introduction-to-rotctld">Introduction to <code>rotctld</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rotctld">Introduction to rotctld</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-L">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Languages_002c-scripting">Languages, scripting</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ldconfig">ldconfig</a>:</td><td>&nbsp;</td><td valign="top"><a href="#ldconfig">ldconfig</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Licensing_002c-Hamlib">Licensing, Hamlib</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Licensing-implications">Licensing implications</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Linux-binary-packages">Linux binary packages</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Unix-binary-packages">Unix binary packages</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-M">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-make">make</a>:</td><td>&nbsp;</td><td valign="top"><a href="#make">make</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-make-install">make install</a>:</td><td>&nbsp;</td><td valign="top"><a href="#make-install">make install</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-make_002c-other-targets"><code>make</code>, other targets</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Other-make-targets">Other make targets</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Microsoft-Windows_002c-compiled-binaries">Microsoft Windows, compiled binaries</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Microsft-Windows-binaries">Microsft Windows binaries</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Microsoft-Windows_002c-compiling">Microsoft Windows, compiling</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Compiling-Microsoft-Windows">Compiling Microsoft Windows</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Microsoft-Windows_002c-pre_002dcompiled-binaries">Microsoft Windows, pre-compiled binaries</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Microsft-Windows-binaries">Microsft Windows binaries</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-N">N</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Network_002c-daemon">Network, daemon</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-NO-WARRANTY">NO WARRANTY</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Copying-and-Redistribution">Copying and Redistribution</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Nutshell">Nutshell</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Hamlib-in-a-Nutshell">Hamlib in a Nutshell</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-O">O</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Other-make-targets">Other <code>make</code> targets</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Other-make-targets">Other make targets</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Overview">Overview</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-P">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Parallel-build-trees">Parallel build trees</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Parallel-build-trees">Parallel build trees</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Pre_002dcompiled-binaries-for-Microsoft-Windows">Pre-compiled binaries for Microsoft Windows</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Microsft-Windows-binaries">Microsft Windows binaries</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Project_002c-Hamlib">Project, Hamlib</a>:</td><td>&nbsp;</td><td valign="top"><a href="#The-Hamlib-project">The Hamlib project</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Pronouncing-Hamlib">Pronouncing Hamlib</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Pronunciation">Pronunciation</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Radio-cloning">Radio cloning</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Radio-cloning">Radio cloning</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Redistribution_002c-copying">Redistribution, copying</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Copying-and-Redistribution">Copying and Redistribution</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-reference_002c-rigctl">reference, <code>rigctl</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigctl-reference">rigctl reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-reference_002c-rigctld">reference, <code>rigctld</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigctld-reference">rigctld reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-reference_002c-rigmem">reference, <code>rigmem</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigmem-reference">rigmem reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-reference_002c-rigsmtr">reference, <code>rigsmtr</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigsmtr-reference">rigsmtr reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-reference_002c-rigswr">reference, <code>rigswr</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigswr-reference">rigswr reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-reference_002c-rotctl">reference, <code>rotctl</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#rotctl-reference">rotctl reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-reference_002c-rotctld">reference, <code>rotctld</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#rotctld-reference">rotctld reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigctl">rigctl</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigctl">rigctl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigctl-reference"><code>rigctl</code> reference</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigctl-reference">rigctl reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigctl_002c-introduction-to"><code>rigctl</code>, introduction to</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigctl">Introduction to rigctl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigctld">rigctld</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigctld">rigctld</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigctld-reference"><code>rigctld</code> reference</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigctld-reference">rigctld reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigctld_002c-introduction-to"><code>rigctld</code>, introduction to</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigctld">Introduction to rigctld</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigmem">rigmem</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigmem">rigmem</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigmem-reference"><code>rigmem</code> reference</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigmem-reference">rigmem reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigmem_002c-introduction-to"><code>rigmem</code>, introduction to</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigmem">Introduction to rigmem</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigsmtr">rigsmtr</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigsmtr">rigsmtr</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigsmtr-reference"><code>rigsmtr</code> reference</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigsmtr-reference">rigsmtr reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigsmtr_002c-introduction-to"><code>rigsmtr</code>, introduction to</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigsmtr">Introduction to rigsmtr</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigswr">rigswr</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigswr">rigswr</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigswr-reference"><code>rigswr</code> reference</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rigswr-reference">rigswr reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rigswr_002c-introduction-to"><code>rigswr</code>, introduction to</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rigswr">Introduction to rigswr</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rotctl">rotctl</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rotctl">rotctl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rotctl-reference"><code>rotctl</code> reference</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rotctl-reference">rotctl reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rotctl_002c-introduction-to"><code>rotctl</code>, introduction to</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rotctl">Introduction to rotctl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rotctld">rotctld</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rotctld">rotctld</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rotctld-reference"><code>rotctld</code> reference</a>:</td><td>&nbsp;</td><td valign="top"><a href="#rotctld-reference">rotctld reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rotctld_002c-introduction-to"><code>rotctld</code>, introduction to</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Introduction-to-rotctld">Introduction to rotctld</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-S">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Scripting-languages">Scripting languages</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source-options">Source options</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-options">Source options</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source-tarballs_002c-compiling">Source tarballs, compiling</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Compiling-source-tarballs">Compiling source tarballs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source_002c-building-from">Source, building from</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Building-from-source">Building from source</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source_002c-daily-snapshots">Source, daily snapshots</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-snapshots">Source snapshots</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source_002c-getting-released">Source, getting released</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-releases">Source releases</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source_002c-getting-snapshots">Source, getting snapshots</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-snapshots">Source snapshots</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source_002c-obtaining-releases">Source, obtaining releases</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-releases">Source releases</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source_002c-obtaining-snapshots">Source, obtaining snapshots</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-snapshots">Source snapshots</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source_002c-RC">Source, RC</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-snapshots">Source snapshots</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source_002c-release-candidates">Source, release candidates</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-snapshots">Source snapshots</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-V">V</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Virtual-radio">Virtual radio</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Virtual-rotator">Virtual rotator</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Overview">Overview</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: &nbsp; </th><td><a class="summary-letter" href="#Concept-Index_cp_letter-A"><b>A</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-B"><b>B</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-C"><b>C</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-D"><b>D</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-F"><b>F</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-G"><b>G</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-H"><b>H</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-I"><b>I</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-L"><b>L</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-M"><b>M</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-N"><b>N</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-O"><b>O</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-P"><b>P</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-R"><b>R</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-S"><b>S</b></a>
 &nbsp; 
<a class="summary-letter" href="#Concept-Index_cp_letter-V"><b>V</b></a>
 &nbsp; 
</td></tr></table>

<hr>



</body>
</html>