kopia lustrzana https://github.com/Hamlib/Hamlib
Synchronize Texinfo manual with man7 pages
The Texinfo manual is now kept in sync with the project information manual pages. The Texinfo manual may be retired at some later date but for now the two sets of documentation will be kept in sync.Hamlib-3.3
rodzic
d984a58113
commit
5a79fcdbe1
|
@ -1,13 +1,13 @@
|
||||||
There are several ways to obtain a working installation of Hamlib. In
|
There are several ways to obtain a working installation of Hamlib.
|
||||||
the following sections discuss installing from a package manager,
|
The following sections discuss installing from a package manager,
|
||||||
building from source, and installing Hamlib project supplied binaries on
|
building from source, and installing Hamlib project supplied binaries
|
||||||
Microsoft Windows@registeredsymbol{}.
|
on Microsoft Windows@registeredsymbol{}.
|
||||||
|
|
||||||
@menu
|
@menu
|
||||||
* Unix binary packages::
|
* Unix binary packages::
|
||||||
* Source options::
|
* Source options::
|
||||||
* Building from source::
|
* Building from source::
|
||||||
* MS Windows 32 binaries::
|
* Microsft Windows binaries::
|
||||||
@end menu
|
@end menu
|
||||||
|
|
||||||
@node Unix binary packages
|
@node Unix binary packages
|
||||||
|
@ -31,17 +31,17 @@ the documentation for your chosen distribution be your guide.
|
||||||
|
|
||||||
Distribution packages are most often official Hamlib releases and in
|
Distribution packages are most often official Hamlib releases and in
|
||||||
some cases could be quite old and lacking support for newer radios or
|
some cases could be quite old and lacking support for newer radios or
|
||||||
rotors. In some cases support is improved in existing radio or rotor
|
rotators. In some cases support is improved in existing radio or
|
||||||
back ends and bugs are fixed in newer releases. Often times to get
|
rotator back ends and bugs are fixed in newer releases. Often times
|
||||||
the improved support/bug fixes, building from source will be required.
|
to get the improved support/bug fixes, building from source will be
|
||||||
Relax, it's not hard. :-)
|
required. Relax, it's not hard. :-)
|
||||||
|
|
||||||
Source code is available as official releases, testing snapshots,
|
Source code is available as official releases, testing snapshots,
|
||||||
daily development snapshots, and the bleeding edge of development
|
daily development snapshots, and the bleeding edge of development
|
||||||
directly from the @url{http://git-scm.com/, Git} repository. As a
|
directly from the @url{https://github.com/Hamlib/Hamlib, Git
|
||||||
rule, even the bleeding edge tarballs should configure and compile
|
repository}. As a rule, even the bleeding edge tarballs should
|
||||||
without error even though certain implementation work may be in
|
configure and compile without error even though certain implementation
|
||||||
progress and may be incomplete or have errors.
|
work may be in progress and may be incomplete or have errors.
|
||||||
|
|
||||||
@menu
|
@menu
|
||||||
* Source releases::
|
* Source releases::
|
||||||
|
@ -56,9 +56,12 @@ progress and may be incomplete or have errors.
|
||||||
@cindex Source, obtaining releases
|
@cindex Source, obtaining releases
|
||||||
|
|
||||||
Official Hamlib source releases, commonly called @dfn{tarballs} can be
|
Official Hamlib source releases, commonly called @dfn{tarballs} can be
|
||||||
found on the @url{http://sourceforge.net/projects/hamlib/files/hamlib/,
|
found on the
|
||||||
SourceForge.net Hamlib files} Web page. The most recent release is
|
@url{http://sourceforge.net/projects/hamlib/files/hamlib/,
|
||||||
listed first.
|
SourceForge.net Hamlib files} Web page. As a convenience, release
|
||||||
|
archives are also mirrored at the
|
||||||
|
@url{https://github.com/Hamlib/Hamlib/releases, GitHub Hamlib
|
||||||
|
releases} page. The most recent release is listed first.
|
||||||
|
|
||||||
@node Source snapshots
|
@node Source snapshots
|
||||||
@subsection Getting source snapshots
|
@subsection Getting source snapshots
|
||||||
|
@ -66,20 +69,25 @@ listed first.
|
||||||
@cindex Source, getting snapshots
|
@cindex Source, getting snapshots
|
||||||
@cindex Source, obtaining snapshots
|
@cindex Source, obtaining snapshots
|
||||||
@cindex Source, daily snapshots
|
@cindex Source, daily snapshots
|
||||||
|
@cindex Source, release candidates
|
||||||
|
@cindex Source, RC
|
||||||
|
|
||||||
Testing release candidates and daily snapshots of the development
|
Testing release candidates (RCs) are posted during the period (often a
|
||||||
repository are available via the World Wide Web from
|
few weeks) before a planned release. Beginning with the 3.2 release,
|
||||||
@url{http://n0nb.users.sourceforge.net/, Hamlib Git daily snapshots}.
|
RCs are hosted by the @url{https://github.com/Hamlib/Hamlib/releases,
|
||||||
These are not official releases but are provided for testing new
|
GitHub release archive}. RCs are identifed by having a @i{~rc}
|
||||||
features and bug fixes.
|
suffix.
|
||||||
|
|
||||||
Testing release snapshots are only posted for a few weeks before a
|
Daily snapshots of the development repository are available via the
|
||||||
planned release. The daily development snapshot is made and posted
|
World Wide Web from @url{http://n0nb.users.sourceforge.net/, Hamlib
|
||||||
each day by around 1030 UTC. Daily snapshots @i{should} compile but
|
Git daily snapshots}. These are not official releases but are
|
||||||
sometimes a bug creeps in that prevents compilation. If that should
|
provided for testing new features and bug fixes.
|
||||||
happen, please report it to the
|
|
||||||
@email{hamlib-developer@@lists.sourceforge.net, hamlib-developer
|
The daily development snapshot is made and posted each day by around
|
||||||
mailing list}.
|
1030 UTC. Daily snapshots @i{should} compile but sometimes a bug
|
||||||
|
creeps in that prevents compilation. If that should happen, please
|
||||||
|
report it to the @email{hamlib-developer@@lists.sourceforge.net,
|
||||||
|
hamlib-developer mailing list}.
|
||||||
|
|
||||||
@node Git clone
|
@node Git clone
|
||||||
@subsection Git repository
|
@subsection Git repository
|
||||||
|
@ -102,6 +110,12 @@ To clone the repository use the following command:
|
||||||
git clone git://git.code.sf.net/p/hamlib/code hamlib
|
git clone git://git.code.sf.net/p/hamlib/code hamlib
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
|
or:
|
||||||
|
|
||||||
|
@example
|
||||||
|
git clone https://github.com/Hamlib/Hamlib.git
|
||||||
|
@end example
|
||||||
|
|
||||||
Odds are that you will want to run the above command in a sub
|
Odds are that you will want to run the above command in a sub
|
||||||
directory of your home directory. The @file{hamlib} directory will be
|
directory of your home directory. The @file{hamlib} directory will be
|
||||||
created by Git and the @dfn{master} branch will be checked out for you
|
created by Git and the @dfn{master} branch will be checked out for you
|
||||||
|
@ -120,13 +134,13 @@ repository.
|
||||||
@cindex Source, building from
|
@cindex Source, building from
|
||||||
|
|
||||||
Building from source will be required for various reasons. Perhaps
|
Building from source will be required for various reasons. Perhaps
|
||||||
only an older release is provided by your distribution, or you'd like
|
only an older release is provided by your distribution, or you would
|
||||||
to test recent changes to Hamlib---either a specific back end or API
|
like to test recent changes to Hamlib---either a specific back end or
|
||||||
changes---and offer a report to the developers, or you'd like to take
|
API changes---and offer a report to the developers, or you'd like to
|
||||||
part in development and offer your contribution to the project, or
|
take part in development and offer your contribution to the project,
|
||||||
you'd just like to learn how to build a relatively comprehensive
|
or you'd just like to learn how to build a relatively comprehensive
|
||||||
package from source. Any is a good reason to build from the source
|
package from source. Any is a good reason to build from the source
|
||||||
code.
|
code archive.
|
||||||
|
|
||||||
Before going further, this manual assumes familiarity with working
|
Before going further, this manual assumes familiarity with working
|
||||||
from the command prompt in a Linux/BSD/Unix like system's @dfn{shell}
|
from the command prompt in a Linux/BSD/Unix like system's @dfn{shell}
|
||||||
|
@ -150,7 +164,7 @@ Let's get started.
|
||||||
* Other make targets::
|
* Other make targets::
|
||||||
* Parallel build trees::
|
* Parallel build trees::
|
||||||
* Adding debugging symbols::
|
* Adding debugging symbols::
|
||||||
* Compiling MS Windows 32::
|
* Compiling Microsoft Windows::
|
||||||
@end menu
|
@end menu
|
||||||
|
|
||||||
@node Compiling source tarballs
|
@node Compiling source tarballs
|
||||||
|
@ -161,16 +175,16 @@ Let's get started.
|
||||||
Before proceeding, it is essential to read the information in the
|
Before proceeding, it is essential to read the information in the
|
||||||
files, @file{README}, @file{INSTALL}, and @file{README.betatester}
|
files, @file{README}, @file{INSTALL}, and @file{README.betatester}
|
||||||
supplied in the Hamlib @dfn{top-level} directory which will be named
|
supplied in the Hamlib @dfn{top-level} directory which will be named
|
||||||
something like @file{hamlib-3.0~git} where the latter part is
|
something like @file{hamlib-3.3~git} where the latter part is the
|
||||||
the release version. In this case the @samp{3.0~git} indicates this is
|
release version. In this case the @samp{3.3~git} indicates this is a
|
||||||
a development snapshot of the Git master branch. These files
|
development snapshot of the Git master branch. These files provide
|
||||||
provide detailed information for compiling Hamlib and will vary some
|
detailed information for compiling Hamlib and will vary some from
|
||||||
from release to release.
|
release to release.
|
||||||
|
|
||||||
Compiling from a source tarball whether it is an official release or
|
Compiling from a source tarball whether it is an official release or a
|
||||||
a testing or daily development snapshot follows the same set of commands,
|
testing or daily development snapshot follows the same set of
|
||||||
known as the @dfn{three step} which are each run from the top-level
|
commands, known as the @dfn{three step} which are each run from the
|
||||||
directory:
|
top-level directory:
|
||||||
|
|
||||||
@example
|
@example
|
||||||
./configure
|
./configure
|
||||||
|
@ -192,7 +206,7 @@ sudo make install
|
||||||
The @command{./configure} command examines your system and checks it
|
The @command{./configure} command examines your system and checks it
|
||||||
for any packages that are required or good to have options for
|
for any packages that are required or good to have options for
|
||||||
compiling Hamlib. The leading @file{./} tells the shell to only run
|
compiling Hamlib. The leading @file{./} tells the shell to only run
|
||||||
the @command{configure} command found in the current directory. It's
|
the @command{configure} command found in the current directory. It is
|
||||||
always possible that a @command{configure} command could be lurking
|
always possible that a @command{configure} command could be lurking
|
||||||
elsewhere and we don't want to run that!
|
elsewhere and we don't want to run that!
|
||||||
|
|
||||||
|
@ -216,9 +230,9 @@ LinuxCommand.org reference above.
|
||||||
@end quotation
|
@end quotation
|
||||||
|
|
||||||
Of course, things are usually complicated a bit by options and Hamlib
|
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,
|
is no exception. The good news is that the defaults, i.e., no
|
||||||
work well in most situations. Options are needed to enable the
|
options, work well in most situations. Options are needed to enable
|
||||||
compilation of certain portions of Hamlib such as the language
|
the compilation of certain portions of Hamlib such as the language
|
||||||
bindings. Optional features usually require that more development
|
bindings. Optional features usually require that more development
|
||||||
tools are installed. The @file{INSTALL}, and @file{README.betatester}
|
tools are installed. The @file{INSTALL}, and @file{README.betatester}
|
||||||
files in the Hamlib top-level directory will have details on the
|
files in the Hamlib top-level directory will have details on the
|
||||||
|
@ -249,16 +263,20 @@ exist during installation as will several other directories in it.
|
||||||
Installing in your home directory means that @dfn{root}, or superuser
|
Installing in your home directory means that @dfn{root}, or superuser
|
||||||
(administrator) privileges are not required when running @command{make
|
(administrator) privileges are not required when running @command{make
|
||||||
install}. On the other hand, some extra work will need to be done so
|
install}. On the other hand, some extra work will need to be done so
|
||||||
other programs can use the library. (TODO: describe this in an
|
other programs can use the library.
|
||||||
appendix).
|
|
||||||
|
@ignore
|
||||||
|
(TODO: describe library hackery in an appendix).
|
||||||
|
@end ignore
|
||||||
|
|
||||||
Another useful option is @samp{--help} which will give a few screens
|
Another useful option is @samp{--help} which will give a few screens
|
||||||
full of options for @command{configure}. If in a desktop environment
|
full of options for @command{configure}. If in a desktop environment
|
||||||
the scroll bar can be used to scroll back up through the output. In
|
the scroll bar can be used to scroll back up through the output. In
|
||||||
either a terminal or a virtual console Linux supports the
|
either a terminal or a virtual console Linux supports the
|
||||||
@key{Shift-PageUp} key combination to scroll back up. As luck would
|
@key{Shift-PageUp} key combination to scroll back up. Converesely
|
||||||
have it, @key{Shift-PageDown} can be used to scroll down toward the
|
@key{Shift-PageDown} can be used to scroll down toward the end of the
|
||||||
end of the output and the shell prompt.
|
output and the shell prompt (Shift-UpArrow/Shift-DownArrow may also
|
||||||
|
work to scroll one line at a time).
|
||||||
|
|
||||||
After a fair amount of time, depending on your computer, and a lot of
|
After a fair amount of time, depending on your computer, and a lot of
|
||||||
screen output, @command{configure} will finish its job. So long as
|
screen output, @command{configure} will finish its job. So long as
|
||||||
|
@ -349,19 +367,9 @@ as root from any directory.
|
||||||
|
|
||||||
@quotation Note
|
@quotation Note
|
||||||
Subsequent installations of Hamlib will not need to have
|
Subsequent installations of Hamlib will not need to have
|
||||||
@command{ldconfig} run after each installation so long as no new
|
@command{ldconfig} run after each installation if a newer major
|
||||||
backend libraries nor a newer major version of Hamlib were installed.
|
version of Hamlib was not installed, i.e. when recompiling the same
|
||||||
|
version during development.
|
||||||
A developer adding a new backend (see @file{README.developer}) will
|
|
||||||
need to run @command{ldconfig} for the new back end library to be
|
|
||||||
found by the library loader (this refers a new back end, i.e. a
|
|
||||||
sibling to the existing Icom, Kenwood, Yaesu, etc.@: back ends, not a
|
|
||||||
new model in an existing back end).
|
|
||||||
|
|
||||||
Likewise, any time a new back end appears in a source tarball,
|
|
||||||
@command{ldconfig} will need to be run for the library loader to find
|
|
||||||
it. There is no harm running @command{ldconfig} after each run of
|
|
||||||
@command{make install}.
|
|
||||||
@end quotation
|
@end quotation
|
||||||
|
|
||||||
On some distributions a bit of configuration will be needed before
|
On some distributions a bit of configuration will be needed before
|
||||||
|
@ -425,7 +433,10 @@ To remove even the generated @file{Makefile}s, run @command{make
|
||||||
distclean} from the top-level directory. After this target is run,
|
distclean} from the top-level directory. After this target is run,
|
||||||
@command{configure} will need to be run again to regenerate the
|
@command{configure} will need to be run again to regenerate the
|
||||||
@file{Makefile}s. This command may not be as useful as the
|
@file{Makefile}s. This command may not be as useful as the
|
||||||
@file{Makefile}s do not take up much space.
|
@file{Makefile}s do not take up much space, however it can be useful
|
||||||
|
for rebuilding the @file{Makefile}s when modifying a
|
||||||
|
@file{Makefile.am} or @file{confgure.ac} during build system
|
||||||
|
development.
|
||||||
|
|
||||||
@node Parallel build trees
|
@node Parallel build trees
|
||||||
@subsection Parallel build trees
|
@subsection Parallel build trees
|
||||||
|
@ -458,16 +469,14 @@ Run:
|
||||||
@command{../hamlib/configure CFLAGS="-ggdb3 -O0" CXXFLAGS="-ggdb3 -O0"}
|
@command{../hamlib/configure CFLAGS="-ggdb3 -O0" CXXFLAGS="-ggdb3 -O0"}
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
from a build directory intended for a debugging build.
|
from a sibling build directory intended for a debugging build.
|
||||||
|
|
||||||
The @samp{-ggdb3} option tells the C compiler, this case the GNU C
|
The @samp{-ggdb3} option tells the C compiler, this case the GNU C
|
||||||
Compiler, @command{gcc}, to add special symbols useful for
|
Compiler, @command{gcc}, to add special symbols useful for GDB, the
|
||||||
@command{gdb}. The @samp{-O0} option tells @command{gcc} to turn off
|
GNU debugger. The @samp{-O0} option tells @command{gcc} to turn off
|
||||||
all optimizations which will make it easier to follow some variables
|
all optimizations which will make it easier to follow some variables
|
||||||
that might otherwise be optimized away. @samp{CFLAGS} and
|
that might otherwise be optimized away. @samp{CFLAGS} and
|
||||||
@samp{CXXFLAGS} may be set independently for each compiler (sadly, a
|
@samp{CXXFLAGS} may be set independently for each compiler.
|
||||||
bug in the build system source file in Hamlib 1.2.15.3 and earlier did
|
|
||||||
not preserve @samp{CXXFLAGS}).
|
|
||||||
|
|
||||||
@quotation Note
|
@quotation Note
|
||||||
There are a number compiler options available for controlling debugging
|
There are a number compiler options available for controlling debugging
|
||||||
|
@ -475,13 +484,13 @@ symbols and setting optimization levels. Please consult the compiler's
|
||||||
manual for all the details.
|
manual for all the details.
|
||||||
@end quotation
|
@end quotation
|
||||||
|
|
||||||
@node Compiling MS Windows 32
|
@node Compiling Microsoft Windows
|
||||||
@subsection Compiling for MS Windows 32 bit architectures
|
@subsection Compiling for Microsoft Windows
|
||||||
@cindex Compiling for MS Windows 32
|
@cindex Compiling for Microsoft Windows
|
||||||
@cindex MS Windows 32, compiling
|
@cindex Microsoft Windows, compiling
|
||||||
|
|
||||||
Currently compiling is done on a Debian 8 (Jessie) virtual machine
|
Currently compiling is done on a Debian 8 (Jessie) virtual machine
|
||||||
using @url{http://www.mingw.org/, MinGW32}. @file{README.build-win32}
|
using @url{http://www.mingw.org/, MinGW}. @file{README.build-win32}
|
||||||
in the @file{scripts} directory has details on how this is
|
in the @file{scripts} directory has details on how this is
|
||||||
accomplished.
|
accomplished.
|
||||||
|
|
||||||
|
@ -489,23 +498,28 @@ Work is ongoing to correct build issues in the
|
||||||
@url{http://www.cygwin.com/, Cygwin} environment running on MS
|
@url{http://www.cygwin.com/, Cygwin} environment running on MS
|
||||||
Windows.
|
Windows.
|
||||||
|
|
||||||
@node MS Windows 32 binaries
|
@node Microsft Windows binaries
|
||||||
@section Pre-compiled binaries for MS Windows 32 bit architectures
|
@section Pre-compiled binaries for Microsoft Windows
|
||||||
@cindex Pre-compiled binaries for MS Windows 32
|
@cindex Pre-compiled binaries for Microsoft Windows
|
||||||
@cindex MS Windows 32, compiled binaries
|
@cindex Microsoft Windows, compiled binaries
|
||||||
@cindex MS Windows 32, pre-compiled binaries
|
@cindex Microsoft Windows, pre-compiled binaries
|
||||||
|
|
||||||
Pre-compiled binaries for MS Windows 32 bit architectures (Windows NT
|
Pre-compiled binaries for Microsoft Windows 32 and 64 bit
|
||||||
and newer) are available for both official releases and daily
|
architectures (Windows NT and newer) are available for both official
|
||||||
development snapshots. Official releases are available through the
|
releases and daily development snapshots. Official releases are
|
||||||
|
available through the
|
||||||
@url{http://sourceforge.net/projects/hamlib/files/hamlib/,
|
@url{http://sourceforge.net/projects/hamlib/files/hamlib/,
|
||||||
SourceForge.net file download service}. Daily development snapshots
|
SourceForge.net file download service}. As an alternative, official
|
||||||
are available from @url{http://n0nb.users.sourceforge.net/}.
|
releases are also available though the
|
||||||
|
@url{https://github.com/Hamlib/Hamlib/releases, Hamlib archive at
|
||||||
|
GitHub}. Daily development snapshots are available from
|
||||||
|
@url{http://n0nb.users.sourceforge.net/}.
|
||||||
|
|
||||||
Beginning with the Hamlib 1.2.15.3 release a self-extracting installer
|
Beginning with the Hamlib 1.2.15.3 release a self-extracting installer
|
||||||
is available. Among its features are selecting which portions of
|
is available. Among its features are selecting which portions of
|
||||||
Hamlib are installed. The @env{PATH} environment variable will need
|
Hamlib are installed. The @env{PATH} environment variable will need
|
||||||
to be set manually per the included @file{README.win32-bin} file.
|
to be set manually per the included @file{README.w32-bin} or
|
||||||
|
@file{README.w64-bin} file.
|
||||||
|
|
||||||
Daily development snapshots feature both a .ZIP archive and the self
|
Daily development snapshots feature both a .ZIP archive and the self
|
||||||
extracting installer.
|
extracting installer.
|
||||||
|
|
|
@ -12,7 +12,7 @@ updated @value{UPDATED}), which is a development effort to provide a
|
||||||
consistent programming interface for programmers wanting to incorporate
|
consistent programming interface for programmers wanting to incorporate
|
||||||
radio and rotor control into their programs.
|
radio and rotor control into their programs.
|
||||||
|
|
||||||
Copyright @copyright{} 2013 Nate Bargmann
|
Copyright @copyright{} 2013,2018 Nate Bargmann
|
||||||
|
|
||||||
@quotation
|
@quotation
|
||||||
Permission is granted to copy, distribute and/or modify this document under
|
Permission is granted to copy, distribute and/or modify this document under
|
||||||
|
|
|
@ -1,33 +1,34 @@
|
||||||
The @dfn{Ham Radio Control Libraries}, @dfn{Hamlib} for short, is a
|
The @dfn{Ham Radio Control Libraries}, @dfn{Hamlib} for short, is a
|
||||||
development effort to provide a consistent interface for programmers
|
development effort to provide a consistent interface for programmers
|
||||||
wanting to incorporate radio control in their programs.
|
wanting to incorporate radio and rotator control in their programs.
|
||||||
|
|
||||||
Hamlib is not a complete user application, rather, it is a software
|
Hamlib is not a complete user application, rather, it is a software
|
||||||
layer intended to make controlling various radios and other shack
|
layer intended to make controlling various radios and other amateur
|
||||||
hardware much easier. Hamlib will allow authors of such software as
|
radio station (shack) hardware much easier. Hamlib will allow authors
|
||||||
logging programs, digital communications programs, or those wanting to
|
of software such as logging programs, digital communications programs,
|
||||||
develop the ultimate radio control software to concentrate on the user
|
or those wanting to develop the ultimate radio control software to
|
||||||
interface and the basic function of the program rather than radio
|
concentrate on the user interface and the basic function of the
|
||||||
control. Hamlib consists of several parts, the programming library,
|
program rather than radio control. Hamlib consists of several parts,
|
||||||
utility programs, and library interfaces to other programming languages.
|
the programming library, utility programs, and library interfaces to
|
||||||
|
other programming languages.
|
||||||
|
|
||||||
Most recent amateur radio transceivers allow external control of their
|
Most recent amateur radio transceivers allow external control of their
|
||||||
functions through a serial interface. Unfortunately, control commands
|
functions through a serial interface. Unfortunately, control commands
|
||||||
are not always consistent across a manufacturer's product line and each
|
are not always consistent across a manufacturer's product line and
|
||||||
manufacturer's product line differs greatly from its competitors.
|
each manufacturer's product line differs greatly from its competitors.
|
||||||
|
|
||||||
Hamlib attempts to solve this problem by presenting a "virtual radio" to
|
Hamlib attempts to solve this problem by presenting a "virtual radio"
|
||||||
the programmer by providing an interface to actions such as setting a
|
to the programmer by providing an interface to actions such as setting
|
||||||
given VFO's frequency, setting the operating mode, querying the radio of
|
a given Variable Frequency Oscillator's (VFO) frequency, setting the
|
||||||
its current status and settings, and giving the application a list of a
|
operating mode, querying the radio of its current status and settings,
|
||||||
given radio's capabilities. Unfortunately, what can be accomplished by
|
and giving the application a list of a given radio's capabilities.
|
||||||
Hamlib is limited by the radios themselves and some offer very limited
|
Unfortunately, what can be accomplished by Hamlib is limited by the
|
||||||
capability.
|
radios themselves and some offer very limited capability.
|
||||||
|
|
||||||
Other devices, such as antenna rotors, can be placed into the Hamlib
|
Other devices, such as antenna rotators, can be placed into the Hamlib
|
||||||
control scheme. Other recent developments include network interface
|
control scheme. Other recent developments include network interface
|
||||||
servers and a USB interface capability. Language bindings are provided
|
servers and a USB interface capability. Language bindings are
|
||||||
for C, C++, Perl, Python, Lua and TCL (more to come).
|
provided for C, C++, Perl, Python, Lua and TCL (more to come).
|
||||||
|
|
||||||
@menu
|
@menu
|
||||||
* Overview::
|
* Overview::
|
||||||
|
@ -44,20 +45,20 @@ for C, C++, Perl, Python, Lua and TCL (more to come).
|
||||||
|
|
||||||
@cindex Front end library
|
@cindex Front end library
|
||||||
@cindex Virtual radio
|
@cindex Virtual radio
|
||||||
@cindex Virtual rotor
|
@cindex Virtual rotator
|
||||||
Hamlib is a @dfn{front end} library providing a @emph{C} language
|
Hamlib is a @dfn{front end} library providing a @emph{C} language
|
||||||
Application Programming Interface @acronym{API} to programmers wishing
|
Application Programming Interface @acronym{API} to programmers wishing
|
||||||
to integrate radio or rotor control in their applications. Hamlib
|
to integrate radio or rotator control in their applications. Hamlib
|
||||||
presents a @dfn{virtual radio} or @dfn{virtual rotor} that is a
|
presents a @dfn{virtual radio} or @dfn{virtual rotator} that is a
|
||||||
consistent interface to an application despite wide differences in radio
|
consistent interface to an application despite wide differences in
|
||||||
and rotor interfaces and capabilities.
|
radio and rotator interfaces and capabilities.
|
||||||
|
|
||||||
@cindex Back end library
|
@cindex Back end library
|
||||||
The front end library uses a number of @dfn{back end} libraries to
|
The front end library uses a number of @dfn{back end} libraries to
|
||||||
translate from the front end to the various individual radio and
|
translate from the front end to the various individual radio and
|
||||||
rotor models. A back end library handles conversion of the
|
rotator models. A back end library handles conversion of the front
|
||||||
front end variables to the format needed by the radio or rotor
|
end variables to the format needed by the radio or rotator device it
|
||||||
device it controls. The back end libraries are generally grouped by
|
controls. The back end libraries are generally grouped by
|
||||||
manufacturer and in some cases by a common control protocol.
|
manufacturer and in some cases by a common control protocol.
|
||||||
|
|
||||||
@quotation
|
@quotation
|
||||||
|
@ -78,23 +79,25 @@ of Hamlib's design.
|
||||||
@cindex Languages, scripting
|
@cindex Languages, scripting
|
||||||
@cindex Interface, languages
|
@cindex Interface, languages
|
||||||
Hamlib also provides an interface library for each of several common
|
Hamlib also provides an interface library for each of several common
|
||||||
@dfn{scripting} languages such as @url{http://www.perl.org, Perl, Perl},
|
@dfn{scripting} languages such as @url{http://www.perl.org, Perl,
|
||||||
@url{http://www.python.org, Python, Python}, @url{https://www.lua.org, Lua, Lua}
|
Perl}, @url{http://www.python.org, Python, Python},
|
||||||
and @url{http://www.tcl.tk, TCL, TCL}. These language @dfn{bindings} are
|
@url{https://www.lua.org, Lua, Lua} and @url{http://www.tcl.tk, TCL,
|
||||||
generated through the use of @url{http://www.swig.org, SWIG, SWIG} a parser/generator
|
TCL}. These language @dfn{bindings} are generated through the use of
|
||||||
for multiple language interfaces to a C library. A native generated @emph{C++}
|
@url{http://www.swig.org, SWIG, SWIG} a parser/generator for multiple
|
||||||
|
language interfaces to a C library. A native generated @emph{C++}
|
||||||
language interface is also provided.
|
language interface is also provided.
|
||||||
|
|
||||||
@cindex Daemon, network
|
@cindex Daemon, network
|
||||||
@cindex Network, daemon
|
@cindex Network, daemon
|
||||||
Besides the C and supplemental APIs, Hamlib also provides a pair of
|
Besides the C and supplemental APIs, Hamlib also provides a pair of
|
||||||
network daemons that provide a text command based API for controlling
|
network daemons that provide a text command based API for controlling
|
||||||
an attached radio or rotor through a @emph{TCP/IP} network connection.
|
an attached radio or rotator through a @emph{TCP/IP} network
|
||||||
The daemons then handle the interface to the Hamlib C API.
|
connection. The daemons then handle the interface to the Hamlib C
|
||||||
|
API.
|
||||||
|
|
||||||
More than one type of device, radio or rotor, may be controlled at a
|
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
|
time, however, there is generally a limit of one device per serial
|
||||||
or other port.
|
port or other port.
|
||||||
|
|
||||||
@node The Hamlib project
|
@node The Hamlib project
|
||||||
@section Hamlib project information
|
@section Hamlib project information
|
||||||
|
@ -102,50 +105,47 @@ or other port.
|
||||||
@cindex Project, Hamlib
|
@cindex Project, Hamlib
|
||||||
|
|
||||||
The Hamlib Project was founded by Frank Singleton,VK3FCS/KM5WS in July
|
The Hamlib Project was founded by Frank Singleton,VK3FCS/KM5WS in July
|
||||||
2000. Shortly after Stephane Fillod, F8CFE, joined Frank on the Hamlib
|
2000. Shortly after Stephane Fillod, F8CFE, joined Frank on the
|
||||||
project and the API and implementation development led to a reasonable
|
Hamlib project and the API and implementation development led to a
|
||||||
level of maturity in a few years. A major milestone was reached when
|
reasonable level of maturity in a few years. A major milestone was
|
||||||
Hamlib 1.2.0 was released in March 2004. The API and Application
|
reached when Hamlib 1.2.0 was released in March 2004. The API and
|
||||||
Binary Interface (@acronym{ABI}) interfaces have remained stable since
|
Application Binary Interface (@acronym{ABI}) interfaces have remained
|
||||||
that time up to the latest release of 1.2.15.3 in late 2012.
|
stable since that time up to the latest release of 3.2 in early 2018.
|
||||||
|
|
||||||
Development continues with a bump of the public version number to 3.0
|
Development continues through the major version number 3.x and beyond.
|
||||||
(essentially simply dropping the ``1.'' of previous releases). While some
|
While some API tweaks are planned, ABI compatibility with the prior
|
||||||
API tweaks are planned, ABI compatibility with the prior 1.2.@i{x}
|
1.2.@i{x} releases remains a priority. Other goals include
|
||||||
releases remains a priority. Other goals include streamlining the
|
streamlining the build system (done), improving the SWIG generated
|
||||||
build system (done), improving the SWIG generated language bindings
|
language bindings (done), improving the overall documentation (this
|
||||||
(in progress), improving the overall documentation (this manual, in
|
manual, in progress), and other updates as warranted.
|
||||||
progress), and other updates as warranted.
|
|
||||||
|
|
||||||
The Project is hosted by @url{https://sourceforge.net/,
|
The Project is hosted by @url{https://sourceforge.net/,
|
||||||
SourceForge.net} at the @url{https://sourceforge.net/projects/hamlib/,
|
SourceForge.net} at the @url{https://sourceforge.net/projects/hamlib/,
|
||||||
Hamlib project page} and the
|
Hamlib project page}. As @url{https://github.com/, GitHub} has become
|
||||||
@url{http://sourceforge.net/apps/mediawiki/hamlib/index.php, Hamlib
|
a very popular project hosting site, Hamlib also has a dedicated
|
||||||
Wiki}.
|
@url{https://github.com/Hamlib/Hamlib, GitHub project page}. GitHub
|
||||||
|
also hosts the @url{http://www.hamlib.org, hamlib.org} Web site and
|
||||||
|
the @url{https://github.com/Hamlib/Hamlib/wiki, Hamlib Wiki}.
|
||||||
|
|
||||||
Development discussion and most user support take place on the
|
Development discussion and most user support take place on the
|
||||||
@url{https://sourceforge.net/p/hamlib/mailman/, hamlib-developer mailing
|
@url{https://sourceforge.net/p/hamlib/mailman/, hamlib-developer
|
||||||
list}. While there are
|
mailing list}. While there are
|
||||||
@url{https://sourceforge.net/p/hamlib/discussion/, SourceForge.net
|
@url{https://sourceforge.net/p/hamlib/discussion/, SourceForge.net
|
||||||
discussion forums}, they are rarely used and not as closely read by the
|
discussion forums}, they are rarely used and not as closely read by
|
||||||
developers as the mailing list.
|
the developers as the mailing list.
|
||||||
|
|
||||||
For @dfn{source code management}, the project uses
|
For @dfn{source code management}, the project uses
|
||||||
@url{http://git-scm.com/, Git}, a fast, distributed content tracker.
|
@url{http://git-scm.com/, Git}, a fast, distributed content tracker.
|
||||||
Among its features is that every developer has the complete Hamlib
|
Among its features is that every developer has the complete Hamlib
|
||||||
development history available locally. While a canonical Git
|
development history available locally. For more information on using
|
||||||
repository is hosted as SourceForge, its availability is not essential to
|
Git, @pxref{Working with Git}.
|
||||||
continued development, although development work flows would change
|
|
||||||
temporarily. For more information on using Git, @pxref{Working with
|
|
||||||
Git}.
|
|
||||||
|
|
||||||
@quotation Note
|
@quotation Note
|
||||||
The SourceForge.net Web interface to the Hamlib Git repository is
|
While a canonical Git repository is hosted as SourceForge, its
|
||||||
currently broken (a ticket is pending) as of late February, 2013. A
|
availability is not essential to continued development, although
|
||||||
mirror exists at @url{https://github.com/N0NB/hamlib, GitHub} which
|
development work flows would change temporarily. Several developers
|
||||||
supports browsing via the Web and other Git commands. Access of the
|
find the GitHub Web interface easier to use and lately development has
|
||||||
SF.net repository by other means (SSH or Git protocols) is unaffected
|
centered around GitHub rather than SourceForge.
|
||||||
by this issue.
|
|
||||||
@end quotation
|
@end quotation
|
||||||
|
|
||||||
@node Applications using Hamlib
|
@node Applications using Hamlib
|
||||||
|
@ -154,9 +154,9 @@ by this issue.
|
||||||
@cindex Applications, using Hamlib
|
@cindex Applications, using Hamlib
|
||||||
|
|
||||||
A number of application developers have taken advantage of Hamlib's
|
A number of application developers have taken advantage of Hamlib's
|
||||||
capabilities to implement radio and/or rotor control. While not
|
capabilities to implement radio and/or rotator control. While not
|
||||||
exhaustive, a list is maintained at the Hamlib Wiki,
|
exhaustive, a list is maintained at the Hamlib Wiki,
|
||||||
@url{https://sourceforge.net/apps/mediawiki/hamlib/,
|
@url{https://github.com/Hamlib/Hamlib/wiki/Applications-and-Screen-Shots,
|
||||||
Applications/Screenshots}. Developers are encouraged to request their
|
Applications/Screenshots}. Developers are encouraged to request their
|
||||||
applications be added to the gallery by way of the hamlib-developer
|
applications be added to the gallery by way of the hamlib-developer
|
||||||
mailing list.
|
mailing list.
|
||||||
|
@ -166,16 +166,17 @@ mailing list.
|
||||||
@cindex Hamlib licensing
|
@cindex Hamlib licensing
|
||||||
@cindex Licensing, Hamlib
|
@cindex Licensing, Hamlib
|
||||||
|
|
||||||
As with other Free Software projects, Hamlib relies heavily on copyleft
|
As with other Free Software projects, Hamlib relies heavily on
|
||||||
licensing to encourage development contributions and provide an open
|
copyleft licensing to encourage development contributions and provide
|
||||||
atmosphere for development. Hamlib's source code is released under two
|
an open atmosphere for development. Hamlib's source code is released
|
||||||
licenses, the @acronym{LGPL} for the library portion, and the
|
under two licenses, the Lesser General Public License (@acronym{LGPL})
|
||||||
@acronym{GPL} for the utility programs.
|
for the library portion, and the General Public License
|
||||||
|
(@acronym{GPL}) for the utility programs.
|
||||||
|
|
||||||
The LGPL allows the library to be used (linked) by programs regardless
|
The LGPL allows the library to be used (linked) by programs regardless
|
||||||
of their individual license. However, any contributions to the library
|
of their individual license. However, any contributions to the
|
||||||
source remain under copyleft which means that the library source code
|
library source remain under copyleft which means that the library
|
||||||
may not be used in violation of the terms of the LGPL.
|
source code may not be used in violation of the terms of the LGPL.
|
||||||
|
|
||||||
The utility program source files are released under the GPL. Any direct
|
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
|
use of these sources must be in a form that complies with the terms of
|
||||||
|
@ -192,12 +193,12 @@ with the terms of the GPL is prohibited.
|
||||||
@cindex Cloning, radio
|
@cindex Cloning, radio
|
||||||
|
|
||||||
Hamlib's focus is on controlling rigs that employ a port and command
|
Hamlib's focus is on controlling rigs that employ a port and command
|
||||||
protocol for setting frequency, mode, VFO, PTT, etc. Most VHF/UHF
|
protocol for setting frequency, mode, VFO, PTT, etc. Most VHF/UHF
|
||||||
transceivers do not employ such control capability but do provide for
|
transceivers do not employ such control capability but do provide for
|
||||||
cloning the memory contents from radio to another of the same model. A
|
cloning the memory contents from radio to another of the same model.
|
||||||
related project, @url{http://chirp.danplanet.com/, CHIRP}, aims to
|
A related project, @url{http://chirp.danplanet.com/, CHIRP}, aims to
|
||||||
support rigs with such a clone capability. Please contact the CHIRP
|
support radios with such a clone capability. Please contact the CHIRP
|
||||||
project for support of such rigs.
|
project for support of such radios.
|
||||||
|
|
||||||
@node Pronunciation
|
@node Pronunciation
|
||||||
@section Pronouncing Hamlib
|
@section Pronouncing Hamlib
|
||||||
|
|
Plik diff jest za duży
Load Diff
Ładowanie…
Reference in New Issue