Improve description of -t command option and w command and provided

command line invocation example.



git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@3014 7ae35d74-ebe9-4afe-98af-79ac388436b8
Hamlib-1.2.13
Nate Bargmann, N0NB 2010-12-09 01:27:50 +00:00
rodzic ada37b9a8f
commit ab6ef4c4fb
1 zmienionych plików z 43 dodań i 29 usunięć

Wyświetl plik

@ -89,11 +89,14 @@ NB: the \fIid\fP is in decimal notation, unless prefixed by
\fI0x\fP, in which case it is hexadecimal. \fI0x\fP, in which case it is hexadecimal.
.TP .TP
.B \-t, --send-cmd-term=char .B \-t, --send-cmd-term=char
Change the termination \fIchar\fP for text protocol when using the \fIsend_cmd\fP command. Change the termination \fIchar\fP for text protocol when using the \fIsend_cmd\fP
The default value is <CR>. Non ASCII printable characters can be specified as an command. The default value is <CR> (0x0d). Non ASCII printable characters can be
ASCII number, in hexadecimal format, prepended with 0x. You may pass an empty string specified as an ASCII number, in hexadecimal format, prepended with 0x. You may
for no termination char. The string -1 tells rigctl to switch to binary protocol. pass an empty string for no termination char. The string '-1' tells rigctl to
See the \fIsend_cmd\fP command for further explanation. switch to binary protocol. See the \fIsend_cmd\fP command for further explanation.
.sp
For example, to specify a command terminator for Kenwood style text commands
pass "-t ';'" to rigctl. See EXAMPLES below.
.TP .TP
.B \-L, --show-conf .B \-L, --show-conf
List all config parameters for the radio defined with -m above. List all config parameters for the radio defined with -m above.
@ -411,10 +414,16 @@ be provided as output power may vary according to these values.
VFO parameter not used in 'VFO mode'. VFO parameter not used in 'VFO mode'.
.TP .TP
.B w, send_cmd 'Cmd' .B w, send_cmd 'Cmd'
Send raw command string to rig. Send raw command string to rig. This is useful for testing and troubleshooting
rig commands and responses when developing a backend.
.sp .sp
For binary protocols enter values as \\0xAA\\0xBB. Expect a 'Reply' from the For binary protocols enter values as \\0xAA\\0xBB. Expect a 'Reply' from the
rig which will likely be a binary block or an ASCII string. rig which will likely be a binary block or an ASCII string depending on the rig's
protocol (see your radio's computer control documentation).
.sp
The command terminator, set by the \fIsend-cmd-term\fP option above, will terminate
each command string sent to the radio. This character should not be a part of
the input string.
.SH EXAMPLES .SH EXAMPLES
Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter in Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter in
interactive mode: interactive mode:
@ -431,6 +440,11 @@ setting baud rate and stop bits:
.sp .sp
$ rigctl -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 $ rigctl -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2
.sp .sp
Start \fBrigctl\fP for an Elecraft K3 using a USB to serial adapter while
specifying a command terminator for the 'w' command:
.sp
$ rigctl -m 229 -r /dev/ttyUSB0 -t';'
.sp
Start \fBrigctl\fP using \fBrpc.rigd\fP and setting the frequency and mode: Start \fBrigctl\fP using \fBrpc.rigd\fP and setting the frequency and mode:
.sp .sp
$ rigctl -m 1901 -r localhost F 7253500 M LSB 0 $ rigctl -m 1901 -r localhost F 7253500 M LSB 0
@ -438,7 +452,7 @@ $ rigctl -m 1901 -r localhost F 7253500 M LSB 0
Connect to a running \fBrigctld\fP with rig model 2 ("NET rigctl") on the Connect to a running \fBrigctld\fP with rig model 2 ("NET rigctl") on the
local host and specifying the TCP port: local host and specifying the TCP port:
.sp .sp
$ rotctl -m 2 -r localhost:4532 $ rigctl -m 2 -r localhost:4532
.SH DIAGNOSTICS .SH DIAGNOSTICS
The \fB-v\fP, \fB--verbose\fP option allows different levels of diagnostics The \fB-v\fP, \fB--verbose\fP option allows different levels of diagnostics
to be output to \fBstderr\fP and correspond to -v for BUG, -vv for ERR, to be output to \fBstderr\fP and correspond to -v for BUG, -vv for ERR,