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

Update utilities man pages for Hamlib 4.0

pull/376/head
Nate Bargmann 2020-09-10 08:36:57 -05:00
rodzic 516779cf03
commit 42f4177306
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: F72625E2EDBED598
10 zmienionych plików z 436 dodań i 452 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

72
doc/man1/ampctl.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, ampctl.c .\" Note: Please keep this page in sync with the source, ampctl.c
.\" .\"
.TH AMPCTL "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH AMPCTL "1" "2020-09-08" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -249,12 +249,12 @@ typed in when in interactive mode or provided as argument(s) in command line
interface mode. In interactive mode commands and their arguments may be interface mode. In interactive mode commands and their arguments may be
entered on a single line: entered on a single line:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
F 14250000 .B F 14250000
.EE .EE
.RE .in
. .
.PP .PP
Since most of the Since most of the
@ -274,7 +274,7 @@ backslash, \(oq\\\(cq, to enter a long command name.
Example: Use \(lq\\dump_caps\(rq to see what capabilities this amplifier and Example: Use \(lq\\dump_caps\(rq to see what capabilities this amplifier and
backend support. backend support.
. .
.PP .IP
.BR Note : .BR Note :
The backend for the amplifier to be controlled, or the amplifier itself may The backend for the amplifier to be controlled, or the amplifier itself may
not support some commands. In that case, the operation will fail with a not support some commands. In that case, the operation will fail with a
@ -283,22 +283,22 @@ error message.
. .
. .
.PP .PP
A simple example: A simple example using commands saved to a file (typed text shown in bold):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ cat <<.EOF. >cmds.txt .RB $ " cat <<.EOF. >cmds.txt"
> # File of commands .RB > " # File of commands"
> F 14250000 .RB > " F 14250000"
> f .RB > " f"
> l PWRINPUT .RB > " l PWRINPUT"
> l PWRFORWARD .RB > " l PWRFORWARD"
> l SWR .RB > " l SWR"
> \\dump_caps > \fB\\dump_caps\fP
> .EOF. .RB > " .EOF."
$ ampctl -m1 - <cmds.txt .RB $ " ampctl -m1 - <cmds.txt"
Amplifier command: # File of commands Amplifier command: # File of commands
@ -344,7 +344,7 @@ Amplifier command:
$ $
.EE .EE
.RE .in
. .
. .
.SS ampctl Commands .SS ampctl Commands
@ -573,19 +573,19 @@ if an error was returned by
.BR Hamlib . .BR Hamlib .
. .
. .
.SH EXAMPLE .SH EXAMPLES
. .
Start Start
.B ampctl .B ampctl
for am Elecraft KPA-1500 using a USB to serial adapter on Linux in interactive for am Elecraft KPA-1500 using a USB to serial adapter on Linux in interactive
mode: mode:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ ampctl -m 201 -r /dev/ttyUSB1 .RB $ " ampctl -m 201 -r /dev/ttyUSB1"
.EE .EE
.RE .in
. .
.PP .PP
Start Start
@ -594,12 +594,12 @@ for an Elecraft KPA-1500 using COM1 on MS Windows while generating TRACE
output to output to
.IR stderr : .IR stderr :
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
> ampctl -m 201 -r COM1 -vvvvv .RB > " ampctl -m 201 -r COM1 -vvvvv"
.EE .EE
.RE .in
. .
.PP .PP
Connect to a running Connect to a running
@ -607,12 +607,12 @@ Connect to a running
with amplifier model 2 (\(lqNET ampctl\(rq) on the local host and specifying with amplifier model 2 (\(lqNET ampctl\(rq) on the local host and specifying
the TCP port, setting frequency and mode: the TCP port, setting frequency and mode:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ ampctl -m 2 -r localhost:4531 F 7253500 .RB $ " ampctl -m 2 -r localhost:4531 F 7253500"
.EE .EE
.RE .in
. .
. .
.SH BUGS .SH BUGS
@ -640,7 +640,7 @@ Copyright \(co 2000-2011 Stephane Fillod
.br .br
Copyright \(co 2000-2018 the Hamlib Group (various contributors) Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br .br
Copyright \(co 2010-2019 Nate Bargmann Copyright \(co 2010-2020 Nate Bargmann
. .
.PP .PP
This is free software; see the file COPYING for copying conditions. There is This is free software; see the file COPYING for copying conditions. There is
@ -658,8 +658,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

103
doc/man1/ampctld.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, ampctld.c .\" Note: Please keep this page in sync with the source, ampctld.c
.\" .\"
.TH AMPCTLD "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH AMPCTLD "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -402,16 +402,15 @@ needed values. In practice, reliable results are obtained by terminating each
command string with a newline character, \(oq\\n\(cq. command string with a newline character, \(oq\\n\(cq.
. .
.PP .PP
Example set frequency and mode commands (Perl code): Example set frequency and mode commands (Perl code (typed text shown in bold)):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
print $socket "F 14250000\\n"; \fBprint $socket "F 14250000\\n";\fP
.br \fBprint $socket "\\\\set_powerstat 1\\n";\fP # escape leading '\\'
print $socket "\\\\set_powerstat 1\\n"; # escape leading '\\'
.EE .EE
.RE .in
. .
.PP .PP
A one line response will be sent as a reply to A one line response will be sent as a reply to
@ -434,14 +433,13 @@ is the Hamlib error code.
.PP .PP
Example get frequency (Perl code): Example get frequency (Perl code):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
print $socket "f\\n"; \fBprint $socket "f\\n";\fP
.br
"14250000\\n" "14250000\\n"
.EE .EE
.RE .in
. .
.PP .PP
Most Most
@ -509,16 +507,14 @@ An example response to a
.B set_frequency .B set_frequency
command sent from the shell prompt (note the prepended \(oq+\(cq): command sent from the shell prompt (note the prepended \(oq+\(cq):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ echo "+F 14250000" | nc -w 1 localhost 4531 $ \fBecho "+F 14250000" | nc -w 1 localhost 4531\fP
.br
set_freq: 14250000 set_freq: 14250000
.br
RPRT 0 RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
In this case the long command name and values are returned on the first line In this case the long command name and values are returned on the first line
@ -530,18 +526,15 @@ An example response to a
.B get_freq .B get_freq
query: query:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ echo "+\\get_freq" | nc -w 1 localhost 4531 $ \fBecho "+\\get_freq" | nc -w 1 localhost 4531\fP
.br
get_freq: get_freq:
.br
Frequency(Hz): 14250000 Frequency(Hz): 14250000
.br
RPRT 0 RPRT 0
.EE .EE
.RE .in
. .
.IP .IP
.BR Note : .BR Note :
@ -600,34 +593,34 @@ For example, invoking a
.B get_freq .B get_freq
query with a leading \(oq;\(cq returns: query with a leading \(oq;\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
get_freq:;Frequency(Hz): 14250000;RPRT 0 get_freq:;Frequency(Hz): 14250000;RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
Or, using the pipe character \(oq|\(cq returns: Or, using the pipe character \(oq|\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
get_freq:|Frequency(Hz): 14250000|RPRT 0 get_freq:|Frequency(Hz): 14250000|RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
And a And a
.B set_freq .B set_freq
command prepended with a \(oq|\(cq returns: command prepended with a \(oq|\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
set_freq: 14250000|RPRT 0 set_freq: 14250000|RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
Such a format will allow reading a response as a single event using a preferred Such a format will allow reading a response as a single event using a preferred
@ -659,30 +652,30 @@ sent to and received from the amplifier which is very useful for amplifier
backend library development and may be requested by the developers. backend library development and may be requested by the developers.
. .
. .
.SH EXAMPLE .SH EXAMPLES
. .
Start Start
.B ampctld .B ampctld
for an Elecraft KPA-1500 using a USB-to-serial adapter and backgrounding: for an Elecraft KPA-1500 using a USB-to-serial adapter and backgrounding:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ ampctld -m 201 -r /dev/ttyUSB1 & .RB $ " ampctld -m 201 -r /dev/ttyUSB1 &"
.EE .EE
.RE .in
. .
.PP .PP
Start Start
.B ampctld .B ampctld
for an Elecraft KPA-1500 using COM2 on MS Windows: for an Elecraft KPA-1500 using COM2 on MS Windows:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ ampctld -m 201 -r COM2 .RB $ " ampctld -m 201 -r COM2"
.EE .EE
.RE .in
. .
.PP .PP
Connect to the already running Connect to the already running
@ -690,12 +683,12 @@ Connect to the already running
and set the frequency to 14.266 MHz with a 1 second read timeout using the and set the frequency to 14.266 MHz with a 1 second read timeout using the
default protocol from the shell prompt: default protocol from the shell prompt:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ echo "\\set_freq 14266000" | nc -w 1 localhost 4531 $ \fBecho "\\set_freq 14266000" | nc -w 1 localhost 4531\fP
.EE .EE
.RE .in
. .
.PP .PP
Connect to a running Connect to a running
@ -704,12 +697,12 @@ with
.B ampctl .B ampctl
on the local host: on the local host:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ ampctl -m2 .RB $ " ampctl -m2"
.EE .EE
.RE .in
. .
. .
.SH SECURITY .SH SECURITY
@ -765,7 +758,7 @@ Copyright \(co 2000-2010 Stephane Fillod
.br .br
Copyright \(co 2000-2018 the Hamlib Group (various contributors) Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br .br
Copyright \(co 2011-2019 Nate Bargmann Copyright \(co 2011-2020 Nate Bargmann
. .
.PP .PP
This is free software; see the file COPYING for copying conditions. There is This is free software; see the file COPYING for copying conditions. There is
@ -783,8 +776,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

96
doc/man1/rigctl.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, rigctl.c .\" Note: Please keep this page in sync with the source, rigctl.c
.\" .\"
.TH RIGCTL "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH RIGCTL "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -284,7 +284,7 @@ Set verbose mode, cumulative (see
below). below).
.TP .TP
.BR \-Y "," \-\-\ignore\-err .BR \-Y "," \-\-\ignore\-err
Ignores rig open errors Ignores rig open errors
. .
.TP .TP
.BR \-Z ", " \-\-debug\-time\-stamps .BR \-Z ", " \-\-debug\-time\-stamps
@ -337,12 +337,12 @@ typed in when in interactive mode or provided as argument(s) in command line
interface mode. In interactive mode commands and their arguments may be interface mode. In interactive mode commands and their arguments may be
entered on a single line: entered on a single line:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
M LSB 2400 .B M LSB 2400
.EE .EE
.RE .in
. .
.PP .PP
Since most of the Since most of the
@ -360,7 +360,7 @@ backslash, \(oq\\\(cq, to enter a long command name.
Example: Use \(lq\\dump_caps\(rq to see what capabilities this radio and Example: Use \(lq\\dump_caps\(rq to see what capabilities this radio and
backend support. backend support.
. .
.PP .IP
.BR Note : .BR Note :
The backend for the radio to be controlled, or the radio itself may not 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 support some commands. In that case, the operation will fail with a
@ -383,19 +383,19 @@ up until the end of the current line including the \(oq#\(cq character is
ignored. ignored.
. .
.PP .PP
A simple example: A simple example (typed text is in bold):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ cat <<.EOF. >cmds.txt .RB $ " cat <<.EOF. >cmds.txt"
> # File of commands .RB > " # File of commands"
> v f m # query rig .RB > " v f m # query rig"
> V VFOB F 14200000 M CW 500 # set rig .RB > " V VFOB F 14200000 M CW 500 # set rig"
> v f m # query rig .RB > " v f m # query rig"
> .EOF. .RB > " .EOF."
$ rigctl -m1 - <cmds.txt .RB $ " rigctl -m1 - <cmds.txt"
v VFOA v VFOA
@ -416,7 +416,7 @@ m CW
$ $
.EE .EE
.RE .in
. .
. .
.SS rigctl Commands .SS rigctl Commands
@ -498,17 +498,17 @@ In VFO mode (see
.B \-\-vfo .B \-\-vfo
option above) only a single VFO parameter is required: option above) only a single VFO parameter is required:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
$ rigctl -m 229 -r /dev/rig -o .RB $ " rigctl -m 229 -r /dev/rig -o"
Rig command: V Rig command: V
VFO: VFOB VFO: VFOB
Rig command: Rig command:
.EE .EE
.RE .in
. .
.TP .TP
.BR v ", " get_vfo .BR v ", " get_vfo
@ -1119,7 +1119,7 @@ Get
.RI \(aq Status \(aq .RI \(aq Status \(aq
.IP .IP
Returns Status as 1 if vfo option is on and 0 if vfo option is off. Returns Status as 1 if vfo option is on and 0 if vfo option is off.
This command reflects the -o switch for rigctl and ritctld and can be dynamically changed by This command reflects the -o switch for rigctl and ritctld and can be dynamically changed by
.B set_vfo_opt. .B set_vfo_opt.
. .
.TP .TP
@ -1128,7 +1128,7 @@ Set
.RI \(aq Status \(aq .RI \(aq Status \(aq
.IP .IP
Set vfo option Status 1=on or 0=off Set vfo option Status 1=on or 0=off
This is the same as using the -o switch for rigctl and ritctld. This is the same as using the -o switch for rigctl and ritctld.
This can be dyamically changed while running. This can be dyamically changed while running.
. .
.TP .TP
@ -1252,18 +1252,18 @@ if an error was returned by
.BR Hamlib . .BR Hamlib .
. .
. .
.SH EXAMPLE .SH EXAMPLES
. .
Start Start
.B rigctl .B rigctl
for a Yaesu FT-920 using a USB to serial adapter on Linux in interactive mode: for a Yaesu FT-920 using a USB to serial adapter on Linux in interactive mode:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctl -m 114 -r /dev/ttyUSB1 .RB $ " rigctl -m 1014 -r /dev/ttyUSB1"
.EE .EE
.RE .in
. .
.PP .PP
Start Start
@ -1271,12 +1271,12 @@ Start
for a Yaesu FT-920 using COM1 on MS Windows while generating TRACE output to for a Yaesu FT-920 using COM1 on MS Windows while generating TRACE output to
.IR stderr : .IR stderr :
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
> rigctl -m 114 -r COM1 -vvvvv .RB > " rigctl -m 1014 -r COM1 -vvvvv"
.EE .EE
.RE .in
. .
.PP .PP
Start Start
@ -1284,12 +1284,12 @@ Start
for a Yaesu FT-920 using a USB to serial adapter while setting baud rate and for a Yaesu FT-920 using a USB to serial adapter while setting baud rate and
stop bits: stop bits:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctl -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 .RB $ " rigctl -m 1014 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2"
.EE .EE
.RE .in
. .
.PP .PP
Start Start
@ -1299,12 +1299,12 @@ terminator for the
.B w .B w
command: command:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctl -m 229 -r /dev/ttyUSB0 -t';' .RB $ " rigctl -m 2029 -r /dev/ttyUSB0 -t';'"
.EE .EE
.RE .in
. .
.PP .PP
Connect to a running Connect to a running
@ -1312,12 +1312,12 @@ Connect to a running
with radio model 2 (\(lqNET rigctl\(rq) on the local host and specifying the with radio model 2 (\(lqNET rigctl\(rq) on the local host and specifying the
TCP port, setting frequency and mode: TCP port, setting frequency and mode:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctl -m 2 -r localhost:4532 F 7253500 M LSB 0 .RB $ " rigctl -m 2 -r localhost:4532 F 7253500 M LSB 0"
.EE .EE
.RE .in
. .
. .
.SH BUGS .SH BUGS
@ -1348,7 +1348,7 @@ Copyright \(co 2000-2011 Stephane Fillod
.br .br
Copyright \(co 2000-2018 the Hamlib Group (various contributors) Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br .br
Copyright \(co 2010-2019 Nate Bargmann Copyright \(co 2010-2020 Nate Bargmann
. .
.PP .PP
This is free software; see the file COPYING for copying conditions. There is This is free software; see the file COPYING for copying conditions. There is
@ -1366,8 +1366,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

30
doc/man1/rigctlcom.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, rigctlcom.c .\" Note: Please keep this page in sync with the source, rigctlcom.c
.\" .\"
.TH RIGCTLCOM "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH RIGCTLCOM "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -108,12 +108,12 @@ to the other com port of the virtual pair.
Virtual serial ports on POSIX systems can be done with Virtual serial ports on POSIX systems can be done with
.BR socat (1): .BR socat (1):
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
$ socat -d -d pty,raw,echo=0 pty,raw,echo=0 .RB $ " socat -d -d pty,raw,echo=0 pty,raw,echo=0"
.EE .EE
.RE .in
. .
.IP .IP
See this See this
@ -342,23 +342,23 @@ attaching to COM10 and using the TS-2000 emulator attached to COM9 (assumes
virtual serial/COM ports pipe has been created with the proper utility virtual serial/COM ports pipe has been created with the proper utility
as described above): as described above):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctlcom -m 4 -R COM9 -S 115200 .RB $ " rigctlcom -m 4 -R COM9 -S 115200"
.EE .EE
.RE .in
. .
.PP .PP
The following diagram shows the communications flow that allows N1MM Logger+ The following diagram shows the communications flow that allows N1MM Logger+
to communicate with a radio connected to Flrig: to communicate with a radio connected to Flrig:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
Flrig -><- rigctlcom -> COM9 <- virt_port_pipe -> COM10 <- N1MM Flrig -><- rigctlcom -> COM9 <- virt_port_pipe -> COM10 <- N1MM
.EE .EE
.RE .in
. .
. .
.SH BUGS .SH BUGS
@ -385,7 +385,7 @@ Copyright \(co 2000-2011 Stephane Fillod
.br .br
Copyright \(co 2000-2018 the Hamlib Group (various contributors) Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br .br
Copyright \(co 2010-2019 Nate Bargmann Copyright \(co 2010-2020 Nate Bargmann
.br .br
Copyright \(co 2019 Michael Black W9MDB Copyright \(co 2019 Michael Black W9MDB
. .
@ -405,8 +405,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

189
doc/man1/rigctld.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, rigctld.c .\" Note: Please keep this page in sync with the source, rigctld.c
.\" .\"
.TH RIGCTLD "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH RIGCTLD "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -207,35 +207,58 @@ Use
.I IPADDR .I IPADDR
as the listening IP address. as the listening IP address.
.IP .IP
The default is ANY. The default is ANY (0.0.0.0).
.IP .IP
Can be run and connected to like this: .B rigctld
can be run and connected to like this:
.
.IP .IP
.nf .EX
rigctld rigctld
rigctl -m 2 .
rigctl -m 2 -r 127.0.0.1 .in +4n
rigctl -m 2 -r localhost rigctl -m 2
rigctl -m 2 -r 192.168.1.1 (local IP address) rigctl -m 2 -r 127.0.0.1
rigctl -m 2 -r ::1 (does not work on Linux as does not listen on IPV6 by default) rigctl -m 2 -r localhost
.BR rigctl -m 2 -r 192.168.1.1 (local IP address)
rigctl -m 2 -r ::1 (on Linux rigctld doesn't listen on IPV6 by default)
.in
.
.IP
rigctld -T 127.0.0.1 rigctld -T 127.0.0.1
rigctl -m 2 .in +4n
rigctl -m 2 -r 127.0.0.1 rigctl -m 2
Exceptions: rigctl -m 2 -r 127.0.0.1
rigctl -m 2 -r localhost (only works if localhost is IPV4 address) .EE
.BR Exceptions:
.EX
rigctl -m 2 -r localhost (only works if localhost is IPV4 address)
.EE
.in
.
.IP
.EX
rigctld -T localhost (will set up on IPV4 or IPV6 based on localhost) rigctld -T localhost (will set up on IPV4 or IPV6 based on localhost)
rigctl -m 2 .in +4n
rigctl -m 2 -r localhost rigctl -m 2
rigctl -m 2 ip6-localhost rigctl -m 2 -r localhost
Exceptions: rigctl -m 2 ip6-localhost
rigctl -m 2 -r 127.0.0.1 (only works if localhost is IPV4 address) .EE
rigctl -m 2 -r ::1 (only works localhost is IPV6 address) Exceptions:
.BR .EX
On Linux only where ip6-localhost fe00::0 rigctl -m 2 -r 127.0.0.1 (only works if localhost is IPV4 address)
rigctl -m 2 -r ::1 (only works localhost is IPV6 address)
.EE
.in
.
.IP
On Linux only where ip6-localhost is fe00::0:
.EX
rigctld -T ip6-localhost rigctld -T ip6-localhost
rigctl -m 2 -r ip6-localhost .in +4n
rigctl -m 2 -r ip6-localhost
.in
.EE
. .
.TP .TP
.BR \-t ", " \-\-port = \fInumber\fP .BR \-t ", " \-\-port = \fInumber\fP
@ -460,8 +483,8 @@ In VFO mode (see
.B \-\-vfo .B \-\-vfo
option above) only a single VFO parameter is required: option above) only a single VFO parameter is required:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
$ rigctl -m 229 -r /dev/rig -o $ rigctl -m 229 -r /dev/rig -o
@ -470,7 +493,7 @@ VFO: VFOB
Rig command: Rig command:
.EE .EE
.RE .in
. .
.TP .TP
.BR v ", " get_vfo .BR v ", " get_vfo
@ -1049,7 +1072,7 @@ Set
.RI \(aq Status \(aq .RI \(aq Status \(aq
.IP .IP
Set vfo option Status 1=on or 0=off Set vfo option Status 1=on or 0=off
This is the same as using the -o switch for rigctl and ritctld. This is the same as using the -o switch for rigctl and ritctld.
This can be dyamically changed while running. This can be dyamically changed while running.
. .
. .
@ -1089,16 +1112,15 @@ needed values. In practice, reliable results are obtained by terminating each
command string with a newline character, \(oq\\n\(cq. command string with a newline character, \(oq\\n\(cq.
. .
.PP .PP
Example set frequency and mode commands (Perl code): Example set frequency and mode commands (Perl code (typed text shown in bold)):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
print $socket "F 14250000\\n"; \fBprint $socket "F 14250000\\n";\fP
.br \fBprint $socket "\\\\set_mode LSB 2400\\n";\fP # escape leading '\\'
print $socket "\\\\set_mode LSB 2400\\n"; # escape leading '\\'
.EE .EE
.RE .in
. .
.PP .PP
A one line response will be sent as a reply to A one line response will be sent as a reply to
@ -1121,14 +1143,13 @@ is the Hamlib error code.
.PP .PP
Example get frequency (Perl code): Example get frequency (Perl code):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
print $socket "f\\n"; \fBprint $socket "f\\n";\fP
.br
"14250000\\n" "14250000\\n"
.EE .EE
.RE .in
. .
.PP .PP
Most Most
@ -1190,16 +1211,14 @@ An example response to a
.B set_mode .B set_mode
command sent from the shell prompt (note the prepended \(oq+\(cq): command sent from the shell prompt (note the prepended \(oq+\(cq):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ echo "+M USB 2400" | nc -w 1 localhost 4532 $ \fBecho "+M USB 2400" | nc -w 1 localhost 4532\fP
.br
set_mode: USB 2400 set_mode: USB 2400
.br
RPRT 0 RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
In this case the long command name and values are returned on the first line In this case the long command name and values are returned on the first line
@ -1211,20 +1230,16 @@ An example response to a
.B get_mode .B get_mode
query: query:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ echo "+\\get_mode" | nc -w 1 localhost 4532 $ \fBecho "+\\get_mode" | nc -w 1 localhost 4532\fP
.br
get_mode: get_mode:
.br
Mode: USB Mode: USB
.br
Passband: 2400 Passband: 2400
.br
RPRT 0 RPRT 0
.EE .EE
.RE .in
. .
.IP .IP
.BR Note : .BR Note :
@ -1283,34 +1298,34 @@ For example, invoking a
.B get_mode .B get_mode
query with a leading \(oq;\(cq returns: query with a leading \(oq;\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
get_mode:;Mode: USB;Passband: 2400;RPRT 0 get_mode:;Mode: USB;Passband: 2400;RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
Or, using the pipe character \(oq|\(cq returns: Or, using the pipe character \(oq|\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
get_mode:|Mode: USB|Passband: 2400|RPRT 0 get_mode:|Mode: USB|Passband: 2400|RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
And a And a
.B set_mode .B set_mode
command prepended with a \(oq|\(cq returns: command prepended with a \(oq|\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
set_mode: USB 2400|RPRT 0 set_mode: USB 2400|RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
Such a format will allow reading a response as a single event using a preferred Such a format will allow reading a response as a single event using a preferred
@ -1371,18 +1386,18 @@ 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 EXAMPLE .SH EXAMPLES
. .
Start Start
.B rigctld .B rigctld
for a Yaesu FT-920 using a USB-to-serial adapter and backgrounding: for a Yaesu FT-920 using a USB-to-serial adapter and backgrounding:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctld -m 114 -r /dev/ttyUSB1 & .RB $ " rigctld -m 1014 -r /dev/ttyUSB1 &"
.EE .EE
.RE .in
. .
.PP .PP
Start Start
@ -1390,24 +1405,24 @@ Start
for a Yaesu FT-920 using a USB-to-serial adapter while setting baud rate and for a Yaesu FT-920 using a USB-to-serial adapter while setting baud rate and
stop bits, and backgrounding: stop bits, and backgrounding:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctld -m 114 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 & .RB $ " rigctld -m 1014 -r /dev/ttyUSB1 -s 4800 -C stop_bits=2 &"
.EE .EE
.RE .in
. .
.PP .PP
Start Start
.B rigctld .B rigctld
for an Elecraft K3 using COM2 on MS Windows: for an Elecraft K3 using COM2 on MS Windows:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctld -m 229 -r COM2 .RB $ " rigctld -m 2029 -r COM2"
.EE .EE
.RE .in
. .
.PP .PP
Connect to the already running Connect to the already running
@ -1415,12 +1430,12 @@ Connect to the already running
and set the frequency to 14.266 MHz with a 1 second read timeout using the and set the frequency to 14.266 MHz with a 1 second read timeout using the
default protocol from the shell prompt: default protocol from the shell prompt:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ echo "\\set_freq 14266000" | nc -w 1 localhost 4532 $ \fBecho "\\set_freq 14266000" | nc -w 1 localhost 4532\P
.EE .EE
.RE .in
. .
.PP .PP
Connect to a running Connect to a running
@ -1429,12 +1444,12 @@ with
.B rigctl .B rigctl
on the local host: on the local host:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rigctl -m2 .RB $ " rigctl -m2"
.EE .EE
.RE .in
. .
. .
.SH SECURITY .SH SECURITY
@ -1490,7 +1505,7 @@ Copyright \(co 2000-2010 Stephane Fillod
.br .br
Copyright \(co 2000-2018 the Hamlib Group (various contributors) Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br .br
Copyright \(co 2011-2019 Nate Bargmann Copyright \(co 2011-2020 Nate Bargmann
. .
.PP .PP
This is free software; see the file COPYING for copying conditions. There is This is free software; see the file COPYING for copying conditions. There is
@ -1508,8 +1523,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

8
doc/man1/rigmem.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, rigmem.c .\" Note: Please keep this page in sync with the source, rigmem.c
.\" .\"
.TH RIGMEM "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH RIGMEM "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -268,7 +268,7 @@ communications.
.PP .PP
Copyright \(co 2003-2011 Stephane Fillod Copyright \(co 2003-2011 Stephane Fillod
.br .br
Copyright \(co 2007,2019 Nate Bargmann Copyright \(co 2007,2019-2020 Nate Bargmann
. .
.PP .PP
This is free software; see the file COPYING for copying conditions. There is This is free software; see the file COPYING for copying conditions. There is
@ -284,8 +284,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

75
doc/man1/rigsmtr.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, rigsmtr.c .\" Note: Please keep this page in sync with the source, rigsmtr.c
.\" .\"
.TH RIGSMTR "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH RIGSMTR "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -239,81 +239,60 @@ if the radio doesn't have the required capabilities.
. .
Collect S-Meter readings on a TS\-850 while an EasycommII rotator makes a full Collect S-Meter readings on a TS\-850 while an EasycommII rotator makes a full
360\(de rotation and record measurements in the file 360\(de rotation and record measurements in the file
.IR csmtr : .I csmtr
(typed text shown in bold):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
rigsmtr \-m 209 \-r /dev/ttyS1 \-M 202 > csmtr .RB $ " rigsmtr \-m 2009 \-r /dev/ttyS1 \-M 202 > csmtr"
.EE .EE
.RE .in
. .
.PP .PP
After completion the file After completion the file
.I csmtr .I csmtr
contains lines such as: contains lines such as:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
0 \-47 0 \-47
.br
30 \-40 30 \-40
.br
60 \-22 60 \-22
.br
90 \-3 90 \-3
.br
120 10 120 10
.br
150 1 150 1
.br
180 \-11 180 \-11
.br
210 \-24 210 \-24
.br
240 \-35 240 \-35
.br
270 \-42 270 \-42
.br
300 \-48 300 \-48
.br
330 \-51 330 \-51
.br
360 \-49 360 \-49
.EE .EE
.RE .in
. .
.PP .PP
The results can be plotted with The results can be plotted with
.BR gnuplot (1): .BR gnuplot (1):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
gnuplot .RB $ " gnuplot"
.br .B set angles degrees
set angles degrees .B set polar
.br .B set grid polar 15.
set polar .B unset border
.br .B unset param
set grid polar 15. .B set style data line
.br .B set rrange [-60:60]
unset border .B set xrange [-60:60]
.br .B set yrange [-60:60]
unset param .B plot csmtr
.br
set style data line
.br
set rrange [-60:60]
.br
set xrange [-60:60]
.br
set yrange [-60:60]
.br
.RI plot " csmtr"
.EE .EE
.RE .in
. .
. .
.SH BUGS .SH BUGS
@ -337,7 +316,7 @@ communications.
.PP .PP
Copyright \(co 2007-2009 Stephane Fillod Copyright \(co 2007-2009 Stephane Fillod
.br .br
Copyright \(co 2018,2019 Nate Bargmann Copyright \(co 2018-2020 Nate Bargmann
.PP .PP
This is free software; see the file COPYING for copying conditions. There is 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. NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
@ -354,8 +333,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

56
doc/man1/rigswr.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, rigswr.c .\" Note: Please keep this page in sync with the source, rigswr.c
.\" .\"
.TH RIGSWR "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH RIGSWR "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -242,49 +242,45 @@ if the rig doesn't have the required capabilities.
. .
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 TS-850 and records VSWR measurements in file
.IR cswr . .I cswr
. (typed text shown in bold):
.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: .in +4n
.EX
.RB $ " rigswr -m 2009 -r /dev/ttyS1 14000000 14200000 50000 > cswr"
.EE
.in
. .
.sp .PP
.RS 0.5i After completion,
.I cswr
contains the following lines:
.
.PP
.in +4n
.EX .EX
14000000 1.50 14000000 1.50
.br
14050000 1.31 14050000 1.31
.br
14100000 1.22 14100000 1.22
.br
14150000 1.07 14150000 1.07
.br
14200000 1.07 14200000 1.07
.EE .EE
.RE .in
. .
.PP .PP
The result can be plotted with The result can be plotted with
.BR gnuplot (1): .BR gnuplot (1):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
gnuplot .RB $ " gnuplot"
.br .B set data style linespoints
set data style linespoints .B set grid
.br .B plot cswr
set grid
.br
.RI plot " cswr"
.EE .EE
.RE .in
. .
. .
.SH BUGS .SH BUGS
@ -314,7 +310,7 @@ Copyright \(co 2004 Thierry Leconte
.br .br
Copyright \(co 2004-2011 Stephane Fillod Copyright \(co 2004-2011 Stephane Fillod
.br .br
Copyright \(co 2007,2018,2019 Nate Bargmann Copyright \(co 2007,2018-2020 Nate Bargmann
.PP .PP
This is free software; see the file COPYING for copying conditions. There is 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. NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
@ -330,8 +326,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

106
doc/man1/rotctl.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, rotctl.c .\" Note: Please keep this page in sync with the source, rotctl.c
.\" .\"
.TH ROTCTL "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH ROTCTL "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -252,14 +252,14 @@ Commands can be entered either as a single char, or as a long command name.
The commands are not prefixed with a dash as the options are. They may be The commands are not prefixed with a dash as the options are. They may be
typed in when in interactive mode or provided as argument(s) in command line typed in when in interactive mode or provided as argument(s) in command line
interface mode. In interactive mode commands and their arguments may be interface mode. In interactive mode commands and their arguments may be
entered on a single line: entered on a single line (typed text shown in bold):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
P 123 45 .B P 123 45
.EE .EE
.RE .in
. .
.PP .PP
Since most of the Since most of the
@ -277,7 +277,7 @@ backslash, \(oq\\\(cq, to enter a long command name.
Example: Use \(lq\\get_info\(rq in interactive mode to see the rotator's Example: Use \(lq\\get_info\(rq in interactive mode to see the rotator's
information. information.
. .
.PP .IP
.BR Note : .BR Note :
The backend for the rotator to be controlled, or the rotator itself may not 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 support some commands. In that case, the operation will fail with a
@ -302,17 +302,17 @@ ignored.
.PP .PP
A simple example: A simple example:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ cat <<.EOF. >cmds.txt .RB $ " cat <<.EOF. >cmds.txt"
> # File of commands .RB > " # File of commands"
> set_pos 180.0 10.0 # rotate .RB > " set_pos 180.0 10.0 # rotate"
> pause 30 # wait for action to complete .RB > " pause 30 # wait for action to complete"
> get_pos # query rotator .RB > " get_pos # query rotator"
> .EOF. .RB > .EOF.
$ rotctl -m 1 - <cmds.txt .RB $ " rotctl -m 1 - <cmds.txt"
set_pos 180.0 10.0 set_pos 180.0 10.0
pause 30 pause 30
@ -321,7 +321,7 @@ get_pos 180.000000
$ $
.EE .EE
.RE .in
. .
. .
.SS Rotator Commands .SS Rotator Commands
@ -357,12 +357,13 @@ Elevation can be -20 to 210 depending on the rotator.
.IP .IP
For example: For example:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
P 163.0 41.0 .B P 163.0 41.0
.EE .EE
.RE .in
.
.IP .IP
.BR Note : .BR Note :
If the rotator does not support setting elevation (most do not) supply If the rotator does not support setting elevation (most do not) supply
@ -474,21 +475,22 @@ which should be an even numbered integer value between 2 and 12.
.IP .IP
For example: For example:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
L -170.0 -85.0 12 .B L -170.0 -85.0 12
.EE .EE
.RE .in
.
.IP .IP
returns: returns:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
Locator: AA55AA00AA00 Locator: AA55AA00AA00
.EE .EE
.RE .in
. .
.TP .TP
.BR l ", " loc2lonlat " \(aq" \fILocator\fP \(aq .BR l ", " loc2lonlat " \(aq" \fILocator\fP \(aq
@ -508,21 +510,23 @@ expressed as a negative value.
.IP .IP
For example: For example:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
l AA55AA00AA00 .B l AA55AA00AA00
.EE .EE
.RE .in
.
.IP .IP
returns: returns:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
Longitude: -169.999983 Latitude: -84.999991 Longitude: -169.999983 Latitude: -84.999991
.EE .EE
.RE .in
.
.IP .IP
.BR Note : .BR Note :
Despite the use of double precision variables internally, some rounding error Despite the use of double precision variables internally, some rounding error
@ -737,30 +741,30 @@ if an error was returned by
.BR Hamlib . .BR Hamlib .
. .
. .
.SH EXAMPLE .SH EXAMPLES
. .
Start Start
.B rotctl .B rotctl
for RotorEZ using the first serial port on Linux: for RotorEZ using the first serial port on Linux:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rotctl -m 401 -r /dev/ttyS0 .RB $ " rotctl -m 401 -r /dev/ttyS0"
.EE .EE
.RE .in
. .
.PP .PP
Start Start
.B rotctl .B rotctl
for RotorEZ using COM2 on MS Windows: for RotorEZ using COM2 on MS Windows:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rotctl -m 401 -r COM2 .RB > " rotctl -m 401 -r COM2"
.EE .EE
.RE .in
. .
.PP .PP
Connect to a running Connect to a running
@ -768,12 +772,12 @@ Connect to a running
with rotator model 2 (\(lqNET rotctl\(rq) on the local host and specifying the with rotator model 2 (\(lqNET rotctl\(rq) on the local host and specifying the
TCP port, and querying the position: TCP port, and querying the position:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rotctl -m 2 -r localhost:4533 \\get_pos .RB $ " rotctl -m 2 -r localhost:4533 \\get_pos"
.EE .EE
.RE .in
. .
. .
.SH BUGS .SH BUGS
@ -799,7 +803,7 @@ Copyright \(co 2001-2011 Stephane Fillod
.br .br
Copyright \(co 2002-2017 the Hamlib Group (various contributors) Copyright \(co 2002-2017 the Hamlib Group (various contributors)
.br .br
Copyright \(co 2003-2019 Nate Bargmann Copyright \(co 2003-2020 Nate Bargmann
. .
.PP .PP
This is free software; see the file COPYING for copying conditions. There is This is free software; see the file COPYING for copying conditions. There is
@ -817,8 +821,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .

153
doc/man1/rotctld.1
Wyświetl plik

@ -5,7 +5,7 @@
.\" .\"
.\" Note: Please keep this page in sync with the source, rotctld.c .\" Note: Please keep this page in sync with the source, rotctld.c
.\" .\"
.TH ROTCTLD "1" "2019-12-10" "Hamlib" "Hamlib Utilities" .TH ROTCTLD "1" "2020-09-09" "Hamlib" "Hamlib Utilities"
. .
. .
.SH NAME .SH NAME
@ -293,14 +293,15 @@ and
.RI \(aq Elevation \(aq .RI \(aq Elevation \(aq
are floating point values. are floating point values.
.IP .IP
For example: For example (typed text shown in bold):
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
P 163.0 41.0 .B P 163.0 41.0
.EE .EE
.RE .in
.
.IP .IP
.BR Note : .BR Note :
If the rotator does not support setting elevation (most do not) supply If the rotator does not support setting elevation (most do not) supply
@ -408,21 +409,22 @@ value between 2 and 12.
.IP .IP
For example: For example:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
L -170.0 -85.0 12 .B L -170.0 -85.0 12
.EE .EE
.RE .in
.
.IP .IP
returns: returns:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
Locator: AA55AA00AA00 Locator: AA55AA00AA00
.EE .EE
.RE .in
. .
.TP .TP
.BR l ", " loc2lonlat " \(aq" \fILocator\fP \(aq .BR l ", " loc2lonlat " \(aq" \fILocator\fP \(aq
@ -442,21 +444,23 @@ expressed as a negative value.
.IP .IP
For example: For example:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
l AA55AA00AA00 .B l AA55AA00AA00
.EE .EE
.RE .in
.
.IP .IP
returns: returns:
. .
.sp .IP
.RS 1.0i .in +4n
.EX .EX
Longitude: -169.999983 Latitude: -84.999991 Longitude: -169.999983 Latitude: -84.999991
.EE .EE
.RE .in
.
.IP .IP
.BR Note : .BR Note :
Despite the use of double precision variables internally, some rounding error Despite the use of double precision variables internally, some rounding error
@ -594,22 +598,22 @@ command string with a newline character, \(oq\\n\(cq.
.PP .PP
Example set position (Perl code): Example set position (Perl code):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
print $socket "P 135 10\\n"; \fBprint $socket "P 135 10\\n";\fP
.EE .EE
.RE .in
. .
.PP .PP
or: or:
. .
.sp .PP
.RS 0.5i .in +4n
.EX
\fBprint $socket "\\\\set_pos 135 10\\n";\fP # escape leading \(oq\\\(cq
.EE .EE
print $socket "\\\\set_pos 135 10\\n"; # escape leading \(oq\\\(cq .in
.EE
.RE
. .
.PP .PP
A one line response will be sent as a reply to A one line response will be sent as a reply to
@ -632,16 +636,14 @@ is the Hamlib error code.
.PP .PP
Example get position (Perl code): Example get position (Perl code):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
print $socket "p\\n"; \fBprint $socket "p\\n";\fP
.br
"135" "135"
.br
"10" "10"
.EE .EE
.RE .IN
. .
.PP .PP
Most Most
@ -703,16 +705,14 @@ An example response to a
.B P .B P
command sent from the shell prompt (note the prepended \(oq+\(cq): command sent from the shell prompt (note the prepended \(oq+\(cq):
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ echo "+P 90 45" | nc -w 1 localhost 4533 $ \fBecho "+P 90 45" | nc -w 1 localhost 4533\fP
.br
set_pos: 90 45 set_pos: 90 45
.br
RPRT 0 RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
In this case the long command name and values are returned on the first line In this case the long command name and values are returned on the first line
@ -724,20 +724,17 @@ An example response to a
.B get_pos .B get_pos
query: query:
. .
.sp .PP
.RS 0.5i .in +3n
.EX .EX
$ echo "+\\get_pos" | nc -w 1 localhost 4533 $ \fBecho "+\\get_pos" | nc -w 1 localhost 4533\fP
.br
get_pos: get_pos:
.br
Azimuth: 90.000000 Azimuth: 90.000000
.br
Elevation: 45.000000 Elevation: 45.000000
.br
RPRT 0 RPRT 0
.EE .EE
.RE .in
.
.IP .IP
.BR Note : .BR Note :
The \(oq\\\(cq is still required for the long command name even with the ERP The \(oq\\\(cq is still required for the long command name even with the ERP
@ -796,34 +793,34 @@ For example, invoking a
.B get_pos .B get_pos
query with a leading \(oq;\(cq returns: query with a leading \(oq;\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
get_pos:;Azimuth: 90.000000;Elevation: 45.000000;RPRT 0 get_pos:;Azimuth: 90.000000;Elevation: 45.000000;RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
Or, using the pipe character \(oq|\(cq returns: Or, using the pipe character \(oq|\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
get_pos:|Azimuth: 90.000000|Elevation: 45.000000|RPRT 0 get_pos:|Azimuth: 90.000000|Elevation: 45.000000|RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
And a And a
.B set_pos .B set_pos
command prepended with a \(oq|\(cq returns: command prepended with a \(oq|\(cq returns:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
set_pos: 135 22.5|RPRT 0 set_pos: 135 22.5|RPRT 0
.EE .EE
.RE .in
. .
.PP .PP
Such a format will allow reading a response as a single event using a preferred Such a format will allow reading a response as a single event using a preferred
@ -863,31 +860,31 @@ 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 EXAMPLE .SH EXAMPLES
. .
Start Start
.B rotctld .B rotctld
for a Hy-Gain Ham IV rotor with the Idiom Press RotorEZ board installed using for a Hy-Gain Ham IV rotor with the Idiom Press RotorEZ board installed using
a USB-to-serial adapter and backgrounding: a USB-to-serial adapter and backgrounding:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rotctld \-m 401 \-r /dev/ttyUSB1 & $ \fBrotctld \-m 401 \-r /dev/ttyUSB1 &\fP
.EE .EE
.RE .in
. .
.PP .PP
Start Start
.B rotctld .B rotctld
for RotorEZ using COM2 on Win32: for RotorEZ using COM2 on Win32:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
.RE > \fBrotctl \-m 401 \-r COM2\fP
$ rotctl \-m 401 \-r COM2
.EE .EE
.in
. .
.PP .PP
Connect to the already running Connect to the already running
@ -895,12 +892,12 @@ Connect to the already running
and set position to 135.0 degrees azimuth and 30.0 degrees elevation with a 1 and set position to 135.0 degrees azimuth and 30.0 degrees elevation with a 1
second read timeout from the shell prompt: second read timeout from the shell prompt:
. .
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ echo "\\set_pos 135.0 30.0" | nc \-w 1 localhost 4533 $ \fBecho "\\set_pos 135.0 30.0" | nc \-w 1 localhost 4533\fP
.EE .EE
.RE .in
. .
.PP .PP
Connect to a running Connect to a running
@ -908,12 +905,12 @@ Connect to a running
with with
.B rotctl .B rotctl
on the local host: on the local host:
.sp .PP
.RS 0.5i .in +4n
.EX .EX
$ rotctl \-m 2 $ \fBrotctl \-m 2\fP
.EE .EE
.RE .in
. .
. .
.SH SECURITY .SH SECURITY
@ -970,7 +967,7 @@ Copyright \(co 2000-2009 Stephane Fillod
.br .br
Copyright \(co 2000-2018 the Hamlib Group (various contributors) Copyright \(co 2000-2018 the Hamlib Group (various contributors)
.br .br
Copyright \(co 2011-2019 Nate Bargmann Copyright \(co 2011-2020 Nate Bargmann
. .
.PP .PP
This is free software; see the file COPYING for copying conditions. There is This is free software; see the file COPYING for copying conditions. There is
@ -988,8 +985,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH COLOPHON .SH COLOPHON
. .
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives: archives are available via
.IP .
.UR http://www.hamlib.org .UR http://www.hamlib.org
hamlib.org hamlib.org
.UE . .UE .