Minor edits to clarify shell commands.

Hamlib-3.0
Nate Bargmann 2012-05-12 21:11:52 -05:00
rodzic 6bdd1a6aa9
commit e8d429fc45
2 zmienionych plików z 16 dodań i 7 usunięć

Wyświetl plik

@ -490,7 +490,8 @@ This protocol is primarily used by the \fINET rigctl\fP (rigctl model 2)
backend which allows applications already written for Hamlib's C API to take backend which allows applications already written for Hamlib's C API to take
advantage of \fBrigctld\fP without the need of rewriting application code. An advantage of \fBrigctld\fP without the need of rewriting application code. An
application's user can select rig model 2 ("NET rigctl") and then set application's user can select rig model 2 ("NET rigctl") and then set
rig_pathname to "localhost:4532" or other network host:port. rig_pathname to "localhost:4532" or other network host:port (set by the \fI-t\fP
option above).
.PP .PP
\fBExtended Response Protocol\fP \fBExtended Response Protocol\fP
.PP .PP
@ -516,7 +517,8 @@ the command was prepended by '+'.
rules 1 and 2. Lines from rule 3 are only returned when data values must be rules 1 and 2. Lines from rule 3 are only returned when data values must be
returned to the client. returned to the client.
.PP .PP
An example response to a \fI+\\set_mode\fP command (note the prepended '+'): An example response to a \fI+\\set_mode\fP command sent from the shell prompt
(note the prepended '+'):
.sp .sp
$ echo "+M USB 2400" | nc -w 1 localhost 4532 $ echo "+M USB 2400" | nc -w 1 localhost 4532
.br .br
@ -586,7 +588,7 @@ Or, using the pipe character '|' returns:
.sp .sp
get_mode:|Mode: USB|Passband: 2400|RPRT 0 get_mode:|Mode: USB|Passband: 2400|RPRT 0
.sp .sp
And a \\set_pos command prepended with a '|' returns: And a \\set_mode command prepended with a '|' returns:
.sp .sp
set_mode: USB 2400|RPRT 0 set_mode: USB 2400|RPRT 0
.PP .PP
@ -627,9 +629,13 @@ Start \fBrigctld\fP for an Elecraft K3 using COM2 on Win32:
$ rigctld -m 229 -r COM2 $ rigctld -m 229 -r COM2
.sp .sp
Connect to the already running \fBrigctld\fP, and set current frequency to Connect to the already running \fBrigctld\fP, and set current frequency to
14.266 MHz with a 1 second read timeout using the default protocol: 14.266 MHz with a 1 second read timeout using the default protocol from the
shell prompt:
.PP .PP
$ echo "\\set_freq 14266000" | nc -w 1 localhost 4532 $ echo "\\set_freq 14266000" | nc -w 1 localhost 4532
Connect to a running \fBrigctld\fP with \fBrigctl\fP on the local host:
.PP
$ rigctl -m2
.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,

Wyświetl plik

@ -298,7 +298,8 @@ This protocol is primarily used by the \fINET rotctl\fP (rotctl model 2) backend
which allows applications already written for Hamlib's C API to take advantage which allows applications already written for Hamlib's C API to take advantage
of \fBrotctld\fP without the need of rewriting application code. An of \fBrotctld\fP without the need of rewriting application code. An
application's user can select rotor model 2 ("NET rotctl") and then set application's user can select rotor model 2 ("NET rotctl") and then set
rot_pathname to "localhost:4533" or other network host:port. rot_pathname to "localhost:4533" or other network host:port (set by the \fI-t\fP
option above).
.PP .PP
\fBExtended Response Protocol\fP \fBExtended Response Protocol\fP
.PP .PP
@ -323,7 +324,8 @@ the command was prepended by '+'.
rules 1 and 2. Records from rule 3 are only returned when data values must be rules 1 and 2. Records from rule 3 are only returned when data values must be
returned to the client. returned to the client.
.PP .PP
An example response to a \fI+P\fP command (note the prepended '+'): An example response to a \fI+P\fP command command sent from the shell prompt
(note the prepended '+'):
.sp .sp
$ echo "+P 90 45" | nc -w 1 localhost 4533 $ echo "+P 90 45" | nc -w 1 localhost 4533
.br .br
@ -414,7 +416,8 @@ Start \fBrotctld\fP for RotorEZ using COM2 on Win32:
$ rotctl -m 401 -r COM2 $ rotctl -m 401 -r COM2
.sp .sp
Connect to the already running \fBrotctld\fP, and set position to Connect to the already running \fBrotctld\fP, and set position to
135.0 degrees azimuth and 30.0 degrees elevation with a 1 second read timeout: 135.0 degrees azimuth and 30.0 degrees elevation with a 1 second read timeout
from the shell prompt:
.sp .sp
$ echo "\\set_pos 135.0 30.0" | nc -w 1 localhost 4533 $ echo "\\set_pos 135.0 30.0" | nc -w 1 localhost 4533
.sp .sp