Merge branch 'master' of github.com:Hamlib/Hamlib

Author: mdblack98

doc/man1/rigctl.1

@@ -81,13 +81,15 @@ Use
 .I device
 as the file name of the port connected to the radio.
 .IP
-Typically /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 ,
+Typically
+.IR /dev/ttyS0 ", " /dev/ttyS1 ", " /dev/ttyUSB0 ,
 etc. on Linux,
 .IR COM1 ", " COM2 ,
 etc. on MS Windows.  The BSD flavors and Mac OS/X have their own designations.
 See your system's documentation.
 .IP
-Can be a network address:port, e.g. 127.0.0.1:12345
+Can be a network address:port, e.g.
+.IR 127.0.0.1:12345
 .IP
 The special string \(lquh\-rig\(rq may be given to enable micro-ham device
 support.
@@ -189,27 +191,27 @@ above. Will exit if no -r is given. Note the dummy device has no serial paramete
 Set configuration parameter(s). Some common ones are:
 .in +4n
 .EX
-.RB   async: "True enables asynchronous data transfer for backends that support it. This allows use of transceive and spectrum data."
-.RB   auto_power_on: "True enables compatible rigs to be powered up on open"
-.RB   auto_power_off: "True enables compatible rigs to be powered down on close"
-.RB   auto_disable_screensaver: "True enables compatible rigs to have their screen saver disabled on open"
-.RB   dcd_type: "Data Carrier Detect (or squelch) interface type override"
-.RB   dcd_pathname: "Path name to the device file of the Data Carrier Detect (or squelch)"
-.RB   disable_yaesu_bandselect: "True disables the automatic band select on band change for Yaesu rigs"
-.RB   dtr_state:  "ON turns on DTR, OFF turns it off, Unset disables it"
-.RB   lo_freq: "Frequency to add to the VFO frequency for use with a transverter"
-.RB   post_write_delay: "Delay in ms between each command sent out"
-.RB   ptt_share: "True enables ptt port to be shared with other apps"
-.RB   ptt_type: "Push-To-Talk interface type override"
-.RB   ptt_pathname: "Path name to the device file of the Push-To-Talk"
-.RB   ptt_bitnum: "Push-To-Talk GPIO bit number"
-.RB   retry: "Max number of retry"
-.RB   rts_state:  "ON turns on DTR, OFF turns it off, Unset disables it"
-.RB   twiddle_timeout: "For satellite ops when VFOB is twiddled will pause VFOB commands until timeout"
-.RB   twiddle_rit: "Suppress get_freq on VFOB for RIT tuning satellites"
-.RB   timeout: "Timeout in ms"
-.RB   write_delay: "Delay in ms between each byte sent out"
-.RB   tuner_control_pathname: "Path name to a script/program to control a tuner with 1 argument of 0/1 for Tuner Off/On"
+.BR   async: "True enables asynchronous data transfer for backends that support it. This allows use of transceive and spectrum data."
+.BR   auto_power_on: "True enables compatible rigs to be powered up on open"
+.BR   auto_power_off: "True enables compatible rigs to be powered down on close"
+.BR   auto_disable_screensaver: "True enables compatible rigs to have their screen saver disabled on open"
+.BR   dcd_type: "Data Carrier Detect (or squelch) interface type override"
+.BR   dcd_pathname: "Path name to the device file of the Data Carrier Detect (or squelch)"
+.BR   disable_yaesu_bandselect: "True disables the automatic band select on band change for Yaesu rigs"
+.BR   dtr_state:  "ON turns on DTR, OFF turns it off, Unset disables it"
+.BR   lo_freq: "Frequency to add to the VFO frequency for use with a transverter"
+.BR   post_write_delay: "Delay in ms between each command sent out"
+.BR   ptt_share: "True enables ptt port to be shared with other apps"
+.BR   ptt_type: "Push-To-Talk interface type override"
+.BR   ptt_pathname: "Path name to the device file of the Push-To-Talk"
+.BR   ptt_bitnum: "Push-To-Talk GPIO bit number"
+.BR   retry: "Max number of retry"
+.BR   rts_state:  "ON turns on DTR, OFF turns it off, Unset disables it"
+.BR   twiddle_timeout: "For satellite ops when VFOB is twiddled will pause VFOB commands until timeout"
+.BR   twiddle_rit: "Suppress get_freq on VFOB for RIT tuning satellites"
+.BR   timeout: "Timeout in ms"
+.BR   write_delay: "Delay in ms between each byte sent out"
+.BR   tuner_control_pathname: "Path name to a script/program to control a tuner with 1 argument of 0/1 for Tuner Off/On"
 .EE
 .in
 .IP
@@ -335,7 +337,7 @@ Sets the cookie to be used for remote access security
 .
 .TP
 .BR \-# ", " \-\-skip_init
-Skips most startup intialization.
+Skips most startup initialization.
 .
 .TP
 .B \-
@@ -701,7 +703,7 @@ and
 .IP
 Number is 1-based antenna# (\(oq1\(cq, \(oq2\(cq, \(oq3\(cq, ...).
 .IP
-Option depends on rig..for Icom it probably sets the Tx & Rx antennas as in the IC-7851. See your manual for rig specific option values. Most rigs don't care about the option.
+Option depends on rig. For Icom it probably sets the Tx & Rx antennas as in the IC-7851. See your manual for rig specific option values. Most rigs don't care about the option.
 .IP
 For the IC-7851, FTDX3000 (and perhaps others) it means this:
 .IP
@@ -727,7 +729,7 @@ A value of 0 for Antenna will return the current TX antenna
 
 
 .IP
-Option returned depends on rig..for Icom is likely the RX only flag.
+Option returned depends on rig. For Icom it is likely the RX only flag.
 .
 .TP
 .BR b ", " send_morse " \(aq" \fIMorse\fP \(aq
@@ -737,6 +739,7 @@ symbols.  For Yaesu rigs use memory#1-5 or up to 50 char msg
 .EX
 Example from command line:  rigctl -m 3073 -r /dev/ttyUSB0 b "CQ CQ DE ME"
 Yaesu example to send message#1: rigctl -m 1035 -r /dev/ttyUSB0 b 1
+.EE
 .
 .TP
 .BR 0xbb ", " stop_morse "
@@ -828,7 +831,7 @@ code.
 .BR 0x93 ", " get_dcs_sql
 Get
 .RI \(aq "DCS Sql" \(aq
- code.
+code.
 .
 .TP
 .BR N ", " set_ts " \(aq" "\fITuning Step\fP" \(aq
@@ -1138,7 +1141,6 @@ Sets memory channel information
 Get channel memory.
 .IP
 If readonly!=0 then only channel data is returned and rig remains on the current channel.  If readonly=0 then rig will be set to the channel requested.
-data.
 .
 .TP
 .BR A ", " set_trn " \(aq" \fITransceive\fP \(aq
@@ -1405,68 +1407,63 @@ Returns current lock mode status 1=On, 2=Off (only useful when using rigctld)
 .
 .TP
 .BR send_raw " \(aq" \fITerminator\fP "\(aq \(aq" \fIString\fP \(aq
-.EX
 Can send ASCII string or 0xnn values or xnn values -- there can be no spaces in the command string.
 Possible terminator values are CR, LF, ;, ICOM, 0-100 (bytes to read), or -1 meaning unknown (will timeout on read)
 Examples (note that a ; must be escaped in Unix/Linux):
+.IP
 For Windows & Unix/Linux we have a new colon-separated format for hex digits
+.EX
   send_raw icom 0xFE:0xFE:0x94:0x03:0xFD Note: colon-separated does not have to be escaped on Unix/Linux
   send_raw -1 0xFE:0xFE:0x94:0x03:0xFD
   send_raw 14 0xFE:0xFE:0x94:0x03:0xFD
   Note that ASCII commands still require escaping the semicolon on Unix/Linux
   send_raw \; FA\;MD\;
-  
+.EE
 For Windows:
+.EX
   send_raw icom 0xFE;0xFE;0x94;0x03;0xFD
   send_raw -1 0xFE;0xFE;0x94;0x03;0xFD
   send_raw 14 0xFE;0xFE;0x94;0x03;0xFD
-
-  For Unix/Linux
+.EE
+For Unix/Linux
+.EX
   send_raw icom 0xFE\;0xFE\;0x94\;0x03\;0xFD
   send_raw \; FA\;MD\;
   send_raw -1 0xFE\;0xFE\;0x94\;0x03\;0xFD
   send_raw 14 0xFE\;0xFE\;0x94\;0x03\;0xFD
+.EE
 .
 .TP
 .BR client_version " \(aq" \fIString\fP "\(aq
-.EX
   Client can send its version to rigctld and get feedback on compatibility, deprecation, and alternatives
 .TP
 .BR hamlib_version
-.EX
 Returns hamlib version with ISO8601 date/time
 .
 .TP
 .BR test
-.EX
 Performs test routines.  Under development.
 .
 .TP
 .BR set_gpio " \(aq" \fIGPIO#\fP "\(aq
-.EX
 Sets GPIO1, GPIO2, GPIO3, GPIO4 on the GPIO ptt port
 Can also use 1,2,3,4
 .
 .TP
 .BR get_gpio " \(aq" \fIGPIO#\fP "\(aq
-.EX
 Reads GPIO1, GPIO2, GPIO3, GPIO4 on the GPIO ptt port
 Can also use 1,2,3,4
 .
 .TP
 .BR skip_init
-.EX
 Skips rig initialization -- useful when executing commands with rigctl to speed up things
 .
 .TP
 .BR freq_skip " " 'skip'
-.EX
 When skip!=0 skips setting freq on TX_VFO when in RX and on RX_VFO when in TX -- for use with gpredict and rigs that do not have TARGETABLE_VFO
 .
 .SH READLINE
 .
-.SH READLINE
-.
 If
 .B Readline
 library development files are found at configure time,