kopia lustrzana https://github.com/Hamlib/Hamlib
Update informational man pages for Hamlib 4.0
Nate Bargmann
rodzic
42f4177306
commit
e4727094ab
|
|
@ -5,7 +5,7 @@
|
|||
.\"
|
||||
.\" Please keep this file in sync with doc/getting_started.texi
|
||||
.\"
|
||||
.TH HAMLIB-PRIMER "7" "2018-05-27" "Hamlib" "Hamlib Information Manual"
|
||||
.TH HAMLIB-PRIMER "7" "2020-09-08" "Hamlib" "Hamlib Information Manual"
|
||||
.
|
||||
.
|
||||
.SH NAME
|
||||
|
|
@ -73,11 +73,13 @@ SourceForge.net Hamlib files
|
|||
.UE
|
||||
Web page.
|
||||
.
|
||||
As a convenience, release archives are also mirrored at the
|
||||
.UR https://github.com/Hamlib/Hamlib/releases
|
||||
GitHub Hamlib releases
|
||||
.UE
|
||||
page.
|
||||
.\" It appears as of early September 2020 that the uploaded releases have been
|
||||
.\" deleted from GitHub
|
||||
'\" As a convenience, release archives are also mirrored at the
|
||||
.\" .UR https://github.com/Hamlib/Hamlib/releases
|
||||
.\" GitHub Hamlib releases
|
||||
'\" .UE
|
||||
.\" page.
|
||||
.
|
||||
The most recent release is listed first.
|
||||
.
|
||||
|
|
@ -87,14 +89,17 @@ The most recent release is listed first.
|
|||
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
|
||||
.UR https://github.com/Hamlib/Hamlib/releases
|
||||
GitHub release archive
|
||||
.UE .
|
||||
Beginning with the 4.0 release, RCs are hosted by the
|
||||
.UR http://sourceforge.net/projects/hamlib/files/hamlib/
|
||||
SourceForge.net Hamlib files
|
||||
.UE
|
||||
Web page.
|
||||
.
|
||||
RCs are identifed by having a
|
||||
.I ~rc
|
||||
suffix.
|
||||
.I ~rcX
|
||||
suffix where the
|
||||
.I X
|
||||
is replace by a numeral for successive release candidates.
|
||||
.
|
||||
.PP
|
||||
Daily snapshots of the development repository are available via the World Wide
|
||||
|
|
@ -140,21 +145,21 @@ None of the meta-data is hidden away on some central server.
|
|||
.PP
|
||||
To clone the repository use the following command:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
git clone https://git.code.sf.net/p/hamlib/code hamlib
|
||||
.B git clone https://git.code.sf.net/p/hamlib/code hamlib
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
or:
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
git clone https://github.com/Hamlib/Hamlib.git
|
||||
.B git clone https://github.com/Hamlib/Hamlib.git
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
.
|
||||
|
|
@ -194,18 +199,22 @@ Any is a good reason to build from the source code archive.
|
|||
.PP
|
||||
Before going further, this manual assumes familiarity with working from the
|
||||
command prompt in a Linux/BSD/Unix like system's
|
||||
.I shell
|
||||
environment, either in a
|
||||
.I Bourne shell
|
||||
environment (compatible Bourne shells include
|
||||
.BR bash (1),
|
||||
.BR ksh (1),
|
||||
.BR zsh (1),
|
||||
and several more) either in a
|
||||
.I virtual console
|
||||
(a text only screen with no graphics) or in a
|
||||
.I terminal
|
||||
in a desktop environment
|
||||
.RB ( xterm ,
|
||||
.BR rxvt ,
|
||||
.BR konsole ,
|
||||
.BR gnome\-terminal ,
|
||||
.BR xfce4\-terminal ,
|
||||
.BR terminal ,
|
||||
.RB ( xterm (1),
|
||||
.BR rxvt (1),
|
||||
.BR konsole "(1) (included with the KDE desktop),"
|
||||
.BR gnome\-terminal (1),
|
||||
.BR xfce4\-terminal (1),
|
||||
.BR terminal "(1) (included in macOS),"
|
||||
etc.).
|
||||
.
|
||||
If this is new to you, take some time and read up on using the shell.
|
||||
|
|
@ -250,14 +259,14 @@ or daily development snapshot follows the same set of commands, known as the
|
|||
.I three step
|
||||
which are each run from the top-level directory:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
\&./configure
|
||||
make
|
||||
sudo make install
|
||||
.B ./configure
|
||||
.B make
|
||||
.B sudo make install
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.SS configure
|
||||
.
|
||||
|
|
@ -279,12 +288,12 @@ command could be lurking elsewhere and we don't want to run that!
|
|||
.PP
|
||||
Run:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
\&./configure
|
||||
.B ./configure
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
from the top-level directory.
|
||||
|
|
@ -346,12 +355,12 @@ file system hierarchy.
|
|||
.
|
||||
Perhaps you want to install to your home directory instead:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
\&./configure \-\-prefix=$HOME/local
|
||||
.B ./configure \-\-prefix=$HOME/local
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.IP
|
||||
.BR Note :
|
||||
|
|
@ -365,7 +374,7 @@ installed to
|
|||
.IR $HOME/local .
|
||||
.
|
||||
.PP
|
||||
All of the files will be installed in the
|
||||
As a result of this option, all of the files will be installed in the
|
||||
.I local
|
||||
directory of your home directory.
|
||||
.
|
||||
|
|
@ -381,6 +390,26 @@ or superuser (administrator) privileges are not required when running
|
|||
On the other hand, some extra work will need to be done so other programs can
|
||||
use the library.
|
||||
.
|
||||
The utilities that are compiled as a part of the Hamlib build system will work
|
||||
as they are
|
||||
.I linked
|
||||
to the library installed under
|
||||
.IR local .
|
||||
.
|
||||
Running them will require declaring the complete path:
|
||||
.
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
.B local/bin/rigctl
|
||||
.EE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
or modifying your shell's
|
||||
.I PATH
|
||||
environment variable (see the shell tutorial site above).
|
||||
.
|
||||
.\" (TODO: describe library hackery in an appendix).
|
||||
.
|
||||
.PP
|
||||
|
|
@ -397,7 +426,7 @@ combination to scroll back up.
|
|||
.
|
||||
Conversely, 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).
|
||||
scroll one line at a time (terminal dependent)).
|
||||
.
|
||||
.PP
|
||||
After a fair amount of time, depending on your computer, and a lot of screen
|
||||
|
|
@ -411,7 +440,7 @@ or some such failure message Hamlib is ready to be compiled.
|
|||
If there is an error and all of the required packages listed in
|
||||
.I README.betatester
|
||||
have been installed, please ask for help on the
|
||||
.MT hamlib\-developer@@lists.sourceforge.net
|
||||
.MT hamlib\-developer@lists.sourceforge.net
|
||||
hamlib-developer mailing list
|
||||
.ME .
|
||||
.
|
||||
|
|
@ -435,12 +464,12 @@ library files and its executable programs.
|
|||
.PP
|
||||
Run:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
make
|
||||
.B make
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
from the top-level directory.
|
||||
|
|
@ -449,7 +478,7 @@ from the top-level directory.
|
|||
Any error that causes
|
||||
.B make
|
||||
to stop early is cause for a question to the
|
||||
.MT hamlib\-developer@@lists.sourceforge.net
|
||||
.MT hamlib\-developer@lists.sourceforge.net
|
||||
hamlib-developer mailing list
|
||||
.ME .
|
||||
.
|
||||
|
|
@ -460,9 +489,9 @@ will take longer than
|
|||
.B configure
|
||||
to complete its run.
|
||||
.
|
||||
As it is a system command, and therefore found in the
|
||||
.BR PATH ,
|
||||
prefixing
|
||||
As it is a system command, and therefore found in the shell's
|
||||
.B PATH
|
||||
environment variable, prefixing
|
||||
.B make
|
||||
with
|
||||
.I ./
|
||||
|
|
@ -490,16 +519,44 @@ family of distributions.
|
|||
.PP
|
||||
Run:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
sudo make install
|
||||
.B sudo make install
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
or:
|
||||
.
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
.RB $ " su -l"
|
||||
Password:
|
||||
.RB # " make install"
|
||||
.EE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
as root from the top-level directory.
|
||||
.
|
||||
.IP
|
||||
.BR Note :
|
||||
The shell session is shown to show the change in prompt from a normal user
|
||||
account to the root accout.
|
||||
.
|
||||
.PP
|
||||
The
|
||||
.B \-l
|
||||
option to
|
||||
.B su
|
||||
forces a
|
||||
.I login
|
||||
shell so that environment variables such as
|
||||
.I PATH
|
||||
are set correctly.
|
||||
.
|
||||
.PP
|
||||
Running
|
||||
.B make install
|
||||
|
|
@ -536,22 +593,22 @@ It too will need to be run with root privileges:
|
|||
.PP
|
||||
Run:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
sudo ldconfig
|
||||
.B sudo ldconfig
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
as root from any directory.
|
||||
as root from any directory or while logged in as root from above.
|
||||
.
|
||||
.PP
|
||||
.IP
|
||||
.BR Note :
|
||||
Subsequent installations of Hamlib will not need to have
|
||||
.B ldconfig
|
||||
run after each installation if a newer version of Hamlib was not installed,
|
||||
i.e. when recompiling the same version during development.
|
||||
i.e., when recompiling the same version during development.
|
||||
.
|
||||
.PP
|
||||
On some distributions a bit of configuration will be needed before
|
||||
|
|
@ -637,7 +694,7 @@ executable files generated by running
|
|||
.B make
|
||||
freeing up considerable disk space.
|
||||
.
|
||||
.PP
|
||||
.IP
|
||||
.BR Note :
|
||||
During development of individual source files, it is not necessary to
|
||||
run
|
||||
|
|
@ -709,12 +766,12 @@ the needed compiler and linker options are passed as environment variables.
|
|||
.
|
||||
.PP
|
||||
Run:
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
\&../hamlib/configure CFLAGS="-ggdb3 -O0" CXXFLAGS="-ggdb3 -O0"
|
||||
.B ../hamlib/configure CFLAGS="-ggdb3 -O0" CXXFLAGS="-ggdb3 -O0"
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
from a sibling build directory intended for a debugging build.
|
||||
|
|
@ -738,7 +795,7 @@ and
|
|||
.B CXXFLAGS
|
||||
may be set independently for each compiler.
|
||||
.
|
||||
.PP
|
||||
.IP
|
||||
.BR Note :
|
||||
There are a number compiler options available for controlling debugging
|
||||
symbols and setting optimization levels.
|
||||
|
|
@ -748,7 +805,7 @@ Please consult the compiler's manual for all the details.
|
|||
.
|
||||
.SS Compiling for Microsoft Windows
|
||||
.
|
||||
Currently compiling is done on a Debian 8 (Jessie) virtual machine using
|
||||
Currently compiling is done on a Debian 10 (Buster) virtual machine using
|
||||
.UR http://www.mingw.org
|
||||
MinGW
|
||||
.UE .
|
||||
|
|
@ -764,16 +821,18 @@ 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.
|
||||
.
|
||||
.PP
|
||||
Official releases are available through the
|
||||
.UR http://sourceforge.net/projects/hamlib/files/hamlib/
|
||||
SourceForge.net file download service
|
||||
.UE .
|
||||
.
|
||||
As an alternative, official releases are also available though the
|
||||
.UR https://github.com/Hamlib/Hamlib/releases
|
||||
Hamlib archive at GitHub
|
||||
.UE .
|
||||
.\"As an alternative, official releases are also available though the
|
||||
.\".UR https://github.com/Hamlib/Hamlib/releases
|
||||
.\"Hamlib archive at GitHub
|
||||
.\".UE .
|
||||
.
|
||||
.PP
|
||||
Daily development snapshots are available from the
|
||||
.UR http://n0nb.users.sourceforge.net/
|
||||
daily snapshots page
|
||||
|
|
@ -786,7 +845,7 @@ available.
|
|||
Among its features are selecting which portions of Hamlib are installed.
|
||||
.
|
||||
The
|
||||
.B PATH
|
||||
.I PATH
|
||||
environment variable will need to be set manually per the included
|
||||
.I README.w32-bin
|
||||
or
|
||||
|
|
@ -799,7 +858,7 @@ extracting installer.
|
|||
.
|
||||
.PP
|
||||
Bug reports and questions about these archives should be sent to the
|
||||
.MT hamlib-developer@@lists.sourceforge.net
|
||||
.MT hamlib-developer@lists.sourceforge.net
|
||||
hamlib-developer mailing list
|
||||
.ME .
|
||||
.
|
||||
|
|
@ -811,7 +870,7 @@ radio and rotator control functions for developers of software primarily of
|
|||
interest to radio amateurs and those interested in radio communications.
|
||||
.
|
||||
.PP
|
||||
Copyright \(co 2001-2018 Hamlib Group (various contributors)
|
||||
Copyright \(co 2001-2020 Hamlib Group (various contributors)
|
||||
.
|
||||
.PP
|
||||
This is free software; see the file COPYING for copying conditions. There is
|
||||
|
|
@ -831,8 +890,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|||
.SH COLOPHON
|
||||
.
|
||||
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
|
||||
archives:
|
||||
.IP
|
||||
archives are available via
|
||||
.
|
||||
.UR http://www.hamlib.org
|
||||
hamlib.org
|
||||
.UE .
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
.\"
|
||||
.\" Please keep this file in sync with doc/utility-programs.texi
|
||||
.\"
|
||||
.TH HAMLIB-UTILITIES "7" "2018-05-27" "Hamlib" "Hamlib Information Manual"
|
||||
.TH HAMLIB-UTILITIES "7" "2020-09-08" "Hamlib" "Hamlib Information Manual"
|
||||
.
|
||||
.
|
||||
.SH NAME
|
||||
|
|
@ -26,17 +26,20 @@ library functions both through the
|
|||
.SM API.
|
||||
.
|
||||
.PP
|
||||
This page summarizes the two test programs,
|
||||
This page summarizes the three test programs,
|
||||
.BR ampctl (1)
|
||||
for testing amplifier back ends,
|
||||
.BR rigctl (1)
|
||||
for testing radio back ends and
|
||||
for testing radio back ends, and
|
||||
.BR rotctl (1)
|
||||
for testing rotator back ends and the two network daemons,
|
||||
.BR rigctld (1)
|
||||
for testing rotator back ends and the three network daemons,
|
||||
.BR ampctld (1),
|
||||
.BR rigctld (1),
|
||||
and
|
||||
.BR rotcltd (1)
|
||||
for radio and rotator access via network sockets.
|
||||
for amplifier, radio, and rotator access via network sockets.
|
||||
.
|
||||
Also included are three demonstation utilities,
|
||||
Also included are three demonstration utilities,
|
||||
.BR rigmem (1),
|
||||
.BR rigsmtr (1),
|
||||
and
|
||||
|
|
@ -70,42 +73,40 @@ additional commands.
|
|||
.
|
||||
.PP
|
||||
In its most simple use as a
|
||||
.I "command line"
|
||||
.I command line
|
||||
program, rigctl is used to set frequency and mode by typing commands after any
|
||||
rigctl options:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rigctl F 14205000
|
||||
.br
|
||||
rigctl M USB 2400
|
||||
.B rigctl F 14205000
|
||||
.B rigctl M USB 2400
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
and then query those values:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rigctl f
|
||||
.br
|
||||
rigctl m
|
||||
.B rigctl f
|
||||
.B rigctl m
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
Entering
|
||||
.I "interactive mode"
|
||||
.I interactive mode
|
||||
is a simple matter of not placing any commands after any rigctl options:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rigctl
|
||||
.B rigctl
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
Entering interactive mode allows successive commands to be entered without
|
||||
|
|
@ -121,35 +122,31 @@ library.
|
|||
.PP
|
||||
Interactive mode is indicated by the spartan prompt:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
Rig command:
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
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:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
Rig command: M
|
||||
.br
|
||||
.RB "Rig command: " M
|
||||
.RB "Mode: " USB
|
||||
.RB "Passband: " 2500
|
||||
|
||||
.RB "Rig command: " m
|
||||
Mode: USB
|
||||
.br
|
||||
Passband: 2500
|
||||
.sp
|
||||
Rig command: m
|
||||
.br
|
||||
Mode: USB
|
||||
.br
|
||||
Passband: 2500
|
||||
.sp
|
||||
|
||||
Rig command:
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
An additional prompt is printed when more information is required by the
|
||||
|
|
@ -168,7 +165,7 @@ The above examples invoked rigctl without specifying a radio model.
|
|||
.
|
||||
This is a feature where the Hamlib internal radio model 1
|
||||
.I dummy
|
||||
is used instead.
|
||||
is used.
|
||||
.
|
||||
The dummy radio provides a way to test Hamlib functions without the need for
|
||||
actual radio hardware.
|
||||
|
|
@ -179,32 +176,29 @@ the actual radio connected to the computer is necessary for debugging.
|
|||
.PP
|
||||
For example, to quickly set frequency on an Elecraft K3:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rigctl -m 229 -r /dev/rig F 3900000
|
||||
.B rigctl -m 2029 -r /dev/rig F 3900000
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
and to query the frequency and then mode:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rigctl -m 229 -r /dev/rig f
|
||||
.br
|
||||
.B rigctl -m 2029 -r /dev/rig f
|
||||
3900000
|
||||
.sp
|
||||
rigctl -m 229 -r /dev/rig m
|
||||
.br
|
||||
|
||||
.B rigctl -m 2029 -r /dev/rig m
|
||||
LSB
|
||||
.br
|
||||
2000
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
.IP
|
||||
.BR Note :
|
||||
the returned values do not have the prompt strings associated with interactive
|
||||
mode as shown above.
|
||||
|
|
@ -220,40 +214,29 @@ option takes the path to the port device on
|
|||
.SM POSIX
|
||||
and the device name on Microsoft Windows.
|
||||
.
|
||||
.PP
|
||||
.IP
|
||||
.BR Note :
|
||||
A complete list of supported radio models may be seen by use of the
|
||||
.B -l
|
||||
option:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rigctl -l
|
||||
.br
|
||||
.B rigctl -l
|
||||
Rig # Mfg Model Version Status
|
||||
.br
|
||||
1 Hamlib Dummy 0.5 Beta
|
||||
.br
|
||||
2 Hamlib NET rigctl 0.3 Beta
|
||||
.br
|
||||
101 Yaesu FT-847 0.5 Beta
|
||||
.br
|
||||
103 Yaesu FT-1000D 0.0.6 Alpha
|
||||
.br
|
||||
1001 Yaesu FT-847 0.5 Beta
|
||||
1003 Yaesu FT-1000D 0.0.6 Alpha
|
||||
\&.
|
||||
.br
|
||||
\&.
|
||||
.br
|
||||
\&.
|
||||
.br
|
||||
2702 Rohde&Schwarz EB200 0.1 Untested
|
||||
.br
|
||||
2801 Philips/Simoco PRM8060 0.1 Alpha
|
||||
.br
|
||||
2901 ADAT www.adat.ch ADT-200A 1.36 Beta
|
||||
27002 Rohde&Schwarz EB200 0.1 Untested
|
||||
28001 Philips/Simoco PRM8060 0.1 Alpha
|
||||
29001 ADAT www.adat.ch ADT-200A 1.36 Beta
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
The list is long so use \f(CWShift\-PageUp\fP/\f(CWShift\-PageDown\fP on
|
||||
|
|
@ -264,7 +247,7 @@ window on Microsoft Windows) or the output can be piped to
|
|||
.BR more (1)
|
||||
or
|
||||
.BR less (1),
|
||||
e.g. \(lq\f(CWrigctl -l | more\fP\(rq to scroll back up the list.
|
||||
e.g., \(lq\f(CWrigctl -l | more\fP\(rq to scroll back up the list.
|
||||
.
|
||||
The list is sorted numerically by model number since Hamlib 1.2.15.1.
|
||||
.
|
||||
|
|
@ -305,40 +288,39 @@ additional commands.
|
|||
.
|
||||
.PP
|
||||
In its most simple use as a
|
||||
.I "command line"
|
||||
.I command line
|
||||
program, rotctl is used to set azimuth position and (optionally) elevation by
|
||||
typing commands after any rotctl options:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rotctl P 145.0 23.0
|
||||
.br
|
||||
rotctl M 8 25
|
||||
.B rotctl P 145.0 23.0
|
||||
.B rotctl M 8 25
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
and then query those values:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rotctl p
|
||||
.B rotctl p
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
Entering
|
||||
.I "interactive mode"
|
||||
.I interactive mode
|
||||
is a simple matter of not placing any commands after any rotctl options:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rotctl
|
||||
.B rotctl
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
Entering interactive mode allows successive commands to be entered without
|
||||
|
|
@ -354,40 +336,34 @@ library.
|
|||
.PP
|
||||
Interactive mode is indicated by the spartan prompt:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
Rotator command:
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
Commands are given at the prompt:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
Rotator command: M
|
||||
.br
|
||||
Direction: 16
|
||||
.br
|
||||
Speed: 60
|
||||
.sp
|
||||
Rotator command: p
|
||||
.br
|
||||
.RB "Rotator command: " M
|
||||
.RB "Direction: " 16
|
||||
.RB "Speed: " 60
|
||||
|
||||
.RB "Rotator command: " p
|
||||
Azimuth: 11.352000
|
||||
.br
|
||||
Elevation: 0.000000
|
||||
.sp
|
||||
Rotator command: p
|
||||
.br
|
||||
|
||||
.RB "Rotator command: " p
|
||||
Azimuth: 27.594000
|
||||
.br
|
||||
Elevation: 0.000000
|
||||
.sp
|
||||
|
||||
Rotator command:
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
An additional prompt is printed when more information is required by the
|
||||
|
|
@ -417,26 +393,24 @@ controller connected to the computer is necessary for debugging.
|
|||
.PP
|
||||
For example, to quickly set position for RotorEZ:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rotctl -m 401 -r /dev/rotor P 100.0 0.0
|
||||
.B rotctl -m 401 -r /dev/rotor P 100.0 0.0
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
and to query the position:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rotctl -m 401 -r /dev/rotor p
|
||||
.br
|
||||
.B rotctl -m 401 -r /dev/rotor p
|
||||
100.000000
|
||||
.br
|
||||
0.000000
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
The returned values do not have the prompt strings associated with interactive
|
||||
|
|
@ -453,40 +427,29 @@ option takes the path to the port device on
|
|||
.SM POSIX
|
||||
or the device name on Microsoft Windows.
|
||||
.
|
||||
.PP
|
||||
.IP
|
||||
.BR Note :
|
||||
A complete list of supported rotator models may be seen by use of the
|
||||
.B -l
|
||||
option:
|
||||
.
|
||||
.sp
|
||||
.RS 0.5i
|
||||
.PP
|
||||
.in +4n
|
||||
.EX
|
||||
rotctl -l
|
||||
.br
|
||||
.B rotctl -l
|
||||
Rot # Mfg Model Version Status
|
||||
.br
|
||||
1 Hamlib Dummy 0.5 Beta
|
||||
.br
|
||||
2 Hamlib NET rotctl 0.3 Beta
|
||||
.br
|
||||
201 Hamlib EasycommI 0.3 Beta
|
||||
.br
|
||||
202 Hamlib EasycommII 0.3 Beta
|
||||
.br
|
||||
\&.
|
||||
.br
|
||||
\&.
|
||||
.br
|
||||
\&.
|
||||
.br
|
||||
1201 AMSAT IF-100 0.1 Untested
|
||||
.br
|
||||
1301 LA7LKA ts7400 0.1 Beta
|
||||
.br
|
||||
1401 Celestron NexStar 0.1 Untested
|
||||
.EE
|
||||
.RE
|
||||
.in
|
||||
.
|
||||
.PP
|
||||
The list is long so use \f(CWShift\-PageUp\fP/\f(CWShift\-PageDown\fP on
|
||||
|
|
@ -511,6 +474,21 @@ The complete reference for rotctl can be found in the
|
|||
manual page.
|
||||
.
|
||||
.
|
||||
.SH ampctl
|
||||
.
|
||||
The
|
||||
.BR ampctl (1)
|
||||
utility is a recent addition to the Hamlib utilities as a part of the 4.0
|
||||
development cycle.
|
||||
.
|
||||
It is intended to test the Hamlib implementation of amplifier control and is
|
||||
similar in function to the utilities previously described.
|
||||
.
|
||||
See the
|
||||
.BR ampctl (1)
|
||||
manual page for the complete reference.
|
||||
.
|
||||
.
|
||||
.SH rigctld
|
||||
.
|
||||
The
|
||||
|
|
@ -698,6 +676,22 @@ The complete reference for rotctld can be found in the
|
|||
manual page.
|
||||
.
|
||||
.
|
||||
.SH ampctl
|
||||
.
|
||||
The
|
||||
.BR ampctld (1)
|
||||
utility is a recent addition to the Hamlib utilities as a part of the 4.0
|
||||
development cycle.
|
||||
.
|
||||
It provides network socket access for the Hamlib implementation of amplifier
|
||||
control and is similar in function to the network utilities previously
|
||||
described.
|
||||
.
|
||||
See the
|
||||
.BR ampctld (1)
|
||||
manual page for the complete reference.
|
||||
.
|
||||
.
|
||||
.SH rigmem
|
||||
.
|
||||
.B rigmem
|
||||
|
|
@ -803,7 +797,7 @@ radio and rotator control functions for developers of software primarily of
|
|||
interest to radio amateurs and those interested in radio communications.
|
||||
.
|
||||
.PP
|
||||
Copyright \(co 2001-2018 Hamlib Group (various contributors)
|
||||
Copyright \(co 2001-2020 Hamlib Group (various contributors)
|
||||
.
|
||||
.PP
|
||||
This is free software; see the file COPYING for copying conditions. There is
|
||||
|
|
@ -814,6 +808,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|||
.
|
||||
.BR less (1),
|
||||
.BR more (1),
|
||||
.BR ampctl (1),
|
||||
.BR ampctld (1),
|
||||
.BR rigctl (1),
|
||||
.BR rigctld (1),
|
||||
.BR rotctl (1),
|
||||
|
|
@ -828,8 +824,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|||
.SH COLOPHON
|
||||
.
|
||||
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
|
||||
archives:
|
||||
.IP
|
||||
archives are available via
|
||||
.
|
||||
.UR http://www.hamlib.org
|
||||
hamlib.org
|
||||
.UE .
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
.\"
|
||||
.\" Please keep this file in sync with doc/nutshell.texi
|
||||
.\"
|
||||
.TH HAMLIB "7" "2018-05-21" "Hamlib" "Hamlib Information Manual"
|
||||
.TH HAMLIB "7" "2020-09-08" "Hamlib" "Hamlib Information Manual"
|
||||
.
|
||||
.
|
||||
.SH NAME
|
||||
|
|
@ -153,20 +153,21 @@ 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 (ABI) interfaces have remained stable
|
||||
since that time up to the latest release of 3.2 in early 2018.
|
||||
since that time up to the release of 3.3 in mid 2018.
|
||||
.
|
||||
Version 4.0 marks a major change to the ABI and certain changes to the API.
|
||||
.
|
||||
.PP
|
||||
Development continues through the major version number
|
||||
.RI 3. x
|
||||
.RI 4. x
|
||||
series and beyond.
|
||||
.
|
||||
While some API tweaks are planned, ABI compatibility with the prior
|
||||
.RI 1.2. x
|
||||
releases remains a priority.
|
||||
The 4.0 release marks a major change in the ABI with several changes for
|
||||
additional modes and such that will require client programs that use the C ABI
|
||||
to be recompiled/relinked, etc.
|
||||
.
|
||||
Other goals include streamlining the build system (done), improving the SWIG
|
||||
generated language bindings (done), improving the overall documentation (this
|
||||
man page with more in progress), and other updates as warranted.
|
||||
Other goals include improving the overall documentation (this man page with
|
||||
more in progress), and other updates as warranted.
|
||||
.
|
||||
.PP
|
||||
The Project is hosted by
|
||||
|
|
@ -255,28 +256,37 @@ atmosphere for development.
|
|||
Hamlib's source code is released under two
|
||||
licenses, the
|
||||
.B Lesser General Public License
|
||||
(LGPL) for the library portion, and the
|
||||
(LGPL) version 2.1 for the library portion, and the
|
||||
.B General Public License
|
||||
(GPL) for the utility programs.
|
||||
(GPL) version 2 for the utility programs.
|
||||
.
|
||||
.PP
|
||||
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.
|
||||
However, any contributions to the library source remain under a copyleft
|
||||
license which means that the library source code may not be used in violation
|
||||
of the terms of the LGPL (see the file
|
||||
.B COPYING.LIB
|
||||
in the main source directory).
|
||||
.
|
||||
Concepts learned by studying these sources for the purpose of understanding
|
||||
the Hamlib API is not covered nor prohibited by the LGPL, however, directly
|
||||
copying LGPL sources into any work that is incompatible with the terms of the
|
||||
LGPL is a violation of the terms of the license.
|
||||
.
|
||||
.PP
|
||||
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.
|
||||
of the GPL (see the file
|
||||
.B COPYING
|
||||
in the main source directory).
|
||||
.
|
||||
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.
|
||||
GPL is a violation of the terms of the license.
|
||||
.
|
||||
.
|
||||
.SS Radios with a clone capability
|
||||
|
|
@ -289,11 +299,11 @@ for cloning the memory contents from radio to another of the same model.
|
|||
.
|
||||
A related project,
|
||||
.UR http://chirp.danplanet.com
|
||||
CHIRP
|
||||
.B Chirp
|
||||
.UE ,
|
||||
aims to support radios with such a clone capability.
|
||||
.
|
||||
Please contact the CHIRP project for support of such radios.
|
||||
Please contact the Chirp project for support of such radios.
|
||||
.
|
||||
.
|
||||
.SS Pronouncing Hamlib
|
||||
|
|
@ -319,11 +329,12 @@ If you're French, the above does not apply! :-)
|
|||
.SH COPYING
|
||||
.
|
||||
This file is part of Hamlib, a project to develop a library that simplifies
|
||||
radio and rotator control functions for developers of software primarily of
|
||||
interest to radio amateurs and those interested in radio communications.
|
||||
radio, rotator, and amplifier control functions for developers of software
|
||||
primarily of interest to radio amateurs and those interested in radio
|
||||
communications.
|
||||
.
|
||||
.PP
|
||||
Copyright \(co 2001-2018 Hamlib Group (various contributors)
|
||||
Copyright \(co 2001-2020 Hamlib Group (various contributors)
|
||||
.
|
||||
.PP
|
||||
This is free software; see the file COPYING for copying conditions. There is
|
||||
|
|
@ -338,8 +349,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|||
.SH COLOPHON
|
||||
.
|
||||
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
|
||||
archives:
|
||||
.IP
|
||||
archives are available via
|
||||
.
|
||||
.UR http://www.hamlib.org
|
||||
hamlib.org
|
||||
.UE .
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue