kopia lustrzana https://github.com/Hamlib/Hamlib
Merge branch 'master' of https://github.com/mdblack98/Hamlib
Michael Black
commit
ff395cc5c0
1
NEWS
1
NEWS
|
|
@ -14,6 +14,7 @@ Version 4.0
|
|||
* New model: Icom IC-R8600. Ekki, DF4OR
|
||||
* New utility: rigctlcom. Mike, W9MDB
|
||||
* New model: FT847UNI for unidirectional early serial numbers. Mike, W9MDB
|
||||
* Remove GNU Texinfo files and build system dependency.
|
||||
|
||||
Version 3.3
|
||||
2018-08-12
|
||||
|
|
|
|||
|
|
@ -95,7 +95,6 @@ package libusb-1.0 which is what is needed.
|
|||
|
||||
Documentation:
|
||||
* Doxygen
|
||||
* Texinfo (for rebuilding the new info and HTML manual)
|
||||
|
||||
|
||||
Git master branch daily snapshot build:
|
||||
|
|
|
|||
|
|
@ -235,7 +235,6 @@ distributions may differ).
|
|||
* automake 1.11 # automake --version
|
||||
* libtool 2.2.6b+ # libtool --version
|
||||
* Git for connection to git.code.sf.net/p/hamlib/code
|
||||
* texinfo 4.13a # makeinfo --version
|
||||
|
||||
N.B. Hamlib requires libtool >= 2.2.6b in compliance with CVE-2009-3736.
|
||||
|
||||
|
|
@ -249,7 +248,6 @@ Optional, but highly recommended:
|
|||
* libgd2 devel # gdlib-config --version
|
||||
* libusb-1.0 devel # 1.0.0 or newer
|
||||
* libreadline devel # ver 5.2 or newer
|
||||
* texlive # 5.1 tested with 'make distcheck'
|
||||
* pkg-config 0.9.0 # pkg-config --version (libxml and USRP)
|
||||
|
||||
N.B.: The libusb-1.0 package is required for building most of the 'kit'
|
||||
|
|
|
|||
Plik diff jest za duży
Load Diff
Plik binarny nie jest wyświetlany.
|
Przed Szerokość: | Wysokość: | Rozmiar: 8.6 KiB |
|
|
@ -1,24 +1,11 @@
|
|||
EXTRA_DIST = hamlib.cfg index.doxygen hamlib.css footer.html \
|
||||
Hamlib_design.eps Hamlib_design.png
|
||||
EXTRA_DIST = hamlib.cfg index.doxygen hamlib.css footer.html
|
||||
|
||||
dist_man_MANS = man1/rigctl.1 man1/rigctld.1 man1/rigmem.1 man1/rigsmtr.1 \
|
||||
man1/rigswr.1 man1/rotctl.1 man1/rotctld.1 man1/rigctlcom.1 \
|
||||
man7/hamlib.7 man7/hamlib-primer.7 man7/hamlib-utilities.7
|
||||
|
||||
htmldir = $(docdir)/html
|
||||
dist_html_DATA = Hamlib_design.png hamlib.html
|
||||
|
||||
SRCDOCLST = ../src/rig.c ../src/rotator.c ../src/tones.c ../src/locator.c \
|
||||
../src/event.c ../src/conf.c ../src/mem.c ../src/settings.c
|
||||
|
||||
info_TEXINFOS = hamlib.texi
|
||||
hamlib_TEXINFOS = nutshell.texi getting_started.texi utility_programs.texi \
|
||||
fdl.texi
|
||||
|
||||
AM_MAKEINFOHTMLFLAGS = --no-headers --no-split
|
||||
|
||||
doc: hamlib.cfg $(SRCDOCLST)
|
||||
doxygen hamlib.cfg
|
||||
|
||||
# Don't attempt to generate DVI file with 'make distcheck'
|
||||
dvi:
|
||||
|
|
|
|||
505
doc/fdl.texi
505
doc/fdl.texi
|
|
@ -1,505 +0,0 @@
|
|||
@c The GNU Free Documentation License.
|
||||
@center Version 1.3, 3 November 2008
|
||||
|
||||
@c This file is intended to be included within another document,
|
||||
@c hence no sectioning command or @node.
|
||||
|
||||
@display
|
||||
Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
|
||||
@uref{http://fsf.org/}
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
@end display
|
||||
|
||||
@enumerate 0
|
||||
@item
|
||||
PREAMBLE
|
||||
|
||||
The purpose of this License is to make a manual, textbook, or other
|
||||
functional and useful document @dfn{free} 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.
|
||||
|
||||
This License is a kind of ``copyleft'', 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.
|
||||
|
||||
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.
|
||||
|
||||
@item
|
||||
APPLICABILITY AND DEFINITIONS
|
||||
|
||||
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 ``Document'', below,
|
||||
refers to any such manual or work. Any member of the public is a
|
||||
licensee, and is addressed as ``you''. You accept the license if you
|
||||
copy, modify or distribute the work in a way requiring permission
|
||||
under copyright law.
|
||||
|
||||
A ``Modified Version'' 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.
|
||||
|
||||
A ``Secondary Section'' 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'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.
|
||||
|
||||
The ``Invariant Sections'' 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.
|
||||
|
||||
The ``Cover Texts'' 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.
|
||||
|
||||
A ``Transparent'' 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 ``Transparent'' is called ``Opaque''.
|
||||
|
||||
Examples of suitable formats for Transparent copies include plain
|
||||
ASCII without markup, Texinfo input format, La@TeX{} 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.
|
||||
|
||||
The ``Title Page'' 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, ``Title Page'' means
|
||||
the text near the most prominent appearance of the work's title,
|
||||
preceding the beginning of the body of the text.
|
||||
|
||||
The ``publisher'' means any person or entity that distributes copies
|
||||
of the Document to the public.
|
||||
|
||||
A section ``Entitled XYZ'' 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 ``Acknowledgements'',
|
||||
``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title''
|
||||
of such a section when you modify the Document means that it remains a
|
||||
section ``Entitled XYZ'' according to this definition.
|
||||
|
||||
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.
|
||||
|
||||
@item
|
||||
VERBATIM COPYING
|
||||
|
||||
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.
|
||||
|
||||
You may also lend copies, under the same conditions stated above, and
|
||||
you may publicly display copies.
|
||||
|
||||
@item
|
||||
COPYING IN QUANTITY
|
||||
|
||||
If you publish printed copies (or copies in media that commonly have
|
||||
printed covers) of the Document, numbering more than 100, and the
|
||||
Document'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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@item
|
||||
MODIFICATIONS
|
||||
|
||||
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:
|
||||
|
||||
@enumerate A
|
||||
@item
|
||||
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.
|
||||
|
||||
@item
|
||||
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.
|
||||
|
||||
@item
|
||||
State on the Title page the name of the publisher of the
|
||||
Modified Version, as the publisher.
|
||||
|
||||
@item
|
||||
Preserve all the copyright notices of the Document.
|
||||
|
||||
@item
|
||||
Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.
|
||||
|
||||
@item
|
||||
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.
|
||||
|
||||
@item
|
||||
Preserve in that license notice the full lists of Invariant Sections
|
||||
and required Cover Texts given in the Document's license notice.
|
||||
|
||||
@item
|
||||
Include an unaltered copy of this License.
|
||||
|
||||
@item
|
||||
Preserve the section Entitled ``History'', 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 ``History'' 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.
|
||||
|
||||
@item
|
||||
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 ``History'' 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.
|
||||
|
||||
@item
|
||||
For any section Entitled ``Acknowledgements'' or ``Dedications'', 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.
|
||||
|
||||
@item
|
||||
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.
|
||||
|
||||
@item
|
||||
Delete any section Entitled ``Endorsements''. Such a section
|
||||
may not be included in the Modified Version.
|
||||
|
||||
@item
|
||||
Do not retitle any existing section to be Entitled ``Endorsements'' or
|
||||
to conflict in title with any Invariant Section.
|
||||
|
||||
@item
|
||||
Preserve any Warranty Disclaimers.
|
||||
@end enumerate
|
||||
|
||||
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's license notice.
|
||||
These titles must be distinct from any other section titles.
|
||||
|
||||
You may add a section Entitled ``Endorsements'', provided it contains
|
||||
nothing but endorsements of your Modified Version by various
|
||||
parties---for example, statements of peer review or that the text has
|
||||
been approved by an organization as the authoritative definition of a
|
||||
standard.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@item
|
||||
COMBINING DOCUMENTS
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
In the combination, you must combine any sections Entitled ``History''
|
||||
in the various original documents, forming one section Entitled
|
||||
``History''; likewise combine any sections Entitled ``Acknowledgements'',
|
||||
and any sections Entitled ``Dedications''. You must delete all
|
||||
sections Entitled ``Endorsements.''
|
||||
|
||||
@item
|
||||
COLLECTIONS OF DOCUMENTS
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@item
|
||||
AGGREGATION WITH INDEPENDENT WORKS
|
||||
|
||||
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 ``aggregate'' if the copyright
|
||||
resulting from the compilation is not used to limit the legal rights
|
||||
of the compilation'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.
|
||||
|
||||
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'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.
|
||||
|
||||
@item
|
||||
TRANSLATION
|
||||
|
||||
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.
|
||||
|
||||
If a section in the Document is Entitled ``Acknowledgements'',
|
||||
``Dedications'', or ``History'', the requirement (section 4) to Preserve
|
||||
its Title (section 1) will typically require changing the actual
|
||||
title.
|
||||
|
||||
@item
|
||||
TERMINATION
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@item
|
||||
FUTURE REVISIONS OF THIS LICENSE
|
||||
|
||||
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
|
||||
@uref{http://www.gnu.org/copyleft/}.
|
||||
|
||||
Each version of the License is given a distinguishing version number.
|
||||
If the Document specifies that a particular numbered version of this
|
||||
License ``or any later version'' 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's public statement of acceptance of a
|
||||
version permanently authorizes you to choose that version for the
|
||||
Document.
|
||||
|
||||
@item
|
||||
RELICENSING
|
||||
|
||||
``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') 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
|
||||
``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the
|
||||
site means any set of copyrightable works thus published on the MMC
|
||||
site.
|
||||
|
||||
``CC-BY-SA'' 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.
|
||||
|
||||
``Incorporate'' means to publish or republish a Document, in whole or
|
||||
in part, as part of another Document.
|
||||
|
||||
An MMC is ``eligible for relicensing'' 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.
|
||||
|
||||
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.
|
||||
|
||||
@end enumerate
|
||||
|
||||
@page
|
||||
@heading ADDENDUM: How to use this License for your documents
|
||||
|
||||
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:
|
||||
|
||||
@smallexample
|
||||
@group
|
||||
Copyright (C) @var{year} @var{your name}.
|
||||
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''.
|
||||
@end group
|
||||
@end smallexample
|
||||
|
||||
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
|
||||
replace the ``with@dots{}Texts.''@: line with this:
|
||||
|
||||
@smallexample
|
||||
@group
|
||||
with the Invariant Sections being @var{list their titles}, with
|
||||
the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
|
||||
being @var{list}.
|
||||
@end group
|
||||
@end smallexample
|
||||
|
||||
If you have Invariant Sections without Cover Texts, or some other
|
||||
combination of the three, merge those two alternatives to suit the
|
||||
situation.
|
||||
|
||||
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.
|
||||
|
||||
@c Local Variables:
|
||||
@c ispell-local-pdict: "ispell-dict"
|
||||
@c End:
|
||||
|
|
@ -1,529 +0,0 @@
|
|||
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@registeredsymbol{}.
|
||||
|
||||
@menu
|
||||
* Unix binary packages::
|
||||
* Source options::
|
||||
* Building from source::
|
||||
* Microsft Windows binaries::
|
||||
@end menu
|
||||
|
||||
@node Unix binary packages
|
||||
@section Installing binary packages on Linux and BSD
|
||||
@cindex Binary packages, Linux, BSD
|
||||
@cindex Linux binary packages
|
||||
@cindex BSD binary packages
|
||||
|
||||
The easiest way to install a released version of Hamlib on a Linux
|
||||
based distribution or a BSD variant is through the provided
|
||||
@dfn{package manager}. While package managers vary according to the
|
||||
distribution (it'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.
|
||||
|
||||
|
||||
@node Source options
|
||||
@section A variety of Hamlib sources
|
||||
@cindex Source options
|
||||
|
||||
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's not hard. :-)
|
||||
|
||||
Source code is available as official releases, testing snapshots,
|
||||
daily development snapshots, and the bleeding edge of development
|
||||
directly from the @url{https://github.com/Hamlib/Hamlib, Git
|
||||
repository}. 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.
|
||||
|
||||
@menu
|
||||
* Source releases::
|
||||
* Source snapshots::
|
||||
* Git clone::
|
||||
@end menu
|
||||
|
||||
@node Source releases
|
||||
@subsection Getting released source
|
||||
@cindex Getting released source
|
||||
@cindex Source, getting released
|
||||
@cindex Source, obtaining releases
|
||||
|
||||
Official Hamlib source releases, commonly called @dfn{tarballs} can be
|
||||
found on the
|
||||
@url{http://sourceforge.net/projects/hamlib/files/hamlib/,
|
||||
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
|
||||
@subsection Getting source snapshots
|
||||
@cindex Getting source snapshots
|
||||
@cindex Source, getting snapshots
|
||||
@cindex Source, obtaining snapshots
|
||||
@cindex Source, daily snapshots
|
||||
@cindex Source, release candidates
|
||||
@cindex Source, RC
|
||||
|
||||
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 @url{https://github.com/Hamlib/Hamlib/releases,
|
||||
GitHub release archive}. RCs are identifed by having a @i{~rc}
|
||||
suffix.
|
||||
|
||||
Daily snapshots of the development repository are available via the
|
||||
World Wide Web from @url{http://n0nb.users.sourceforge.net/, Hamlib
|
||||
Git daily snapshots}. These are not official releases but are
|
||||
provided for testing new features and bug fixes.
|
||||
|
||||
The daily development snapshot is made and posted each day by around
|
||||
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
|
||||
@subsection Git repository
|
||||
@cindex Git repository
|
||||
@cindex Git clone
|
||||
|
||||
The source repository can be @dfn{cloned} which copies the repository
|
||||
to your computer including its entire history, branches, and release
|
||||
tag information. In other words, once the @command{git}
|
||||
@option{clone} 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.
|
||||
|
||||
To clone the repository use the following command:
|
||||
|
||||
@example
|
||||
git clone git://git.code.sf.net/p/hamlib/code hamlib
|
||||
@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
|
||||
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
|
||||
as the @dfn{working copy}. 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.
|
||||
|
||||
@xref{Working with Git}.
|
||||
|
||||
@node Building from source
|
||||
@section Building from source
|
||||
@cindex Building from source
|
||||
@cindex Source, building from
|
||||
|
||||
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---either a specific back end or
|
||||
API changes---and offer a report to the developers, or you'd like to
|
||||
take part in development and offer your contribution to the project,
|
||||
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
|
||||
code archive.
|
||||
|
||||
Before going further, this manual assumes familiarity with working
|
||||
from the command prompt in a Linux/BSD/Unix like system's @dfn{shell}
|
||||
environment, either in a @dfn{virtual console} (a text only screen
|
||||
with no graphics) or in a @dfn{terminal} in a desktop environment
|
||||
(@command{xterm}, @command{rxvt}, @command{konsole},
|
||||
@command{gnome-terminal}, @command{xfce4-terminal},
|
||||
@command{terminal}, etc.). If this is new to you, take some time and
|
||||
read up on using the shell. A good tutorial can be found at
|
||||
@url{http://linuxcommand.org/, LinuxCommand.org} 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).
|
||||
|
||||
Let's get started.
|
||||
|
||||
@menu
|
||||
* Compiling source tarballs::
|
||||
* Bootstrapping from a Git clone::
|
||||
* Other make targets::
|
||||
* Parallel build trees::
|
||||
* Adding debugging symbols::
|
||||
* Compiling Microsoft Windows::
|
||||
@end menu
|
||||
|
||||
@node Compiling source tarballs
|
||||
@subsection Compiling source tarballs
|
||||
@cindex Compiling source tarballs
|
||||
@cindex Source tarballs, compiling
|
||||
|
||||
Before proceeding, it is essential to read the information in the
|
||||
files, @file{README}, @file{INSTALL}, and @file{README.betatester}
|
||||
supplied in the Hamlib @dfn{top-level} directory which will be named
|
||||
something like @file{hamlib-3.3~git} where the latter part is the
|
||||
release version. In this case the @samp{3.3~git} 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.
|
||||
|
||||
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 @dfn{three step} which are each run from the
|
||||
top-level directory:
|
||||
|
||||
@example
|
||||
./configure
|
||||
make
|
||||
sudo make install
|
||||
@end example
|
||||
|
||||
@menu
|
||||
* configure::
|
||||
* make::
|
||||
* make install::
|
||||
* ldconfig::
|
||||
@end menu
|
||||
|
||||
@node configure
|
||||
@subsubsection @command{configure}
|
||||
@cindex configure
|
||||
|
||||
The @command{./configure} command examines your system and checks it
|
||||
for any packages that are required or good to have options for
|
||||
compiling Hamlib. The leading @file{./} tells the shell to only run
|
||||
the @command{configure} command found in the current directory. It is
|
||||
always possible that a @command{configure} command could be lurking
|
||||
elsewhere and we don't want to run that!
|
||||
|
||||
Run:
|
||||
|
||||
@example
|
||||
@command{./configure}
|
||||
@end example
|
||||
|
||||
from the top-level directory.
|
||||
|
||||
@quotation Note
|
||||
Some distributions are configured so commands can only be run from
|
||||
directories listed in the @env{PATH} environment variable. The
|
||||
@file{./} is necessary or the @command{configure} command will not be
|
||||
run as the @dfn{current directory} (defined as @file{.}) is not in the
|
||||
@env{PATH}. This is considered a default security feature so that
|
||||
only programs provided by the distribution are run. @env{PATH} can be
|
||||
modified for your own session, but that is a topic for the
|
||||
LinuxCommand.org reference above.
|
||||
@end quotation
|
||||
|
||||
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 @file{INSTALL}, and @file{README.betatester}
|
||||
files in the Hamlib top-level directory will have details on the
|
||||
options available for that release.
|
||||
|
||||
A useful option is @samp{--prefix} which tells @command{configure}
|
||||
where in the file system hierarchy Hamlib should be installed. If it
|
||||
is not given, Hamlib will be installed in the @file{/usr/local} file
|
||||
system hierarchy. Perhaps you want to install to your home directory
|
||||
instead:
|
||||
|
||||
@example
|
||||
@command{./configure --prefix=$HOME/local}
|
||||
@end example
|
||||
|
||||
@quotation Note
|
||||
For practice you may wish to start out using the
|
||||
@samp{--prefix=$HOME/local} 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
|
||||
@samp{$HOME/local}.
|
||||
@end quotation
|
||||
|
||||
All of the files will be installed in the @file{local} directory of
|
||||
your home directory. @file{local} will be created if it does not
|
||||
exist during installation as will several other directories in it.
|
||||
Installing in your home directory means that @dfn{root}, or superuser
|
||||
(administrator) privileges are not required when running @command{make
|
||||
install}. On the other hand, some extra work will need to be done so
|
||||
other programs can use the library.
|
||||
|
||||
@ignore
|
||||
(TODO: describe library hackery in an appendix).
|
||||
@end ignore
|
||||
|
||||
Another useful option is @samp{--help} which will give a few screens
|
||||
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
|
||||
either a terminal or a virtual console Linux supports the
|
||||
@key{Shift-PageUp} key combination to scroll back up. Converesely
|
||||
@key{Shift-PageDown} 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).
|
||||
|
||||
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
|
||||
the few lines previous to the shell prompt don't say ``error'' or some
|
||||
such failure message Hamlib is ready to be compiled. If there is an
|
||||
error and all of the required packages listed in
|
||||
@file{README.betatester} have been installed, please ask for help on
|
||||
the @email{hamlib-developer@@lists.sourceforge.net, hamlib-developer
|
||||
mailing list}.
|
||||
|
||||
@node make
|
||||
@subsubsection @command{make}
|
||||
@cindex make
|
||||
|
||||
The @command{make} command is responsible for running the
|
||||
@dfn{compiler} which reads the source files and from the instructions
|
||||
it finds in them writes @dfn{object} files which are the binary
|
||||
instructions the @acronym{CPU} of a computer can execute.
|
||||
@command{make} then calls the @dfn{linker} which puts the object files
|
||||
together in the correct order to create the Hamlib library files and
|
||||
its executable programs.
|
||||
|
||||
Run:
|
||||
|
||||
@example
|
||||
@command{make}
|
||||
@end example
|
||||
|
||||
from the top-level directory.
|
||||
|
||||
Any error that causes @command{make} to stop early is cause for a
|
||||
question to the @email{hamlib-developer@@lists.sourceforge.net,
|
||||
hamlib-developer mailing list}.
|
||||
|
||||
In general @command{make} will take longer than @command{configure} to
|
||||
complete its run. As it is a system command and therefore found in
|
||||
the @env{PATH}, prefixing @command{make} with @file{./} will cause a
|
||||
@samp{command not found} error from the shell.
|
||||
|
||||
@node make install
|
||||
@subsubsection @command{make install}
|
||||
@cindex make install
|
||||
|
||||
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, @command{su} and @command{sudo}.
|
||||
@command{sudo} is probably the most popular these days, particularly
|
||||
when using the @url{http://www.ubuntu.com, Ubuntu} family of
|
||||
distributions.
|
||||
|
||||
Run:
|
||||
|
||||
@example
|
||||
@command{sudo make install}
|
||||
@end example
|
||||
|
||||
as root from the top-level directory.
|
||||
|
||||
Running @command{make install} 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 @samp{--prefix} option to
|
||||
@command{configure} in the directory hierarchy (yes, this is by design
|
||||
and @command{make} is not just flinging files any old place!).
|
||||
|
||||
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} not having write permissions in the system directory
|
||||
structure.
|
||||
|
||||
@node ldconfig
|
||||
@subsubsection @command{ldconfig}
|
||||
@cindex ldconfig
|
||||
|
||||
Once the installation is complete one more step is required if Hamlib
|
||||
has never been installed from a local build before. The
|
||||
@command{ldconfig} command tells the system library loader where to
|
||||
find the newly installed Hamlib libraries. It too will need to be run
|
||||
with root privileges:
|
||||
|
||||
Run:
|
||||
|
||||
@example
|
||||
@command{sudo ldconfig}
|
||||
@end example
|
||||
|
||||
as root from any directory.
|
||||
|
||||
@quotation Note
|
||||
Subsequent installations of Hamlib will not need to have
|
||||
@command{ldconfig} run after each installation if a newer major
|
||||
version of Hamlib was not installed, i.e. when recompiling the same
|
||||
version during development.
|
||||
@end quotation
|
||||
|
||||
On some distributions a bit of configuration will be needed before
|
||||
@command{ldconfig} will add locally compiled software to its database.
|
||||
Please consult your distribution's documentation.
|
||||
|
||||
@node Bootstrapping from a Git clone
|
||||
@subsection Bootstrapping from a @command{git clone}
|
||||
@cindex Bootstrapping from a Git clone
|
||||
@cindex Git clone, bootsrapping
|
||||
|
||||
Choosing to build from from a @command{git clone} requires a few more
|
||||
development tools (notice a theme here?) as detailed in
|
||||
@file{README.developer}. The most critical will be the GNU Autotools
|
||||
(@command{autoconf}, @command{automake}, @command{libtool}, and more)
|
||||
from which the build system consisting of @file{configure}, the
|
||||
various @file{Makefile.in}s throughout the directory structure, and
|
||||
the final @file{Makefile}s are generated.
|
||||
|
||||
In the top-level directory is the @command{bootstrap} script from
|
||||
which the build system is @dfn{bootsrapped}---the process of
|
||||
generating the Hamlib build system from @file{configure.ac} and the
|
||||
various @file{Makefile.am}s. At its completion the
|
||||
@command{configure} script will be present to configure the build
|
||||
system.
|
||||
|
||||
Next @command{configure} is run with any needed build options
|
||||
(@command{configure --help} 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 @command{configure} command line.
|
||||
|
||||
After the configuration is complete, the build may proceed with the
|
||||
@command{make} step as for the source tarballs above. Or
|
||||
@command{configure --help} may be run, and @command{configure} run
|
||||
again with specific options in which case the @file{Makefile}s will be
|
||||
regenerated and the build can proceed with the new configuration.
|
||||
|
||||
@xref{configure}.
|
||||
|
||||
@node Other make targets
|
||||
@subsection Other @command{make} targets
|
||||
@cindex Other @command{make} targets
|
||||
@cindex @command{make}, other targets
|
||||
|
||||
Besides @command{make install}, other @dfn{targets} exist when running
|
||||
@command{make}. Running @command{make clean} from the top-level
|
||||
directory removes all of the generated object and executable files
|
||||
generated by running @command{make} freeing up considerable disk
|
||||
space.
|
||||
|
||||
@quotation Note
|
||||
During development of individual source files, it is not necessary to
|
||||
run @command{make clean} each time before @command{make}. Simply run
|
||||
@command{make} and only the modified file(s) and any objects that
|
||||
depend on them will be recompiled. This speeds up development time
|
||||
considerably.
|
||||
@end quotation
|
||||
|
||||
To remove even the generated @file{Makefile}s, run @command{make
|
||||
distclean} from the top-level directory. After this target is run,
|
||||
@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 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
|
||||
@subsection Parallel build trees
|
||||
@cindex Parallel build trees
|
||||
@cindex Build, parallel trees
|
||||
|
||||
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 @command{make} targets
|
||||
described above, it does help the developer find files in the source
|
||||
tree! One such way of using parallel builds is described in
|
||||
@file{README.developer}.
|
||||
|
||||
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 @command{configure}
|
||||
from each directory. The generated @file{Makefile}s are unique to
|
||||
each build directory and will not interfere with each other.
|
||||
|
||||
@node Adding debugging symbols
|
||||
@subsection Adding debugging symbols
|
||||
@cindex Adding debugging symbols
|
||||
|
||||
When additional debugging symbols are needed with, for example, the
|
||||
GNU Debugger, @command{gdb}, the needed compiler and linker options
|
||||
are passed as environment variables.
|
||||
|
||||
Run:
|
||||
@example
|
||||
@command{../hamlib/configure CFLAGS="-ggdb3 -O0" CXXFLAGS="-ggdb3 -O0"}
|
||||
@end example
|
||||
|
||||
from a sibling build directory intended for a debugging build.
|
||||
|
||||
The @samp{-ggdb3} option tells the C compiler, this case the GNU C
|
||||
Compiler, @command{gcc}, to add special symbols useful for GDB, the
|
||||
GNU debugger. The @samp{-O0} option tells @command{gcc} to turn off
|
||||
all optimizations which will make it easier to follow some variables
|
||||
that might otherwise be optimized away. @samp{CFLAGS} and
|
||||
@samp{CXXFLAGS} may be set independently for each compiler.
|
||||
|
||||
@quotation Note
|
||||
There are a number compiler options available for controlling debugging
|
||||
symbols and setting optimization levels. Please consult the compiler's
|
||||
manual for all the details.
|
||||
@end quotation
|
||||
|
||||
@node Compiling Microsoft Windows
|
||||
@subsection Compiling for Microsoft Windows
|
||||
@cindex Compiling for Microsoft Windows
|
||||
@cindex Microsoft Windows, compiling
|
||||
|
||||
Currently compiling is done on a Debian 8 (Jessie) virtual machine
|
||||
using @url{http://www.mingw.org/, MinGW}. @file{README.build-win32}
|
||||
in the @file{scripts} directory has details on how this is
|
||||
accomplished.
|
||||
|
||||
Work is ongoing to correct build issues in the
|
||||
@url{http://www.cygwin.com/, Cygwin} environment running on MS
|
||||
Windows.
|
||||
|
||||
@node Microsft Windows binaries
|
||||
@section Pre-compiled binaries for Microsoft Windows
|
||||
@cindex Pre-compiled binaries for Microsoft Windows
|
||||
@cindex Microsoft Windows, compiled binaries
|
||||
@cindex Microsoft Windows, pre-compiled binaries
|
||||
|
||||
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
|
||||
@url{http://sourceforge.net/projects/hamlib/files/hamlib/,
|
||||
SourceForge.net file download service}. As an alternative, official
|
||||
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
|
||||
is available. Among its features are selecting which portions of
|
||||
Hamlib are installed. The @env{PATH} environment variable will need
|
||||
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
|
||||
extracting installer.
|
||||
|
||||
Bug reports and questions about these archives should be sent to the
|
||||
@email{hamlib-developer@@lists.sourceforge.net, hamlib-developer
|
||||
mailing list}.
|
||||
170
doc/hamlib.texi
170
doc/hamlib.texi
|
|
@ -1,170 +0,0 @@
|
|||
\input texinfo @c -*-texinfo-*-
|
||||
@c %**start of header
|
||||
@setfilename hamlib.info
|
||||
@include version.texi
|
||||
@documentencoding UTF-8
|
||||
@settitle Ham Radio Control Libraries @value{VERSION}
|
||||
@c %**end of header
|
||||
|
||||
@copying
|
||||
This manual is for the Ham Radio Control Libraries (version @value{VERSION}
|
||||
updated @value{UPDATED}), which is a development effort to provide a
|
||||
consistent programming interface for programmers wanting to incorporate
|
||||
radio and rotor control into their programs.
|
||||
|
||||
Copyright @copyright{} 2013,2018 Nate Bargmann
|
||||
|
||||
@quotation
|
||||
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''.
|
||||
@end quotation
|
||||
@end copying
|
||||
|
||||
@dircategory Software libraries
|
||||
@direntry
|
||||
* Hamlib: (hamlib). Ham Radio Control Libraries.
|
||||
@end direntry
|
||||
|
||||
@setchapternewpage odd
|
||||
@titlepage
|
||||
@title Ham Radio Control Libraries
|
||||
@subtitle for version @value{VERSION}, @value{UPDATED}
|
||||
@vskip 0pt plus 1filll
|
||||
@insertcopying
|
||||
@author Nate Bargmann, N0NB (@email{n0nb@@n0nb.us})
|
||||
@end titlepage
|
||||
|
||||
@contents
|
||||
|
||||
@ifnottex
|
||||
@node Top
|
||||
@top Ham Radio Control Libraries
|
||||
|
||||
This manual is for Ham Radio Control Libraries (Hamlib) (version @value{VERSION},
|
||||
@value{UPDATED}).
|
||||
|
||||
@menu
|
||||
* Copying and Redistribution::
|
||||
* Hamlib in a Nutshell::
|
||||
* Getting started::
|
||||
* Utility programs::
|
||||
* GNU Free Documentation License::
|
||||
* Working with Git::
|
||||
* List of Figures::
|
||||
* Concept Index::
|
||||
@end menu
|
||||
|
||||
|
||||
@node Copying and Redistribution
|
||||
@unnumbered Copying and Redistribution
|
||||
@cindex Copying, redistribution
|
||||
@cindex Redistribution, copying
|
||||
@cindex Copyleft
|
||||
|
||||
This manual documents Hamlib, a programming library and various supplied
|
||||
programs, which is
|
||||
@url{http://en.wikipedia.org/wiki/Free_Software_Definition, Free
|
||||
Software, Free Software}. 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.
|
||||
|
||||
Such licensing is often termed
|
||||
@url{http://en.wikipedia.org/wiki/Copyleft, copyleft, copyleft} as a
|
||||
play against the common ``all rights reserved'' terms of normal
|
||||
@url{http://en.wikipedia.org/wiki/Copyright, copyright, copyright}. 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---the
|
||||
@url{http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License, GNU
|
||||
Lesser General Public License, GNU Lesser General Public License}
|
||||
@acronym{LGPL} for the ``front end'' and ``back end'' library source
|
||||
code files, and the
|
||||
@url{http://en.wikipedia.org/wiki/GNU_General_Public_License, GNU
|
||||
General Public License, GNU General Public License} @acronym{GPL} 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.
|
||||
|
||||
This manual is covered by the
|
||||
@url{http://en.wikipedia.org/wiki/GNU_Free_Documentation_License, GNU
|
||||
Free Documentation License, GNU Free Documentation License}
|
||||
@acronym{GFDL} 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.
|
||||
|
||||
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.
|
||||
|
||||
@cindex NO WARRANTY
|
||||
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).
|
||||
@end ifnottex
|
||||
|
||||
|
||||
@c ------------ Chapter ------------
|
||||
@node Hamlib in a Nutshell
|
||||
@chapter Hamlib in a Nutshell
|
||||
@cindex Nutshell
|
||||
|
||||
@include nutshell.texi
|
||||
|
||||
@c ------------ Chapter ------------
|
||||
@node Getting started
|
||||
@chapter Getting started
|
||||
|
||||
@include getting_started.texi
|
||||
|
||||
@c ------------ Chapter ------------
|
||||
@node Utility programs
|
||||
@chapter Utility programs reference
|
||||
|
||||
@include utility_programs.texi
|
||||
|
||||
@c ----------------- Appendixes start here ------------------
|
||||
|
||||
|
||||
@node GNU Free Documentation License
|
||||
@appendix GNU Free Documentation License
|
||||
|
||||
@include fdl.texi
|
||||
|
||||
|
||||
@node Working with Git
|
||||
@appendix Working with Git
|
||||
|
||||
Git offers a myriad of commands and options. Fortunately, only a few
|
||||
are needed for Hamlib development.
|
||||
|
||||
|
||||
@node List of Figures
|
||||
@unnumbered List of Figures
|
||||
@listoffloats Figure
|
||||
|
||||
|
||||
@node Concept Index
|
||||
@unnumbered Concept Index
|
||||
|
||||
@printindex cp
|
||||
|
||||
@bye
|
||||
|
|
@ -1,219 +0,0 @@
|
|||
The @dfn{Ham Radio Control Libraries}, @dfn{Hamlib} for short, is a
|
||||
development effort to provide a consistent interface for programmers
|
||||
wanting to incorporate radio and rotator control in their programs.
|
||||
|
||||
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.
|
||||
|
||||
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's product line and
|
||||
each manufacturer's product line differs greatly from its competitors.
|
||||
|
||||
Hamlib attempts to solve this problem by presenting a "virtual radio"
|
||||
to the programmer by providing an interface to actions such as setting
|
||||
a given Variable Frequency Oscillator'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's capabilities.
|
||||
Unfortunately, what can be accomplished by Hamlib is limited by the
|
||||
radios themselves and some offer very limited capability.
|
||||
|
||||
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).
|
||||
|
||||
@menu
|
||||
* Overview::
|
||||
* The Hamlib project::
|
||||
* Applications using Hamlib::
|
||||
* Licensing implications::
|
||||
* Radio cloning::
|
||||
* Pronunciation::
|
||||
@end menu
|
||||
|
||||
@node Overview
|
||||
@section A view from the top of the tower
|
||||
@cindex Overview
|
||||
|
||||
@cindex Front end library
|
||||
@cindex Virtual radio
|
||||
@cindex Virtual rotator
|
||||
Hamlib is a @dfn{front end} library providing a @emph{C} language
|
||||
Application Programming Interface @acronym{API} to programmers wishing
|
||||
to integrate radio or rotator control in their applications. Hamlib
|
||||
presents a @dfn{virtual radio} or @dfn{virtual rotator} that is a
|
||||
consistent interface to an application despite wide differences in
|
||||
radio and rotator interfaces and capabilities.
|
||||
|
||||
@cindex Back end library
|
||||
The front end library uses a number of @dfn{back end} 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.
|
||||
|
||||
@quotation
|
||||
Since a picture is worth quite a few words, here is a visual representation
|
||||
of Hamlib's design.
|
||||
@ifhtml
|
||||
@*@*
|
||||
@end ifhtml
|
||||
@float Figure, fig:img1
|
||||
@image{Hamlib_design,,,Hamlib Design}
|
||||
@caption{Hamlib design---@i{courtesy of Martin Ewing, AA6E}.}
|
||||
@shortcaption{Hamlib design}
|
||||
@end float
|
||||
@*
|
||||
@end quotation
|
||||
|
||||
@cindex Scripting languages
|
||||
@cindex Languages, scripting
|
||||
@cindex Interface, languages
|
||||
Hamlib also provides an interface library for each of several common
|
||||
@dfn{scripting} languages such as @url{http://www.perl.org, Perl,
|
||||
Perl}, @url{http://www.python.org, Python, Python},
|
||||
@url{https://www.lua.org, Lua, Lua} and @url{http://www.tcl.tk, TCL,
|
||||
TCL}. These language @dfn{bindings} are generated through the use of
|
||||
@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.
|
||||
|
||||
@cindex Daemon, network
|
||||
@cindex Network, daemon
|
||||
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 @emph{TCP/IP} network
|
||||
connection. The daemons then handle the interface to the Hamlib C
|
||||
API.
|
||||
|
||||
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.
|
||||
|
||||
@node The Hamlib project
|
||||
@section Hamlib project information
|
||||
@cindex Hamlib project
|
||||
@cindex Project, Hamlib
|
||||
|
||||
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}) interfaces have remained
|
||||
stable since that time up to the latest release of 3.2 in early 2018.
|
||||
|
||||
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} 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.
|
||||
|
||||
The Project is hosted by @url{https://sourceforge.net/,
|
||||
SourceForge.net} at the @url{https://sourceforge.net/projects/hamlib/,
|
||||
Hamlib project page}. As @url{https://github.com/, GitHub} has become
|
||||
a very popular project hosting site, Hamlib also has a dedicated
|
||||
@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
|
||||
@url{https://sourceforge.net/p/hamlib/mailman/, hamlib-developer
|
||||
mailing list}. While there are
|
||||
@url{https://sourceforge.net/p/hamlib/discussion/, SourceForge.net
|
||||
discussion forums}, they are rarely used and not as closely read by
|
||||
the developers as the mailing list.
|
||||
|
||||
For @dfn{source code management}, the project uses
|
||||
@url{http://git-scm.com/, Git}, 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, @pxref{Working with Git}.
|
||||
|
||||
@quotation Note
|
||||
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.
|
||||
@end quotation
|
||||
|
||||
@node Applications using Hamlib
|
||||
@section Applications using Hamlib
|
||||
@cindex Hamlib applications
|
||||
@cindex Applications, using Hamlib
|
||||
|
||||
A number of application developers have taken advantage of Hamlib's
|
||||
capabilities to implement radio and/or rotator control. While not
|
||||
exhaustive, a list is maintained at the Hamlib Wiki,
|
||||
@url{https://github.com/Hamlib/Hamlib/wiki/Applications-and-Screen-Shots,
|
||||
Applications/Screenshots}. Developers are encouraged to request their
|
||||
applications be added to the gallery by way of the hamlib-developer
|
||||
mailing list.
|
||||
|
||||
@node Licensing implications
|
||||
@section Using Hamlib with your program
|
||||
@cindex Hamlib licensing
|
||||
@cindex Licensing, Hamlib
|
||||
|
||||
As with other Free Software projects, Hamlib relies heavily on
|
||||
copyleft licensing to encourage development contributions and provide
|
||||
an open atmosphere for development. Hamlib's source code is released
|
||||
under two licenses, the Lesser General Public License (@acronym{LGPL})
|
||||
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
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@xref{Copying and Redistribution}.
|
||||
|
||||
@node Radio cloning
|
||||
@section Radios with a clone capability
|
||||
@cindex Radio cloning
|
||||
@cindex Cloning, radio
|
||||
|
||||
Hamlib'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, @url{http://chirp.danplanet.com/, CHIRP}, aims to
|
||||
support radios with such a clone capability. Please contact the CHIRP
|
||||
project for support of such radios.
|
||||
|
||||
@node Pronunciation
|
||||
@section Pronouncing Hamlib
|
||||
@cindex Pronouncing Hamlib
|
||||
@cindex Hamlib, pronouncing
|
||||
|
||||
English speakers seem to have two alternate pronunciations for our
|
||||
project:
|
||||
|
||||
@itemize @bullet
|
||||
@item Hamlib (Ham - lib, long "i", as in library.) IPA style: /'ham læb/
|
||||
@item Hamlib (Ham - lib, short "i", as in liberty.) IPA style: /'ham lɪb/
|
||||
@end itemize
|
||||
|
||||
Then again, we have people who say Linux "L-eye-nux" and those who say
|
||||
"L-in-nux"...
|
||||
|
||||
If you're French, the above does not apply! :-)
|
||||
|
|
@ -1,571 +0,0 @@
|
|||
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.
|
||||
|
||||
This chapter focuses on the two test programs, @command{rigctl} for
|
||||
testing radio back ends and @command{rotctl} for testing rotator back
|
||||
ends and the two network daemons, @command{rigctld} and
|
||||
@command{rotcltd} for radio and rotator access via network sockets.
|
||||
Also included are three demonstation utilities, @command{rigmem},
|
||||
@command{rigsmtr}, and @command{rigswr} which provide functional
|
||||
examples of how Hamlib may be used to accomplish various tasks.
|
||||
|
||||
|
||||
@menu
|
||||
* rigctl::
|
||||
* rotctl::
|
||||
* rigctld::
|
||||
* rotctld::
|
||||
* rigmem::
|
||||
* rigsmtr::
|
||||
* rigswr::
|
||||
@end menu
|
||||
|
||||
@node rigctl
|
||||
@section @command{rigctl}
|
||||
@cindex rigctl
|
||||
|
||||
@command{rigctl} 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.
|
||||
|
||||
@menu
|
||||
* Introduction to rigctl::
|
||||
* rigctl reference::
|
||||
@end menu
|
||||
|
||||
@node Introduction to rigctl
|
||||
@subsection Introduction to @command{rigctl}
|
||||
@cindex Introduction to @command{rigctl}
|
||||
@cindex @command{rigctl}, introduction to
|
||||
|
||||
Most likely the first of the Hamlib utility programs that is used is
|
||||
@command{rigctl}. @command{rigctl} is a character based interactive
|
||||
program and a command line program able to set or query a radio's
|
||||
value with a single command. @command{rigctl} is invoked from a shell
|
||||
command prompt with various options and additional commands.
|
||||
|
||||
In its most simple use as a @dfn{command line} program,
|
||||
@command{rigctl} is used to set frequency and mode by typing commands
|
||||
after any @command{rigctl} options:
|
||||
|
||||
@example
|
||||
@kbd{rigctl F 14205000}
|
||||
@kbd{rigctl M USB 2400}
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
and then query those values:
|
||||
|
||||
@example
|
||||
@kbd{rigctl f}
|
||||
@kbd{rigctl m}
|
||||
@end example
|
||||
|
||||
Entering interactive mode is a simple matter of not placing any
|
||||
commands after any @command{rigctl} options:
|
||||
|
||||
@example
|
||||
@kbd{rigctl}
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
Entering @dfn{interactive mode} allows successive commands to be
|
||||
entered without exiting @command{rigctl}. Recent additions to
|
||||
@command{rigctl} allow command editing and history recall through use
|
||||
of the @url{https://tiswww.case.edu/php/chet/readline/rltop.html,
|
||||
Readline} library.
|
||||
|
||||
Interactive mode is indicated by the spartan prompt:
|
||||
|
||||
@example
|
||||
Rig command:
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
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:
|
||||
|
||||
@example
|
||||
Rig command: @kbd{M}
|
||||
Mode: @kbd{USB}
|
||||
Passband: @kbd{2500}
|
||||
|
||||
Rig command: @kbd{m}
|
||||
Mode: USB
|
||||
Passband: 2500
|
||||
|
||||
Rig command:
|
||||
@end example
|
||||
|
||||
An additional prompt is printed when more information is required by
|
||||
the command. For @kbd{M} above, @command{rigctl} prompted for the
|
||||
``Mode'' and ``Passband'' values. For @kbd{m} above, @command{rigctl}
|
||||
returned the ``Mode'' and ``Passband'' values without further prompts.
|
||||
The command prompt is returned after each command invocation.
|
||||
|
||||
The above examples invoked @command{rigctl} without specifying a radio
|
||||
model. This is a feature where the Hamlib internal radio @dfn{dummy} 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.
|
||||
|
||||
For example, to quickly set frequency on an Elecraft K3:
|
||||
|
||||
@example
|
||||
@kbd{rigctl -m 229 -r /dev/rig F 3900000}
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
and to query the frequency and then mode:
|
||||
|
||||
@example
|
||||
@kbd{rigctl -m 229 -r /dev/rig f}
|
||||
3900000
|
||||
|
||||
@kbd{rigctl -m 229 -r /dev/rig m}
|
||||
LSB
|
||||
2000
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
The returned values do not have the prompt strings associated with
|
||||
interactive mode as shown above.
|
||||
|
||||
The @option{-m} option takes a numeric value that corresponds to a
|
||||
given radio back end model. The @option{-r} option takes the path to
|
||||
the port device on @acronym{POSIX} and the device name on Microsoft
|
||||
Windows.
|
||||
|
||||
@quotation Note
|
||||
A complete list of supported radio models may be seen by use of the
|
||||
@option{-l} option:
|
||||
|
||||
@example
|
||||
@kbd{rigctl -l}
|
||||
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&Schwarz EB200 0.1 Untested
|
||||
2801 Philips/Simoco PRM8060 0.1 Alpha
|
||||
2901 ADAT www.adat.ch ADT-200A 1.36 Beta
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
The list is long so use @kbd{@key{SHIFT}-PageUp}/
|
||||
@kbd{@key{SHIFT}-PageDown} on Linux, @kbd{@key{ScrollLock}} then
|
||||
@kbd{@key{PageUp}}/@kbd{@key{PageDown}} on Free BSD, or use the
|
||||
scrollbar to the virtual terminal window (@command{cmd} window on
|
||||
Microsoft Windows) or the output can be piped to '@command{more}' or
|
||||
'@command{less}', e.g.@: '@kbd{rigctl -l | more}' 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.
|
||||
@end quotation
|
||||
|
||||
@node rigctl reference
|
||||
@subsection @command{rigctl} reference
|
||||
@cindex @command{rigctl} reference
|
||||
@cindex reference, @command{rigctl}
|
||||
|
||||
The complete reference for @command{rigctl} can be found in the
|
||||
@kbd{rigctl}(1) Unix manual page.
|
||||
|
||||
|
||||
@node rotctl
|
||||
@section @command{rotctl}
|
||||
@cindex rotctl
|
||||
|
||||
Identical in function to @command{rigctl}, @command{rotctl} provides a
|
||||
means for testing Hamlib functions useful for rotator control and
|
||||
@acronym{QTH} (Maidenhead gridsquare system, see
|
||||
@url{https://en.wikipedia.org/wiki/Maidenhead_Locator_System,
|
||||
Maidenhead Locator System}) locator computations. As rotators have a
|
||||
much narrower scope than radios, there are fewer command line options
|
||||
and commands for @command{rotctl}.
|
||||
|
||||
@menu
|
||||
* Introduction to rotctl::
|
||||
* rotctl reference::
|
||||
@end menu
|
||||
|
||||
@node Introduction to rotctl
|
||||
@subsection Introduction to @command{rotctl}
|
||||
@cindex Introduction to @command{rotctl}
|
||||
@cindex @command{rotctl}, introduction to
|
||||
|
||||
@command{rotctl} is a character based interactive program and a
|
||||
command line program able to set or query a rotator's value with a
|
||||
single command. @command{rotctl} is invoked from a shell command
|
||||
prompt with various options and additional commands.
|
||||
|
||||
In its most simple use as a command line program, @command{rotctl} is
|
||||
used to set frequency and mode by typing commands after any
|
||||
@command{rotctl} options:
|
||||
|
||||
@example
|
||||
@kbd{rotctl P 145.0 23.0}
|
||||
@kbd{rotctl M 8 25}
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
and then query those values:
|
||||
|
||||
@example
|
||||
@kbd{rotctl p}
|
||||
@end example
|
||||
|
||||
Entering interactive mode is a simple matter of not placing any
|
||||
commands after any @command{rotctl} options:
|
||||
|
||||
@example
|
||||
@kbd{rotctl}
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
Entering interactive mode allows successive commands to be entered
|
||||
without exiting @command{rotctl}. Interactive mode allows for command
|
||||
editing and history recall through the use of the @url{
|
||||
https://tiswww.case.edu/php/chet/readline/rltop.html, Readline}
|
||||
library.
|
||||
|
||||
Interactive mode is indicated by the spartan prompt:
|
||||
|
||||
@example
|
||||
Rotator command:
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
Commands are given at the prompt:
|
||||
|
||||
@example
|
||||
Rotator command: @kbd{M}
|
||||
Direction: 16
|
||||
Speed: 60
|
||||
|
||||
Rotator command: @kbd{p}
|
||||
Azimuth: 11.352000
|
||||
Elevation: 0.000000
|
||||
|
||||
Rotator command: @kbd{p}
|
||||
Azimuth: 27.594000
|
||||
Elevation: 0.000000
|
||||
|
||||
Rotator command:
|
||||
@end example
|
||||
|
||||
An additional prompt is printed when more information is required by
|
||||
the command. For @kbd{M} above, @command{rotctl} prompted for the
|
||||
``Direction'' and ``Speed'' values. For @kbd{p} above,
|
||||
@command{rotctl} returned the ``Azimuth'' and ``Elevation'' values
|
||||
without further prompts. The command prompt is returned after each
|
||||
command invocation.
|
||||
|
||||
The above examples invoked @command{rotctl} 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.
|
||||
|
||||
For example, to quickly set position for RotorEZ:
|
||||
|
||||
@example
|
||||
@kbd{rotctl -m 401 -r /dev/rotor P 100.0 0.0}
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
and to query the position:
|
||||
|
||||
@example
|
||||
@kbd{rotctl -m 401 -r /dev/rotor p}
|
||||
100.000000
|
||||
0.000000
|
||||
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
The returned values do not have the prompt strings associated with
|
||||
interactive mode as shown above.
|
||||
|
||||
The @option{-m} option takes a numeric value that corresponds to a
|
||||
given rotator back end model. The @option{-r} option takes the path to
|
||||
the port device on @acronym{POSIX} or the device name on MS Windows.
|
||||
|
||||
@quotation Note
|
||||
A complete list of supported radio models may be seen by use of the
|
||||
@option{-l} option:
|
||||
|
||||
@example
|
||||
@kbd{rotctl -l}
|
||||
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
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
The list is long so use @kbd{@key{SHIFT}-PageUp}/
|
||||
@kbd{@key{SHIFT}-PageDown} on Linux, @kbd{@key{ScrollLock}} then
|
||||
@kbd{@key{PageUp}}/@kbd{@key{PageDown}} on Free BSD, or use the
|
||||
scrollbar to the virtual terminal window (@command{cmd} window on MS
|
||||
Windows) or the output can be piped to '@command{more}' or
|
||||
'@command{less}', e.g.@: '@kbd{rotctl -l | more}' 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.
|
||||
@end quotation
|
||||
|
||||
|
||||
@node rotctl reference
|
||||
@subsection @command{rotctl} reference
|
||||
@cindex @command{rotctl} reference
|
||||
@cindex reference, @command{rotctl}
|
||||
|
||||
The complete reference for @command{rotctl} can be found in the
|
||||
@kbd{rotctl}(1) Unix manual page.
|
||||
|
||||
|
||||
@node rigctld
|
||||
@section @command{rigctld}
|
||||
@cindex rigctld
|
||||
|
||||
The @command{rigctld} program is a network server that accepts the
|
||||
familiar commands of @command{rigctl} and provides the response data
|
||||
over a @acronym{TCP/IP} network socket to an application. In this
|
||||
manner an application can access a @command{rigctld} instance from
|
||||
nearly anywhere (caveat, no security is currently provided by
|
||||
@command{rigctld}). Applications using @command{rigctld} do not link
|
||||
directly to Hamlib nor use its C API.
|
||||
|
||||
@menu
|
||||
* Introduction to rigctld::
|
||||
* rigctld reference::
|
||||
@end menu
|
||||
|
||||
@node Introduction to rigctld
|
||||
@subsection Introduction to @command{rigctld}
|
||||
@cindex Introduction to @command{rigctld}
|
||||
@cindex @command{rigctld}, introduction to
|
||||
|
||||
@command{rigctld} communicates to a client through a @acronym{TCP}
|
||||
network socket using text commands shared with @command{rigctl}. The
|
||||
protocol is simple; commands are sent to @command{rigctld} on one line
|
||||
and @command{rigctld} responds to ``get'' commands with the requested
|
||||
values, one per line, when successful, otherwise, it responds with one
|
||||
line @samp{RPRT x}, where @samp{x} is a negative number indicating the
|
||||
Hamlib error code. Commands that do not return values respond with
|
||||
the line @samp{RPRT x}, where @samp{x} is zero when successful,
|
||||
otherwise a negative number indicating the Hamlib error code. Each
|
||||
line is terminated with a newline @code{\n} character. This protocol
|
||||
is primarily for use by the @code{NET rigctl} (radio model 2) backend.
|
||||
|
||||
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 @samp{RPRT x} 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
|
||||
@command{rigctld} directly through a @acronym{TCP} network socket.
|
||||
|
||||
Multiple radios can be controlled on different @acronym{TCP} ports by
|
||||
use of multiple @command{rigctld} processes each listening on a unique
|
||||
@acronym{TCP} port. It is hoped that @command{rigctld} will be
|
||||
especially useful for client authors using languages such as
|
||||
@url{http://www.perl.org/, Perl}, @url{http://www.python.org/,
|
||||
Python}, @url{http://php.net/, PHP},
|
||||
@url{http://www.ruby-lang.org/en/, Ruby}, @url{http://www.tcl.tk/,
|
||||
TCL}, and others.
|
||||
|
||||
@node rigctld reference
|
||||
@subsection @command{rigctld} reference
|
||||
@cindex @command{rigctld} reference
|
||||
@cindex reference, @command{rigctld}
|
||||
|
||||
The complete reference for @command{rigctld} can be found in the
|
||||
@kbd{rigctld}(1) Unix manual page.
|
||||
|
||||
|
||||
@node rotctld
|
||||
@section @command{rotctld}
|
||||
@cindex rotctld
|
||||
|
||||
The @command{rotctld} program is a network server that accepts the
|
||||
familiar commands of @command{rotctl} and provides the response data
|
||||
over a @acronym{TCP/IP} network socket to an application. In this
|
||||
manner an application can access a @command{rotctld} instance from
|
||||
nearly anywhere (caveat, no security is currently provided by
|
||||
@command{rotctld}). Applications using @command{rotctld} do not link
|
||||
directly to Hamlib nor use its C API.
|
||||
|
||||
@menu
|
||||
* Introduction to rotctld::
|
||||
* rotctld reference::
|
||||
@end menu
|
||||
|
||||
@node Introduction to rotctld
|
||||
@subsection Introduction to @command{rotctld}
|
||||
@cindex Introduction to @command{rotctld}
|
||||
@cindex @command{rotctld}, introduction to
|
||||
|
||||
@command{rotctld} communicates to a client through a @acronym{TCP}
|
||||
network socket using text commands shared with @command{rotctl}. The
|
||||
protocol is simple, commands are sent to @command{rotctld} on one line
|
||||
and @command{rotctld} responds to ``get'' commands with the requested
|
||||
values, one per line, when successful, otherwise, it responds with one
|
||||
line @samp{RPRT x}, where @samp{x} is a negative number indicating the
|
||||
Hamlib error code. Commands that do not return values respond with
|
||||
the line @samp{RPRT x}, where @samp{x} is zero when successful,
|
||||
otherwise a negative number indicating the Hamlib error code. Each
|
||||
line is terminated with a newline @code{\n} character. This protocol
|
||||
is primarily for use by the @code{NET rotctl} (rot model 2) backend.
|
||||
|
||||
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 @samp{RPRT x} 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
|
||||
@command{rotctld} directly through a @acronym{TCP} network socket.
|
||||
|
||||
Multiple rotators can be controlled on different @acronym{TCP} ports by
|
||||
use of multiple @command{rotctld} processes each listening on a unique
|
||||
@acronym{TCP} port. It is hoped that @command{rotctld} will be
|
||||
especially useful for client authors using languages such as
|
||||
@url{http://www.perl.org/, Perl}, @url{http://www.python.org/,
|
||||
Python}, @url{http://php.net/, PHP},
|
||||
@url{http://www.ruby-lang.org/en/, Ruby}, @url{http://www.tcl.tk/,
|
||||
TCL}, and others.
|
||||
|
||||
@node rotctld reference
|
||||
@subsection @command{rotctld} reference
|
||||
@cindex @command{rotctld} reference
|
||||
@cindex reference, @command{rotctld}
|
||||
|
||||
The complete reference for @command{rotctld} can be found in the
|
||||
@kbd{rotctld}(1) Unix manual page.
|
||||
|
||||
|
||||
@node rigmem
|
||||
@section @command{rigmem}
|
||||
@cindex rigmem
|
||||
|
||||
@command{rigmem} may be used to backup and restore memory of radio
|
||||
transceivers and receivers.
|
||||
|
||||
@menu
|
||||
* Introduction to rigmem::
|
||||
* rigmem reference::
|
||||
@end menu
|
||||
|
||||
@node Introduction to rigmem
|
||||
@subsection Introduction to @command{rigmem}
|
||||
@cindex Introduction to @command{rigmem}
|
||||
@cindex @command{rigmem}, introduction to
|
||||
|
||||
Backup and restore memory of radio transceivers and receivers.
|
||||
@command{rigmem} accepts @samp{command}s from the command line only.
|
||||
|
||||
@node rigmem reference
|
||||
@subsection @command{rigmem} reference
|
||||
@cindex @command{rigmem} reference
|
||||
@cindex reference, @command{rigmem}
|
||||
|
||||
The complete reference for @command{rigmem} can be found in the
|
||||
@kbd{rigmem}(1) Unix manual page.
|
||||
|
||||
@node rigsmtr
|
||||
@section @command{rigsmtr}
|
||||
@cindex rigsmtr
|
||||
|
||||
@command{rigsmtr} uses Hamlib to control a radio to measure S-Meter
|
||||
value versus antenna azimuth.
|
||||
|
||||
@menu
|
||||
* Introduction to rigsmtr::
|
||||
* rigsmtr reference::
|
||||
@end menu
|
||||
|
||||
@node Introduction to rigsmtr
|
||||
@subsection Introduction to @command{rigsmtr}
|
||||
@cindex Introduction to @command{rigsmtr}
|
||||
@cindex @command{rigsmtr}, introduction to
|
||||
|
||||
@command{rigsmtr} 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.
|
||||
|
||||
To work correctly, @command{rigsmtr} needs a radio that could measure
|
||||
S-Meter and a Hamlib backend that is able to retrieve it, connected to
|
||||
a Hamlib supported rotator.
|
||||
|
||||
@node rigsmtr reference
|
||||
@subsection @command{rigsmtr} reference
|
||||
@cindex @command{rigsmtr} reference
|
||||
@cindex reference, @command{rigsmtr}
|
||||
|
||||
The complete reference for @command{rigsmtr} can be found in the
|
||||
@kbd{rigsmtr}(1) Unix manual page.
|
||||
|
||||
@node rigswr
|
||||
@section @command{rigswr}
|
||||
@cindex rigswr
|
||||
|
||||
@command{rigswr} may be used to measure VSWR vs frequency.
|
||||
|
||||
@menu
|
||||
* Introduction to rigswr::
|
||||
* rigswr reference::
|
||||
@end menu
|
||||
|
||||
@node Introduction to rigswr
|
||||
@subsection Introduction to @command{rigswr}
|
||||
@cindex Introduction to @command{rigswr}
|
||||
@cindex @command{rigswr}, introduction to
|
||||
|
||||
@command{rigswr} uses Hamlib to control a radio to measure
|
||||
@acronym{VSWR} (Voltage Standing Wave Ratio) over a frequency range.
|
||||
It scans frequencies from @var{start_freq} to @var{stop_freq} with an
|
||||
optional increment of @var{freq_step} (default step is 100 kHz). All
|
||||
values must be entered as an integer in Hertz (cycles per second).
|
||||
|
||||
@quotation Note
|
||||
@command{rigswr} assumes that @var{start_freq} is less than or equal
|
||||
to @var{stop_freq}. If it is greater, @command{rigswr} will exit
|
||||
without doing anything.
|
||||
@end quotation
|
||||
|
||||
For each frequency, @command{rigswr} transmits at 25% of total POWER
|
||||
during 0.5 second in CW mode and reads @acronym{VSWR}.
|
||||
|
||||
Frequency and the corresponding @acronym{VSWR} are then printed on
|
||||
@file{stdout}.
|
||||
|
||||
To work correctly, @command{rigswr} needs a radio that can measure
|
||||
@acronym{VSWR} and a Hamlib backend that supports reading
|
||||
@acronym{VSWR} from the radio.
|
||||
|
||||
@node rigswr reference
|
||||
@subsection @command{rigswr} reference
|
||||
@cindex @command{rigswr} reference
|
||||
@cindex reference, @command{rigswr}
|
||||
|
||||
The complete reference for @command{rigswr} can be found in the
|
||||
@kbd{rigswr}(1) Unix manual page.
|
||||
|
|
@ -85,7 +85,7 @@ The bin/ directory is where the executables and DLL files are placed. Header
|
|||
files are under include/Hamlib/ and compiler specific files are under lib/*.
|
||||
HTML documents for the .EXE programs are in doc/ while text documents
|
||||
(READMEs and such) are in the main archive directory. The doc/ directory
|
||||
also contains the generated HTML texinfo manual. The embedded
|
||||
contains the classic Unix manual pages converted to HTML. The embedded
|
||||
README.w[32|64]-bin.txt file generated by the build-w[32|64].sh script
|
||||
describes setting the PATH environment variable in Windows 2000, Windows XP,
|
||||
and Windows 7.
|
||||
|
|
|
|||
|
|
@ -195,8 +195,6 @@ make install
|
|||
mkdir -p ${ZIP_DIR}/bin ${ZIP_DIR}/lib/msvc ${ZIP_DIR}/lib/gcc ${ZIP_DIR}/include ${ZIP_DIR}/doc
|
||||
cp -a src/libhamlib.def ${ZIP_DIR}/lib/msvc/libhamlib-2.def; todos ${ZIP_DIR}/lib/msvc/libhamlib-2.def
|
||||
cp -a ${INST_DIR}/include/hamlib ${ZIP_DIR}/include/.; todos ${ZIP_DIR}/include/hamlib/*.h
|
||||
cp -a doc/Hamlib_design.png ${ZIP_DIR}/doc
|
||||
cp -a doc/hamlib.html ${ZIP_DIR}/doc
|
||||
|
||||
# C++ binding is useless on w32 because of ABI
|
||||
rm ${ZIP_DIR}/include/hamlib/{rig,rot}class.h
|
||||
|
|
|
|||
|
|
@ -195,8 +195,6 @@ make install
|
|||
mkdir -p ${ZIP_DIR}/bin ${ZIP_DIR}/lib/gcc ${ZIP_DIR}/include ${ZIP_DIR}/doc ${ZIP_DIR}/lib/msvc # ${ZIP_DIR}/pdf
|
||||
cp -a src/libhamlib.def ${ZIP_DIR}/lib/msvc/libhamlib-2.def; todos ${ZIP_DIR}/lib/msvc/libhamlib-2.def
|
||||
cp -a ${INST_DIR}/include/hamlib ${ZIP_DIR}/include/.; todos ${ZIP_DIR}/include/hamlib/*.h
|
||||
cp -a doc/Hamlib_design.png ${ZIP_DIR}/doc
|
||||
cp -a doc/hamlib.html ${ZIP_DIR}/doc
|
||||
|
||||
# C++ binding is useless on w64 because of ABI
|
||||
rm ${ZIP_DIR}/include/hamlib/{rig,rot}class.h
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue