.\" Hey, EMACS: -*- nroff -*- .\" 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" "March 12, 2013" "Hamlib" "Radio Control Program" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME rigctl \- control radio transceivers and receivers .SH SYNOPSIS .B rigctl [\fIOPTION\fR]... [\fICOMMAND\fR]... .SH DESCRIPTION Control radio transceivers and receivers. \fBrigctl\fP accepts \fBcommands\fP from the command line as well as in interactive mode if none are provided on the command line. .PP .\" TeX users may be more comfortable with the \fB\fP and .\" \fI\fP escape sequences to invoke bold face and italics, .\" respectively. Keep in mind that \fBHamlib\fP is BETA level software. While a lot of backend libraries lack complete rig support, the basic functions are usually well supported. The API may change without publicized notice, while an advancement of the major version (e.g. 1.x to 3.x) indicates such a change. .PP 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 ('-'). .PP Here is a summary of the supported options: .TP .B \-m, --model=id Select radio model number. See model list (use 'rigctl \-l'). .sp NB: \fBrigctl\fP (or third party software) will use rig model 2 for NET rigctl (rigctld). .TP .B \-r, --rig-file=device 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. .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. .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. .TP .B \-P, --ptt-type=type Use \fItype\fP of Push-To-Talk device. Supported types are RIG, DTR, RTS, PARALLEL, NONE, overriding PTT type defined in the rig's backend. .sp Some side effects of this command are that when type is set to DTR, read PTT state comes from Hamlib frontend, not read from the radio. When set to NONE, PTT state cannot be read or set even if rig backend supports reading/setting PTT status from the rig. .TP .B \-D, --dcd-type=type Use \fItype\fP of Data Carrier Detect device. Supported types are RIG, DSR, CTS, CD, PARALLEL, NONE. .TP .B \-s, --serial-speed=baud Set serial speed to \fIbaud\fP rate. Uses maximum serial speed from rig backend capabilities as the default. .TP .B \-c, --civaddr=id Use \fIid\fP as the CI-V address to communicate with the rig. Only useful for Icom rigs. .sp NB: the \fIid\fP is in decimal notation, unless prefixed by \fI0x\fP, in which case it is hexadecimal. .TP .B \-t, --send-cmd-term=char Change the termination \fIchar\fP for text protocol when using the \fIsend_cmd\fP command. The default value is (0x0d). Non ASCII printable characters can be specified as an ASCII number, in hexadecimal format, prepended with 0x. You may pass an empty string for no termination char. The string '\-1' tells rigctl to switch to binary protocol. See the \fIsend_cmd\fP command for further explanation. .sp For example, to specify a command terminator for Kenwood style text commands pass "\-t ';'" to rigctl. See EXAMPLES below. .TP .B \-L, --show-conf List all config parameters for the radio defined with \-m above. .TP .B \-C, --set-conf=parm=val[,parm=val]* Set config parameter. e.g. stop_bits=2 .sp Use \-L option for a list. .TP .B \-l, --list List all model numbers defined in \fBHamlib\fP and exit. As of 1.2.15.1 the list is sorted by model number. .sp \fBN.B.\fP In Linux the list can be scrolled back using Shift-PageUp/ Shift-PageDown, or using the scrollbars of a virtual terminal in X or the cmd window in Windows. The output can be piped to 'more' or 'less', e.g. 'rigctl \-l | more'. .TP .B \-u, --dump-caps Dump capabilities for the radio defined with \-m above and exit. .TP .B \-o, --vfo Set vfo mode, requiring an extra VFO argument in front of each appropriate command. Otherwise, 'currVFO' is assumed when this option is not set. .TP .B \-i, --read-history Read previously saved command and argument history from a file (default '~/.rigctl_history') for the current session. Available when \fBrigctl\fP is built with Readline support (see READLINE below). .sp \fBN.B.\fP To read a history file stored in another directory, set the RIGCTL_HIST_DIR environment variable, e.g. 'RIGCTL_HIST_DIR=~/tmp rigctl -i'. When RIGCTL_HIST_DIR is not set, the value of HOME is used. .TP .B \-I, --save-history Write current session and previous session(s), if -i option is given, command and argument history to a file (default '~/.rigctl_history') at the end of the current session. Complete commands with arguments are saved as a single line to be recalled and used or edited. Available when \fBrigctl\fP is built with Readline support (see READLINE below). .sp \fBN.B.\fP To write a history file in another directory, set the RIGCTL_HIST_DIR environment variable, e.g. 'RIGCTL_HIST_DIR=~/tmp rigctl -I'. When RIGCTL_HIST_DIR is not set, the value of HOME is used. .TP .B \-v, --verbose Set verbose mode, cumulative (see DIAGNOSTICS below). .TP .B \-h, --help Show summary of these options and exit. .TP .B \-V, --version Show version of \fBrigctl\fP and exit. .PP \fBN.B.\fP Some options may not be implemented by a given backend and will return an error. This is most likely to occur with the \fI\-\-set-conf\fP and \fI\-\-show-conf\fP options. .PP Please note that 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 \fBHamlib\fP error code. .SH COMMANDS Commands can be entered either as a single char, or as a long command name. Basically, the commands do not take a dash in front of them on the command line, as the options do. 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: .sp Rig command: M LSB 2400 .PP Since most of the \fBHamlib\fP operations have a \fIset\fP and a \fIget\fP method, an upper case letter will be used for \fIset\fP method whereas the corresponding lower case letter refers to the \fIget\fP method. Each operation also has a long name; in interactive mode, prepend a backslash to enter a long command name. .sp Example: Use '\\dump_caps' to see what this radio and backend support. .PP Please note that 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 \fBHamlib\fP error message. .PP As an alternative to the READLINE command history features a special command of a single dash ('-') may be used to read commands from standard input. Commands must be separated by whitespace similar to the commands given on the command line. Comments may be added using the '#' character, all text up until the end of the current line including the '#' character is ignored. .sp Example: $ 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. $ rigctl -m1 - . .PP We are already aware of the bugs in the previous section :-) .SH AUTHORS Written by Stephane Fillod, Nate Bargmann, and the Hamlib Group .PP . .SH COPYRIGHT Copyright \(co 2000-2011 Stephane Fillod .br Copyright \(co 2010-2013 Nate Bargmann .br Copyright \(co 2000-2010 the Hamlib Group. .sp This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .SH SEE ALSO .BR hamlib (3), .BR rigctld(8)