From f409370200e7ce4dc6578ae5c88a90301db51905 Mon Sep 17 00:00:00 2001 From: Nate Bargmann Date: Fri, 6 Jan 2012 23:21:31 -0600 Subject: [PATCH] Update rigctl/rigctld man pages. Document maximum pathname length for -r, -p, and -d options. Note that -r and -m options are not optional. Bump copyright date to 2012. --- tests/rigctl.1 | 21 ++++++++++----------- tests/rigctld.8 | 15 ++++++++------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/tests/rigctl.1 b/tests/rigctl.1 index 1a4d6f0b8..c6c52d848 100644 --- a/tests/rigctl.1 +++ b/tests/rigctl.1 @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH RIGCTL "1" "June 21, 2011" "Hamlib" "Radio Control Program" +.TH RIGCTL "1" "January 6, 2012" "Hamlib" "Radio Control Program" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -38,8 +38,9 @@ Please report bugs and provide feedback at the e-mail address given in the REPORTING BUGS section. Patches and code enhancements are also welcome. .SH OPTIONS This program follows the usual GNU command line syntax, with long -options starting with two dashes (`-'). - +options starting with two dashes (`-'). At a minimum the -m and -r options +are required (not optional). +.PP Here is a summary of the supported options: .TP .B \-m, --model=id @@ -52,17 +53,15 @@ when using \fBrpc.rigd\fP or rig model 2 for NET rigctl (rigctld). Use \fIdevice\fP as the file name of the port the radio is connected. Often a serial port, but could be a USB to serial adapter. Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux or COM1, COM2, etc. -on Win32. -.sp -Default is \fB/dev/rig\fP (may be a symbolic link to the actual device). +on Win32. Maximum length of 99 characters .TP .B \-p, --ptt-file=device Use \fIdevice\fP as the file name of the Push-To-Talk device using a -device file as described above. +device file as described above. Maximum length of 99 characters .TP .B \-d, --dcd-file=device Use \fIdevice\fP as the file name of the Data Carrier Detect device using a -device file as described above. +device file as described above. Maximum length of 99 characters .TP .B \-P, --ptt-type=type Use \fItype\fP of Push-To-Talk device. @@ -430,7 +429,7 @@ The command terminator, set by the \fIsend-cmd-term\fP option above, will terminate each command string sent to the radio. This character should not be a part of the input string. .SH EXAMPLES -Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter in +Start \fBrigctl\fP for a Yaesu FT-920 using a USB to serial adapter on Linux in interactive mode: .sp $ rigctl -m 114 -r /dev/ttyUSB1 @@ -490,9 +489,9 @@ Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group .SH COPYRIGHT Copyright \(co 2000-2010 Stephane Fillod .br -Copyright \(co 2010 Nate Bargmann +Copyright \(co 2010-2012 Nate Bargmann .br -Copyright \(co 2000-2010 the Hamlib Group. +Copyright \(co 2000-2012 the Hamlib Group. .sp This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY diff --git a/tests/rigctld.8 b/tests/rigctld.8 index c096d0bcc..c8f7832db 100644 --- a/tests/rigctld.8 +++ b/tests/rigctld.8 @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH RIGCTLD "8" "June 21, 2011" "Hamlib" "Rig Control Daemon" +.TH RIGCTLD "8" "January 6, 2012" "Hamlib" "Rig Control Daemon" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -58,7 +58,8 @@ Please report bugs and provide feedback at the e-mail address given in the \fIREPORTING BUGS\fP section. Patches and code enhancements are also welcome. .SH OPTIONS This program follows the usual GNU command line syntax, with long -options starting with two dashes ('-'). +options starting with two dashes ('-'). At a minimum the -m and -r options +are required (not optional). .PP Here is a summary of the supported options: .TP @@ -69,15 +70,15 @@ Select radio model number. See the -l, --list option below. Use \fIdevice\fP as the file name of the port the radio is connected. Often a serial port, but could be a USB to serial adapter or USB port device. Typically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux or COM1, COM2, -etc. on Win32. +etc. on Win32. Maximum length of 99 characters .TP .B \-p, --ptt-file=device Use \fIdevice\fP as the file name of the Push-To-Talk device using a -device file as described above. +device file as described above. Maximum length of 99 characters .TP .B \-d, --dcd-file=device Use \fIdevice\fP as the file name of the Data Carrier Detect device using a -device file as described above. +device file as described above. Maximum length of 99 characters .TP .B \-P, --ptt-type=type Use \fItype\fP of Push-To-Talk device. @@ -657,9 +658,9 @@ Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group .SH COPYRIGHT Copyright \(co 2000-2010 Stephane Fillod .br -Copyright \(co 2011 Nate Bargmann +Copyright \(co 2011-2012 Nate Bargmann .br -Copyright \(co 2000-2010 the Hamlib Group. +Copyright \(co 2000-2012 the Hamlib Group. .PP This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY