mirror
/
Hamlib
kopia lustrzana https://github.com/Hamlib/Hamlib
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Many man page updates to provide needed information and (hopefully) 

improve readability.  Also, tried to keep the man pages as consistent
as possible.


git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2189 7ae35d74-ebe9-4afe-98af-79ac388436b8
Hamlib-1.2.6.2
Nate Bargmann, N0NB 2007-02-24 20:24:34 +00:00
rodzic 4f79abfaba
commit 6fb48baf21
8 zmienionych plików z 492 dodań i 276 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

43
rpcrig/rpc.rigd.8
Wyświetl plik

@ -21,12 +21,12 @@ rigd \- Hamlib rig service daemon
.B rpc.rigd
[\fIOPTION\fR]...
.SH DESCRIPTION
The \fBrigd\fP program is a Hamlib rig daemon that handles RPC client requests.
This allows multiple user programs to share one radio. At this time multiple
radio support is not available (help needed!).
The \fBrigd\fP program is a \fBHamlib\fP rig daemon that handles RPC client
requests. This allows multiple user programs to share one radio. At this time
multiple radio support is not available (help needed!).
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" \fI<whatever>\fP escape sequences to invoke bold face and italics,
.\" respectively.
Keep in mind that \fBHamlib\fP is BETA level software.
While a lot of backend libraries lack complete rig support, the basic functions
@ -39,13 +39,13 @@ REPORTING BUGS section. Patches and code enhancements are also welcome.
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
.PP
Here is a summary of the supported options:
.TP
.B \-m, --model=id
Select radio model number. See rig model list (use 'rigctl -l').
.br
\fINote:\fP \fBrigctl\fP (or third party software) will use rig model 1901
NB: \fBrigctl\fP (or third party software) will use rig model 1901
when using \fBrigd\fP.
.TP
.B \-r, --rig-file=device
@ -70,44 +70,47 @@ Use \fItype\fP of Data Carrier Detect device.
Supported types are RIG, DSR, CTS, CD, PARALLEL, NONE.
.TP
.B \-s, --serial-speed=baud
Set serial speed to \fIbaud\fP rate. Uses maximum backend defined rig speed as
the default.
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.
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 \-t, --prog=number
Use \fInumber\fP as the RPC program number. The default is 536871065.
.TP
.B \-v, --verbose
Set verbose mode, cumulative.
Set verbose mode, cumulative (see DIAGNOSTICS below).
.TP
.B \-h, --help
Show a summary of these options and exit.
.TP
.B \-V, --version
Show the version of \fBrigd\fP and exit.
.PP
Please note that the backend for the radio to be controlled,
or the radio itself may not support some commands. In that case,
the operation will fail with a \fBHamlib\fP error code.
.SH EXAMPLES
Start rigd as root for a Yaesu FT-920 using a USB to serial adapter and
Start \fBrigd\fP as root for a Yaesu FT-920 using a USB to serial adapter and
backgrounding:
.PP
# rpc.rigd -m 114 -r /dev/ttyUSB1 &
.PP
Start rigd as root for a Yaesu FT-920 using COM1 while generating TRACE output:
Start \fBrigd\fP as root for a Yaesu FT-920 using COM1 while generating TRACE output:
.PP
# rpc.rigd -m 114 -r /dev/ttyS0 -vvvvv
.PP
Start rigd as root for a Yaesu FT-920 using a USB to serial adapter while
Start \fBrigd\fP as root for a Yaesu FT-920 using a USB to serial adapter while
setting baud rate and stop bits and backgrounding:
.PP
# rpc.rigd -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 &
@ -130,11 +133,13 @@ radios on a CI-V bus).
Does not support more than one communication device for multiple rig control.
(e.g. for Single Operator 2 Radio) Help needed!
.SH REPORTING BUGS
Report bugs to <hamlib-developer@users.sourceforge.net>.
Report bugs to <hamlib-developer@lists.sourceforge.net>.
.br
We are already aware of the bugs in the previous section :-)
.SH AUTHORS
Written by Stephane Fillod and the Hamlib Group <http://www.hamlib.org>.
Written by Stephane Fillod and the Hamlib Group
.br
<http://www.hamlib.org>.
.SH COPYRIGHT
Copyright \(co 2000-2007 Stephane Fillod and the Hamlib Group.
.PP
@ -142,5 +147,5 @@ 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 rigctl (1)
.BR rigctl (1),
.BR hamlib (3)

108
rpcrot/rpc.rotd.8
Wyświetl plik

@ -2,7 +2,7 @@
.\" 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 ROTD "8" "22 September 2002" "Hamlib"
.TH ROTD "8" "February 24, 2007" "Hamlib" "RPC Rotator Daemon"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -21,67 +21,107 @@ rotd \- Hamlib rotator service daemon
.B rpc.rotd
[\fIOPTION\fR]...
.SH DESCRIPTION
The \fBrotd\fP program is a Hamlib rotator daemon that handles RPC client requests.
The \fBrotd\fP program is a \fBHamlib\fP rotator daemon that handles RPC
client requests. This allows multiple user programs to share one rotator. At
this time multiple rotator support is not available (help needed!).
.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 ALPHA 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.
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
Please report bugs and provide feedback at the e-mail address given in the
REPORTING BUGS section. Patches and code enhancements are also welcome.
.SH OPTIONS
This program follow the usual GNU command line syntax, with long
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
Here is a summary of the supported options:
.TP
.B \-m, \-\-model=id
Select rotator model number. See model list.
.B \-m, --model=id
Select rotator model number. See model list (use 'rotctl -l').
.br
NB: \fBrotctl\fP (or third party software) will use rotor model 101
when using \fBrotd\fP.
.TP
.B \-r, --rot-file=device
Use \fBdevice\fP as the file name of the rotator to operate on.
Use \fIdevice\fP as the file name of the port the rotator 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 \fBbaud\fP rate. Uses maximal rotator speed as default.
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rotor
backend as the default.
.TP
.B \-C, \-\-set\-conf=parm=val[,parm=val]*
Set config parameter.
.B \-C, --set-conf=parm=val[,parm=val]*
Set config parameter. e.g. stop_bits=2
.br
Use -L option of \fBrotctl\fP for a list.
.TP
.B \-t, --prog=number
Use \fBnumber\fP as the RPC program number. The default is 536873369.
Use \fInumber\fP as the RPC program number. The default is 536873369.
.TP
.B \-v, \-\-verbose
Set verbose mode, cumulative (BUG, ERR, WARN, VERBOSE, TRACE).
.B \-v, --verbose
Set verbose mode, cumulative (see DIAGNOSTICS below).
.TP
.B \-h, \-\-help
Show summary of options and exit.
.B \-h, --help
Show summary of these options and exit.
.TP
.B \-V, \-\-version
Show version of program and exit.
Show version of \fBrpc.rotd\fP and exit.
.PP
Please note that the backend for the rotator to be controlled,
or the rotator itself may not support some commands. In that case,
the operation will fail with a standard error code.
.SH AUTHOR
Written by Stephane Fillod.
.SH BUGS
No authentication whatsoever. Could be done through domain restriction though.
Please ask if stronger security needed.
the operation will fail with a \fBHamlib\fP error code.
.SH EXAMPLES
Start \fBrotd\fP as root for a RotorEZ using a USB to serial adapter and
backgrounding:
.PP
This almost empty section...
# rpc.rotd -m 401 -r /dev/ttyUSB1 &
.PP
Start \fBrotd\fP as root for a RotorEZ using COM1 while generating TRACE
output:
.PP
# rpc.rotd -m 401 -r /dev/ttyS0 -vvvvv
.PP
Start \fBrotd\fP as root for a RotorEZ using a USB to serial adapter while
setting baud rate and stop bits and backgrounding:
.PP
# rpc.rotd -m 401 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 &
.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,
-vvv for WARN, -vvvv for VERBOSE, or -vvvvv for 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 rotator which is very useful for rotator backend
library development and may be requested by the developers.
.SH SECURITY
No authentication whatsoever; could be done through domain restriction,
though. Please ask if stronger security is needed.
.SH BUGS
Does not support more than one communication device for multiple rotor control.
(e.g. for Single Operator 2 Radio) Help needed!
.SH REPORTING BUGS
Report bugs to <hamlib-developer@users.sourceforge.net>.
Report bugs to <hamlib-developer@lists.sourceforge.net>.
.br
I'm already aware of the bug in the previous section :-)
We are already aware of the bug in the previous section :-)
.SH AUTHORS
Written by Stephane Fillod and the Hamlib Group
.br
<http://www.hamlib.org>.
.SH COPYRIGHT
Copyright \(co 2000-2002 Stephane Fillod.
Copyright \(co 2000-2007 Stephane Fillod and the Hamlib Group.
Contributed by Francois Retief <fgretief@sun.ac.za>.
.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 rotctl (1)
.BR rotctl (1),
.BR hamlib (3)

15
tests/README
Wyświetl plik

@ -1,21 +1,22 @@
You will find in the tests/ subdirectory various programs to exercise
the Hamlib library.
Most of the time, you will have to make sure that the backend for
your rig is loaded by passing the model number of your rig by argument.
If you don't know the number, listrigs can give it to you,
"rigctl --list" will also output something like this:
Rig# Mfg Model Vers.
1 Hamlib Dummy 0.1
1506 Winradio WR-3500 0.6
210 Kenwood TS-870S 0.1
311 Icom IC-706MkIIG 0.2
105 Yaesu FT-747GX 0.1
1 Hamlib Dummy 0.1
1506 Winradio WR-3500 0.6
210 Kenwood TS-870S 0.1
311 Icom IC-706MkIIG 0.2
105 Yaesu FT-747GX 0.1
[etc.]
In any case, you are encouraged to checked for correct initialization
by reading the source code, at the begining of the main(). Check also
In any case, you are encouraged to check for correct initialization
by reading the source code, at the begining of the main(). Check also
that the program is setup for your rig path strncpy(my_rig->state.rig_path...
dumpcaps - Output the caps contents of a rig

183
tests/rigctl.1
Wyświetl plik

@ -2,7 +2,7 @@
.\" 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 RIGCTL "1" "January 13, 2007" "Hamlib"
.TH RIGCTL "1" "February 24, 2007" "Hamlib" "Radio Control Program"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -22,94 +22,112 @@ rigctl \- control radio transceivers and receivers
[\fIOPTION\fR]... [\fICOMMAND\fR]...
.SH DESCRIPTION
Control radio transceivers and receivers.
\fBrigctl\fP accepts \fBcommands\fP from command line as well as in
interactive mode if none provided in command line.
\fBrigctl\fP accepts \fBcommands\fP from the command line as well as in
interactive mode if none are provided on the command line.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" \fI<whatever>\fP escape sequences to invoke 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.
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
Please report bugs and provide feedback at the e-mail address given in the
REPORTING BUGS section. Patches and code enhancements are also welcome.
.SH OPTIONS
This program follow the usual GNU command line syntax, with long
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
Here is a summary of the supported options:
.TP
.B \-m, \-\-model=id
Select radio model number. See model list.
.B \-m, --model=id
Select radio model number. See model list (use 'rigctl -l').
.br
NB: \fBrigctl\fP (or third party software) will use rig model 1901
when using \fBrpc.rigd\fP.
.TP
.B \-r, --rig-file=device
Use \fBdevice\fP as the file name of the radio to operate on.
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 \-p, --ptt-file=device
Use \fBdevice\fP as the file name of the Push-To-Talk device to operate on.
Use \fIdevice\fP as the file name of the Push-To-Talk device using a
device file as described above.
.TP
.B \-d, --dcd-file=device
Use \fBdevice\fP as the file name of the Data Carrier Detect device
to operate on.
Use \fIdevice\fP as the file name of the Data Carrier Detect device using a
device file as described above.
.TP
.B \-p, --ptt-type=type
Use \fBtype\fP device as the kind of the Push-To-Talk device to operate on.
Use \fItype\fP of Push-To-Talk device.
Supported types are RIG, DTR, RTS, PARALLEL, NONE.
.TP
.B \-d, --dcd-type=type
Use \fBtype\fP device as the kind of the Data Carrier Detect device
to operate on.
Use \fItype\fP of Data Carrier Detect device.
Supported types are RIG, DSR, CTS, CD, PARALLEL, NONE.
.TP
.B \-s, --serial-speed=baud
Set serial speed to \fBbaud\fP rate. Uses maximal rig speed as default.
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rig
backend capabilities as the 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 \fBid\fP is in decimal notation, unless prefixed by \fB0x\fP,
in which case it is hexadecimal.
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 \-L, \-\-show-conf
List all config parameters.
.B \-L, --show-conf
List all config parameters for the radio defined with -m above.
.TP
.B \-C, \-\-set\-conf=parm=val[,parm=val]*
Set config parameter.
.B \-C, --set-conf=parm=val[,parm=val]*
Set config parameter. e.g. stop_bits=2
.br
Use -L option for a list.
.TP
.B \-l, \-\-list
List all model numbers and exit.
.B \-l, --list
List all model numbers defined in \fBHamlib\fP and exit.
.TP
.B \-u, \-\-dump\-caps
Dump capabilities and exit.
.B \-u, --dump-caps
Dump capabilities for the radio defined with -m above and exit.
.TP
.B \-o, \-\-vfo
Set vfo mode, requiring an extra VFO argument in front of each appropriate command.
Otherwise, VFO_CURR is assumed when this option is not set.
.B \-o, --vfo
Set vfo mode, requiring an extra VFO argument in front of each appropriate
command. Otherwise, VFO_CURR is assumed when this option is not set.
.TP
.B \-v, \-\-verbose
Set verbose mode, cumulative (BUG, ERR, WARN, VERBOSE, TRACE).
.B \-v, --verbose
Set verbose mode, cumulative (see DIAGNOSTICS below).
.TP
.B \-h, \-\-help
Show summary of options and exit.
.B \-h, --help
Show summary of these options and exit.
.TP
.B \-V, \-\-version
Show version of program and exit.
.B \-V, --version
Show version of \fBrigctl\fP and exit.
.PP
\fBNOTE!\fP Some options may not be implemented by a given backend and will
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
and \fI\-\-show-conf\fP options.
.SH COMMANDS
Commands can be entered either as a single char, or as a long command name.
Basically, the commands do not take a dash in front of them on the command
line, as the options usually do. They may be typed in when in interactive mode
or provided as argument in command line interface mode.
line, as the options do. They may be typed in when in interactive mode
or provided as argument(s) in command line interface mode.
.PP
Since most of the Hamlib operations have a \fIset\fP and a \fIget\fP method,
upper case letter will be used for \fIset\fP method whereas the corresponding
lower case letter refers to the \fIget\fP method.
In interactive, prepend a backslash to enter a long command name.
Example: "\\dump_caps" to see what this model can do.
Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP method,
an upper case letter will be used for \fIset\fP method whereas the
corresponding lower case letter refers to the \fIget\fP method.
In interactive mode, prepend a backslash to enter a long command name.
.br
Example: Use "\\dump_caps" to see what this radio can do.
.PP
Please note that the backend for the radio to be controlled,
or the radio itself may not support some commands. In that case,
the operation will fail with a standard error message.
the operation will fail with a \fBHamlib\fP error message.
.PP
A summary of commands is included below.
Here is a summary of the supported commands:
.TP
.B F, set_freq
Set frequency, in Hz.
@ -275,34 +293,73 @@ Get power status.
.B _, get_info
Get misc information about the rig.
.TP
.B dump_caps
.B 1, dump_caps
Not a real rig remote command, it just dumps capabilities,
i.e. what the backend knows about this model, and what it can do.
.TP
.B 2, power2mW
Converts a power value in a range of \fI0.0 ... 1.0\fP to the real transmit
power in milli-Watts. The \fIfrequency\fP and \fImode\fP also need to be
provided as output power may vary according to these values.
.TP
.B w, send_cmd
Send raw command string to rig. Binary protocols enter values as \0xAA\0xBB
.SH EXAMPLES
Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter in
interactive mode:
.SH RETURN VALUE
rigctl exits with:
0 if all operations went fine; 1 if there was an invalid command line
option or arg; or 2 if an error was returned by Hamlib.
$ rigctl -m 114 -r /dev/ttyUSB1
.SH AUTHOR
Written by Stephane Fillod.
Start \fBrigctl\fP for a Yaesu FT-920 using COM1 while generating TRACE output
to \fBstderr\fP:
$ rigctl -m 114 -r /dev/ttyS0 -vvvvv
Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter while
setting baud rate and stop bits:
$ rigctl -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2
Start \fBrigctl\fP using \fBrpc.rigd\fP and setting the frequency and mode:
$ rigctl -m 1901 -r localhost F 7253500 M LSB 0
.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,
-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
\fBrigctl\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.
.SH BUGS
set_chan has no entry method as of yet, hence left unimplemented.
.PP
This almost empty section...
.SH REPORTING BUGS
Report bugs to <hamlib-developer@users.sourceforge.net>.
Report bugs to <hamlib-developer@lists.sourceforge.net>.
.br
I'm already aware of the bug in the previous section :-)
We are already aware of the bugs in the previous section :-)
.SH AUTHORS
Written by Stephane Fillod and the Hamlib Group
.br
<http://www.hamlib.org>.
.SH COPYRIGHT
Copyright \(co 2000-2006 Stephane Fillod & Frank Singleton.
Copyright \(co 2000-2007 Stephane Fillod, Frank Singleton, 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
.BR hamlib (3)
.BR hamlib (3),
.BR rpc.rigd (8)

138
tests/rigmem.1
Wyświetl plik

@ -2,7 +2,7 @@
.\" 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 RIGCTL "1" "February 26, 2006" "Hamlib"
.TH RIGMEM "1" "February 24, 2007" "Hamlib" "Radio Memory Operations"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -22,95 +22,131 @@ rigmem \- backup and restore memory of radio transceivers and receivers
[\fIOPTION\fR]... [\fICOMMAND\fR]...
.SH DESCRIPTION
Backup and restore memory of radio transceivers and receivers.
\fBrigmem\fP accepts \fBcommands\fP from command line only.
\fBrigmem\fP accepts \fIcommands\fP from the command line only.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" \fI<whatever>\fP escape sequences to invoke 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.
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
Please report bugs and provide feedback at the e-mail address given in the
REPORTING BUGS section. Patches and code enhancements are also welcome.
.SH OPTIONS
This program follow the usual GNU command line syntax, with long
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
Here is a summary of the supported options:
.TP
.B \-m, \-\-model=id
Select radio model number. See model list, as reported by rigctl.
.B \-m, --model=id
Select radio model number. See model list (use 'rigctl -l').
.br
NB: \fBrigmem\fP (or third party software) will use rig model 1901
when using \fBrpc.rigd\fP.
.TP
.B \-r, --rig-file=device
Use \fBdevice\fP as the file name of the radio to operate on.
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 \fBbaud\fP rate. Uses maximal rig speed as default.
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rig
backend capabilities as the 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.
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.
.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
.B \-x, --xml
Use XML format instead of CSV, if libxml2 is available.
.TP
.B \-v, \-\-verbose
Set verbose mode, cumulative (BUG, ERR, WARN, VERBOSE, TRACE).
.B \-v, --verbose
Set verbose mode, cumulative (see DIAGNOSTICS below).
.TP
.B \-h, \-\-help
Show summary of options and exit.
.B \-h, --help
Show a summary of these options and exit.
.TP
.B \-V, \-\-version
Show version of program and exit.
.B \-V, --version
Show version of \fBrigmem\fP and exit.
.PP
\fBNOTE!\fP Some options may not be implemented by a given backend and will
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
option.
.SH COMMANDS
Backup and restore are supported for basic CSV file and XML format where available.
Backup and restore are supported for basic CSV file and XML format where
available.
.PP
Please note that the backend for the radio to be controlled,
or the radio itself may not support some commands. In that case,
the operation will fail with a standard error message.
the operation will fail with a \fBHamlib\fP error message.
.PP
A summary of commands is included below.
Here is a summary of the supported commands:
.TP
.B save
Save all the content of memory in a CSV (or XML) file given as argument to the command.
Save all the content of memory in a CSV (or XML) file given as an argument to
the command.
.TP
.B load
Load the content into all the memory from a CSV (or XML) file given as argument to the command.
Load the content into all the memory from a CSV (or XML) file given as
an argument to the command.
.TP
.B save_parm
Save all the parameters of the radio in a CSV (or XML) file given as argument to the command.
Save all the parameters of the radio in a CSV (or XML) file given as an
argument to the command.
.TP
.B load_parm
Load the parameters of the radio from a CSV (or XML) file given as argument to the command.
Load the parameters of the radio from a CSV (or XML) file given as an
argument to the command.
.TP
.B clear
Very DANGEROUS command, as it will completly clear out everything you have programmed
in the memory of you radio. ALL DATA WILL BE LOST. Use at your own risks!
This is a very \fBDANGEROUS\fP command, as it will completely clear out
everything you have programmed in the memory of your radio. \fBALL DATA WILL
BE LOST\fP. Use at your own risk!
.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,
-vvv for WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
.SH RETURN VALUE
rigmem exits with:
0 if all operations went fine; 1 if there was an invalid command line
option or arg; or 2 if an error was returned by Hamlib.
.SH AUTHOR
Man page written by Stephane Fillod.
.SH BUGS
This almost empty section...
.SH REPORTING BUGS
Report bugs to <hamlib-developer@users.sourceforge.net>.
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
\fBrigmem\fP exits with:
.br
I'm already aware of the bug in the previous section :-)
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.
.SH BUGS
This empty section...
.SH REPORTING BUGS
Report bugs to <hamlib-developer@lists.sourceforge.net>.
.br
We are already aware of the bug in the previous section :-)
.SH AUTHOR
Written by Stephane Fillod and the Hamlib Group
.br
<http://www.hamlib.org>.
.SH COPYRIGHT
Copyright \(co 2000-2006 Stephane Fillod.
Copyright \(co 2000-2007 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
.BR hamlib (3), rigctl(1)
.BR rigctl (1),
.BR hamlib (3)

153
tests/rigswr.1
Wyświetl plik

@ -2,7 +2,7 @@
.\" 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"
.TH RIGSWR "1" "February 24, 2007" "Hamlib" "Radio SWR Measurement Tool"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -16,83 +16,97 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
rigswr \- measure VSWR vs frequency using hamlib
rigswr \- measure VSWR vs frequency using \fBHamlib\fP.
.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:
\fBrigswr\fP uses \fBHamlib\fP 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.
It scans frequencies from \fIstart_freq\fP to \fIstop_freq\fP with a step of
\fIfreq_step\fP. For each frequency, it transmits at 25% of total POWER during
0.5 second in CW mode and reads VSWR.
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
.\" 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.
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
Please report bugs and provide feedback at the e-mail address given in the
REPORTING BUGS section. Patches and code enhancements are also welcome.
.SH OPTIONS
This program follow the usual GNU command line syntax, with long
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
Here is a summary of the supported options:
.TP
.B \-m, \-\-model=id
Select radio model number. See model list provided by rigctl.
.B \-m, --model=id
Select radio model number. See model list (use 'rigctl -l').
.br
NB: \fBrigswr\fP (or third party software) will use rig model 1901
when using \fBrpc.rigd\fP.
.TP
.B \-r, --rig-file=device
Use \fBdevice\fP as the file name of the radio to operate on.
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 \fBbaud\fP rate. Uses maximal rig speed as default.
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rig
backend capabilities as the 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.
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 \-p, --ptt-file=device
Use \fBdevice\fP as the file name of the Push-To-Talk device to operate on.
Use \fIdevice\fP as the file name of the Push-To-Talk device using a
device file as described above.
.br
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.
Use \fItype\fP of Push-To-Talk device.
Supported types are RIG, DTR, RTS, PARALLEL, NONE.
.br
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.
.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 \-v, \-\-verbose
Set verbose mode, cumulative (BUG, ERR, WARN, VERBOSE, TRACE).
.B \-v, --verbose
Set verbose mode, cumulative (see DIAGNOSTICS below).
.TP
.B \-h, \-\-help
Show summary of options and exit.
.B \-h, --help
Show summary of these 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.
.B \-V, --version
Show version of \fBrigswr\fP and exit.
.PP
\fBNOTE!\fP Some options may not be implemented by a given backend and will
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
option.
.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 :
rigswr -m 209 -r /dev/ttyS1 14000000 14290000 50000 > cswr
.PP
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.
.PP
After completion, cswr file contains the following lines:
.br
14000000 1.50
.br
@ -103,9 +117,8 @@ After completion, cswr file contains the following lines :
14150000 1.07
.br
14200000 1.07
.TP
Result could then be ploted with gnuplot:
Result could then be plotted with \fBgnuplot\fP:
.br
gnuplot
.br
@ -114,19 +127,45 @@ set data style linespoints
set grid
.br
plot "cswr"
.SH AUTHOR
Man page written by Thierry Leconte & Stephane Fillod .
.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,
-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
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.
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.
.SH REPORTING BUGS
Report bugs to <hamlib-developer@users.sourceforge.net>.
Report bugs to <hamlib-developer@lists.sourceforge.net>.
.br
We are already aware of the bug in the previous section :-)
.SH AUTHORS
Written by Thierry Leconte, Stephane Fillod, and the Hamlib Group
.br
<http://www.hamlib.org>.
.SH COPYRIGHT
Copyright \(co 2004-2006 Thierry Leconte & Stephane Fillod
Copyright \(co 2004-2007 Thierry Leconte, 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
.BR hamlib (3), rigctl(1)
.BR rigctl (1),
.BR gnuplot (1),
.BR hamlib (3)

120
tests/rotctl.1
Wyświetl plik

@ -2,7 +2,7 @@
.\" 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 ROTCTL "1" "February 26, 2006" "Hamlib"
.TH ROTCTL "1" "February 24, 2007" "Hamlib" "Rotator Control Program"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -22,49 +22,59 @@ rotctl \- control antenna rotators
[\fIOPTION\fR]... [\fICOMMAND\fR]...
.SH DESCRIPTION
Control antenna rotators.
\fBrotctl\fP accepts \fBcommands\fP from command line as well as in
interactive mode if none provided in command line.
\fBrotctl\fP accepts \fIcommands\fP from the command line as well as in
interactive mode if none are provided on the command line.
.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 ALPHA level software.
A lof of stuff hasn't been tested thoroughly, and the API may change
without publicized notice. Please report bugs and feedback at
the e-mail address given in the REPORTING BUGS section.
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
Please report bugs and provide feedback at the e-mail address given in the
REPORTING BUGS section. Patches and code enhancements are also welcome.
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
Here is s summary of the supported options:
.TP
.B \-m, \-\-model=id
Select rotator model number. See model list.
.B \-m, --model=id
Select rotator model number. See model list (use 'rotctl -l').
.TP
.B \-r, --rot-file=device
Use \fBdevice\fP as the file name of the rotator to operate. Default is
\fB/dev/rotator\fP (may be a symbolic link to the actual device).
Use \fIdevice\fP as the file name of the port the rotator is connected.
Often a serial port, but could be a USB to serial adapter. Typically
/dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc.
.br
Default is \fB/dev/rotator\fP (may be a symbolic link to the actual device).
.TP
.B \-s, --serial-speed=baud
Set serial speed to \fBbaud\fP rate. Uses maximum serial speed from rotator
Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rotator
backend capabilites as default.
.TP
.B \-L, \-\-show-conf
List all config parameters.
.B \-L, --show-conf
List all config parameters for the rotor defined with -m above.
.TP
.B \-C, \-\-set\-conf=parm=val[,parm=val]*
Set config parameter.
.B \-C, --set-conf=parm=val[,parm=val]*
Set config parameter. e.g. stop_bits=2
.br
Use -L option for a list.
.TP
.B \-l, \-\-list
List all model numbers and exit.
.B \-l, --list
List all model numbers defined in \fBHamlib\fP and exit.
.TP
.B \-v, \-\-verbose
Set verbose mode, cumulative (BUG, ERR, WARN, VERBOSE, TRACE).
.B \-v, --verbose
Set verbose mode, cumulative (see DIAGNOSTICS below).
.TP
.B \-h, \-\-help
Show summary of options and exit.
.B \-h, --help
Show summary of these options and exit.
.TP
.B \-V, \-\-version
Show version of program and exit.
Show version of \fBrotctl\fP and exit.
.PP
\fBNOTE!\fP Some options may not be implemented by a given backend and will
return an error. This is most likely to occur with the \fI\-\-set-conf\fP
@ -72,15 +82,19 @@ and \fI\-\-show-conf\fP options.
.SH COMMANDS
Commands can be entered either as a single char, or as a long command name.
Basically, the commands do not take a dash in front of them, as
the options usually do. They may be typed in when in interactive mode
or provided as argument in command line interface mode.
Since most of the Hamlib operations have a \fIset\fP and a \fIget\fP method,
upper case letter will be used for \fIset\fP method whereas the corresponding
lower case letter refers to the \fIget\fP method.
the options do. They may be typed in when in interactive mode
or provided as argument(s) in command line interface mode.
.PP
Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP method,
an upper case letter will be used for \fIset\fP method whereas the
corresponding lower case letter refers to the \fIget\fP method. In
interactive mode, prepend a backslash to enter a long command name.
.br
Example: Use "\\get_info" to see the rotor's info.
.PP
Please note that the backend for the rotator to be controlled,
or the rotator itself may not support some commands. In that case,
the operation will fail with a standard error message.
the operation will fail with a \fBHamlib\fP error message.
.PP
A summary of commands is included below.
.TP
@ -105,30 +119,54 @@ Move the rotator in a specific direction.
.B C, set_conf
Set a configuration parameter. It is safe to give "Token" a value of '0'
(zero). "Value" may be a string up to 20 characters.
.br
See -L output
.TP
.B _, get_info
Get misc information on the rotator.
.SH EXAMPLES
Start \fBrotctl\fP for RotorEZ using COM1:
.SH RETURN VALUE
rotctl exits with:
0 if all operations went fine; 1 if there was an invalid command line
option or arg; or 2 if an error was returned by Hamlib.
$ rotctl -m 401 -r /dev/ttyS0
.SH AUTHOR
Written by Stephane Fillod.
Start \fBrotctl\fP using \fBrpc.rotd\fP:
$ rotctl -m 101
.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,
-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
\fBrotctl\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.
.SH BUGS
.PP
This suspicious empty section...
This suspiciously empty section...
.SH REPORTING BUGS
Report bugs to <hamlib-developer@users.sourceforge.net>.
Report bugs to <hamlib-developer@lists.sourceforge.net>.
.br
I'm already aware of the bug in the previous section :-)
We are already aware of the bug in the previous section :-)
.SH AUTHOR
Written by Stephane Fillod and the Hamlib Group
.br
<http://www.hamlib.org>.
.SH COPYRIGHT
Copyright \(co 2000-2006 Stephane Fillod.
Copyright \(co 2000-2007 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
.BR hamlib (3)
.BR hamlib (3),
.BR rpc.rotd (8)

8
tests/rotctl.c
Wyświetl plik

@ -5,7 +5,7 @@
* It takes commands in interactive mode as well as
* from command line options.
*
* $Id: rotctl.c,v 1.9 2006-10-07 19:12:35 csete Exp $
* $Id: rotctl.c,v 1.10 2007-02-24 20:24:34 n0nb Exp $
*
*
* This program is free software; you can redistribute it and/or
@ -104,8 +104,8 @@ struct test_table test_list[] = {
{ 'K', "park", park, ARG_NONE, },
{ 'S', "stop", stop, ARG_NONE, },
{ 'R', "reset", reset, ARG_IN, "Reset" },
{ 'M', "move", move, ARG_IN, "Direction", "Speed" },
{ 'C', "set_conf", inter_set_conf, ARG_IN, "Token", "Value" },
{ 'M', "move", move, ARG_IN, "Direction", "Speed" },
{ 'C', "set_conf", inter_set_conf, ARG_IN, "Token", "Value" },
{ '_', "get_info", get_info, ARG_OUT, "Info" },
{ 0x00, "", NULL },
@ -113,7 +113,7 @@ struct test_table test_list[] = {
/*
* Reminder: when adding long options,
* keep up to date SHORT_OPTIONS, usage()'s output and man page. thanks.
* keep up to date SHORT_OPTIONS, usage()'s output and man page. thanks.
* NB: do NOT use -W since it's reserved by POSIX.
* TODO: add an option to read from a file
*/