diff --git a/doc/man1/ampctl.1 b/doc/man1/ampctl.1 index e44ebcc88..01bcc00f1 100644 --- a/doc/man1/ampctl.1 +++ b/doc/man1/ampctl.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -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 entered on a single line: . -.sp -.RS 0.5i +.PP +.in +4n .EX -F 14250000 +.B F 14250000 .EE -.RE +.in . .PP 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 backend support. . -.PP +.IP .BR Note : 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 @@ -283,22 +283,22 @@ error message. . . .PP -A simple example: +A simple example using commands saved to a file (typed text shown in bold): . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ cat <<.EOF. >cmds.txt -> # File of commands -> F 14250000 -> f -> l PWRINPUT -> l PWRFORWARD -> l SWR -> \\dump_caps -> .EOF. +.RB $ " cat <<.EOF. >cmds.txt" +.RB > " # File of commands" +.RB > " F 14250000" +.RB > " f" +.RB > " l PWRINPUT" +.RB > " l PWRFORWARD" +.RB > " l SWR" +> \fB\\dump_caps\fP +.RB > " .EOF." -$ ampctl -m1 - ampctl -m 201 -r COM1 -vvvvv +.RB > " ampctl -m 201 -r COM1 -vvvvv" .EE -.RE +.in . .PP 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 the TCP port, setting frequency and mode: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ ampctl -m 2 -r localhost:4531 F 7253500 +.RB $ " ampctl -m 2 -r localhost:4531 F 7253500" .EE -.RE +.in . . .SH BUGS @@ -640,7 +640,7 @@ Copyright \(co 2000-2011 Stephane Fillod .br Copyright \(co 2000-2018 the Hamlib Group (various contributors) .br -Copyright \(co 2010-2019 Nate Bargmann +Copyright \(co 2010-2020 Nate Bargmann . .PP 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 . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/ampctld.1 b/doc/man1/ampctld.1 index 5c66324ac..31d97844f 100644 --- a/doc/man1/ampctld.1 +++ b/doc/man1/ampctld.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -402,16 +402,15 @@ needed values. In practice, reliable results are obtained by terminating each command string with a newline character, \(oq\\n\(cq. . .PP -Example set frequency and mode commands (Perl code): +Example set frequency and mode commands (Perl code (typed text shown in bold)): . -.sp -.RS 0.5i +.PP +.in +4n .EX -print $socket "F 14250000\\n"; -.br -print $socket "\\\\set_powerstat 1\\n"; # escape leading '\\' +\fBprint $socket "F 14250000\\n";\fP +\fBprint $socket "\\\\set_powerstat 1\\n";\fP # escape leading '\\' .EE -.RE +.in . .PP A one line response will be sent as a reply to @@ -434,14 +433,13 @@ is the Hamlib error code. .PP Example get frequency (Perl code): . -.sp -.RS 0.5i +.PP +.in +4n .EX -print $socket "f\\n"; -.br +\fBprint $socket "f\\n";\fP "14250000\\n" .EE -.RE +.in . .PP Most @@ -509,16 +507,14 @@ An example response to a .B set_frequency command sent from the shell prompt (note the prepended \(oq+\(cq): . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ echo "+F 14250000" | nc -w 1 localhost 4531 -.br +$ \fBecho "+F 14250000" | nc -w 1 localhost 4531\fP set_freq: 14250000 -.br RPRT 0 .EE -.RE +.in . .PP 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 query: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ echo "+\\get_freq" | nc -w 1 localhost 4531 -.br +$ \fBecho "+\\get_freq" | nc -w 1 localhost 4531\fP get_freq: -.br Frequency(Hz): 14250000 -.br RPRT 0 .EE -.RE +.in . .IP .BR Note : @@ -600,34 +593,34 @@ For example, invoking a .B get_freq query with a leading \(oq;\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX get_freq:;Frequency(Hz): 14250000;RPRT 0 .EE -.RE +.in . .PP Or, using the pipe character \(oq|\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX get_freq:|Frequency(Hz): 14250000|RPRT 0 .EE -.RE +.in . .PP And a .B set_freq command prepended with a \(oq|\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX set_freq: 14250000|RPRT 0 .EE -.RE +.in . .PP 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. . . -.SH EXAMPLE +.SH EXAMPLES . Start .B ampctld for an Elecraft KPA-1500 using a USB-to-serial adapter and backgrounding: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ ampctld -m 201 -r /dev/ttyUSB1 & +.RB $ " ampctld -m 201 -r /dev/ttyUSB1 &" .EE -.RE +.in . .PP Start .B ampctld for an Elecraft KPA-1500 using COM2 on MS Windows: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ ampctld -m 201 -r COM2 +.RB $ " ampctld -m 201 -r COM2" .EE -.RE +.in . .PP 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 default protocol from the shell prompt: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ echo "\\set_freq 14266000" | nc -w 1 localhost 4531 +$ \fBecho "\\set_freq 14266000" | nc -w 1 localhost 4531\fP .EE -.RE +.in . .PP Connect to a running @@ -704,12 +697,12 @@ with .B ampctl on the local host: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ ampctl -m2 +.RB $ " ampctl -m2" .EE -.RE +.in . . .SH SECURITY @@ -765,7 +758,7 @@ Copyright \(co 2000-2010 Stephane Fillod .br Copyright \(co 2000-2018 the Hamlib Group (various contributors) .br -Copyright \(co 2011-2019 Nate Bargmann +Copyright \(co 2011-2020 Nate Bargmann . .PP 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 . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/rigctl.1 b/doc/man1/rigctl.1 index c57eaf440..ff0b3c6b9 100644 --- a/doc/man1/rigctl.1 +++ b/doc/man1/rigctl.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -284,7 +284,7 @@ Set verbose mode, cumulative (see below). .TP .BR \-Y "," \-\-\ignore\-err -Ignores rig open errors +Ignores rig open errors . .TP .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 entered on a single line: . -.sp -.RS 0.5i +.PP +.in +4n .EX -M LSB 2400 +.B M LSB 2400 .EE -.RE +.in . .PP 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 backend support. . -.PP +.IP .BR Note : 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 @@ -383,19 +383,19 @@ up until the end of the current line including the \(oq#\(cq character is ignored. . .PP -A simple example: +A simple example (typed text is in bold): . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ cat <<.EOF. >cmds.txt -> # File of commands -> v f m # query rig -> V VFOB F 14200000 M CW 500 # set rig -> v f m # query rig -> .EOF. +.RB $ " cat <<.EOF. >cmds.txt" +.RB > " # File of commands" +.RB > " v f m # query rig" +.RB > " V VFOB F 14200000 M CW 500 # set rig" +.RB > " v f m # query rig" +.RB > " .EOF." -$ rigctl -m1 - rigctl -m 114 -r COM1 -vvvvv +.RB > " rigctl -m 1014 -r COM1 -vvvvv" .EE -.RE +.in . .PP Start @@ -1284,12 +1284,12 @@ Start for a Yaesu FT-920 using a USB to serial adapter while setting baud rate and stop bits: . -.sp -.RS 0.5i +.PP +.in +4n .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 -.RE +.in . .PP Start @@ -1299,12 +1299,12 @@ terminator for the .B w command: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ rigctl -m 229 -r /dev/ttyUSB0 -t';' +.RB $ " rigctl -m 2029 -r /dev/ttyUSB0 -t';'" .EE -.RE +.in . .PP 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 TCP port, setting frequency and mode: . -.sp -.RS 0.5i +.PP +.in +4n .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 -.RE +.in . . .SH BUGS @@ -1348,7 +1348,7 @@ Copyright \(co 2000-2011 Stephane Fillod .br Copyright \(co 2000-2018 the Hamlib Group (various contributors) .br -Copyright \(co 2010-2019 Nate Bargmann +Copyright \(co 2010-2020 Nate Bargmann . .PP 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 . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/rigctlcom.1 b/doc/man1/rigctlcom.1 index 305ffdbfc..7d63037df 100644 --- a/doc/man1/rigctlcom.1 +++ b/doc/man1/rigctlcom.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -108,12 +108,12 @@ to the other com port of the virtual pair. Virtual serial ports on POSIX systems can be done with .BR socat (1): . -.sp -.RS 1.0i +.IP +.in +4n .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 -.RE +.in . .IP 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 as described above): . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ rigctlcom -m 4 -R COM9 -S 115200 +.RB $ " rigctlcom -m 4 -R COM9 -S 115200" .EE -.RE +.in . .PP The following diagram shows the communications flow that allows N1MM Logger+ to communicate with a radio connected to Flrig: . -.sp -.RS 0.5i +.PP +.in +4n .EX Flrig -><- rigctlcom -> COM9 <- virt_port_pipe -> COM10 <- N1MM .EE -.RE +.in . . .SH BUGS @@ -385,7 +385,7 @@ Copyright \(co 2000-2011 Stephane Fillod .br Copyright \(co 2000-2018 the Hamlib Group (various contributors) .br -Copyright \(co 2010-2019 Nate Bargmann +Copyright \(co 2010-2020 Nate Bargmann .br Copyright \(co 2019 Michael Black W9MDB . @@ -405,8 +405,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .SH COLOPHON . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/rigctld.1 b/doc/man1/rigctld.1 index 5813636a0..959b24255 100644 --- a/doc/man1/rigctld.1 +++ b/doc/man1/rigctld.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -207,35 +207,58 @@ Use .I IPADDR as the listening IP address. .IP -The default is ANY. +The default is ANY (0.0.0.0). .IP -Can be run and connected to like this: +.B rigctld +can be run and connected to like this: +. .IP -.nf +.EX rigctld - rigctl -m 2 - rigctl -m 2 -r 127.0.0.1 - rigctl -m 2 -r localhost - rigctl -m 2 -r 192.168.1.1 (local IP address) - rigctl -m 2 -r ::1 (does not work on Linux as does not listen on IPV6 by default) -.BR +. +.in +4n +rigctl -m 2 +rigctl -m 2 -r 127.0.0.1 +rigctl -m 2 -r localhost +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 - rigctl -m 2 - rigctl -m 2 -r 127.0.0.1 - Exceptions: - rigctl -m 2 -r localhost (only works if localhost is IPV4 address) -.BR +.in +4n +rigctl -m 2 +rigctl -m 2 -r 127.0.0.1 +.EE +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) - rigctl -m 2 - rigctl -m 2 -r localhost - rigctl -m 2 ip6-localhost - Exceptions: - 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) -.BR -On Linux only where ip6-localhost fe00::0 +.in +4n +rigctl -m 2 +rigctl -m 2 -r localhost +rigctl -m 2 ip6-localhost +.EE +Exceptions: +.EX +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 - rigctl -m 2 -r ip6-localhost +.in +4n +rigctl -m 2 -r ip6-localhost +.in +.EE . .TP .BR \-t ", " \-\-port = \fInumber\fP @@ -460,8 +483,8 @@ In VFO mode (see .B \-\-vfo option above) only a single VFO parameter is required: . -.sp -.RS 1.0i +.IP +.in +4n .EX $ rigctl -m 229 -r /dev/rig -o @@ -470,7 +493,7 @@ VFO: VFOB Rig command: .EE -.RE +.in . .TP .BR v ", " get_vfo @@ -1049,7 +1072,7 @@ Set .RI \(aq Status \(aq .IP 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. . . @@ -1089,16 +1112,15 @@ needed values. In practice, reliable results are obtained by terminating each command string with a newline character, \(oq\\n\(cq. . .PP -Example set frequency and mode commands (Perl code): +Example set frequency and mode commands (Perl code (typed text shown in bold)): . -.sp -.RS 0.5i +.PP +.in +4n .EX -print $socket "F 14250000\\n"; -.br -print $socket "\\\\set_mode LSB 2400\\n"; # escape leading '\\' +\fBprint $socket "F 14250000\\n";\fP +\fBprint $socket "\\\\set_mode LSB 2400\\n";\fP # escape leading '\\' .EE -.RE +.in . .PP A one line response will be sent as a reply to @@ -1121,14 +1143,13 @@ is the Hamlib error code. .PP Example get frequency (Perl code): . -.sp -.RS 0.5i +.PP +.in +4n .EX -print $socket "f\\n"; -.br +\fBprint $socket "f\\n";\fP "14250000\\n" .EE -.RE +.in . .PP Most @@ -1190,16 +1211,14 @@ An example response to a .B set_mode command sent from the shell prompt (note the prepended \(oq+\(cq): . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ echo "+M USB 2400" | nc -w 1 localhost 4532 -.br +$ \fBecho "+M USB 2400" | nc -w 1 localhost 4532\fP set_mode: USB 2400 -.br RPRT 0 .EE -.RE +.in . .PP 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 query: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ echo "+\\get_mode" | nc -w 1 localhost 4532 -.br +$ \fBecho "+\\get_mode" | nc -w 1 localhost 4532\fP get_mode: -.br Mode: USB -.br Passband: 2400 -.br RPRT 0 .EE -.RE +.in . .IP .BR Note : @@ -1283,34 +1298,34 @@ For example, invoking a .B get_mode query with a leading \(oq;\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX get_mode:;Mode: USB;Passband: 2400;RPRT 0 .EE -.RE +.in . .PP Or, using the pipe character \(oq|\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX get_mode:|Mode: USB|Passband: 2400|RPRT 0 .EE -.RE +.in . .PP And a .B set_mode command prepended with a \(oq|\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX set_mode: USB 2400|RPRT 0 .EE -.RE +.in . .PP 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. . . -.SH EXAMPLE +.SH EXAMPLES . Start .B rigctld for a Yaesu FT-920 using a USB-to-serial adapter and backgrounding: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ rigctld -m 114 -r /dev/ttyUSB1 & +.RB $ " rigctld -m 1014 -r /dev/ttyUSB1 &" .EE -.RE +.in . .PP Start @@ -1390,24 +1405,24 @@ Start for a Yaesu FT-920 using a USB-to-serial adapter while setting baud rate and stop bits, and backgrounding: . -.sp -.RS 0.5i +.PP +.in +4n .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 -.RE +.in . .PP Start .B rigctld for an Elecraft K3 using COM2 on MS Windows: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ rigctld -m 229 -r COM2 +.RB $ " rigctld -m 2029 -r COM2" .EE -.RE +.in . .PP 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 default protocol from the shell prompt: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ echo "\\set_freq 14266000" | nc -w 1 localhost 4532 +$ \fBecho "\\set_freq 14266000" | nc -w 1 localhost 4532\P .EE -.RE +.in . .PP Connect to a running @@ -1429,12 +1444,12 @@ with .B rigctl on the local host: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ rigctl -m2 +.RB $ " rigctl -m2" .EE -.RE +.in . . .SH SECURITY @@ -1490,7 +1505,7 @@ Copyright \(co 2000-2010 Stephane Fillod .br Copyright \(co 2000-2018 the Hamlib Group (various contributors) .br -Copyright \(co 2011-2019 Nate Bargmann +Copyright \(co 2011-2020 Nate Bargmann . .PP 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 . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/rigmem.1 b/doc/man1/rigmem.1 index 7f093471d..c22be596c 100644 --- a/doc/man1/rigmem.1 +++ b/doc/man1/rigmem.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -268,7 +268,7 @@ communications. .PP Copyright \(co 2003-2011 Stephane Fillod .br -Copyright \(co 2007,2019 Nate Bargmann +Copyright \(co 2007,2019-2020 Nate Bargmann . .PP 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 . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/rigsmtr.1 b/doc/man1/rigsmtr.1 index d1998a60d..68d9ad413 100644 --- a/doc/man1/rigsmtr.1 +++ b/doc/man1/rigsmtr.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -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 360\(de rotation and record measurements in the file -.IR csmtr : +.I csmtr +(typed text shown in bold): . -.sp -.RS 0.5i +.PP +.in +4n .EX -rigsmtr \-m 209 \-r /dev/ttyS1 \-M 202 > csmtr +.RB $ " rigsmtr \-m 2009 \-r /dev/ttyS1 \-M 202 > csmtr" .EE -.RE +.in . .PP After completion the file .I csmtr contains lines such as: . -.sp -.RS 0.5i +.PP +.in +4n .EX 0 \-47 -.br 30 \-40 -.br 60 \-22 -.br 90 \-3 -.br 120 10 -.br 150 1 -.br 180 \-11 -.br 210 \-24 -.br 240 \-35 -.br 270 \-42 -.br 300 \-48 -.br 330 \-51 -.br 360 \-49 .EE -.RE +.in . .PP The results can be plotted with .BR gnuplot (1): . -.sp -.RS 0.5i +.PP +.in +4n .EX -gnuplot -.br -set angles degrees -.br -set polar -.br -set grid polar 15. -.br -unset border -.br -unset param -.br -set style data line -.br -set rrange [-60:60] -.br -set xrange [-60:60] -.br -set yrange [-60:60] -.br -.RI plot " csmtr" +.RB $ " gnuplot" +.B set angles degrees +.B set polar +.B set grid polar 15. +.B unset border +.B unset param +.B set style data line +.B set rrange [-60:60] +.B set xrange [-60:60] +.B set yrange [-60:60] +.B plot csmtr .EE -.RE +.in . . .SH BUGS @@ -337,7 +316,7 @@ communications. .PP Copyright \(co 2007-2009 Stephane Fillod .br -Copyright \(co 2018,2019 Nate Bargmann +Copyright \(co 2018-2020 Nate Bargmann .PP 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. @@ -354,8 +333,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .SH COLOPHON . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/rigswr.1 b/doc/man1/rigswr.1 index d593d3c61..fa996434a 100644 --- a/doc/man1/rigswr.1 +++ b/doc/man1/rigswr.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -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 TS-850 and records VSWR measurements in file -.IR cswr . -. -.sp -.RS 0.5i -.EX -rigswr -m 209 -r /dev/ttyS1 14000000 14200000 50000 > cswr -.EE -.RE +.I cswr +(typed text shown in bold): . .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 -.RS 0.5i +.PP +After completion, +.I cswr +contains the following lines: +. +.PP +.in +4n .EX 14000000 1.50 -.br 14050000 1.31 -.br 14100000 1.22 -.br 14150000 1.07 -.br 14200000 1.07 .EE -.RE +.in . .PP The result can be plotted with .BR gnuplot (1): . -.sp -.RS 0.5i +.PP +.in +4n .EX -gnuplot -.br -set data style linespoints -.br -set grid -.br -.RI plot " cswr" +.RB $ " gnuplot" +.B set data style linespoints +.B set grid +.B plot cswr .EE -.RE +.in . . .SH BUGS @@ -314,7 +310,7 @@ Copyright \(co 2004 Thierry Leconte .br Copyright \(co 2004-2011 Stephane Fillod .br -Copyright \(co 2007,2018,2019 Nate Bargmann +Copyright \(co 2007,2018-2020 Nate Bargmann .PP 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. @@ -330,8 +326,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .SH COLOPHON . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/rotctl.1 b/doc/man1/rotctl.1 index 8403ac6b2..669ad3c8e 100644 --- a/doc/man1/rotctl.1 +++ b/doc/man1/rotctl.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -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 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 -entered on a single line: +entered on a single line (typed text shown in bold): . -.sp -.RS 0.5i +.PP +.in +4n .EX -P 123 45 +.B P 123 45 .EE -.RE +.in . .PP 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 information. . -.PP +.IP .BR Note : 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 @@ -302,17 +302,17 @@ ignored. .PP A simple example: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ cat <<.EOF. >cmds.txt -> # File of commands -> set_pos 180.0 10.0 # rotate -> pause 30 # wait for action to complete -> get_pos # query rotator -> .EOF. +.RB $ " cat <<.EOF. >cmds.txt" +.RB > " # File of commands" +.RB > " set_pos 180.0 10.0 # rotate" +.RB > " pause 30 # wait for action to complete" +.RB > " get_pos # query rotator" +.RB > .EOF. -$ rotctl -m 1 - " rotctl -m 401 -r COM2" .EE -.RE +.in . .PP 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 TCP port, and querying the position: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ rotctl -m 2 -r localhost:4533 \\get_pos +.RB $ " rotctl -m 2 -r localhost:4533 \\get_pos" .EE -.RE +.in . . .SH BUGS @@ -799,7 +803,7 @@ Copyright \(co 2001-2011 Stephane Fillod .br Copyright \(co 2002-2017 the Hamlib Group (various contributors) .br -Copyright \(co 2003-2019 Nate Bargmann +Copyright \(co 2003-2020 Nate Bargmann . .PP 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 . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE . diff --git a/doc/man1/rotctld.1 b/doc/man1/rotctld.1 index 528908af9..c3bb64a2c 100644 --- a/doc/man1/rotctld.1 +++ b/doc/man1/rotctld.1 @@ -5,7 +5,7 @@ .\" .\" 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 @@ -293,14 +293,15 @@ and .RI \(aq Elevation \(aq are floating point values. .IP -For example: +For example (typed text shown in bold): . -.sp -.RS 1.0i +.IP +.in +4n .EX -P 163.0 41.0 +.B P 163.0 41.0 .EE -.RE +.in +. .IP .BR Note : If the rotator does not support setting elevation (most do not) supply @@ -408,21 +409,22 @@ value between 2 and 12. .IP For example: . -.sp -.RS 1.0i +.IP +.in +4n .EX -L -170.0 -85.0 12 +.B L -170.0 -85.0 12 .EE -.RE +.in +. .IP returns: . -.sp -.RS 1.0i +.IP +.in +4n .EX Locator: AA55AA00AA00 .EE -.RE +.in . .TP .BR l ", " loc2lonlat " \(aq" \fILocator\fP \(aq @@ -442,21 +444,23 @@ expressed as a negative value. .IP For example: . -.sp -.RS 1.0i +.IP +.in +4n .EX -l AA55AA00AA00 +.B l AA55AA00AA00 .EE -.RE +.in +. .IP returns: . -.sp -.RS 1.0i +.IP +.in +4n .EX Longitude: -169.999983 Latitude: -84.999991 .EE -.RE +.in +. .IP .BR Note : 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 Example set position (Perl code): . -.sp -.RS 0.5i +.PP +.in +4n .EX -print $socket "P 135 10\\n"; +\fBprint $socket "P 135 10\\n";\fP .EE -.RE +.in . .PP or: . -.sp -.RS 0.5i +.PP +.in +4n +.EX +\fBprint $socket "\\\\set_pos 135 10\\n";\fP # escape leading \(oq\\\(cq .EE -print $socket "\\\\set_pos 135 10\\n"; # escape leading \(oq\\\(cq -.EE -.RE +.in . .PP A one line response will be sent as a reply to @@ -632,16 +636,14 @@ is the Hamlib error code. .PP Example get position (Perl code): . -.sp -.RS 0.5i +.PP +.in +4n .EX -print $socket "p\\n"; -.br +\fBprint $socket "p\\n";\fP "135" -.br "10" .EE -.RE +.IN . .PP Most @@ -703,16 +705,14 @@ An example response to a .B P command sent from the shell prompt (note the prepended \(oq+\(cq): . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ echo "+P 90 45" | nc -w 1 localhost 4533 -.br +$ \fBecho "+P 90 45" | nc -w 1 localhost 4533\fP set_pos: 90 45 -.br RPRT 0 .EE -.RE +.in . .PP 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 query: . -.sp -.RS 0.5i +.PP +.in +3n .EX -$ echo "+\\get_pos" | nc -w 1 localhost 4533 -.br +$ \fBecho "+\\get_pos" | nc -w 1 localhost 4533\fP get_pos: -.br Azimuth: 90.000000 -.br Elevation: 45.000000 -.br RPRT 0 .EE -.RE +.in +. .IP .BR Note : 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 query with a leading \(oq;\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX get_pos:;Azimuth: 90.000000;Elevation: 45.000000;RPRT 0 .EE -.RE +.in . .PP Or, using the pipe character \(oq|\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX get_pos:|Azimuth: 90.000000|Elevation: 45.000000|RPRT 0 .EE -.RE +.in . .PP And a .B set_pos command prepended with a \(oq|\(cq returns: . -.sp -.RS 0.5i +.PP +.in +4n .EX set_pos: 135 22.5|RPRT 0 .EE -.RE +.in . .PP 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. . . -.SH EXAMPLE +.SH EXAMPLES . Start .B rotctld for a Hy-Gain Ham IV rotor with the Idiom Press RotorEZ board installed using a USB-to-serial adapter and backgrounding: . -.sp -.RS 0.5i +.PP +.in +4n .EX -$ rotctld \-m 401 \-r /dev/ttyUSB1 & +$ \fBrotctld \-m 401 \-r /dev/ttyUSB1 &\fP .EE -.RE +.in . .PP Start .B rotctld for RotorEZ using COM2 on Win32: . -.sp -.RS 0.5i +.PP +.in +4n .EX -.RE -$ rotctl \-m 401 \-r COM2 +> \fBrotctl \-m 401 \-r COM2\fP .EE +.in . .PP 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 second read timeout from the shell prompt: . -.sp -.RS 0.5i +.PP +.in +4n .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 -.RE +.in . .PP Connect to a running @@ -908,12 +905,12 @@ Connect to a running with .B rotctl on the local host: -.sp -.RS 0.5i +.PP +.in +4n .EX -$ rotctl \-m 2 +$ \fBrotctl \-m 2\fP .EE -.RE +.in . . .SH SECURITY @@ -970,7 +967,7 @@ Copyright \(co 2000-2009 Stephane Fillod .br Copyright \(co 2000-2018 the Hamlib Group (various contributors) .br -Copyright \(co 2011-2019 Nate Bargmann +Copyright \(co 2011-2020 Nate Bargmann . .PP 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 . Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot -archives: -.IP +archives are available via +. .UR http://www.hamlib.org hamlib.org .UE .