ARIM

Section: arim (5)
Updated: 2018-07-28

NAME

arim - related files

FILES

${HOME}/arim/arim.ini

This is an "INI File" format configuration file for ARIM, which is read on program start up. It is divided into sections, each containing a list of keys which specify program properties as name=value pairs, one to a line. Section names occupy a line by themselves and are enclosed in square brackets. Lines beginning with the '#' character are treated as comments. If a key is not present in the file the property is set to its default value. The following sections and keys are defined:

[tnc]
Each ARDOP TNC is configured in a separate [tnc] section. The first [tnc] section in the file defines port 1, the second port 2, and so on. The limit is 10 TNC definitions.
ipaddr
The IP address of the TNC, either in "dotted quad" numerical form or a host name e.g. "localhost" or "DELL-1520.example.net". Max length for host names is 253 characters. Default: localhost. NOTE: on Cygwin, 'localhost' may not work as the address for an ARDOP_Win instance running on the same Windows PC. Use the IP address of the Windows host instead, e.g. "192.168.1.54", as discovered by running ipconfig in the Cygwin terminal. Set this address in the ARDOP_Win TNC "Virtual TNC Setup" dialog box as well.
port
The TCP port on which the TNC is listening. Default: 8515. mycall The station callsign, e.g. NW8L or NW8L-4, max length 10 characters. Call must be no longer than 7 characters and may have optional SSID in ranges: -A to -Z or -0 to -15. ARIM will respond to queries and messages addressed to this call. Messages will be stored in the inbox. Default: NOCALL.
netcall
A net callsign, e.g. RRNET, max length 10 characters. Any printable characters are allowed. When sending a message to this call, no ACK is expected. When receiving, ARIM will recognize messages addressed to this call and store them in the inbox but no ACK will be returned to prevent channel congestion. ARIM will not respond to queries addressed to the net call. Starting with ARIM v0.27, up to 8 net callsigns may be defined for a TNC. Default: one netcall, QST.
gridsq
The station's grid square locator. It must be a well formed Maidenhead locator, either 4, 6 or 8 characters long. For example: DM65 or DM65qf or DM65qf15. Letter pairs are not case-sensitive. Default: DM65.
btime The beacon interval time in minutes, or 0 to disable the beacon. Max time is 999 minutes. Default: 0.
reset-btime-on-tx Controls whether or not the beacon timer is reset when the station transmits an ARDOP frame. This is useful to prevent beacon transmissions from interfering with traffic between stations, e.g. on a net. This setting has no effect when the beacon is disabled. Set to TRUE to enable beacon timer reset on transmit, FALSE to disable it. Default: FALSE.
name
A name assigned to the TNC and advertised by the beacon, e.g. RRNET/ARIM. This is also returned when the TNC receives the ARIM 'pname' query. Max length is 31 characters. Default: Empty.
info
Information describing the TNC, returned in response to the 'info' query. Use the character pair to indicate a line break if you want to format the text into multiple lines; this will be converted to a newline character in the response. Max length is 127 characters. Default: Empty.
fecmode
The initial ARDOP FECMODE. This is the frame type, in the format modulation.bandwidth.baudrate. Max length is 20 characters. Default: 4FSK.200.50S.
fecrepeats
The initial ARDOP FECREPEATS value. This is the number of times each FEC frame will be repeated by the sender. This may be useful when propagation is poor, but at thecost of reduced throughput - depending on FEC mode, an ARIM frame may extend across multiple ARDOP FEC frames, each of which will be repeated. Max value is 5. Default: 0.
fecid
The initial ARDOP FECID value, which controls whether or not an ARDOP ID frame is sent by the TNC at the start of FEC transmissions. Set to TRUE to enable FECID, FALSE to disable it. Default: FALSE.
leader
The initial ARDOP LEADER time in msec. The leader is a special 50 baud two tone signal which precedes data transmission, used by the receiving TNC for synchronization. This may need to be adjusted to compensate for loss of leader due to delays in PTT or VOX keying or audio path latencies in some SDR radios. Range is 120-2500. Default: 240.
trailer
The initial ARDOP TRAILER time in msec. Range is 0-200. Non-zero trailer time is only needed for certain SDR radios and is a function of the audio processing latency relative to release of PTT. For these cases try a value of 100-200 msec. Default: 0.
squelch
The initial ARDOP SQUELCH setting. This controls the sensitivity of the TNC's leader detector. Lower values mean greater sensitivity but also greater risk of false triggering. Range is 1-10. Default: 5.
busydet
The initial ARDOP BUSYDET setting. This controls the sensitivity of the TNC's busy detector. Lower values mean greater sensitivity but also greater risk of false triggering. Setting the value to 0 disables the busy detector. The busy detector should be disabled only in an emergency situation or in very high local noise environments. Range is 0-10. Default: 5.
listen
Controls whether or not the TNC listens for ARQ connect requests or pings from other stations. Set to TRUE to enable listening, FALSE to disable it. Default: TRUE.
enpingack
Controls whether or not the TNC responds to pings from other stations. Set to TRUE to enable ping ACKs, FALSE to disable them. Default: TRUE. Note: works only with ARDOP TNC version 0.9.5 or higher.
arq-bandwidth
Sets the ARQ connection bandwidth, either a maximum negotiated value, or a forced value. The value must be one of: 200MAX, 500MAX, 1000MAX, 2000MAX, 200FORCED, 500FORCED, 1000FORCED or 2000FORCED. Default is 500MAX. arq-timeout The inactivity timeout for ARQ connections in seconds. Range is 30-600. Default: 120.
arq-timeout
The inactivity timeout for ARQ connections in seconds. Range is 30-600. Default: 120.
arq-sendcr
Controls whether or not CRLF line endings are sent in ARQ mode, instead of Unix style LF endings. Set to TRUE to send CR, FALSE to send only LF. Default: TRUE.
[arim] This section holds settings for the ARIM messaging protocol.
mycall
The callsign used as the "from" address for messages. Default: NOCALL.
send-repeats
The number of times an ARIM message will be repeated in the absence of an ACK response from the recipient. It is recommended that this value not exceed 3to prevent tying up the channel with repeats in poor conditions. Default: 0. ack-timeout The maximum time in seconds after sending a message that ARIM will wait for an ACK before repeating it. Applies when send-repeats is not 0. Max is 999 seconds. Default: 30.
fecmode-downshift
Controls whether or not the FEC mode is progressively "downshifted", or changed to a more robust mode each time an ARIM message is repeated after a NAK or ACK timeout. Set to TRUE to enable, FALSE to disable downshifting. Default: FALSE. This works in tandem with the 'send-repeats' parameter. If 'fecmode-downshift' is TRUE and 'send-repeats' is nonzero, then progressively more robust FEC modes are used for re-transmissions after a NAK or timeout. The strategy is to move to the next member of the same modulation family that uses less bandwidth. The mode of last resort is 4FSK.200.50S. For example, if the initial mode is 8PSK.2000.100, then downshifting would progress to 8PSK.1000.100, then 8PSK.500.100, and so on. The original FEC mode is restored after the message send operation completes. This is experimental. There are many kinds of channel impairments and no single downshift strategy is best for all. For details look at the FEC mode downshift table in the msg.c source code file.
frame-timeout
The time in seconds after which an incomplete ARIM frame will be abandoned and the receive buffer cleared. Because an ARIM frame may be spread over many ARDOP frames, a failure to receive one or more ARDOP frames will cause an ARIM timeout. Max is 999 seconds. Default: 30.
files-dir
The directory in which files available for other stations to read are located. This can be an absolute path or a relative path rooted in the ARIM working directory and must be terminated with a '/' character. Max length is 255 characters. Default: files/
add-files-dir
Specifies an additional shared files directory accessible to remote stations. This must be a path relative to the shared files root directory specified by the files-dir parameter. By default, only files in the shared files root directory may be listed or downloaded, and any directories it contains are hidden. If you need to share files organized into multiple directories, use the 'add-files-dir' parameter to expose them. For example:
add-files-dir = forms/

