From 8161cda2fc9cc4ac010741438e54b14e3d36cf38 Mon Sep 17 00:00:00 2001 From: Mike Black W9MDB Date: Thu, 20 Jul 2023 07:49:56 -0500 Subject: [PATCH] Update man pages --- doc/man1/rigctl.1 | 24 +++++++++++++----------- doc/man1/rigctld.1 | 40 +++++++++++++++++++++------------------- 2 files changed, 34 insertions(+), 30 deletions(-) diff --git a/doc/man1/rigctl.1 b/doc/man1/rigctl.1 index e863d170a..acf0e8849 100644 --- a/doc/man1/rigctl.1 +++ b/doc/man1/rigctl.1 @@ -190,24 +190,26 @@ above. Note the dummy device has no serial parameters. Set configuration parameter(s). Some common ones are: .in +4n .EX -.RB write_delay: "Delay in ms between each byte sent out" -.RB post_write_delay: "Delay in ms between each command sent out" -.RB timeout: "Timeout in ms" -.RB retry: "Max number of retry" -.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 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 lo_freq: "Frequency to add to the VFO frequency for use with a transverter" +.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: "True turns on DTR' +.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: "True turns on RTS' .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 async: "True enables asynchronous data transfer for backends that support it. This allows use of transceive and spectrum data." +.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" .EE .in diff --git a/doc/man1/rigctld.1 b/doc/man1/rigctld.1 index 3049ac4d2..ff7a50f21 100644 --- a/doc/man1/rigctld.1 +++ b/doc/man1/rigctld.1 @@ -296,25 +296,27 @@ above. Set configuration parameter(s). Some common ones are: .in +4 .EX -.RB write_delay: "Delay in ms between each byte sent out" -.RB post_write_delay: "Delay in ms between each command sent out" -.RB timeout: "Timeout in ms" -.RB retry: "Max number of retry" -.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 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 lo_freq: "Frequency to add to the VFO frequency for use with a transverter" -.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 disable_yaesu_bandselect: "True disables the automatic band select on band change for Yaesu rigs" -.RB ptt_share: "True enables ptt port to be shared with other apps" -.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 async: "True enables asynchronous data transfer for backends that support it. This allows use of transceive and spectrum data." -.RB tuner_control_pathname: "Path name to a script/program to control a tuner with 1 argument of 0/1 for Tuner Off/On" +.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: "True turns on DTR' +.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: "True turns on RTS' +.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" .EE .in .IP