1RIGMEM(1) Hamlib Utilities RIGMEM(1)
2
6 rigmem - backup and restore memory of radio transceivers and receivers
7
9 rigmem [-ahvVx] [-m id] [-r device] [-s baud] [-c id] [-C parm=val]
10 [-p sep] command [file]
11
13 Backup and restore memory of radio transceivers and receivers. rigmem
14 accepts commands from the command line only.
15 Keep in mind that Hamlib is BETA level software. While a lot of back‐
17 end libraries lack complete radio support, the basic functions are usu‐
18 ally well supported.
19 Please report bugs and provide feedback at the e-mail address given in
21 the BUGS section below. Patches and code enhancements sent to the same
22 address are welcome.
23
25 This program follows the usual GNU command line syntax. Short options
26 that take an argument may have the value follow immediately or be sepa‐
27 rated by a space. Long options starting with two dashes (‘-’) require
28 an ‘=’ between the option and any argument.
29 Here is a summary of the supported options:
31 -m, --model=id
33 Select radio model number.
34 See model list (use “rigctl -l”).
36 -r, --rig-file=device
38 Use device as the file name of the port connected to the radio.
39 Often a serial port, but could be a USB to serial adapter. Typ‐
41 ically /dev/ttyS0, /dev/ttyS1, /dev/ttyUSB0, etc. on Linux,
42 COM1, COM2, etc. on MS Windows. The BSD flavors and Mac OS/X
43 have their own designations. See your system's documentation.
44 -s, --serial-speed=baud
46 Set radio serial speed to baud rate.
47 Uses maximum serial speed from radio backend capabilities as the
49 default.
50 -c, --civaddr=id
52 Use id as the CI-V address to communicate with the radio.
53 Only useful for Icom and some Ten-Tec radios.
55 Note: The id is in decimal notation, unless prefixed by 0x, in
57 which case it is hexadecimal.
58 -C, --set-conf=parm=val[,parm=val]
60 Set radio configuration parameter(s), e.g. stop_bits=2.
61 Use the -L option of rigctl for a list of configuration parame‐
63 ters for a given model number.
64 -p, --set-separator=sep
66 Set character as column separator instead of the CSV comma.
67 Some common alternatives are the vertical bar (pipe), ‘|’, semi‐
69 colon, ‘;’, and colon, ‘:’.
70 -a, --all
72 Bypass mem_caps, apply to all fields of channel_t.
73 -x, --xml
75 Use XML format instead of CSV, if libxml2 is available.
76 -v, --verbose
78 Set verbose mode, cumulative (see DIAGNOSTICS below).
79 -h, --help
81 Show a summary of these options and exit.
82 -V, --version
84 Show version of rigmem and exit.
85 Note: Some options may not be implemented by a given backend and will
87 return an error. This is most likely to occur with the --set-conf
88 option.
89
91 Backup and restore are supported for basic CSV file and XML format
92 where available.
93 Please note that the backend for the radio to be controlled, or the
95 radio itself may not support some commands. In that case, the operation
96 will fail with a Hamlib error message.
97 Here is a summary of the supported commands:
99 save file
101 Save all the content of memory in a CSV (or XML) file given as
102 an argument to the command.
103 load file
105 Load the content into all the memory from a CSV (or XML) file
106 given as an argument to the command.
107 save_parm file
109 Save all the parameters of the radio in a CSV (or XML) file
110 given as an argument to the command.
111 load_parm file
113 Load the parameters of the radio from a CSV (or XML) file given
114 as an argument to the command.
115 clear This is a very DANGEROUS command, as it will completely clear
117 out everything you have programmed in the memory of your radio.
118 ALL DATA WILL BE LOST. Use at your own risk!
119
121 The -v, --verbose option allows different levels of diagnostics to be
122 output to stderr and correspond to -v for BUG, -vv for ERR, -vvv for
123 WARN, -vvvv for VERBOSE, or -vvvvv for TRACE.
124 A given verbose level is useful for providing needed debugging informa‐
126 tion to the email address below. For example, TRACE output shows all
127 of the values sent to and received from the radio which is very useful
128 for radio backend library development and may be requested by the
129 developers.
130
132 rigmem exits with:
133 0 if all operations completed normally;
135 1 if there was an invalid command line option or argument;
137 2 if an error was returned by Hamlib.
139 3 the Hamlib backend has no memory support implemented and/or the
141 radio has no memory access available.
142
144 Report bugs to:
145 Hamlib Developer mailing list
147 ⟨hamlib-developer@lists.sourceforge.net⟩
148
150 This file is part of Hamlib, a project to develop a library that sim‐
151 plifies radio, rotator, and amplifier control functions for developers
152 of software primarily of interest to radio amateurs and those inter‐
153 ested in radio communications.
154 Copyright © 2003-2011 Stephane Fillod
156 Copyright © 2007,2019-2020 Nate Bargmann
157 This is free software; see the file COPYING for copying conditions.
159 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
160 PARTICULAR PURPOSE.
161
163 rigctl(1), hamlib(7)
164
166 Links to the Hamlib Wiki, Git repository, release archives, and daily
167 snapshot archives are available via hamlib.org ⟨http://www.hamlib.org⟩.
168Hamlib 2020-09-09 RIGMEM(1)