Hamlib/tests/rigswr.1

.\"                                      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 26, 2006" "Hamlib"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
rigswr \- measure VSWR vs frequency using hamlib
.SH SYNOPSIS
.B rigswr
[\fIOPTION\fR]... start_freq stop_freq [freq_step]
.SH DESCRIPTION
\fBrigswr\fP uses Hamlib to control a rig to measure VSWR vs frequency: 
.br
It scans frequencies from start_freq to stop_freq with step freq_step.
For each frequency, it transmits at 25% of total POWER during 0.5 second in CW mode
and read VSWR.
.br
Frequency and corresponding VSWR are then printed on stdout.
.br
To work correctly, rigswr needs a rig that could measure VSWR and a Hamlib backend that 
is able to get it.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
Keep in mind that \fBHamlib\fP is still BETA level software. 
A lof of stuff hasn't been tested thoroughly, and the API may change
without publicised notice. Please report bugs and feedback at
the e-mail address given in the REPORTING BUGS section.
.SH OPTIONS
This program follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
.TP
.B \-m, \-\-model=id
Select radio model number. See model list provided by rigctl.
.TP
.B \-r, --rig-file=device
Use \fBdevice\fP as the file name of the radio to operate on.
.TP
.B \-s, --serial-speed=baud
Set serial speed to \fBbaud\fP rate. Uses maximal rig speed as default.
.TP
.B \-c, --civaddr=id
Use \fBid\fP as the CI-V address to communicate with the rig. 
Only for Icom rigs. NB: the id is in decimal, unless prefixed by \fB0x\fP,
in which case it is hexadecimal.
.TP
.B \-p, --ptt-file=device
Use \fBdevice\fP as the file name of the Push-To-Talk device to operate on.
This is only needed if the radio doesn't have legacy PTT control.
.TP
.B \-p, --ptt-type=type
Use \fBtype\fP device as the kind of the Push-To-Talk device to operate on.
Supported types are RIG, DTR, RTS, PARALLEL, NONE.
This is only needed if the radio doesn't have legacy PTT control.
.TP
.B \-C, \-\-set\-conf=parm=val[,parm=val]*
Set config parameter. See -L option of rigctl for a list.
.TP
.B \-v, \-\-verbose
Set verbose mode, cumulative (BUG, ERR, WARN, VERBOSE, TRACE).
.TP
.B \-h, \-\-help
Show summary of options and exit.
.TP
.B \-V, \-\-version
Show version of program and exit.

.SH RETURN VALUE
rigswr exits with:
0 if all operations went fine; 1 if there was an invalid command line
option or arg; 2 if an error was returned by Hamlib; 3 if the rig
doesn't have the required capabilities.

.SH EXAMPLE
rigswr -m 209 -r /dev/tty1 14000000 14350000 50000 > cswr

.br
Scans frequencies between 14MHz and 14.200MHz with 50KHz step on a TS850 and
record VSWR measurements in file cswr.
.br
After completion, cswr file contains the following lines :
.br
  14000000 1.50
.br
  14050000 1.31
.br
  14100000 1.22
.br
  14150000 1.07
.br
  14200000 1.07

.TP
Result could then be ploted with gnuplot:
.br
gnuplot
.br
set data style linespoints
.br
set grid
.br
plot "cswr"
.SH AUTHOR
Man page written by Thierry Leconte & Stephane Fillod .
.SH BUGS
Depending on keyer/QSK setup, transmits in CW mode may not be modulated
thus giving possibly wrong result. Please report this situation if it happens.
.SH REPORTING BUGS
Report bugs to <hamlib-developer@users.sourceforge.net>.
.SH COPYRIGHT
Copyright \(co 2004-2006 Thierry Leconte & Stephane Fillod
.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
.BR hamlib (3), rigctl(1)