kopia lustrzana https://github.com/Hamlib/Hamlib
Update man pages for content and conformance
As some content was getting dated, refresh the content of the various manual pages and while doing so, update the pages to conform more closely to man-pages(7), man(7), and groff_man(7).pull/20/head
Nate Bargmann
rodzic
35a28884f9
commit
743f67edaa
1679
tests/rigctl.1
1679
tests/rigctl.1
Plik diff jest za duży
Load Diff
1814
tests/rigctld.1
1814
tests/rigctld.1
Plik diff jest za duży
Load Diff
364
tests/rigmem.1
364
tests/rigmem.1
|
|
@ -1,152 +1,290 @@
|
||||||
.\" Hey, EMACS: -*- nroff -*-
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
.\" First parameter, NAME, should be all caps
|
|
||||||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
|
||||||
.\" other parameters are allowed: see man(7), man(1)
|
|
||||||
.TH RIGMEM "1" "August 21, 2011" "Hamlib" "Radio Memory Operations"
|
|
||||||
.\" Please adjust this date whenever revising the manpage.
|
|
||||||
.\"
|
.\"
|
||||||
.\" Some roff macros, for reference:
|
.\" For layout and available macros, see man(7), man-pages(7), groff_man(7)
|
||||||
.\" .nh disable hyphenation
|
.\" Please adjust the date whenever revising the manpage.
|
||||||
.\" .hy enable hyphenation
|
.\"
|
||||||
.\" .ad l left justify
|
.\" Note: Please keep this page in sync with the source, rigmem.c
|
||||||
.\" .ad b justify to both left and right margins
|
.\"
|
||||||
.\" .nf disable filling
|
.TH RIGMEM "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
|
||||||
.\" .fi enable filling
|
.
|
||||||
.\" .br insert line break
|
.
|
||||||
.\" .sp <n> insert n+1 empty lines
|
|
||||||
.\" for manpage-specific macros, see man(7)
|
|
||||||
.SH NAME
|
.SH NAME
|
||||||
|
.
|
||||||
rigmem \- backup and restore memory of radio transceivers and receivers
|
rigmem \- backup and restore memory of radio transceivers and receivers
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B rigmem
|
.
|
||||||
[\fIOPTION\fR]... [\fICOMMAND\fR]...
|
.
|
||||||
|
.SY rigmem
|
||||||
|
.OP \-ahvVx
|
||||||
|
.OP \-m id
|
||||||
|
.OP \-r device
|
||||||
|
.OP \-s baud
|
||||||
|
.OP \-c id
|
||||||
|
.OP \-C parm=val
|
||||||
|
.OP \-p sep
|
||||||
|
command
|
||||||
|
.RI [ file ]
|
||||||
|
.YS
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
|
.
|
||||||
Backup and restore memory of radio transceivers and receivers.
|
Backup and restore memory of radio transceivers and receivers.
|
||||||
\fBrigmem\fP accepts \fIcommands\fP from the command line only.
|
.B rigmem
|
||||||
|
accepts
|
||||||
|
.IR command s
|
||||||
|
from the command line only.
|
||||||
|
.
|
||||||
.PP
|
.PP
|
||||||
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
Keep in mind that Hamlib is BETA level software. While a lot of backend
|
||||||
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics,
|
libraries lack complete rig support, the basic functions are usually well
|
||||||
.\" respectively.
|
supported.
|
||||||
Keep in mind that \fBHamlib\fP is BETA level software.
|
.
|
||||||
While a lot of backend libraries lack complete rig support, the basic functions
|
|
||||||
are usually well supported. The API may change without publicized notice,
|
|
||||||
while an advancement of the minor version (e.g. 1.1.x to 1.2.x) indicates such
|
|
||||||
a change.
|
|
||||||
.PP
|
.PP
|
||||||
Please report bugs and provide feedback at the e-mail address given in the
|
Please report bugs and provide feedback at the e-mail address given in the
|
||||||
REPORTING BUGS section. Patches and code enhancements are also welcome.
|
.B BUGS
|
||||||
|
section below. Patches and code enhancements sent to the same address are
|
||||||
|
welcome.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
This program follows the usual GNU command line syntax, with long
|
.
|
||||||
options starting with two dashes (`-').
|
This program follows the usual GNU command line syntax. Short options that
|
||||||
|
take an argument may have the value follow immediately or be separated by a
|
||||||
Here is a summary of the supported options:
|
space. Long options starting with two dashes (\(oq\-\(cq) require an
|
||||||
.TP
|
\(oq=\(cq between the option and any argument.
|
||||||
.B \-m, --model=id
|
.
|
||||||
Select radio model number. See model list (use 'rigctl -l').
|
|
||||||
.TP
|
|
||||||
.B \-r, --rig-file=device
|
|
||||||
Use \fIdevice\fP as the file name of the port the radio is connected.
|
|
||||||
Often a serial port, but could be a USB to serial adapter. Typically
|
|
||||||
/dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
|
|
||||||
.TP
|
|
||||||
.B \-s, --serial-speed=baud
|
|
||||||
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rig
|
|
||||||
backend capabilities as the default.
|
|
||||||
.TP
|
|
||||||
.B \-c, --civaddr=id
|
|
||||||
Use \fIid\fP as the CI-V address to communicate with the rig. Only useful for
|
|
||||||
Icom rigs.
|
|
||||||
.br
|
|
||||||
NB: the \fIid\fP is in decimal notation, unless prefixed by
|
|
||||||
\fI0x\fP, in which case it is hexadecimal.
|
|
||||||
.TP
|
|
||||||
.B \-C, --set-conf=parm=val[,parm=val]*
|
|
||||||
Set config parameter. e.g. stop_bits=2
|
|
||||||
.br
|
|
||||||
Use -L option of \fBrigctl\fP for a list.
|
|
||||||
.TP
|
|
||||||
.B \-x, --xml
|
|
||||||
Use XML format instead of CSV, if libxml2 is available.
|
|
||||||
.TP
|
|
||||||
.B \-v, --verbose
|
|
||||||
Set verbose mode, cumulative (see DIAGNOSTICS below).
|
|
||||||
.TP
|
|
||||||
.B \-h, --help
|
|
||||||
Show a summary of these options and exit.
|
|
||||||
.TP
|
|
||||||
.B \-V, --version
|
|
||||||
Show version of \fBrigmem\fP and exit.
|
|
||||||
.PP
|
.PP
|
||||||
\fBNOTE!\fP Some options may not be implemented by a given backend and will
|
Here is a summary of the supported options:
|
||||||
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-m ", " \-\-model = \fIid\fP
|
||||||
|
Select radio model number.
|
||||||
|
.IP
|
||||||
|
See model list (use \(lqrigctl \-l\(rq).
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-r ", " \-\-rig\-file = \fIdevice\fP
|
||||||
|
Use
|
||||||
|
.I device
|
||||||
|
as the file name of the port connected to the radio.
|
||||||
|
.IP
|
||||||
|
Often a serial port, but could be a USB to serial adapter. Typically
|
||||||
|
.IR /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 ,
|
||||||
|
etc. on Linux,
|
||||||
|
.IR COM1 ", " COM2 ,
|
||||||
|
etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations.
|
||||||
|
See your system's documentation.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-s ", " \-\-serial\-speed = \fIbaud\fP
|
||||||
|
Set radio serial speed to
|
||||||
|
.I baud
|
||||||
|
rate.
|
||||||
|
.IP
|
||||||
|
Uses maximum serial speed from rig backend capabilities as the default.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-c ", " \-\-civaddr = \fIid\fP
|
||||||
|
Use
|
||||||
|
.I id
|
||||||
|
as the CI-V address to communicate with the rig.
|
||||||
|
.IP
|
||||||
|
Only useful for Icom and some Ten-Tec rigs.
|
||||||
|
.IP
|
||||||
|
.BR Note :
|
||||||
|
The
|
||||||
|
.I id
|
||||||
|
is in decimal notation, unless prefixed by
|
||||||
|
.IR 0x ,
|
||||||
|
in which case it is hexadecimal.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-C ", " \-\-set\-conf = \fIparm=val\fP [ \fI,parm=val\fP ]
|
||||||
|
Set radio configuration parameter(s), e.g.
|
||||||
|
.IR stop_bits=2 .
|
||||||
|
.IP
|
||||||
|
Use the
|
||||||
|
.B -L
|
||||||
|
option of
|
||||||
|
.B rigctl
|
||||||
|
for a list of configuration parameters for a given model number.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-p ", " \-\-set\-separator = \fIsep\fP
|
||||||
|
Set character as column separator instead of the CSV comma.
|
||||||
|
.IP
|
||||||
|
Some common alternatives are the vertical bar (pipe), \(oq|\(cq, semicolon,
|
||||||
|
\(oq;\(cq, and colon, \(oq:\(cq.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-a ", " \-\-all
|
||||||
|
Bypass mem_caps, apply to all fields of channel_t.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-x ", " \-\-xml
|
||||||
|
Use XML format instead of CSV, if libxml2 is available.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-v ", " \-\-verbose
|
||||||
|
Set verbose mode, cumulative (see
|
||||||
|
.B DIAGNOSTICS
|
||||||
|
below).
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-h ", " \-\-help
|
||||||
|
Show a summary of these options and exit.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.BR \-V ", " \-\-version
|
||||||
|
Show version of
|
||||||
|
.B rigmem
|
||||||
|
and exit.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
.BR Note :
|
||||||
|
Some options may not be implemented by a given backend and will return an
|
||||||
|
error. This is most likely to occur with the
|
||||||
|
.B \-\-set\-conf
|
||||||
option.
|
option.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH COMMANDS
|
.SH COMMANDS
|
||||||
|
.
|
||||||
Backup and restore are supported for basic CSV file and XML format where
|
Backup and restore are supported for basic CSV file and XML format where
|
||||||
available.
|
available.
|
||||||
|
.
|
||||||
.PP
|
.PP
|
||||||
Please note that the backend for the radio to be controlled,
|
Please note that the backend for the radio to be controlled, or the radio
|
||||||
or the radio itself may not support some commands. In that case,
|
itself may not support some commands. In that case, the operation will fail
|
||||||
the operation will fail with a \fBHamlib\fP error message.
|
with a
|
||||||
|
.B Hamlib
|
||||||
|
error message.
|
||||||
|
.
|
||||||
.PP
|
.PP
|
||||||
Here is a summary of the supported commands:
|
Here is a summary of the supported commands:
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B save
|
.BI save " file"
|
||||||
Save all the content of memory in a CSV (or XML) file given as an argument to
|
Save all the content of memory in a CSV (or XML) file given as an argument to
|
||||||
the command.
|
the command.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B load
|
.BI load " file"
|
||||||
Load the content into all the memory from a CSV (or XML) file given as
|
Load the content into all the memory from a CSV (or XML) file given as an
|
||||||
an argument to the command.
|
argument to the command.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B save_parm
|
.BI save_parm " file"
|
||||||
Save all the parameters of the radio in a CSV (or XML) file given as an
|
Save all the parameters of the radio in a CSV (or XML) file given as an
|
||||||
argument to the command.
|
argument to the command.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B load_parm
|
.BI load_parm " file"
|
||||||
Load the parameters of the radio from a CSV (or XML) file given as an
|
Load the parameters of the radio from a CSV (or XML) file given as an argument
|
||||||
argument to the command.
|
to the command.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B clear
|
.B clear
|
||||||
This is a very \fBDANGEROUS\fP command, as it will completely clear out
|
This is a very
|
||||||
everything you have programmed in the memory of your radio. \fBALL DATA WILL
|
.B DANGEROUS
|
||||||
BE LOST\fP. Use at your own risk!
|
command, as it will completely clear out everything you have programmed in the
|
||||||
|
memory of your radio.
|
||||||
|
.BR "ALL DATA WILL BE LOST" .
|
||||||
|
Use at your own risk!
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH DIAGNOSTICS
|
.SH DIAGNOSTICS
|
||||||
The \fB-v\fP, \fB--version\fP option allows different levels of diagnostics
|
.
|
||||||
to be output to \fBstderr\fP and correspond to -v for BUG, -vv for ERR,
|
The
|
||||||
-vvv for WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
|
.BR \-v ,
|
||||||
|
.B \-\-verbose
|
||||||
|
option allows different levels of diagnostics to be output to
|
||||||
|
.B stderr
|
||||||
|
and correspond to \-v for
|
||||||
|
.BR BUG ,
|
||||||
|
\-vv for
|
||||||
|
.BR ERR ,
|
||||||
|
\-vvv for
|
||||||
|
.BR WARN ,
|
||||||
|
\-vvvv for
|
||||||
|
.BR VERBOSE ,
|
||||||
|
or \-vvvvv for
|
||||||
|
.BR TRACE .
|
||||||
|
.
|
||||||
|
.PP
|
||||||
A given verbose level is useful for providing needed debugging information to
|
A given verbose level is useful for providing needed debugging information to
|
||||||
the email address below. For example, TRACE output shows all of the values
|
the email address below. For example, TRACE output shows all of the values
|
||||||
sent to and received from the radio which is very useful for radio backend
|
sent to and received from the radio which is very useful for radio backend
|
||||||
library development and may be requested by the developers.
|
library development and may be requested by the developers.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH EXIT STATUS
|
.SH EXIT STATUS
|
||||||
\fBrigmem\fP exits with:
|
.
|
||||||
.br
|
.B rigmem
|
||||||
0 if all operations completed normally;
|
exits with:
|
||||||
.br
|
.
|
||||||
1 if there was an invalid command line option or argument;
|
.TP
|
||||||
.br
|
.B 0
|
||||||
2 if an error was returned by \fBHamlib\fP.
|
if all operations completed normally;
|
||||||
.br
|
.
|
||||||
3 the \fBHamlib\fP backend has no memory support implemented and/or
|
.TP
|
||||||
the rig has no memory access available.
|
.B 1
|
||||||
|
if there was an invalid command line option or argument;
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 2
|
||||||
|
if an error was returned by
|
||||||
|
.BR Hamlib .
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 3
|
||||||
|
the
|
||||||
|
.B Hamlib
|
||||||
|
backend has no memory support implemented and/or the rig has no memory access
|
||||||
|
available.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
This empty section...
|
.
|
||||||
.SH REPORTING BUGS
|
Report bugs to:
|
||||||
Report bugs to <hamlib-developer@lists.sourceforge.net>.
|
.IP
|
||||||
|
.nf
|
||||||
|
.MT hamlib\-developer@lists.sourceforge.net
|
||||||
|
Hamlib Developer mailing list
|
||||||
|
.ME
|
||||||
|
.fi
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.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.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Copyright \(co 2003-2011 Stephane Fillod
|
||||||
.br
|
.br
|
||||||
We are already aware of the bug in the previous section :-)
|
Copyright \(co 2007,2018 Nate Bargmann
|
||||||
.SH AUTHOR
|
.
|
||||||
Written by Stephane Fillod and the Hamlib Group
|
.PP
|
||||||
.br
|
This is free software; see the file COPYING for copying conditions. There is
|
||||||
<http://www.hamlib.org>.
|
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||||
.SH COPYRIGHT
|
.
|
||||||
Copyright \(co 2000-2009 Stephane Fillod and the Hamlib Group.
|
.
|
||||||
.br
|
|
||||||
This is free software; see the source for copying conditions.
|
|
||||||
There is NO warranty; not even for MERCHANTABILITY
|
|
||||||
or FITNESS FOR A PARTICULAR PURPOSE.
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
.
|
||||||
.BR rigctl (1),
|
.BR rigctl (1),
|
||||||
.BR hamlib (3)
|
.BR hamlib (7)
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH COLOPHON
|
||||||
|
.
|
||||||
|
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
|
||||||
|
archives:
|
||||||
|
.IP
|
||||||
|
.UR http://www.hamlib.org
|
||||||
|
hamlib.org
|
||||||
|
.UE .
|
||||||
|
|
|
||||||
401
tests/rigsmtr.1
401
tests/rigsmtr.1
|
|
@ -1,130 +1,295 @@
|
||||||
.\" Hey, EMACS: -*- nroff -*-
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
.\" First parameter, NAME, should be all caps
|
|
||||||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
|
||||||
.\" other parameters are allowed: see man(7), man(1)
|
|
||||||
.TH RIGSMTR "1" "January 5, 2008" "Hamlib"
|
|
||||||
.\" Please adjust this date whenever revising the manpage.
|
|
||||||
.\"
|
.\"
|
||||||
.\" Some roff macros, for reference:
|
.\" For layout and available macros, see man(7), man-pages(7), groff_man(7)
|
||||||
.\" .nh disable hyphenation
|
.\" Please adjust the date whenever revising the manpage.
|
||||||
.\" .hy enable hyphenation
|
.\"
|
||||||
.\" .ad l left justify
|
.\" Note: Please keep this page in sync with the source, rigsmtr.c
|
||||||
.\" .ad b justify to both left and right margins
|
.\"
|
||||||
.\" .nf disable filling
|
.TH RIGSMTR "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
|
||||||
.\" .fi enable filling
|
.
|
||||||
.\" .br insert line break
|
.
|
||||||
.\" .sp <n> insert n+1 empty lines
|
|
||||||
.\" for manpage-specific macros, see man(7)
|
|
||||||
.SH NAME
|
.SH NAME
|
||||||
|
.
|
||||||
rigsmtr \- measure S-Meter vs azimuth using Hamlib
|
rigsmtr \- measure S-Meter vs azimuth using Hamlib
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B rigsmtr
|
.
|
||||||
[\fIOPTION\fR]... [time_step]
|
.SY rigsmtr
|
||||||
|
.OP \-hvV
|
||||||
|
.OP \-m id
|
||||||
|
.OP \-r device
|
||||||
|
.OP \-s baud
|
||||||
|
.OP \-c id
|
||||||
|
.OP \-C parm=val
|
||||||
|
.OP \-M id
|
||||||
|
.OP \-R device
|
||||||
|
.OP \-S baud
|
||||||
|
.OP \-N parm=val
|
||||||
|
.RI [ time_step ]
|
||||||
|
.YS
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
\fBrigsmtr\fP uses Hamlib to control a rig to measure S-Meter vs azimuth:
|
.
|
||||||
.br
|
.B rigsmtr
|
||||||
It rotates the antenna from minimum azimuth to maximum azimuth.
|
uses
|
||||||
Every second or \fItime_step\fP if specified in seconds, it retrieves the signal strength.
|
.B Hamlib
|
||||||
.br
|
to control a rig to measure S-Meter value versus antenna azimuth.
|
||||||
Azimuth in degree and corresponding S-Meter level in dB relative to S9 are then printed on stdout.
|
.
|
||||||
.br
|
|
||||||
To work correctly, rigsmtr needs a rig that could measure S-Meter and a Hamlib backend that
|
|
||||||
is able to get it, mounted on a Hamlib supported rotator.
|
|
||||||
.PP
|
.PP
|
||||||
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
It rotates the antenna from minimum azimuth to maximum azimuth.
|
||||||
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
|
Every second, or
|
||||||
.\" respectively.
|
.I time_step
|
||||||
Keep in mind that \fBHamlib\fP is still BETA level software.
|
if specified in seconds, it retrieves the signal strength. Azimuth in degrees
|
||||||
A lof of stuff hasn't been tested thoroughly, and the API may change
|
and the corresponding S-Meter level in dB relative to S9 are then printed on
|
||||||
without publicised notice. Please report bugs and feedback at
|
.BR stdout .
|
||||||
the e-mail address given in the REPORTING BUGS section.
|
.
|
||||||
|
.PP
|
||||||
|
To work correctly, rigsmtr needs a rig that could measure S-Meter and a Hamlib
|
||||||
|
backend that is able to retrieve it, connected to a Hamlib supported rotator.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Keep in mind that Hamlib is BETA level software. While a lot of backend
|
||||||
|
libraries lack complete rig support, the basic functions are usually well
|
||||||
|
supported.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Please report bugs and provide feedback at the e-mail address given in the
|
||||||
|
.B BUGS
|
||||||
|
section below. Patches and code enhancements sent to the same address are
|
||||||
|
welcome.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
This program follow the usual GNU command line syntax, with long
|
.
|
||||||
options starting with two dashes (`-').
|
This program follows the usual GNU command line syntax. Short options that
|
||||||
A summary of options is included below.
|
take an argument may have the value follow immediately or be separated by a
|
||||||
|
space. Long options starting with two dashes (\(oq\-\(cq) require an
|
||||||
|
\(oq=\(cq between the option and any argument.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Here is a summary of the supported options.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-m, \-\-model=id
|
.BR \-m ", " \-\-model = \fIid\fP
|
||||||
Select radio model number. See model list provided by rigctl.
|
Select radio model number.
|
||||||
|
.IP
|
||||||
|
See model list (use \(lqrigctl \-l\(rq).
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-r, \-\-rig\-file=device
|
.BR \-r ", " \-\-rig\-file = \fIdevice\fP
|
||||||
Use \fBdevice\fP as the file name of the radio to operate on.
|
Use
|
||||||
|
.I device
|
||||||
|
as the file name of the port connected to the radio.
|
||||||
|
.IP
|
||||||
|
Often a serial port, but could be a USB to serial adapter. Typically
|
||||||
|
.IR /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 ,
|
||||||
|
etc. on Linux,
|
||||||
|
.IR COM1 ", " COM2 ,
|
||||||
|
etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations.
|
||||||
|
See your system's documentation.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-s, \-\-serial\-speed=baud
|
.BR \-s ", " \-\-serial\-speed = \fIbaud\fP
|
||||||
Set radio serial speed to \fBbaud\fP rate. Uses maximal rig speed as default.
|
Set radio serial speed to
|
||||||
|
.I baud
|
||||||
|
rate.
|
||||||
|
.IP
|
||||||
|
Uses maximum serial speed from rig backend capabilities as the default.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-c, \-\-civaddr=id
|
.BR \-c ", " \-\-civaddr = \fIid\fP
|
||||||
Use \fBid\fP as the CI-V address to communicate with the rig.
|
Use
|
||||||
Only for Icom rigs. NB: the id is in decimal, unless prefixed by \fB0x\fP,
|
.I id
|
||||||
|
as the CI-V address to communicate with the rig.
|
||||||
|
.IP
|
||||||
|
Only useful for Icom and some Ten-Tec rigs.
|
||||||
|
.IP
|
||||||
|
.BR Note :
|
||||||
|
The
|
||||||
|
.I id
|
||||||
|
is in decimal notation, unless prefixed by
|
||||||
|
.IR 0x ,
|
||||||
in which case it is hexadecimal.
|
in which case it is hexadecimal.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-C, \-\-set\-conf=parm=val[,parm=val]*
|
.BR \-C ", " \-\-set\-conf = \fIparm=val\fP [ \fI,parm=val\fP ]
|
||||||
Set radio config parameter. See -L option of rigctl for a list.
|
Set radio configuration parameter(s), e.g.
|
||||||
|
.IR stop_bits=2 .
|
||||||
|
.IP
|
||||||
|
Use the
|
||||||
|
.B -L
|
||||||
|
option of
|
||||||
|
.B rigctl
|
||||||
|
for a list of configuration parameters for a given model number.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-M, \-\-rot\-model=id
|
.BR \-M ", " \-\-rot\-model = \fIid\fP
|
||||||
Select radio model number. See model list provided by rotctl.
|
Select rotator model number.
|
||||||
|
.IP
|
||||||
|
See model list (use \(lqrotctl \-l\(rq).
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-R, \-\-rot\-file=device
|
.BR \-R ", " \-\-rot\-file = \fIdevice\fP
|
||||||
Use \fBdevice\fP as the file name of the rotator to operate on.
|
Use
|
||||||
|
.I device
|
||||||
|
as the file name of the port connected to the rotator.
|
||||||
|
.IP
|
||||||
|
Often a serial port, but could be a USB to serial adapter. Typically
|
||||||
|
.IR /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 ,
|
||||||
|
etc. on Linux,
|
||||||
|
.IR COM1 ", " COM2 ,
|
||||||
|
etc. on MS Windows. The BSD flavors and Mac OS/X have their own
|
||||||
|
designations. See your system's documentation.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-S, \-\-rot\-serial\-speed=baud
|
.BR \-S ", " \-\-rot\-serial\-speed = \fIbaud\fP
|
||||||
Set rotator serial speed to \fBbaud\fP rate. Uses maximal speed as default.
|
Set rotator serial speed to
|
||||||
|
.I baud
|
||||||
|
rate.
|
||||||
|
.IP
|
||||||
|
Uses maximum serial speed from rotator backend capabilities as the default.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-N, \-\-rot\-set\-conf=parm=val[,parm=val]*
|
.BR \-N ", " \-\-rot\-set\-conf = \fIparm=val\fP [ \fI,parm=val\fP ]
|
||||||
Set rotator config parameter. See -L option of rotctl for a list.
|
Set rotator configuration parameter(s), e.g.
|
||||||
|
.IR stop_bits=2 .
|
||||||
|
.IP
|
||||||
|
Use the
|
||||||
|
.B -L
|
||||||
|
option of
|
||||||
|
.B rotctl
|
||||||
|
for a list of configuration parameters for a given model number.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-v, \-\-verbose
|
.BR \-v ", " \-\-verbose
|
||||||
Set verbose mode, cumulative (BUG, ERR, WARN, VERBOSE, TRACE).
|
Set verbose mode, cumulative (see
|
||||||
|
.B DIAGNOSTICS
|
||||||
|
below).
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-h, \-\-help
|
.BR \-h ", " \-\-help
|
||||||
Show summary of options and exit.
|
Show a summary of these options and exit.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-V, \-\-version
|
.BR \-V ", " \-\-version
|
||||||
Show version of program and exit.
|
Show version of
|
||||||
|
.B rigsmtr
|
||||||
.SH RETURN VALUE
|
and exit.
|
||||||
rigsmtr exits with:
|
.
|
||||||
0 if all operations went fine; 1 if there was an invalid command line
|
.PP
|
||||||
option or arg; 2 if an error was returned by Hamlib; 3 if the rig
|
.BR Note :
|
||||||
doesn't have the required capabilities.
|
Some options may not be implemented by a given backend and will return an
|
||||||
|
error. This is most likely to occur with the
|
||||||
|
.BR \-\-set\-conf " and " \-\-rot\-set\-conf
|
||||||
|
options.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH DIAGNOSTICS
|
||||||
|
.
|
||||||
|
The
|
||||||
|
.BR \-v ,
|
||||||
|
.B \-\-verbose
|
||||||
|
option allows different levels of diagnostics to be output to
|
||||||
|
.B stderr
|
||||||
|
and correspond to \-v for
|
||||||
|
.BR BUG ,
|
||||||
|
\-vv for
|
||||||
|
.BR ERR ,
|
||||||
|
\-vvv for
|
||||||
|
.BR WARN ,
|
||||||
|
\-vvvv for
|
||||||
|
.BR VERBOSE ,
|
||||||
|
or \-vvvvv for
|
||||||
|
.BR TRACE .
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
A given verbose level is useful for providing needed debugging information to
|
||||||
|
the email address below. For example, TRACE output shows all of the values
|
||||||
|
sent to and received from the radio which is very useful for radio backend
|
||||||
|
library development and may be requested by the developers.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH EXIT STATUS
|
||||||
|
.
|
||||||
|
.B rigsmtr
|
||||||
|
exits with:
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 0
|
||||||
|
if all operations completed normally;
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 1
|
||||||
|
if there was an invalid command line option or argument;
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 2
|
||||||
|
if an error was returned by
|
||||||
|
.BR Hamlib ;
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 3
|
||||||
|
if the rig doesn't have the required capabilities.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH EXAMPLE
|
.SH EXAMPLE
|
||||||
rigsmtr -m 209 -r /dev/ttyS1 -M 202 > csmtr
|
.
|
||||||
|
Collect S-Meter readings on a TS\-850 while an EasycommII rotator makes a full
|
||||||
|
360\(de rotation and record measurements in the file
|
||||||
|
.IR csmtr :
|
||||||
|
.
|
||||||
|
.sp
|
||||||
|
.RS 0.5i
|
||||||
|
.EX
|
||||||
|
rigsmtr \-m 209 \-r /dev/ttyS1 \-M 202 > csmtr
|
||||||
|
.EE
|
||||||
|
.RE
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
After completion the file
|
||||||
|
.I csmtr
|
||||||
|
contains lines such as:
|
||||||
|
.
|
||||||
|
.sp
|
||||||
|
.RS 0.5i
|
||||||
|
.EX
|
||||||
|
0 \-47
|
||||||
.br
|
.br
|
||||||
Collect S-Meter readings on a TS850 while an EasycommII rotator makes a
|
30 \-40
|
||||||
full 360\(de, and record measurements in file csmtr.
|
|
||||||
.br
|
.br
|
||||||
After completion, csmtr file contains for example the following lines :
|
60 \-22
|
||||||
.br
|
.br
|
||||||
0 -47
|
90 \-3
|
||||||
.br
|
|
||||||
30 -40
|
|
||||||
.br
|
|
||||||
60 -22
|
|
||||||
.br
|
|
||||||
90 -3
|
|
||||||
.br
|
.br
|
||||||
120 10
|
120 10
|
||||||
.br
|
.br
|
||||||
150 1
|
150 1
|
||||||
.br
|
.br
|
||||||
180 -11
|
180 \-11
|
||||||
.br
|
.br
|
||||||
210 -24
|
210 \-24
|
||||||
.br
|
.br
|
||||||
240 -35
|
240 \-35
|
||||||
.br
|
.br
|
||||||
270 -42
|
270 \-42
|
||||||
.br
|
.br
|
||||||
300 -48
|
300 \-48
|
||||||
.br
|
.br
|
||||||
330 -51
|
330 \-51
|
||||||
.br
|
|
||||||
360 -49
|
|
||||||
|
|
||||||
.TP
|
|
||||||
Result could then be ploted with gnuplot:
|
|
||||||
.br
|
.br
|
||||||
|
360 \-49
|
||||||
|
.EE
|
||||||
|
.RE
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
The results can be plotted with
|
||||||
|
.BR gnuplot (1):
|
||||||
|
.
|
||||||
|
.sp
|
||||||
|
.RS 0.5i
|
||||||
|
.EX
|
||||||
gnuplot
|
gnuplot
|
||||||
.br
|
.br
|
||||||
set angles degrees
|
set angles degrees
|
||||||
|
|
@ -145,20 +310,50 @@ set xrange [-60:60]
|
||||||
.br
|
.br
|
||||||
set yrange [-60:60]
|
set yrange [-60:60]
|
||||||
.br
|
.br
|
||||||
plot "csmtr"
|
.RI plot " csmtr"
|
||||||
.SH AUTHOR
|
.EE
|
||||||
Man page written by Stephane Fillod.
|
.RE
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
Need more testing. Reports are welcome.
|
.
|
||||||
.SH REPORTING BUGS
|
Report bugs to:
|
||||||
Report bugs to <hamlib-developer@users.sourceforge.net>.
|
.IP
|
||||||
.SH COPYRIGHT
|
.nf
|
||||||
Copyright \(co 2004-2009 Thierry Leconte & Stephane Fillod
|
.MT hamlib\-developer@lists.sourceforge.net
|
||||||
|
Hamlib Developer mailing list
|
||||||
|
.ME
|
||||||
|
.fi
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.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.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Copyright \(co 2007-2009 Stephane Fillod
|
||||||
.br
|
.br
|
||||||
This is free software; see the source for copying conditions.
|
Copyright \(co 2018 Nate Bargmann
|
||||||
There is NO warranty; not even for MERCHANTABILITY
|
.PP
|
||||||
or FITNESS FOR A PARTICULAR PURPOSE.
|
This is free software; see the file COPYING for copying conditions. There is
|
||||||
|
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
.
|
||||||
|
.BR gnuplot (1),
|
||||||
.BR rigctl (1),
|
.BR rigctl (1),
|
||||||
.BR rotctl (1),
|
.BR rotctl (1),
|
||||||
.BR hamlib (3)
|
.BR hamlib (7)
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH COLOPHON
|
||||||
|
.
|
||||||
|
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
|
||||||
|
archives:
|
||||||
|
.IP
|
||||||
|
.UR http://www.hamlib.org
|
||||||
|
hamlib.org
|
||||||
|
.UE .
|
||||||
|
|
|
||||||
408
tests/rigswr.1
408
tests/rigswr.1
|
|
@ -1,110 +1,262 @@
|
||||||
.\" Hey, EMACS: -*- nroff -*-
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
.\" First parameter, NAME, should be all caps
|
|
||||||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
|
||||||
.\" other parameters are allowed: see man(7), man(1)
|
|
||||||
.TH RIGSWR "1" "February 24, 2007" "Hamlib" "Radio SWR Measurement Tool"
|
|
||||||
.\" Please adjust this date whenever revising the manpage.
|
|
||||||
.\"
|
.\"
|
||||||
.\" Some roff macros, for reference:
|
.\" For layout and available macros, see man(7), man-pages(7), groff_man(7)
|
||||||
.\" .nh disable hyphenation
|
.\" Please adjust the date whenever revising the manpage.
|
||||||
.\" .hy enable hyphenation
|
.\"
|
||||||
.\" .ad l left justify
|
.\" Note: Please keep this page in sync with the source, rigswr.c
|
||||||
.\" .ad b justify to both left and right margins
|
.\"
|
||||||
.\" .nf disable filling
|
.TH RIGSWR "1" "2018-04-29" "Hamlib" "Hamlib Utilities"
|
||||||
.\" .fi enable filling
|
.
|
||||||
.\" .br insert line break
|
.
|
||||||
.\" .sp <n> insert n+1 empty lines
|
|
||||||
.\" for manpage-specific macros, see man(7)
|
|
||||||
.SH NAME
|
.SH NAME
|
||||||
rigswr \- measure VSWR vs frequency using \fBHamlib\fP.
|
.
|
||||||
|
rigswr \- measure VSWR vs frequency.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B rigswr
|
.
|
||||||
[\fIOPTION\fR]... start_freq stop_freq [freq_step]
|
.SY rigswr
|
||||||
|
.OP \-hvV
|
||||||
|
.OP \-m id
|
||||||
|
.OP \-r device
|
||||||
|
.OP \-s baud
|
||||||
|
.OP \-c id
|
||||||
|
.OP \-C parm=val
|
||||||
|
.OP \-p device
|
||||||
|
.OP \-P type
|
||||||
|
start_freq
|
||||||
|
stop_freq
|
||||||
|
.RI [ freq_step ]
|
||||||
|
.SY
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
\fBrigswr\fP uses \fBHamlib\fP to control a rig to measure VSWR vs frequency:
|
.
|
||||||
.br
|
.B rigswr
|
||||||
It scans frequencies from \fIstart_freq\fP to \fIstop_freq\fP with a step of
|
uses
|
||||||
\fIfreq_step\fP. For each frequency, it transmits at 25% of total POWER during
|
.B Hamlib
|
||||||
0.5 second in CW mode and reads VSWR.
|
to control a radio to measure VSWR (Voltage Standing Wave Ratio) over a
|
||||||
|
frequency range.
|
||||||
Frequency and the corresponding VSWR are then printed on \fBstdout\fP.
|
.
|
||||||
|
|
||||||
To work correctly, \fBrigswr\fP needs a rig that can measure VSWR and a
|
|
||||||
\fBHamlib\fP backend that supports reading VSWR from the rig.
|
|
||||||
.PP
|
.PP
|
||||||
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
It scans frequencies from
|
||||||
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
|
.I start_freq
|
||||||
.\" respectively.
|
to
|
||||||
Keep in mind that \fBHamlib\fP is BETA level software.
|
.I stop_freq
|
||||||
While a lot of backend libraries lack complete rig support, the basic functions
|
with an optional increment of
|
||||||
are usually well supported. The API may change without publicized notice,
|
.I freq_step
|
||||||
while an advancement of the minor version (e.g. 1.1.x to 1.2.x) indicates such
|
(default step is 100 kHz). All values must be entered as an integer in Hertz
|
||||||
a change.
|
(cycles per second).
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
.BR Note :
|
||||||
|
.B rigswr
|
||||||
|
assumes that
|
||||||
|
.I start_freq
|
||||||
|
is less than or equal to
|
||||||
|
.IR stop_freq .
|
||||||
|
If it is greater,
|
||||||
|
.B rigswr
|
||||||
|
will exit without doing anything.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
For each frequency, it transmits at 25% of total POWER during 0.5 second in CW
|
||||||
|
mode and reads VSWR.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Frequency and the corresponding VSWR are then printed on
|
||||||
|
.BR stdout .
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
To work correctly,
|
||||||
|
.B rigswr
|
||||||
|
needs a radio that can measure VSWR and a
|
||||||
|
.B Hamlib
|
||||||
|
backend that supports reading VSWR from the radio.
|
||||||
|
.PP
|
||||||
|
Keep in mind that Hamlib is BETA level software. While a lot of backend
|
||||||
|
libraries lack complete rig support, the basic functions are usually well
|
||||||
|
supported.
|
||||||
|
.
|
||||||
.PP
|
.PP
|
||||||
Please report bugs and provide feedback at the e-mail address given in the
|
Please report bugs and provide feedback at the e-mail address given in the
|
||||||
REPORTING BUGS section. Patches and code enhancements are also welcome.
|
.B BUGS
|
||||||
|
section below. Patches and code enhancements sent to the same address are
|
||||||
|
welcome.
|
||||||
|
.
|
||||||
|
.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
This program follows the usual GNU command line syntax, with long
|
.
|
||||||
options starting with two dashes (`-').
|
This program follows the usual GNU command line syntax. Short options that
|
||||||
|
take an argument may have the value follow immediately or be separated by a
|
||||||
|
space. Long options starting with two dashes (\(oq\-\(cq) require an
|
||||||
|
\(oq=\(cq between the option and any argument.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
Here is a summary of the supported options:
|
Here is a summary of the supported options:
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-m, --model=id
|
.BR \-m ", " \-\-model = \fIid\fP
|
||||||
Select radio model number. See model list (use 'rigctl -l').
|
Select radio model number.
|
||||||
|
.IP
|
||||||
|
See model list (use \(lqrigctl \-l\(rq).
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-r, --rig-file=device
|
.BR \-r ", " \-\-rig\-file = \fIdevice\fP
|
||||||
Use \fIdevice\fP as the file name of the port the radio is connected.
|
Use
|
||||||
|
.I device
|
||||||
|
as the file name of the port connected to the radio.
|
||||||
|
.IP
|
||||||
Often a serial port, but could be a USB to serial adapter. Typically
|
Often a serial port, but could be a USB to serial adapter. Typically
|
||||||
/dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
|
.IR /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 ,
|
||||||
|
etc. on Linux,
|
||||||
|
.IR COM1 ", " COM2 ,
|
||||||
|
etc. on MS Windows. The BSD flavors and Mac OS/X have their own designations.
|
||||||
|
See your system's documentation.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-s, --serial-speed=baud
|
.BR \-s ", " \-\-serial\-speed = \fIbaud\fP
|
||||||
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rig
|
Set radio serial speed to
|
||||||
backend capabilities as the default.
|
.I baud
|
||||||
|
rate.
|
||||||
|
.IP
|
||||||
|
Uses maximum serial speed from rig backend capabilities as the default.
|
||||||
.TP
|
.TP
|
||||||
.B \-c, --civaddr=id
|
.BR \-c ", " \-\-civaddr = \fIid\fP
|
||||||
Use \fIid\fP as the CI-V address to communicate with the rig. Only useful for
|
Use
|
||||||
Icom rigs.
|
.I id
|
||||||
.br
|
as the CI-V address to communicate with the rig.
|
||||||
NB: the \fIid\fP is in decimal notation, unless prefixed by
|
.IP
|
||||||
\fI0x\fP, in which case it is hexadecimal.
|
Only useful for Icom and some Ten-Tec rigs.
|
||||||
|
.IP
|
||||||
|
.BR Note :
|
||||||
|
The
|
||||||
|
.I id
|
||||||
|
is in decimal notation, unless prefixed by
|
||||||
|
.IR 0x ,
|
||||||
|
in which case it is hexadecimal.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-p, --ptt-file=device
|
.BR \-C ", " \-\-set\-conf = \fIparm=val\fP [ \fI,parm=val\fP ]
|
||||||
Use \fIdevice\fP as the file name of the Push-To-Talk device using a
|
Set radio configuration parameter(s), e.g.
|
||||||
device file as described above.
|
.IR stop_bits=2 .
|
||||||
.br
|
.IP
|
||||||
This is only needed if the radio doesn't have legacy PTT control.
|
Use the
|
||||||
|
.B -L
|
||||||
|
option of
|
||||||
|
.B rigctl
|
||||||
|
for a list of configuration parameters for a given model number.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-p, --ptt-type=type
|
.BR \-p ", " \-\-ptt\-file = \fIdevice\fP
|
||||||
Use \fItype\fP of Push-To-Talk device.
|
Use
|
||||||
Supported types are RIG, DTR, RTS, PARALLEL, NONE.
|
.I device
|
||||||
.br
|
as the file name of the Push-To-Talk port using a device file as with the
|
||||||
This is only needed if the radio doesn't have legacy PTT control.
|
.B \-r
|
||||||
|
option above.
|
||||||
|
.IP
|
||||||
|
This is only needed if the radio doesn't have CAT PTT control and requires a
|
||||||
|
separate device port to key the transmitter.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-C, --set-conf=parm=val[,parm=val]*
|
.BR \-P ", " \-\-ptt\-type = \fItype\fP
|
||||||
Set config parameter. e.g. stop_bits=2
|
Use
|
||||||
.br
|
.I type
|
||||||
Use -L option of \fBrigctl\fP for a list.
|
of Push-To-Talk device.
|
||||||
|
.IP
|
||||||
|
Supported types are RIG (CAT), DTR, RTS, PARALLEL, NONE.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-v, --verbose
|
.BR \-v ", " \-\-verbose
|
||||||
Set verbose mode, cumulative (see DIAGNOSTICS below).
|
Set verbose mode, cumulative (see
|
||||||
|
.B DIAGNOSTICS
|
||||||
|
below).
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-h, --help
|
.BR \-h ", " \-\-help
|
||||||
Show summary of these options and exit.
|
Show a summary of these options and exit.
|
||||||
|
.
|
||||||
.TP
|
.TP
|
||||||
.B \-V, --version
|
.BR \-V ", " \-\-version
|
||||||
Show version of \fBrigswr\fP and exit.
|
Show version of
|
||||||
|
.B rigswr
|
||||||
|
and exit.
|
||||||
|
.
|
||||||
.PP
|
.PP
|
||||||
\fBNOTE!\fP Some options may not be implemented by a given backend and will
|
.BR Note :
|
||||||
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
|
Some options may not be implemented by a given backend and will return an
|
||||||
|
error. This is most likely to occur with the
|
||||||
|
.B \-\-set\-conf
|
||||||
option.
|
option.
|
||||||
.SH EXAMPLE
|
.
|
||||||
rigswr -m 209 -r /dev/ttyS1 14000000 14290000 50000 > cswr
|
.
|
||||||
|
.SH DIAGNOSTICS
|
||||||
|
.
|
||||||
|
The
|
||||||
|
.BR \-v ,
|
||||||
|
.B \-\-verbose
|
||||||
|
option allows different levels of diagnostics to be output to
|
||||||
|
.B stderr
|
||||||
|
and correspond to \-v for
|
||||||
|
.BR BUG ,
|
||||||
|
\-vv for
|
||||||
|
.BR ERR ,
|
||||||
|
\-vvv for
|
||||||
|
.BR WARN ,
|
||||||
|
\-vvvv for
|
||||||
|
.BR VERBOSE ,
|
||||||
|
or \-vvvvv for
|
||||||
|
.BR TRACE .
|
||||||
|
.
|
||||||
.PP
|
.PP
|
||||||
|
A given verbose level is useful for providing needed debugging information to
|
||||||
|
the email address below. For example, TRACE output shows all of the values
|
||||||
|
sent to and received from the radio which is very useful for radio backend
|
||||||
|
library development and may be requested by the developers.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH EXIT STATUS
|
||||||
|
.
|
||||||
|
.B rigswr
|
||||||
|
exits with:
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 0
|
||||||
|
if all operations completed normally;
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 1
|
||||||
|
if there was an invalid command line option or argument;
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 2
|
||||||
|
if an error was returned by
|
||||||
|
.BR Hamlib ;
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
.B 3
|
||||||
|
if the rig doesn't have the required capabilities.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH EXAMPLE
|
||||||
|
.
|
||||||
Scans frequencies between 14.000 MHz and 14.200 MHz with 50 kHz step on a
|
Scans frequencies between 14.000 MHz and 14.200 MHz with 50 kHz step on a
|
||||||
TS-850 and records VSWR measurements in file cswr.
|
TS-850 and records VSWR measurements in file
|
||||||
|
.IR cswr .
|
||||||
|
.
|
||||||
|
.sp
|
||||||
|
.RS 0.5i
|
||||||
|
.EX
|
||||||
|
rigswr -m 209 -r /dev/ttyS1 14000000 14200000 50000 > cswr
|
||||||
|
.EE
|
||||||
|
.RE
|
||||||
|
.
|
||||||
.PP
|
.PP
|
||||||
After completion, cswr file contains the following lines:
|
After completion, cswr file contains the following lines:
|
||||||
.br
|
.
|
||||||
|
.sp
|
||||||
|
.RS 0.5i
|
||||||
|
.EX
|
||||||
14000000 1.50
|
14000000 1.50
|
||||||
.br
|
.br
|
||||||
14050000 1.31
|
14050000 1.31
|
||||||
|
|
@ -114,55 +266,71 @@ After completion, cswr file contains the following lines:
|
||||||
14150000 1.07
|
14150000 1.07
|
||||||
.br
|
.br
|
||||||
14200000 1.07
|
14200000 1.07
|
||||||
.TP
|
.EE
|
||||||
Result could then be plotted with \fBgnuplot\fP:
|
.RE
|
||||||
.br
|
.
|
||||||
|
.PP
|
||||||
|
The result can be plotted with
|
||||||
|
.BR gnuplot (1):
|
||||||
|
.
|
||||||
|
.sp
|
||||||
|
.RS 0.5i
|
||||||
|
.EX
|
||||||
gnuplot
|
gnuplot
|
||||||
.br
|
.br
|
||||||
set data style linespoints
|
set data style linespoints
|
||||||
.br
|
.br
|
||||||
set grid
|
set grid
|
||||||
.br
|
.br
|
||||||
plot "cswr"
|
.RI plot " cswr"
|
||||||
.SH DIAGNOSTICS
|
.EE
|
||||||
The \fB-v\fP, \fB--version\fP option allows different levels of diagnostics
|
.RE
|
||||||
to be output to \fBstderr\fP and correspond to -v for BUG, -vv for ERR,
|
.
|
||||||
-vvv for WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
|
.
|
||||||
|
|
||||||
A given verbose level is useful for providing needed debugging information to
|
|
||||||
the email address below. For example, TRACE output shows all of the values
|
|
||||||
sent to and received from the radio which is very useful for radio backend
|
|
||||||
library development and may be requested by the developers.
|
|
||||||
.SH EXIT STATUS
|
|
||||||
\fBrigswr\fP exits with:
|
|
||||||
.br
|
|
||||||
0 if all operations completed normally;
|
|
||||||
.br
|
|
||||||
1 if there was an invalid command line option or argument;
|
|
||||||
.br
|
|
||||||
2 if an error was returned by \fBHamlib\fP;
|
|
||||||
.br
|
|
||||||
3 if the rig doesn't have the required capabilities.
|
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
|
.
|
||||||
Depending on keyer/QSK setup, transmissions in CW mode may not be modulated
|
Depending on keyer/QSK setup, transmissions in CW mode may not be modulated
|
||||||
thus possibly giving a wrong result. Please report this situation if it happens.
|
thus possibly giving a wrong result. Please report this situation if it
|
||||||
.SH REPORTING BUGS
|
happens.
|
||||||
Report bugs to <hamlib-developer@lists.sourceforge.net>.
|
.
|
||||||
|
.PP
|
||||||
|
Report bugs to:
|
||||||
|
.IP
|
||||||
|
.nf
|
||||||
|
.MT hamlib\-developer@lists.sourceforge.net
|
||||||
|
Hamlib Developer mailing list
|
||||||
|
.ME
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.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.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Copyright \(co 2004 Thierry Leconte
|
||||||
.br
|
.br
|
||||||
We are already aware of the bug in the previous section :-)
|
Copyright \(co 2004-2011 Stephane Fillod
|
||||||
.SH AUTHORS
|
|
||||||
Written by Thierry Leconte, Stephane Fillod, and the Hamlib Group
|
|
||||||
.br
|
.br
|
||||||
<http://www.hamlib.org>.
|
Copyright \(co 2007,2018 Nate Bargmann
|
||||||
.SH COPYRIGHT
|
.PP
|
||||||
Copyright \(co 2004-2009 Thierry Leconte, Stephane Fillod, and the Hamlib
|
This is free software; see the file COPYING for copying conditions. There is
|
||||||
Group.
|
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||||
.br
|
.
|
||||||
This is free software; see the source for copying conditions.
|
.
|
||||||
There is NO warranty; not even for MERCHANTABILITY
|
|
||||||
or FITNESS FOR A PARTICULAR PURPOSE.
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.BR rigctl (1),
|
.
|
||||||
.BR gnuplot (1),
|
.BR gnuplot (1),
|
||||||
.BR hamlib (3)
|
.BR rigctl (1),
|
||||||
|
.BR hamlib (7)
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH COLOPHON
|
||||||
|
.
|
||||||
|
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
|
||||||
|
archives:
|
||||||
|
.IP
|
||||||
|
.UR http://www.hamlib.org
|
||||||
|
hamlib.org
|
||||||
|
.UE .
|
||||||
|
|
|
||||||
1014
tests/rotctl.1
1014
tests/rotctl.1
Plik diff jest za duży
Load Diff
1169
tests/rotctld.1
1169
tests/rotctld.1
Plik diff jest za duży
Load Diff
Ładowanie…
Reference in New Issue