1FLDIGI(1)                                                            FLDIGI(1)
2
3
4

NAME

6       fldigi - digital modem program for hamradio operators
7

SYNOPSIS

9       fldigi [OPTIONS]
10

DESCRIPTION

12       Fldigi is a cross-platform multi-modem program for most of the digital
13       modes used by radio amateurs today: CW, PSK, MFSK, MT-63, RTTY,
14       Hellschreiber, DominoEX, Olivia, THOR and Throb are all supported. It
15       can also help calibrate a sound card to a time signal and do on-air
16       frequency measurement tests. Fldigi features basic rig control,
17       logging, and contest operation, “panoramic” PSK decoding, a PSK
18       Reporter client, and remote control via XML-RPC.
19

OPTIONS

21       Long options begin with two hyphens and are handled by fldigi. The
22       option names may be abbreviated to any unambiguous substring, and the
23       option argument may be separated from the name by a space or equals
24       sign, as per getopt(3).
25
26       Short options begin with a single hyphen and are passed directly to
27       FLTK. They may be abbreviated only as indicated.
28
29       --config-dir DIRECTORY
30           Look for and store configuration files in directory DIRECTORY,
31           which is created if it does not exist. Defaults to “$HOME/.fldigi”.
32
33       --rx-ipc-key KEY
34           Set the receive message queue key. May be given in hex if prefixed
35           with “0x”. Defaults to “9876” or “0x2694”.
36
37       --tx-ipc-key KEY
38           Set the transmit message queue key. May be given in hex if prefixed
39           with “0x”. Defaults to “6789” or “0x1a85”.
40
41       --arq-server-address HOSTNAME
42           Set the ARQ TCP server address. Defaults to “127.0.0.1”.  HOSTNAME
43           may be any node name string accepted by getaddrinfo(3).
44
45       --arq-server-port PORT
46           Set the ARQ TCP server port. Defaults to “7322”.  PORT may be any
47           service name string accepted by getaddrinfo(3).
48
49           Note
50           The --xmlrpc-* options are only available if fldigi was built with
51           XML-RPC support.
52
53       --xmlrpc-server-address HOSTNAME
54           Set the XML-RPC server address. Defaults to “127.0.0.1”.
55
56       --xmlrpc-server-port PORT
57           Set the XML-RPC server port. Defaults to “7362”.
58
59       --xmlrpc-allow REGEX
60           Allow only the methods whose names match REGEX.  REGEX is a POSIX
61           extended regular expression.
62
63       --xmlrpc-deny REGEX
64           Allow only the methods whose names do not match REGEX.
65
66       --xmlrpc-list
67           List all available XML-RPC methods and exit. May be preceded by the
68           --xmlrpc-allow or --xmlrpc-deny options to verify their effect.
69
70       --cpu-speed-test
71           Perform the CPU speed test that is normally done when fldigi is run
72           without an existing configuration directory. Results are shown in
73           the event log and options may be changed to the recommended values
74           for the measured CPU speed.
75
76       --noise
77           Unhide controls for adding noise to the transmitted signal.
78
79       --wfall-only
80           Hide all main window widgets except the menu bar and waterfall
81           (with its associated controls). Meant to be used with external
82           programs that control fldigi with XML-RPC.
83
84       --debug-level LEVEL
85           Set the event log verbosity.  LEVEL is clamped to the range [0,5];
86           for Quiet, Error, Warning, Info, Verbose and Debug. Defaults to “3”
87           (Info).
88
89       --version
90           Print version information and exit.
91
92       --build-info
93           Print build information and exit.
94
95       --help
96           Print options summary and exit.
97
98   Standard FLTK options
99       -bg, -background COLOUR
100           Set the background colour.
101
102       -bg2, -background2 COLOUR
103           Set the secondary (text) background colour.
104
105       -di, -display DISPLAY
106           Specifies the X server to connect to; see X(7).
107
108       -dn, -dnd or -nodn, -nodnd
109           Enable or disable drag and drop copy and paste in text fields.
110
111       -fg, -foreground COLOUR
112           Set the foreground colour.
113
114       -g, -geometry GEOMETRY
115           Set the initial window size and position.  Fldigi may not honour
116           this option.
117
118       -i, -iconic
119           Start fldigi in iconified state.  Fldigi may not honour this
120           option.
121
122       -k, -kbd or -nok, -nokbd
123           Enable or disable visible keyboard focus in non-text widgets.
124
125       -na, -name CLASSNAME
126           Set the window class. Defaults to “Fldigi”.
127
128       -ti, -title WINDOWTITLE
129           Set the window title. Defaults to “fldigi - <callsign>”.
130
131   Additional UI options
132       --font FONT[:SIZE]
133           Set the widget font and (optionally) size. Defaults to “sans:12”.
134
135   Options useful to developers
136           Note
137           The --benchmark-* options are only enabled if fldigi was built
138           (exclusively) for benchmarking and batch decoding.
139
140       --benchmark-modem ID
141           Specify the modem. Defaults to “25” (“BPSK31”).
142
143       --benchmark-frequency FREQ
144           Set the modem frequency in Hz. Defaults to “1000”.
145
146       --benchmark-afc BOOLEAN
147           Enable or disable modem AFC. Defaults to “false”.
148
149       --benchmark-squelch BOOLEAN
150           Enable or disable modem squelch. Defaults to “false”.
151
152       --benchmark-squelch-level LEVEL
153           Set the modem squelch level (1—100%). Defaults to “0.0”.
154
155       --benchmark-input INPUT
156           Specify the input. Must be a positive integer indicating the number
157           of samples of silence to generate as the input, or, if fldigi was
158           linked with libsndfile, the name of the input audio file. The
159           filename must contain non-digit characters.
160
161       --benchmark-output FILE
162           Specify the output data file. Non-textual output (i.e.
163           Hellschreiber or MFSK images) cannot be saved. Default: decoder
164           output is discarded.
165
166       --benchmark-src-ratio RATIO
167           Specify the sample rate conversion ratio. Defaults to “1.0” (input
168           is not resampled).
169
170       --benchmark-src-type TYPE
171           Set the sample rate conversion type. TYPE is an integer in the
172           range [0,4]. Defaults to “2” (“Fastest SINC Interpolator”).
173
174           Warning
175           The following options should not be relied upon. They are listed
176           here only for the sake of completeness, and may be replaced by GUI
177           settings or removed altogether in a future version.
178
179       --wfall-width WIDTH
180           Set the waterfall width.
181
182       --wfall-height HEIGHT
183           Set the waterfall height.
184
185       --window-width WIDTH
186           Set the minimum window width.
187
188       --window-height HEIGHT
189           Set the minimum window height.
190
191       --exit-after SECONDS
192           Run for approximately SECONDS seconds.
193
194       --frames-per-buffer FRAMES
195           Set frames per buffer option to FRAMES when creating PortAudio
196           streams. Defaults to “0” (let PortAudio choose).
197