This allows limited access to the 'forms' directory in the shared files root directory. A remote station may list, read or downloaded the files it contains, but any subdirectories are hidden. To grant full access to a directory, including the hierarchy of files and subdirectories rooted there, append the '*' wildcard character to the end of the path. For example:

add-files-dir = contests/*

This grants full access to the 'contests' directory in the shared files root directory. This exposes not only the files in 'contests', but also the hierarchy of subdirectories rooted there. Subdirectories such as contests/2017 or contests/2017/June are visible, and a remote station may list and download the files they contain.

Max length is 255 characters. NOTE: You may define no more than 16 add-files-dir parameters. Default: None.

ac-files-dir
Specifies an access-controlled shared files directory accessible only to remote stations that are authenticated in an ARQ session. This must be a path relative to the shared files root directory specified by the files-dir parameter. File path syntax is the same as for the add-files-dir parameter.

Max length is 255 characters. NOTE: You may define no more than 16 ac-files-dir parameters. Default: None.

max-file-size
The maximum size of files that can be transferred in an ARIM message. The output of the flist query is filtered in accordance with this limit. To disable access to shared files, set this to 0. Max is 16384 bytes. Default: 4096.
max-msg-days
The maximum age, in days, for messages to be kept in the inbox, outbox and sent messages mailbox. Messages that exceed this limit are automatically purged whenever the corresponding message list view is opened in ARIM (using the 'li', 'lo' or 'ls' commands). Set to 0 to disable the automatic message purge feature. Default: 0.
dynamic-file
A dynamic file definition of the form alias:command where alias is a "dummy" file name used to invoke the command command, with a colon ':' separating the two, for example:
spwxfc:python /home/nw8l/scripts/forecast.py

Use absolute paths to script files when ARIM is built from source and installed. Relative paths can be used for "portable" binary installations where the script filesare contained in same directory as the arim executable file. Dynamic files are used to return the output of a script or system command in response to a file query. alias must be unique among any other dynamic file definitions and file names in the shared files folder. In response to the query sq file alias, command will be executed in a shell and its output returned in the response. command can be a batch file, a script invocation like python myscript or a system command like date or uname -a. The output size in bytes is limited by the max-file-size parameter. Errors generated by dynamic file scripts are written to a file named dyn-file-error-YYYYMMDD.login the log folder. Max length is 128 characters. NOTE: you may define no more than 16 dynamic-file parameters. Default: None.

pilot-ping
The number of times a pilot ping will be repeated in the absence of a PINGACK response from the recipient. It is recommended that this value not exceed 3 to prevent tying up the channel with repeats in poor conditions. Set to 0 to disable pilot pings; otherwise the range is 2-15. Default: 0.
pilot-ping-thr
When pilot pings are enabled, this is the threshold by which signal reports from the target station are judged. If the reported constellation quality is above the threshold, the message (or query) send proceeds; if below this threshold it is cancelled. It is recommended that this value be 60 or higher; choose a threshold suitable for the FEC mode in use. Min is 50, Max is 100. Default: 60.
[log] Logging settings appear in this section.
debug-log
Set to TRUE to enable debug logging, FALSE to disable it. Default: FALSE. traffic-log Set to TRUE to enable traffic logging, FALSE to disable it. Default: TRUE.
[ui] User interface settings appear in this section.
color-code
Set to TRUE for color coding of items in the traffic monitor view, calls heard list and TNC command view according to the scheme discussed in the Color Coded Display section. Set to TRUE to enable, FALSE to disable color coding. Default: TRUE.
show-titles
Set to TRUE to show titles for all views (panes) in the UI, FALSE to hide them. Default: TRUE.
last-time-heard
Selects the calls heard list timestamp format. Set to CLOCK to indicate time station was last heard, in HH:MM:SS format (either local time or UTC). Set to ELAPSED to indicate elapsed time since station last heard, in DD:HH:MM format. Default: CLOCK.
mon-timestamp
Set to TRUE to enable timestamps in the traffic monitor view. Set to FALSE to disable them. Default: FALSE. Prior to version 0.12 this was located in the [arim] section.
utc-time
Selects the time zone used for timestamps in the UI and log output, and for the clock in the title bar. Set to TRUE for UTC, and FALSE for local time. Default: TRUE.
theme
The UI theme, either one of the built-in themes (DARK or LIGHT) or a custom theme defined in the arim-themes file described below. Default: DARK.

${HOME}/arim/arim-themes

This is an "INI File" format definition file which is read on program start up. It contains user defined UI theme definitions which augment the built-in "DARK" and "LIGHT" themes. The file is divided into sections, each containing a list of keys which specify theme properties as name=value pairs, one to a line. Section names occupy a line by themselves and are enclosed in square brackets. Lines beginning with the '#' character are treated as comments. If a key is not present in the file the property is set to its default value. The following sections and keys are defined:

[theme]
Each theme is configured in a separate [theme] section. This is a group of color and text attribute assignments for various UI elements in ARIM. The allowable colors are: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, and WHITE. What you see will vary with the color palette used by your terminal emulator. The allowable text attributes are: BLINK, BOLD, DIM, ITALIC, NORMAL, REVERSE, STANDOUT and UNDERLINE. Not all of these attributes work on a given terminal type; you'll need to experiment with them. Up to 5 themes can be defined. Example themes are included in the distributed arim-themes file.
name
The name of the theme. Maximum length: 15 characters.
ui-background-color
The background color used everywhere except dialog boxes. Default: WHITE.
ui-dialog-background-color
The background color used in dialog boxes. Default: WHITE.
ui-dialog-attr
The text attribute for text in dialog boxes. Default: NORMAL.
ui-default-color
The default color for traces printed in the TRAFFIC MONITOR view not otherwise defined. Default: BLACK.
ui-default-attr
The default text attribute for traces printed in the TRAFFIC MONITOR view not otherwise defined. Default: NORMAL.
ui-status-indicator-color
The color for the "status indicators" section of the status bar. Default: BLACK.
ui-status-indicator-attr
The text attribute for the "status indicators" section of the status bar. Default: NORMAL.
ui-status-notify-color
The color for notification messages that temporarily replace the menu on the status bar. Default: BLACK.
ui-status-notify-attr
The text attribute for notification messages that temporarily replace the menu on the status bar. Default: NORMAL.
ui-clock-color
The color for the clock on the title bar. Default: BLACK.
ui-clock-attr
The text attribute for the clock on the title bar. Default: NORMAL.
ui-msg-cntr-color
The color for the new messages/files counter on the title bar. Default: BLACK.
ui-msg-cntr-attr
The text attribute for the new messages/files counter on the title bar. Default: NORMAL.
ui-ch-busy-color
The color for the "CHANNEL BUSY" indicator on the status bar. Default: BLACK.
ui-ch-busy-attr
The text attribute for the "CHANNEL BUSY" indicator on the status bar. Default: NORMAL.
ui-title-color
The color for the title text centered in the title bar. Default: BLACK.
ui-title-attr
The text attribute for the title text centered in the title bar. Default: NORMAL.
tm-err-color
The color used for ARIM and ARDOP error frames printed in the TRAFFIC MONITOR view, e.g. [E] or [X] tags. Default: BLACK.
tm-err-attr
The text attribute for ARIM and ARDOP error frames printed in the TRAFFIC MONITOR view, e.g. [E] or [X] tags. Default: NORMAL.
tm-message-color
The color used for ARIM message frames printed in the TRAFFIC MONITOR view, [M] or [A] tags. Default: BLACK.
tm-message-attr
The text attribute for ARIM message frames printed in the TRAFFIC MONITOR view, [M] or [A] tags. Default: NORMAL.
tm-net-color
The color used for ARIM "net" message frames printed in the TRAFFIC MONITOR view, [M] tag. Default: BLACK.
tm-net-attr
The text attribute for ARIM "net" message frames printed in the TRAFFIC MONITOR view, [M] or [A] tags. Default: NORMAL.
tm-query-color
The color used for ARIM query frames printed in the TRAFFIC MONITOR view, [Q] or [R] tags. Default: BLACK.
tm-query-attr
The text attribute for ARIM query frames printed in the TRAFFIC MONITOR view, [Q] or [R] tags. Default: NORMAL.
tm-beacon-color
The color used for ARIM beacon frames printed in the TRAFFIC MONITOR view, [B] tag. Default: BLACK.
tm-beacon-attr
The text attribute for ARIM beacon frames printed in the TRAFFIC MONITOR view, [B] tag. Default: NORMAL.
tm-arq-color
The color used for ARDOP ARQ frames printed in the TRAFFIC MONITOR view, [@] tag. Default: BLACK.
tm-ping-attr
The text attribute for ARDOP ARQ frames printed in the TRAFFIC MONITOR view, [@] tag. Default: NORMAL.
tm-ping-color
The color used for ARDOP PING and PINGACK frames printed in the TRAFFIC MONITOR view, [P] or [p] tags. Default: BLACK.
tm-ping-attr
The text attribute for ARDOP PING and PINGACK printed in the TRAFFIC MONITOR view, [P] or [p] tags. Default: NORMAL.
tm-id-color
The color used for ARDOP ID frames printed in the TRAFFIC MONITOR view, [P] or [p] tags. Default: BLACK.
tm-id-attr
The text attribute for ARDOP ID frames printed in the TRAFFIC MONITOR view, [P] or [p] tags. Default: NORMAL.
tm-tx-frame-attr
The text attribute for ARDOP or ARIM frames printed in the TRAFFIC MONITOR view that are sent to the TNC for transmission over the air. This can be used to distinguish outgoing from incoming frames. This attribute is ORed with any other attribute set for the frame type. Default: NORMAL.
tc-cmd-color
The color used for commands sent by ARIM to the ARDOP TNC and printed in the TNC COMMANDS view. Default: BLACK.
tc-cmd-attr
The text attribute for commands sent by ARIM to the ARDOP TNC and printed in the TNC COMMANDS view. This helps to distinguish outgoing commands from incoming responses. Default: NORMAL.
tc-ptt-true-color
The color used for PTT TRUE async response sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: BLACK.
tc-ptt-true-attr
The text attribute for PTT TRUE async responses sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: NORMAL.
tc-ptt-false-color
The color used for PTT NORMAL async response sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: BLACK.
tc-ptt-false-attr
The text attribute for PTT NORMAL async responses sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: NORMAL.
tc-buffer-color
The color used for BUFFER async response sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: BLACK.
tc-buffer-attr
The text attribute for BUFFER async responses sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: NORMAL.
tc-ping-color
The color used for PING, PINGACK and PINGREPLY async responses sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: BLACK.
tc-ping-attr
The text attribute for PING, PINGACK and PINGREPLY async responses sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: NORMAL.
tc-busy-color
The color used for BUSY async response sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: BLACK.
tc-busy-attr
The text attribute for BUSY async responses sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: NORMAL.
tc-newstate-color
The color used for NEWSTATE async response sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: BLACK.
tc-newstate-attr
The text attribute for NEWSTATE async responses sent by the ARDOP TNC and printed in the TNC COMMANDS view. Default: NORMAL.

SEE ALSO

arim(1), /usr/local/share/doc/arim/arim-help.pdf