ENVIRONMENT

199       Fldigi uses several environment variables, mainly set for child
200       processes created by the <EXEC> macro and the notifier.
201
202   General variables
203       FLDIGI_BROWSER
204           The web browser to use for http and file URIs. Overrides $BROWSER
205           and xdg-open(1).
206
207   Macro variables
208       The following variables are created in the environment of the child
209       process that is forked by the <EXEC> macro. They are empty if values
210       are not available.
211
212       FLDIGI_RX_IPC_KEY
213           The receive message queue key.
214
215       FLDIGI_TX_IPC_KEY
216           The transmit message queue key.
217
218       FLDIGI_XMLRPC_ADDRESS
219           The XML-RPC server address string.
220
221       FLDIGI_XMLRPC_PORT
222           The XML-RPC server port string.
223
224       FLDIGI_ARQ_ADDRESS
225           The ARQ server address string.
226
227       FLDIGI_ARQ_PORT
228           The ARQ server port string.
229
230       FLDIGI_VERSION
231           The version string.
232
233       FLDIGI_PID
234           The process ID of the parent fldigi process.
235
236       FLDIGI_CONFIG_DIR
237           The configuration directory.
238
239       FLDIGI_MY_CALL
240           The operator’s callsign.
241
242       FLDIGI_MY_NAME
243           The operator’s name.
244
245       FLDIGI_MY_LOCATOR
246           The operator’s IARU (Maidenhead) locator.
247
248       FLDIGI_MODEM
249           The short modem name.
250
251       FLDIGI_MODEM_LONG_NAME
252           The long modem name.
253
254       FLDIGI_DIAL_FREQUENCY
255           The rig (radio) frequency.
256
257       FLDIGI_AUDIO_FREQUENCY
258           The modem (audio) centre frequency.
259
260       FLDIGI_FREQUENCY
261           The actual receive/transmit frequency, i.e. the sum of rig and
262           modem frequencies taking into account the rig sideband.
263
264       FLDIGI_LOG_FREQUENCY
265           The text (frequency in MHz) contained in the QSO Freq log field.
266
267       FLDIGI_LOG_TIME_ON
268           The text (QSO start time) contained in the (time) On log field.
269
270       FLDIGI_LOG_TIME_OFF
271           The text (QSO end time) contained in the (time) Off log field.
272
273       FLDIGI_LOG_CALL
274           The text (other station’s callsign) contained in the Call log
275           field.
276
277       FLDIGI_LOG_NAME
278           The text (other station’s name) contained in the Name log field.
279
280       FLDIGI_LOG_RST_IN
281           The text (received RST) contained in the (RST) In log field.
282
283       FLDIGI_LOG_RST_OUT
284           The text (sent RST) contained in the (RST) Out log field.
285
286       FLDIGI_LOG_QTH
287           The text (other station’s QTH) contained in the QTH log field.
288
289       FLDIGI_LOG_LOCATOR
290           The text (other station’s Maidenhead locator) contained in the Loc
291           log field.
292
293       FLDIGI_LOG_NOTES
294           The text (free-form notes) contained in the Notes log field.
295
296       FLDIGI_AZ
297           The text (azimuth in degrees to other station) contained in the Az
298           log field.
299
300   Notifier variables
301       The following variables are created in the environment of child
302       processes created by the notifier.
303
304       FLDIGI_NOTIFY_STRi
305           These variables (i in [0,9]) contain substrings matched by
306           capturing groups in the event’s regular expression. 0 contains the
307           whole matched text.
308
309       FLDIGI_NOTIFY_STR_NUM
310           The number of substrings available.
311
312       FLDIGI_NOTIFY_CALLSIGN
313           Builtin event types that match callsigns will place the callsign in
314           this variable.
315
316       FLDIGI_NOTIFY_TEXT
317           The complete string that matched the event’s regular expression.
318
319       FLDIGI_NOTIFY_AUDIO_FREQUENCY
320           The modem frequency.
321
322       FLDIGI_NOTIFY_EVENT
323           The event type.
324
325       FLDIGI_NOTIFY_COUNTRY
326           The station’s country name (for events of type "station heard
327           twice").
328
329   Debugging variables
330       The following variables are only used if fldigi was built with
331       debugging support (--enable-debug), or they are only useful when
332       debugging specific modules.
333
334       FLDIGI_NO_EXEC
335           If set, this variable disables glibc’s malloc debugging, which
336           fldigi enables by default when built for debugging.
337
338       FLDIGI_TRACE_LOCKS
339           Traces Fl::lock() calls.
340
341       FLDIGI_HAMLIB_DEBUG
342           Initialises hamlib in debug mode.
343

RESTRICTIONS

345       Fldigi is licensed under the GNU GPL, which grants you the right to run
346       the program for any purpose (freedom 0). However, permission to use it
347       for the transmission of radio signals can only be obtained from the
348       communications authority of your country. When given, this permission
349       almost always comes in the form of an amateur radio license.
350
351       If you do not have an amateur radio license you can still have fun
352       using fldigi as a shortwave listener. One way to do so is by using the
353       builtin PSK Reporter client to submit realtime spots of transmitting
354       stations; see RESOURCES below. All you need is a computer, homebrew SDR
355       receiver, and simple wire antenna!
356

FILES

358       Various files and subdirectories are created in $HOME/.fldigi. Some of
359       the most interesting ones are listed below.
360
361       fldigi_def.xml
362           The main settings file.
363
364       fldigi.prefs
365           The “status” file. Stores window geometries, button states, current
366           modem, current audio frequency, squelch level, and so on.
367
368       status_log.txt
369           The event log.
370
371       macros/macros.mdf
372           The default macro file.
373
374       palettes/
375           This directory contains waterfall palettes.
376
377       scripts/
378           This directory is added to the PATH environment variable of the
379           child process that runs <EXEC> macros.
380
381       logs/
382           This directory contains logged received and sent text (when such
383           logging is enabled), including the default logbook database,
384           logbook.adif.
385
386       images/
387           Received MFSK images are automatically saved in this directory.
388
389       freqanalysis.csv
390           This file is written by the frequency analysis modem. The fields
391           are dial frequency, audio frequency, and offset. See documentation
392           for details.
393
394           Note
395           The following files are used if present. They must be downloaded
396           and copied to ~/.fldigi/ by the user.
397
398       cty.dat
399           List of DXCC entities and callsign prefixes; used to display
400           tooltips in the received text buffer, and also to auto-fill the
401           Country, Locator and Azimuth log fields. Available at
402           http://www.country-files.com/cty/.
403
404       lotw1.txt
405           List of known LOTW users (one callsign per line); used for the
406           received text tooltips. Available at http://www.hb9bza.net/lotw/.
407
408       AGMemberList.txt or eqsl.txt
409           List of “Authenticity Guaranteed” eQSL users (one callsign per
410           line); used for the received text tooltips. Available at
411           http://www.eqsl.cc/QSLcard/Programming.cfm.
412

EXAMPLES

414       fldigi --wfall-height 144 --font sans:11 -fg "#c0c0c0" -bg "#5f5f63"
415       -bg2 "#19213b"
416           This is how the author of this document invokes fldigi.
417
418       fldigi --xmlrpc-deny "main.(tx|tune|run_macro)"
419           Unregister XML-RPC methods that may transmit.
420
421       ssh -L 7362:localhost:7362 remote-host xvfb-run fldigi -display :99
422           Start fldigi on remote-host under a “fake” X server. (The
423           xvfb-run(1) utility is available on Debian systems). The remote
424           “headless” fldigi is then controlled via XML-RPC on port 7362, i.e
425           from flrig, flamp etc.
426
427       fldigi --benchmark-input 480000 --benchmark-modem 1
428           Benchmark the DominoEX-4 modem with 480K audio samples.
429
430       fldigi --benchmark-input audio.wav --benchmark-modem 25
431       --benchmark-frequency 1500 --benchmark-afc 1 --benchmark-squelch 1
432       --benchmark-squelch-level 5.0 --benchmark-output out.txt
433           Read audio.wav (whose sample rate must be 8000Hz in this case) and
434           decode BPSK-31 signals at 1500Hz. AFC is enabled and the squelch is
435           set to 5%. Decoded text is saved to out.txt.
436

BUGS

438       Yes.
439

SEE ALSO

441       fldigi-shell(1), gmfsk(1), gpsk31(1), grig(1), rigctl(1), xlog(1),
442       getaddrinfo(3), getopt(3), regex(7), X(7)
443

RESOURCES

445       Main web site: http://www.w1hkj.com/Fldigi.html
446
447       Sourceforge project page: http://sourceforge.net/projects/fldigi/
448
449       Wiki and bug tracker: https://fedorahosted.org/fldigi/
450
451       More information on MFSK16, DominoEX and other digital modes can be
452       found at http://www.qsl.net/zl1bpu/ and
453       http://www.w1hkj.com/FldigiHelp/Modes/index.htm
454
455       The PSK Automatic Propagation Reporter site can be found at
456       http://www.pskreporter.info/
457

AUTHORS

459       Fldigi was written by
460
461       •   David Freese, W1HKJ.
462
463       •   Stelios Bounanos, M0GLD.
464
465       •   Leigh L. Klotz, Jr., WA5ZNU.
466
467       Fldigi also includes code written by others. Among them are
468
469       •   Tomi Manninen, OH2BNS.
470
471       •   Pawel Jalocha, SP9VRC.
472
473       •   Hamish Moffatt, VK3SB.
474
475       This manual page was written by Stelios Bounanos
476       <sb[at]enotty(dot)net>.
477

COPYING

479       License GPLv3+: GNU GPL version 3 or later.
480
481
482
483                                  09/02/2022                         FLDIGI(1)
Impressum