diff --git a/Makefile.am b/Makefile.am index 9b180577..04f0d204 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,7 +1,7 @@ ACLOCAL_AMFLAGS = -I m4 -I m4/intl # AC_CONFIG_MACRO_DIR([m4]) -SUBDIRS = po src +SUBDIRS = po doc src if HAVE_FLUID flgen: diff --git a/configure.ac b/configure.ac index 8edffd98..35ca3691 100644 --- a/configure.ac +++ b/configure.ac @@ -1,7 +1,7 @@ # -*- Autoconf -*- # Process this file with autoconf to produce a configure script. -AC_COPYRIGHT([Copyright (C) 2007, 2008 Stelios Bounanos, M0GLD (m0gld AT enotty DOT net)]) +AC_COPYRIGHT([Copyright (C) 2007, 2008, 2009 Stelios Bounanos, M0GLD (m0gld AT enotty DOT net)]) AC_PREREQ(2.61) @@ -31,7 +31,7 @@ AC_CANONICAL_HOST # define target, target_cpu, target_vendor, target_os AC_CANONICAL_TARGET -AM_INIT_AUTOMAKE([-Wall foreign std-options dist-bzip2 1.9.6]) +AM_INIT_AUTOMAKE([-Wall foreign std-options 1.9.6]) AM_MAINTAINER_MODE AC_CONFIG_SRCDIR([src/main.cxx]) AC_CONFIG_HEADER([src/config.h]) @@ -232,6 +232,11 @@ AM_CONDITIONAL([NEED_HAMLIB_LOCATOR], [test "$need_locator_c" = "yes"], [:]) # (default to LIBINTL) AC_FLDIGI_INTL +### asciidoc +# substitute ASCIIDOC and A2X in doc/Makefile +# set HAVE_ASCIIDOC Makefile conditional +AC_FLDIGI_DOCS + ### output AH_TOP([ @@ -242,7 +247,7 @@ AH_BOTTOM([ #include "util.h" #endif /* CONFIG_H_ */ ]) -AC_CONFIG_FILES([Makefile src/Makefile po/Makefile.in]) +AC_CONFIG_FILES([Makefile src/Makefile po/Makefile.in doc/Makefile]) AC_OUTPUT diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 00000000..16d860a9 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,56 @@ +# Copyright (C) 2009 Stelios Bounanos, M0GLD (m0gld AT enotty DOT net) + +ASCIIDOC_CONF = asciidoc.conf +ASCIIDOC_SRC = fldigi.1.txt fldigi-shell.1.txt guide.txt +ASCIIDOC_MAN_DIST = fldigi.1 fldigi-shell.1 +ASCIIDOC_MAN_INST = fldigi.1 +if ENABLE_XMLRPC + ASCIIDOC_MAN_INST += fldigi-shell.1 +endif +ASCIIDOC_HTML = guide.html + +EXTRA_DIST = $(ASCIIDOC_CONF) $(ASCIIDOC_SRC) $(ASCIIDOC_MAN_DIST) + +man_MANS = $(ASCIIDOC_MAN_INST) +MOSTLYCLEANFILES = *.xml +DISTCLEANFILES = $(ASCIIDOC_HTML) +MAINTAINERCLEANFILES = $(ASCIIDOC_MAN_INST) + +A2X_ARGS = --format=manpage --destination-dir=$(builddir)/../doc +if HAVE_ASCIIDOC_NO_XMLLINT + A2X_ARGS += --no-xmllint +endif + +.SECONDEXPANSION: + +%.1: $$@.txt $(ASCIIDOC_CONF) +if HAVE_ASCIIDOC + $(A2X) $(A2X_ARGS) $< +else + echo '.TH "NOT-BUILT" "1" "" "" ""' > $@ +endif +# Without .SECONDEXPANSION we would use something like this: +#$(ASCIIDOC_MAN_INST): asciidoc.conf +# a2x $(A2X_ARGS) $@.txt +#fldigi.1: fldigi.1.txt +#fldigi-shell.1: fldigi-shell.1.txt + +# The rest of the Makefile is enabled only if we have asciidoc +if HAVE_ASCIIDOC + +ASCIIDOC_ICONS_DIR ?= /usr/share/asciidoc/images/icons +# Additional attributes are defined in guide.conf +ASCIIDOC_ARGS = --unsafe -a toc -a data-uri -a badges -a icons -a iconsdir=$(ASCIIDOC_ICONS_DIR) + +%.html: $$*.txt $(ASCIIDOC_CONF) + @if ! test -d $(ASCIIDOC_ICONS_DIR); then \ + echo " *** The default asciidoc icons directory, \"$(ASCIIDOC_ICONS_DIR)\", does not exist." >&2; \ + echo " *** Please rerun make with the correct ASCIIDOC_ICONS_DIR, e.g.:" >&2; \ + echo " *** make ASCIIDOC_ICONS_DIR=/path/to/icons" >&2; \ + false; \ + fi + $(ASCIIDOC) $(ASCIIDOC_ARGS) --out-file $@ $< + +all-local: $(ASCIIDOC_MAN_DIST) $(ASCIIDOC_HTML) + +endif diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf new file mode 100644 index 00000000..b5d4a7af --- /dev/null +++ b/doc/asciidoc.conf @@ -0,0 +1,2 @@ +[miscellaneous] +newline=\n diff --git a/doc/fldigi-shell.1.txt b/doc/fldigi-shell.1.txt new file mode 100644 index 00000000..e9d42ab7 --- /dev/null +++ b/doc/fldigi-shell.1.txt @@ -0,0 +1,151 @@ +FLDIGI-SHELL(1) +=============== + + +== NAME == +fldigi-shell - program for controlling fldigi + + +== SYNOPSIS == +*fldigi-shell* ['OPTIONS'] ['FILE'] + + +== DESCRIPTION == +The fldigi-shell program controls +fldigi(1)+ over HTTP via XML-encoded remote +procedure calls (XML-RPC). It can call any XML-RPC method exported by fldigi, +and also defines some useful commands of its own. + + +== OPTIONS == +*-d*:: + Enable debug output. + +*-u* 'URL':: + Use 'URL' to access the server. Defaults to ``http://localhost:7362/RPC2'', + which corresponds to fldigi's default listen address and port. + +*-c* 'COMMAND':: + Execute command 'COMMAND' and exit. + + +== COMMANDS == +[NOTE] +================================================================================ +The ``x:yz'' notation refers to the return type and argument type(s). They are: +``n'' (nil), ``i'' (integer), and ``s'' (string). +================================================================================ + +debug (n:n:):: + Toggle debug output. + +eval (s:s):: + Evaluate Perl code. + +exit (n:n):: + Exit the shell. + +help (n:n):: + Print help for server (fldigi) methods and shell commands. + +history (s:n):: + Print command history. + +modems (s:n):: + List all modem names. + +poll (s:i):: + Poll for new received text every 'i' seconds. Defaults to '1'. + +pskrqsy (n:si):: + QSY to 'i'^th^ best frequency for grid 's'. The list of frequencies is + retrieved from the PSK Reporter website; see *RESOURCES*. The grid square + string may be left empty, and the index argument defaults to '0' (first + frequency). + +recvtext (s:n):: + Get all received text. + +reinit (n:n):: + Fetch commands from the server and rebuild command list. + +send (n:s):: + Send text interactively, one line at a time. + +sendchar (n:s):: + Send text interactively, one character at a time. + +sendfile (n:s):: + Send text read from file 's'. + +sendstr (n:s):: + Send string 's'. + +source (n:s):: + Read commands from file 's'. + +time (s:s):: + Time a command. + +wait (n:s):: + Wait for server TRX state to become 's'. + + +== EXTENDED DESCRIPTION == +The shell has three modes of operation: + +. Interactive mode with history, tab completion and command line editing. This + is the default mode when fldigi-shell is run without arguments. + +. Batch mode for a single command with the *-c* option. + +. Batch mode to ``source'' a file containing Perl code. Fldigi-shell commands + can be called using ``execute("COMMAND [ARG ...]")'' calls. + + +== FILES == +$HOME/.fldigi/shell-history:: + Contains the fldigi-shell command history. + + +== EXAMPLES == ++while :; do fldigi-shell -c pskrqsy; sleep 900; done+:: + Change to the ``best frequency'' (see PSK Reporter) every fifteen minutes. + + +== SEE ALSO == +fldigi(1), xmlrpc(1), readline(3), RPC::XML(3pm) + + +== BUGS == +* Some additional command wrappers are needed. +* Command completion should be enabled for the arguments of some commands. +* The XML-RPC handling code should probably go in a separate module. +* It should be possible to pass multiple '-c CMD' arguments. + + +== RESOURCES == +Fldigi web site: http://www.w1hkj.com/Fldigi.html + +The PSK Automatic Propagation Reporter site can be found at +http://www.pskreporter.info/ + +The GNU Readline Library: http://directory.fsf.org/project/readline/ + +XML-RPC home page: http://www.xmlrpc.com/ + + +== AUTHOR == +Fldigi-shell and this manual page were written by Stelios Bounanos, +M0GLD+ +. + + +== COPYING == +License GPLv2+: GNU GPL version 2 or later. + + +//////////////////////////////////////////////////////////////////////////////// +// Emacs settings +// Local Variables: +// mode: doc +// End: +//////////////////////////////////////////////////////////////////////////////// diff --git a/doc/fldigi.1.txt b/doc/fldigi.1.txt new file mode 100644 index 00000000..965cfd4a --- /dev/null +++ b/doc/fldigi.1.txt @@ -0,0 +1,443 @@ +FLDIGI(1) +========= + + +== NAME == +fldigi - digital modem program for hamradio operators + + +== SYNOPSIS == +*fldigi* ['OPTIONS'] + + +== DESCRIPTION == +*Fldigi* is a cross-platform multi-modem program for most of the digital modes +used by radio amateurs today: CW, PSK, MFSK, MT-63, RTTY, Hellschreiber, +DominoEX, Olivia, THOR and Throb are all supported. It can also help calibrate a +sound card to a time signal and do on-air frequency measurement tests. Fldigi +features basic rig control, logging, and contest operation, ``panoramic'' PSK +decoding, a PSK Reporter client, and remote control via XML-RPC. + + +== OPTIONS == +Long options begin with two hyphens and are handled by fldigi. The option names +may be abbreviated to any unambiguous substring, and the option argument may be +separated from the name by a space or equals sign, as per +getopt(3)+. + +Short options begin with a single hyphen and are passed directly to FLTK. They +may be abbreviated only as indicated. + +*--config-dir* 'DIRECTORY':: + Look for and store configuration files in directory 'DIRECTORY', which is + created if it does not exist. Defaults to ``$HOME/.fldigi''. + +*--rx-ipc-key* 'KEY':: + Set the receive message queue key. May be given in hex if prefixed with + ``0x''. Defaults to ``9876'' or ``0x2694''. + +*--tx-ipc-key* 'KEY':: + Set the transmit message queue key. May be given in hex if prefixed with + ``0x''. Defaults to ``6789'' or ``0x1a85''. + +*--arq-server-address* 'HOSTNAME':: + Set the ARQ TCP server address. Defaults to ``127.0.0.1''. 'HOSTNAME' may be + any 'node name' string accepted by +getaddrinfo(3)+. + +*--arq-server-port* 'PORT':: + Set the ARQ TCP server port. Defaults to ``7322''. 'PORT' may be any 'service + name' string accepted by +getaddrinfo(3)+. + +[NOTE] +================================================================================ +The '--xmlrpc-*' options are only available if fldigi was built with XML-RPC +support. +================================================================================ + +*--xmlrpc-server-address* 'HOSTNAME':: + Set the XML-RPC server address. Defaults to ``127.0.0.1''. + +*--xmlrpc-server-port* 'PORT':: + Set the XML-RPC server port. Defaults to ``7362''. + +*--xmlrpc-allow* 'REGEX':: + Allow only the methods whose names match 'REGEX'. 'REGEX' is a POSIX extended + regular expression. + +*--xmlrpc-deny* 'REGEX':: + Allow only the methods whose names do not match 'REGEX'. + +*--xmlrpc-list*:: + List all available XML-RPC methods and exit. May be preceded by the + '--xmlrpc-allow' or '--xmlrpc-deny' options to verify their effect. + +*--debug-level* 'LEVEL':: + Set the event log verbosity. 'LEVEL' is clamped to the range [0,4]; for + 'Quiet', 'Error', 'Warning', 'Info', and 'Debug'. Defaults to ``2'' + ('Warning'). + +*--version*:: + Print version information and exit. + +*--help*:: + Print options summary and exit. + +=== Standard FLTK options === +*-bg, -background* 'COLOUR':: + Set the background colour. + +*-bg2, -background2* 'COLOUR':: + Set the secondary (text) background colour. + +*-di, -display* 'DISPLAY':: + Specifies the X server to connect to; see +X(7)+. + +*-dn, -dnd* or *-nodn, -nodnd*:: + Enable or disable drag and drop copy and paste in text fields. + +*-fg, -foreground* 'COLOUR':: + Set the foreground colour. + +*-g, -geometry* 'GEOMETRY':: + Set the initial window size and position. *Fldigi may not honour this option*. + +*-i, -iconic*:: + Start fldigi in iconified state. *Fldigi may not honour this option*. + +*-k, -kbd* or *-nok, -nokbd*:: + Enable or disable visible keyboard focus in non-text widgets. + +*-na, -name* 'CLASSNAME':: + Set the window class. Defaults to ``Fldigi''. + +*-ti, -title* 'WINDOWTITLE':: + Set the window title. Defaults to ``fldigi - ''. + +=== Additional UI options === +*--font* 'FONT[:SIZE]':: + Set the widget font and (optionally) size. Defaults to ``sans:12''. + +=== Options useful to developers === +[NOTE] +================================================================================ +The --benchmark-* options are only enabled if fldigi was built (exclusively) for +benchmarking and batch decoding. +================================================================================ + +*--benchmark-modem* 'ID':: + Specify the modem. Defaults to ``25'' (``BPSK31''). + +*--benchmark-frequency* 'FREQ':: + Set the modem frequency in Hz. Defaults to ``1000''. + +*--benchmark-afc* 'BOOLEAN':: + Enable or disable modem AFC. Defaults to ``false''. + +*--benchmark-squelch* 'BOOLEAN':: + Enable or disable modem squelch. Defaults to ``false''. + +*--benchmark-squelch-level* 'LEVEL':: + Set the modem squelch level (1--100%). Defaults to ``0.0''. + +*--benchmark-input* 'INPUT':: + Specify the input. Must be a positive integer indicating the number of samples + of silence to generate as the input, or, if fldigi was linked with libsndfile, + the name of the input audio file. The filename must contain non-digit + characters. + +*--benchmark-output* 'FILE':: + Specify the output data file. Non-textual output (i.e. Hellschreiber or MFSK + images) cannot be saved. Default: decoder output is discarded. + +*--benchmark-src-ratio* 'RATIO':: + Specify the sample rate conversion ratio. Defaults to ``1.0'' (input is not + resampled). + +*--benchmark-src-type* 'TYPE':: + Set the sample rate conversion type. TYPE is an integer in the range + [0,4]. Defaults to ``2'' (``Fastest SINC Interpolator''). + +[WARNING] +================================================================================ +*The following options should not be relied upon. They are listed here only for +the sake of completeness, and may be replaced by GUI settings or removed +altogether in a future version.* +================================================================================ + +*--wfall-width* 'WIDTH':: + Set the waterfall width. + +*--wfall-height* 'HEIGHT':: + Set the waterfall height. + +*--window-width* 'WIDTH':: + Set the minimum window width. + +*--window-height* 'HEIGHT':: + Set the minimum window height. + +*--exit-after* 'SECONDS':: + Run for approximately 'SECONDS' seconds. + +*--frames-per-buf* 'FRAMES':: + Set frames per buffer option to 'FRAMES' when creating PortAudio + streams. Defaults to ``0'' (let PortAudio choose). + +*--pskr-test-str* 'STRING':: + Test the PSK reporter client pattern matching. UTSL! + + +== ENVIRONMENT == +Fldigi uses several environment variables: + +FLDIGI_BROWSER:: + The web browser to use for http and file URIs. Overrides +$BROWSER+ and + +xdg-open(1)+. + +[NOTE] +================================================================================ +The following variables are created in the environment of the child process that +is forked by the '' macro. They are empty if values are not available. +================================================================================ + +FLDIGI_RX_IPC_KEY:: + The receive message queue key. + +FLDIGI_TX_IPC_KEY:: + The transmit message queue key. + +FLDIGI_VERSION:: + The version string. + +FLDIGI_PID:: + The process ID of the parent fldigi process. + +FLDIGI_CONFIG_DIR:: + The configuration directory. + +FLDIGI_MY_CALL:: + The operator's callsign. + +FLDIGI_MY_NAME:: + The operator's name. + +FLDIGI_MY_LOCATOR:: + The operator's IARU locator. + +FLDIGI_MODEM:: + The short modem name. + +FLDIGI_MODEM_LONG_NAME:: + The long modem name. + +FLDIGI_DIAL_FREQUENCY:: + The rig (radio) frequency. + +FLDIGI_AUDIO_FREQUENCY:: + The modem (audio) centre frequency. + +FLDIGI_FREQUENCY:: + The actual receive/transmit frequency, i.e. the sum of rig and modem + frequencies taking into account the rig sideband. + +FLDIGI_LOG_FREQUENCY:: + The text (frequency in MHz) contained in the 'QSO Freq' log field. + +FLDIGI_LOG_TIME_ON:: + The text (QSO start time) contained in the (time) 'On' log field. + +FLDIGI_LOG_TIME_OFF:: + The text (QSO end time) contained in the (time) 'Off' log field. + +FLDIGI_LOG_CALL:: + The text (other station's callsign) contained in the 'Call' log field. + +FLDIGI_LOG_NAME:: + The text (other station's name) contained in the 'Name' log field. + +FLDIGI_LOG_RST_IN:: + The text (received RST) contained in the (RST) 'In' log field. + +FLDIGI_LOG_RST_OUT:: + The text (sent RST) contained in the (RST) 'Out' log field. + +FLDIGI_LOG_QTH:: + The text (other station's QTH) contained in the 'QTH' log field. + +FLDIGI_LOG_LOCATOR:: + The text (other station's IARU locator) contained in the 'Loc' log field. + +FLDIGI_LOG_NOTES:: + The text (free-form notes) contained in the 'Notes' log field. + +FLDIGI_AZ:: + The text (azimuth in degrees to other station) contained in the 'Az' log field. + +[NOTE] +================================================================================ +The following variables are only used if fldigi was built with debugging support +('--enable-debug'), or they are only useful when debugging specific modules. +================================================================================ + +FLDIGI_PSKRTEST_COLOR:: + Forces colour output even if stdout is not a terminal. + +FLDIGI_PSKRTEST_NOTEOL:: + Forces EOL matching. UTSL! + +FLDIGI_NO_EXEC:: + If set, this variable disables glibc's malloc debugging, which fldigi enables + by default when built for debugging. + +FLDIGI_TRACE_LOCKS:: + Traces 'Fl::lock()' calls. + +FLDIGI_HAMLIB_DEBUG:: + Initialises hamlib in debug mode. + + +== RESTRICTIONS == +Fldigi is licensed under the GNU GPL, which grants you the right to run the +program for any purpose (freedom 0). However, permission to use it for the +transmission of radio signals can only be obtained from the communications +authority of your country. When given, this permission almost always comes in +the form of an amateur radio license. + +If you do not have an amateur radio license you can still have fun using fldigi +as a shortwave listener. One way to do so is by using the builtin PSK Reporter +client to submit realtime spots of transmitting stations; see RESOURCES below. +All you need is a computer, homebrew SDR receiver, and simple wire antenna! + + +== FILES == +Various files and subdirectories are created in $HOME/.fldigi. Some of the most +interesting ones are listed below. + +fldigi_def.xml:: + The main settings file. + +fldigi.prefs:: + The ``status'' file. Stores window geometries, button states, current modem, + current audio frequency, squelch level, and so on. + +logbook.adif:: + The default file in which fldigi saves its QSO data. + +status_log.txt:: + The event log. + +macros/macros.mdf:: + The default macro file. + +palettes/:: + This directory contains waterfall palettes. + +scripts/:: + This directory is added to the PATH environment variable of the child process + that runs macros. + +logs/:: + This directory contains logged received and sent text (when such logging is + enabled). + +images/:: + Received MFSK images are automatically saved in this directory. + +freqanalysis.csv:: + This file is written by the frequency analysis modem. The fields are dial + frequency, audio frequency, and offset. See documentation for details. + +[NOTE] +================================================================================ +The following files are used if present. They must be downloaded and copied +to ~/.fldigi/ by the user. +================================================================================ + +cty.dat:: + List of DXCC entities and callsign prefixes; used to display tooltips in the + received text buffer, and also to auto-fill the Country, Locator and Azimuth + log fields. Available at http://www.country-files.com/cty/. + +lotw1.txt:: + List of known LOTW users (one callsign per line); used for the received text + tooltips. Available at http://www.hb9bza.net/lotw/. + +AGMemberList.txt or eqsl.txt:: + List of ``Authenticity Guaranteed'' eQSL users (one callsign per line); used + for the received text tooltips. Available at + http://www.eqsl.cc/QSLcard/Programming.cfm. + + +== EXAMPLES == ++fldigi --wfall-height 144 --font sans:11 -fg "#c0c0c0" -bg "#5f5f63" -bg2 "#19213b"+:: + This is how the author of this document invokes fldigi. + ++fldigi --xmlrpc-deny "main.(tx|tune|run_macro)"+:: + Unregister XML-RPC methods that may transmit. + ++ssh -L 7362:localhost:7362 remote-host xvfb-run fldigi -display :99+:: + Start fldigi on 'remote-host' under a ``fake'' X server. (The +xvfb-run(1)+ + utility is available on Debian systems). The remote ``headless'' fldigi is + then controlled via XML-RPC on port 7362, e.g. using +fldigi-shell(1)+. + ++fldigi --benchmark-input 480000 --benchmark-modem 1+:: + Benchmark the DominoEX-4 modem with 480K audio samples. + ++fldigi --benchmark-input audio.wav --benchmark-modem 25 --benchmark-frequency 1500 --benchmark-afc 1 --benchmark-squelch 1 --benchmark-squelch-level 5.0 --benchmark-output out.txt+:: + Read 'audio.wav' (whose sample rate must be 8000Hz in this case) and decode + BPSK-31 signals at 1500Hz. AFC is enabled and the squelch is set to 5%. + Decoded text is saved to 'out.txt'. + + +== BUGS == +* Batch decoding requires a connection to the X server even though no window is displayed. +* There is no batch encoding mode. +* Probably a few more. + + +== SEE ALSO == +fldigi-shell(1), gmfsk(1), gpsk31(1), grig(1), rigctl(1), xlog(1), +getaddrinfo(3), getopt(3), regex(7), X(7) + + +== RESOURCES == +Main web site: http://www.w1hkj.com/Fldigi.html + +BerliOS project page: http://developer.berlios.de/projects/fldigi/ + +More information on MFSK16, DominoEX and other digital modes can be found at +http://www.qsl.net/zl1bpu/ + +The PSK Automatic Propagation Reporter site can be found at +http://www.pskreporter.info/ + + +== AUTHORS == +Fldigi was written by:: +________________________________________________________________________________ + * David Freese, +W1HKJ+. + * Stelios Bounanos, +M0GLD+. + * Leigh L. Klotz, Jr., +WA5ZNU+. +________________________________________________________________________________ + +Fldigi also includes code written by others. Among them are::: +________________________________________________________________________________ + * Tomi Manninen, +OH2BNS+. + * Pawel Jalocha, +SP9VRC+. + * Hamish Moffatt, +VK3SB+. +________________________________________________________________________________ + ++++ ++++ + +This manual page was written by Stelios Bounanos . + + +== COPYING == +License GPLv2+: GNU GPL version 2 or later. + +//////////////////////////////////////////////////////////////////////////////// +// Emacs settings +// Local Variables: +// mode: doc +// End: +//////////////////////////////////////////////////////////////////////////////// diff --git a/doc/guide.conf b/doc/guide.conf new file mode 100644 index 00000000..d27d4c0b --- /dev/null +++ b/doc/guide.conf @@ -0,0 +1,3 @@ +[attributes] +toclevels=1 +numbered= diff --git a/doc/guide.txt b/doc/guide.txt new file mode 100644 index 00000000..4e002fad --- /dev/null +++ b/doc/guide.txt @@ -0,0 +1,747 @@ +Beginners' Guide to Fldigi +========================== + +// Uncomment the section below to enable the hand written TOC and avoid some +// javascript security warnings with brain-dead browsers. Remember to update +// when changing the sections. +//////////////////////////////////////////////////////////////////////////////// +.Table of Contents +<> + +<> + +<> + +<> + +<> + +// <> +//////////////////////////////////////////////////////////////////////////////// + + +:revision: 3.11 +// Aliases +:docsurl: http://www.w1hkj.com/FldigiHelp/index.html +:docs: {docsurl}[Online Documentation] +:home: http://www.w1hkj.com/Fldigi.html + +// This used to be a subsection titled "Where can I find detailed instructions +// for Fldigi?" +******************************************************************************** +Of necessity, this Beginners' Guide contains only as much as you need to know to +get started. You should learn how to make best use of the program by reading the +{docs}. You can also access it from within the Fldigi program from the 'Help' +menu item. +******************************************************************************** + + +[[ref-beginners-q-a]] +== Beginners' Questions Answered == + +=== What is Fldigi? === +{home}[Fldigi] is a computer program intended for Amateur Radio Digital Modes +operation using a PC (Personal Computer). Fldigi operates (as does most similar +software) in conjunction with a conventional HF SSB radio transceiver, and uses +the PC sound card as the main means of input from the radio, and output to the +radio. These are audio-frequency signals. The software also controls the radio +by means of another connection, typically a serial port. + +Fldigi is multi-mode, which means that it is able to operate many popular +digital modes without switching programs, so you only have one program to +learn. Fldigi includes all the popular modes, such as DominoEX, MFSK16, PSK31, +and RTTY. + +Unusually, Fldigi is available for multiple computer operating systems; +FreeBSD(TM); Linux(TM), OS X(TM) and Windows(TM). + +=== What is a Digital Mode? === +Digital Modes are a means of operating Amateur radio from the computer +keyboard. The computer acts as 'modem' (modulator - demodulator), as well as +allowing you to type, and see what the other person types. It also controls the +transmitter, changes modes as required, and provides various convenient features +such as easy tuning of signals and prearranged messages. + +In this context, we are talking about modes used on the HF (high frequency) +bands, specifically 'chat' modes, those used to have a regular conversation in a +similar way to voice or Morse, where one operator 'talks' for a minute or two, +then another does the same. These chat modes allow multiple operators to take +part in a 'net'. + +Because of sophisticated digital signal processing which takes place inside the +computer, digital modes can offer performance that cannot be achieved using +voice (and in some cases even Morse), through reduced bandwidth, improved +signal-to-noise performance and reduced transmitter power requirement. Some +modes also offer built-in automatic error correction. + +Digital Mode operating procedure is not unlike Morse operation, and many of the +same abbreviations are used. Software such as Fldigi makes this very simple as +most of the procedural business is set up for you using the Function Keys at the +top of the keyboard. These are easy to learn. + +=== Why all the different modes? === +HF propagation is very dependent on the ionosphere, which reflects the signals +back to earth. There are strong interactions between different signals arriving +from different paths. Experience has shown that particular modulation systems, +speeds and bandwidths suit different operating conditions. + +Other factors such as available band space, operating speed and convenience, +noise level, signal level and available power also affect the choice of +mode. While in many cases several different modes might be suitable, having a +choice adds to the operating pleasure. It is difficult to advise which mode is +best for each particular occasion, and experience plays an important role. +footnote:[To gain a good insight into each mode and its capabilities, you might +consider purchasing 'Digital Modes for All Occasions' (ISBN 1-872309-82-8) by +Murray Greenman ZL1BPU, published by the RSGB and also available from +FUNKAMATEUR and CQ Communications; or the ARRL's 'HF Digital Handbook' (ISBN +0-87259-103-4) by Steve Ford, WB8IMY.] + +=== How do I recognise and tune in the signals? === +Recognising the different modes comes with experience. It is a matter of +listening to the signal, and observing the appearance of the signal on the +tuning display. You can also practise transmitting with the transceiver +disconnected, listening to the sound of the signals coming from the +computer. There is also (see later paragraph) an automatic tuning option which +can recognise and tune in most modes for you. + +The software provides a tuning display which shows the radio signals that are +receivable within the transceiver passband. Using a 'point and click' technique +with the mouse, you can click on the centre of a signal to select it, and the +software will tune it in for you. Some modes require more care than others, and +of course you need to have the software set for the correct mode first — not +always so easy! + +The <> (automatic mode detection and tuning) feature uses a +special sequence of tones transmitted at the beginning of each transmission to +identify and tune in the signals received. For this feature to work, not only do +you need to enable the feature in the receiver, but in addition the stations you +are wishing to tune in need to have this feature enabled on transmission. Other +programs also offer this RSID feature as an option. + + +[[ref-setting-up]] +== Setting Up == + +=== Fldigi settings === +.Essentials +* Use the menu +Configure->Operator+ item to set the operator name, callsign, + locator and so on. + +* If you have more than one sound card, use the menu +Configure->Sound Card+, + +Audio Devices+ tab, to select the sound card you wish to use. You can ignore + the other tabs for now. + +.Rig Control +* Use the menu +Configure->Rig Control+ item to set how you will control the + rig. If you will key the rig via a serial port, in the +Hardware PTT+ tab + select 'Use serial port PTT', the device name you will use, and which line + controls PTT. If in doubt, check both 'RTS' and 'DTR'. You *must* then press + the +Initialize+ button. + +* If you plan to use CAT control of the rig via the COM port, check 'Use Hamlib' + in the +Hamlib+ tab. Select your rig model from the drop-down menu and set the + serial port device name, baud rate, and RTS/CTS options as needed. If in + addition you wish to use PTT control via CAT, also check 'PTT via Hamlib + command'. You *must* then press the +Initialize+ button. + +[NOTE] +================================================================================ +If your rig is CAT-capable but not yet supported by +http://www.hamlib.org/[Hamlib], it may still be possible to control it via +Fldigi's +RigCAT+ system. Refer to the {docs} for details. +================================================================================ + +// The above paragraph & note replace this one: +//////////////////////////////////////////////////////////////////////////////// +* If you plan to use CAT control of the rig via the COM port, check 'Use RigCAT' + in the RigCAT tab. If in addition you wish to use PTT control via CAT, also then + check 'PTT via CAT command'. You *must* then press the +Initialize+ button. +//////////////////////////////////////////////////////////////////////////////// + +.CPU Speed +* When you start Fldigi for the very first time, it makes a series of + measurements to determine your computer's processing speed. Although these + measurements are usually accurate, if you have a very slow processor (under + 700MHz), you should verify that 'Slow CPU' under +Configure->Misc->CPU+ has + been enabled. The receiver decoding strategy of certain modems uses fewer + processor cycles in this mode. + +.Modems +* Each of the modems can be individually set up from the +Configure->Modems+ + multi-tabbed dialog. You need not change anything here to start with, although + it might be a good idea to set the 'secondary text' for DominoEX and THOR to + something useful, such as your call and locator. footnote:[Secondary text is + transmitted when the text you type does not keep up with the typing speed of + the mode — this handy text appears in a small window at the very bottom of the + screen.] Note that this set of tabs is also where you set the RTTY modem speed + and shift, although the default values should be fine for normal operation. + +.Other settings +* Use the menu +Configure->UI+, +Restart+ tab, to set the aspect ratio of the + waterfall display and whether or not you want to dock a second digiscope to + the main window. + +* Use the menu +Configure->IDs+ item to set whether you wish to transmit RSID + data at the start of each over (this is for the benefit of others and does not + affect RSID reception). If you plan to regularly use the RSID feature on + receive, you should deselect the option that starts new modems at the ``sweet + spot'' frequencies in +Misc->Sweet Spot+. + +Finally, use the menu item +Configure->Save Config+ to save the new +configuration. + +=== Sound Card Mixer === +* Use your sound card 'Master Volume' applet to select the sound card, the Wave + output and set the transmit audio level. You can check the level using the + <> button, top right, beyond the Menu. + +* On Windows, the 'Volume' applet can usually be opened by clicking + +Start->Run…+ and entering +sndvol32+, or from the Control Panel. + +* Use your sound card 'Recording Control' applet to select the sound card, the + Line or Mic input and set the receiver audio level. Watch the waterfall + display for receiver noise when setting the level. If you see any dark blue + noise, you have the right input and about the right level. The actual setting + is not very important, provided you see blue noise. If the audio level is too + high, the little diamond shaped indicator (bottom right) will show red. The + waterfall may also show red bands. Performance will be degraded if the level + is too high. + +* On Windows, the 'Record' applet can usually be opened by clicking + +Start->Run…+ and entering +sndvol32+, or from the Control Panel. If opened + from the Control Panel, you'll end up with the Master Volume applet, and need + to switch using +Options->Properties+, and selecting the +Recording+ radio + button. + + +[[ref-guided-tour]] +== Guided Tour == + +The main window consists of three main panes. Study it carefully as you read +these notes. From top to bottom, these are the Receive pane (navajo white), the +Transmit pane (light cyan), and the Waterfall pane (black). At the top is the +collection of entry items which form the Log Data, and at the very top, a +conventional drop-down Menu system, with entries for File, Op Mode, Configure, +View and Help. + +Between the Transmit and the Waterfall panes is a line of boxes (buttons) which +represent the Function Keys F1 - F12. This is the Macro group. Below the +Waterfall pane is another line of boxes (buttons), which provide various control +features. This is the Controls group. The program and various buttons can mostly +be operated using the mouse or the keyboard, and users generally find it +convenient to use the mouse while tuning around, and the keyboard and function +keys during a QSO. + +[[ref-receive-pane]] +=== Receive Pane === +This is where the text from decoded incoming signals is displayed, in black +text. When you transmit, the transmitted text is also displayed here, but in red, +so the Receive pane becomes a complete record of the QSO. The information in +this pane can also be logged to a file. + +The line at the bottom of this pane can be dragged up and down with the +mouse. You might prefer to drag it down a bit to enlarge the Receive pane and +reduce the size of the Transmit pane. + +=== Transmit Pane === +This is where you type what you want to transmit. The mouse must click in here +before you type (to obtain 'focus') otherwise your text will go nowhere. You can +type in here while you are receiving, and when you start transmitting, the text +already typed will be sent first. This trick is a cool way to impress others +with your typing speed! As the text is transmitted, the text colour changes from +black to red. At the end of the over, all the transmitted text (and any as yet +not transmitted) will be deleted. + +=== Waterfall Pane === +This is the main tuning facility. There are three modes, Waterfall, FFT and +Signal, selected by a button in the Control group. For now, leave it in +Waterfall mode, as this is the easiest to tune with, and gives the best +identification of the signal. + +[horizontal] +*+WF+* (Waterfall):: + A spectrogram display of signal strength versus frequency over passing + time. The receiver passband is analysed and displayed with lower frequencies + to the left, higher to the right. Weak signals and background noise are dark + while stronger signals show as brighter colours. As time passes (over a few + seconds), the historic signals move downwards like a waterfall. + +*+FFT+* (Fast Fourier Transform):: + A spectrum display of the mean signal strength versus frequency. Again + frequency is displayed from left to right, but now the vertical direction + shows signal strength and there is no brightness or historic information. + +*+SIG+* (Signal):: + An oscilloscope type of display showing the raw audio being captured by the + sound card. + +At the top of the pane is a scale of frequency in Hz, which corresponds to the +frequency displayed immediately below it. This scale can be moved around and +zoomed using buttons in the Control group. + +As you move the mouse around in this pane you will see a yellow group of tuning +marks following the mouse pointer. Tuning is achieved by left-clicking on a +signal displayed by the waterfall in this pane. Use these yellow marks to +exactly straddle the signal and then left-click on the centre of the signal. The +tuning marks change to red. The red vertical lines will show the approximate +width of the active signal area (the expected signal bandwidth), while a red +horizontal bar above will indicate the receiver software's active decoding +range. When you left-click, the red marks move to where you clicked, and will +attempt to auto-track the signal from there. + +[TIP] +.Audio history and ``casual tuning'' +================================================================================ +You can temporarily ``monitor'' a different signal by right-clicking on it. As +long as you hold the mouse button down, the signal under it will be decoded; as +soon as you release the mouse, decoding will revert to the previously tuned spot +(where the red marks are). If you also hold the +Control+ key down before +right-clicking, Fldigi will first decode all of its buffered audio at that +frequency. +================================================================================ + +=== Log Data === +Fldigi provides two QSO entry views, one for casual QSO logging and the second +for contesting. The +View->Contest fields+ menu item switches between the two +modes. + +The 'Frequency', 'Time Off', and (when in contest mode) '#Out' fields are filled +by the program. All the others can be populated by manual keyboard entry or by +selection from the <>. The 'Time Off' field is +continuously updated with the current GMT time. The 'Time On' field will be +filled in when the 'Call' is updated, but can be modified later by the operator. + +A right click on the Receive pane brings up a context sensitive menu that will +reflect which of the two QSO capture views you have open. If you highlight text +in the Receive pane then the menu selection will operate on that text. If you +simply point to a word of text and right click then the menu selection will +operate on the single word. + +[TIP] +.Quick log entry +================================================================================ +Certain fields ('Call', 'Name', 'RST In', 'QTH' and 'Locator') may also be +populated semi-automatically. Point to a word in the Receive pane and either +double-left-click or hold a Shift key down and left-click. The program will +then use some simple heuristics to decide which log field will receive the text. +================================================================================ + +It is generally not possible to distinguish between Operator and QTH names. For +this reason, Fldigi will use the first non-Call and non-Locator word to fill the +'Name' field, and subsequent clicks will send text to the 'QTH' field. +Likewise, a text string may be both a valid callsign and a valid +http://en.wikipedia.org/wiki/Maidenhead_Locator_System[IARU locator]. For best +results, you should attempt to fill the log fields in the order in which they +appear on the main window, and clear the log fields after logging the QSO. Of +course, text can always be manually typed or pasted into any of the log fields! + +You can query online and local (e.g. CD) database systems for data regarding a +callsign. You make the query by either clicking on the globe button, or +selecting 'Look up call' from the popup menu. The latter will also move the +call to the 'Call' field. + +When the 'Call' field is filled in, the logbook will be searched for the most +recent QSO with that station and, if an entry is found, the 'Name', 'QTH' and +other fields will be pre-filled. If the logbook dialog is open, that last QSO +will also be selected for viewing in the logbook. + +You open the logbook by selecting from the View menu; +View->Logbook+. The +logbook title bar will show you which logbook you currently have open. Fldigi +can maintain an unlimited (except for disk space) number of logbooks. + +=== Menu === +At the very top of the program window is a conventional drop-down menu. If you +click on any of the items, a list of optional functions will appear. Keyboard +menu selection is also provided. Where underscored characters are shown in the +menu, you can select these menu items from the keyboard using the marked +character and +Alt+ at the same time, then moving around with the ++up+/+down+/+left+/+right+ keys. Press +Esc+ to quit from the menu with no +change. + +==== Menu functions ==== + +.File +Allows you to open or save Macros (we won't get into that here), turn on/off +logging to file, record/play audio samples, and exit the program. You can also +exit the program by clicking on the +X+ in the top right corner of the window, +in the usual manner. + +.Op Mode +This is where you select the operating modem used for transmission and +reception. Some modes only have one option. Where more are offered, drag the +mouse down the list and sideways following the arrow to a secondary list, before +releasing it. When you start the program next time, it will remember the last +mode you used. + +Not all the modes are widely used, so choose a mode which _(a)_ maximises your +chance of a QSO, and _(b)_ is appropriate for the band, conditions, bandwidth +requirements and permissions relevant to your operating licence. + +At the bottom of the list are two ``modes'' which aren't modes at all, and do not +transmit (see {docs} for details). 'WWV' mode allows you to receive a +standard time signal so the beeps it transmits can be used for sound card +calibration. 'Freq Analysis' provides just a waterfall display with a very +narrow cursor, and a frequency meter which indicates the received frequency in +Hz to two decimal places. This is useful for on-air frequency measurement. + +.Configure +This is where you set up the program to suit your computer, yourself and your +operating preferences. The operating settings of the program are grouped into +several categories and there are menu items in which you enter your personal +information, or define your computer sound card, for example. Modems can be +individually changed, each having different adjustments. The Modems dialog has +multiple tabs, so you can edit any one of them. Don't fool with the settings +until you know what you are doing! The final item, +Save Config+ allows you to +save the altered configuration for next time you start the program (otherwise +changes are temporary). + +.View +This menu item allows you to open extra windows. Most will be greyed out, but +two that are available are the Digiscope, and the PSK Browser. The Digiscope +provides a mode-specific graphical analysis of the received signal, and can have +more than one view (left click in the new window to change the view), or maybe +none at all. The PSK Browser is a rather cool tool that allows you to monitor +several PSK31 signals all at the same time! These windows can be resized to +suit. + +.Help +Brings up the Online Documentation, the Fldigi Home Page, and various +information about the program. + +==== Other controls ==== + +[[ref-rsid]] +.RSID +This button turns on the receive RSID (automatic mode detection and tuning) +feature. When in use, the button turns yellow and no text reception is possible +until a signal is identified, or the feature is turned off again. If you plan to +use the RSID feature on receive, you must leave the 'Start New Modem at Sweet +Spot' item in the menu +Configure->Defaults->Misc+ tab unchecked. + +[[ref-tune]] +.TUNE +This button transmits a continuous tone at the current audio frequency. The tone +level will be at the maximum signal level for any modem, which makes this +function useful for adjusting your transceiver's output power. + +=== Macro buttons === +This line of buttons provides user-editable QSO features. For example, the first +button on the left sends CQ for you. Both the function of these buttons (we call +them Macros) and the label on each button, can be changed. + +Select each button to use it by pressing the corresponding Function Key (F1 - +F12, you'll notice the buttons are grouped in patterns four to a group, just as +the Function Keys are). You can also select them with a left-click of the +mouse. If you right-click on the button, you are able to edit the button's label +and its function. A handy dialog pops up to allow this to be done. There are +many standard shortcuts, such as ++, which you can use within the +Macros. Notice that the buttons also turn the transmitter on and off as +necessary. + +You can just about hold a complete QSO using these buttons from left to right +(but please don't!). Notice that at the right are two spare buttons you can set +as you wish, and then a button labelled +1+. Yes, this is the first set of +_four_ sets of Macros, and you can access the others using this button, which +changes to read +2+, +3+, +4+ then +1+ again (right-click to go backwards), or +by pressing +Alt+ and the corresponding number (1-4, not F1-F4) at the same +time. + +[NOTE] +================================================================================ +If you _really_ mess up the Macros and can't see how to fix them, just close the +program without saving them, and reopen it. +================================================================================ + +=== Controls === +The line of buttons under the waterfall is used to control the program (as +opposed to the QSO). If you hover the mouse over these buttons, you'll see a +little yellow hint box appear which tells you what each button does. + +The first button switches between Waterfall, FFT and Scope modes. The next two +buttons adjust the signal level over which the waterfall works. The default +range is from 0dB downwards 70dB (i.e. to -70dB). Both of these values can be +adjusted to suit your sound card and receiver audio level. + +The next button sets the scale zoom factor (visible display width, ×1, ×2 or +×4), and the next three buttons move the visible waterfall area in relation to +the bandwidth cursor. + +The next button selects the waterfall speed. NORM or SLOW setting is best unless +you have a very fast computer. + +The next four buttons (two on either side of a number, the audio frequency in +Hz) control the receiving frequency (they move the red cursor lines). + +The +QSY+ button moves the signal under the bandwidth cursor to a preset audio +frequency (typically, the centre of the transceiver's passband). The Store +button allows you to store or recall the current frequency and mode. See the +{docs} for details on these functions. + +The +Lk+ button locks the transmit frequency (fixes the red cursors), and the ++Rv+ button turns the signal decoding upside down (some modes are sideband +sensitive, and if they are the wrong way up, can't be received +correctly). Remember to turn this one off when you're done, or you won't receive +anything! If every signal you hear is upside down, check your transceiver +sideband setting. + +The +T/R+ button forces the transmitter on or off. + +[CAUTION] +================================================================================ +Use the +T/R+ button with care, as it will stop transmission immediately, losing +whatever is in the buffer (what you have typed in the Transmit pane), or start +it immediately, even if nothing is ready to transmit. +================================================================================ + +There are two further controls in the bottom right corner of the program, to the +right of the Status line: + ++AFC+ (AFC) control:: + When this button is pressed, an indicator on the button turns yellow, and the + program will automatically retune to drifting signals. When the button is + again pressed, AFC is off, and the tuning will stay where you leave it. + ++SQL+ (Squelch) control:: + When off (no coloured indicator on the button), the receiver displays all + ``text'' received, even if there is no signal present, and the receiver is + simply attempting to decode noise. When activated by pressing the button, the + indicator turns yellow. If the incoming signal strength exceeds that set by + the adjacent slider control (above the +SQL+ button), the indicator turns + green and the incoming signal is decoded and printed. The signal strength is + indicated on the green bar beside the Squelch level slider. If nothing seems + to be printing, the first thing to do is check the Squelch! + +=== Status Line === +At the very bottom line of the Fldigi window is a row of useful information. At +the left is the current operating mode. Next (some modes) is the measured +signal-to-noise ratio at the receiver, and (in some modes) the measured signal +intermodulation level (IMD). + +The larger central box shows (in DominoEX and THOR modes) the received +'Secondary Text'. This is information (such as station identification) which is +transmitted automatically whenever the transmitter has completed all user text +that is available to send. It is transmitted using special characters, and is +automatically directed to this special window. Secondary text you transmit is +also shown here. This box changes size when you enlarge the program window. + + +[[ref-operating]] +== Operating == + +=== Procedure === +Operating procedure for digital modes is similar to that for Morse. Some of the +same abbreviations are used. For example, at the beginning of an over, you might +send +VK3XYZ de WB8ABC+ or just +RR Jack+ and so on. At the end of an over, it +is usual to send +ZL1ABC de AA3AR K+, and at the end of a QSO +73 F3XYZ de 3D2ZZ +SK+. When operating in a group or net it is usual to sign +AA3AE es gp de ZK8WW +K+. + +It is also considered a courtesy to send a blank line or two (press +Enter+) +before any text at the start of an over, and following the last text at the end +of an over. You can also place these in the macros. The purpose is to separate +your text from the previous text, and especially from any rubbish that was +printed between overs. + +Fldigi does all of this for you. The Function Keys are set up to provide these +start and end of over facilities, and can be edited to suit your preferences. In +order that the other station's callsign can appear when these keys are used, you +need to set the other station's callsign in the log data — it does not matter if +you use the log facility or not. + +[NOTE] +.Macro symbols +================================================================================ +Some Function Key Macro buttons have graphic symbols on them which imply +the following: + +[horizontal] +*+>>+*:: The transmitter comes on and stays on when you use this button/macro. + +*+||+*:: The transmitter goes off when the text from this button/macro has been + sent. + +*+>|+*:: The transmitter comes on, sends the text from this button/macro, and + goes off when the text from this button/macro has been sent. +================================================================================ + +The Macros are set up to control the transmitter as necessary, but you can also +switch the transmitter on at the start of an over with +Ctrl+ and +T+ or the TX +macro button, and off again with +Ctrl+ and +R+ or the RX macro button. If you +have Macros copied into or text already typed in the Transmit pane when you +start the transmitter, this is sent first. + +Calling another station you have tuned in is as simple as pushing a button. Put +his callsign into the log data (right click, select Call) and press the +ANS+ +Macro button (or F2) when you are ready. If he replies, you are in business! +Then press +QSO+ (F3) to start each over, and +BTU+ (F4) to end it, and +SK+ +(F5) to sign off. + +[NOTE] +================================================================================ +When typing text, the correct use of upper and lower case is important: + +* Modes such as RTTY and THROB have no lower case capability. + +* In most other modes, excessive use of upper case is considered impolite, like + SHOUTING! + +* Modes such as PSK31, MFSK16, DominoEX and THOR use character sets which are + optimised for lower case. You should use lower case as much as possible in + these modes to achieve maximum text speed. In these modes upper case + characters are noticeably slower to send and also slightly more prone to + errors. +================================================================================ + +=== Adjustment === +Most digital modes do not require much transmitter power, as the receiver +software is very sensitive. Many modes (PSK31, THROB, MT63) also require very +high transmitter linearity, which is another reason to keep transmitter power +below 30% of maximum. Some modes (Hellschreiber, Morse) have high peak power +output, which may not indicate well on the conventional power meter, another +reason to keep the average transmitted power low to prevent a very broad signal +being transmitted. + +Adjust the transmitter output power using the TUNE button, top right, beyond the +Menu. The output will be the same as the peak power in other modes. Adjust the +master Volume applet Wave Out and Master Volume controls to achieve the +appropriate power. Use of excessive drive will result in distortion (signal +difficult to tune in, and often poorer reception) and a very broad signal. + +Some multi-carrier modes (MT63 for example) may require individual adjustment as +the average power may be rather low. + +[TIP] +================================================================================ +Where possible, use the area above 1200Hz on the waterfall. + +* Below 1200Hz the second harmonic of the transmitted audio will pass through + the transmitter filters. + +* When using lower frequency tones, adjust the transmitter and audio level with + great care, as the second (and even third) harmonic will appear in the + transmitter passband, causing excessive signal width. + +* A narrow (CW) filter in the rig is no help in this regard, as it is only used + on receive. When you do use a narrow filter, this will restrict the area over + which the receiver and transmitter will operate (without retuning of + course). Try adjusting the passband tuning (if available). + +* Keep the sound card audio level to a minimum and set the transmitter gain to a + similar level used for SSB. +================================================================================ + +=== Waterfall Tuning === +When using this program, as with most other digital modes programs, tuning is +generally accomplished by leaving the transceiver VFO at a popular spot (for +example 14.070MHz, USB), and performing all the 'tuning' by moving around within +the software. + +The Fldigi software has a second ``VFO'' which is tuned by clicking on the +waterfall. On a busy band, you may see many signals at the same time (especially +with PSK31 or Morse), and so you can click with the mouse on any one of these +signals to tune it in, receive it, and if the opportunity allows, reply to the +station. + +The software ``VFO'' operates in a transceive mode, so the transmitter signal is +automatically and exactly tuned to the received frequency. If you click +correctly on the signal, your reply will always be in tune with the other +station. + +[IMPORTANT] +================================================================================ +You *must not* use RIT (Clarifier) when using digital modes. + +* With RIT on, you will probably have to retune after every over. + +* Use of the RIT will also cause the other station to change frequency, and you + will chase each other across the band. + +* Older transceivers without digital synthesis may have an unwanted offset + (frequency difference) between transmit and receive frequencies. Such rigs + should not be used for digital modes. +================================================================================ + +Wider digital modes (MT63, Olivia) can be tuned using the rig if necessary, as +tuning is not at all critical. The software tuning still operates, but because +the signal is so wide, there is limited ability to move around in the waterfall +tuning. + + +[[ref-special-keys]] +== Special Keys == + +Several special keyboard controls are provided to make operating easier. + +.Start Transmission +Press +Ctrl+ and +T+ to start transmission if there is text ready in the transmit +buffer. + +.Pause Transmission +Press +Pause+ or +Break+ while in receive, and the program will switch to +transmit mode. It will continue with the text in the transmit buffer (the +Transmit pane text) from the current point, i.e. where the red (previously sent) +text ends and the black (yet to be sent) text begins. If the buffer only +contains unsent text, then it will begin at the first character in the +buffer. If the buffer is empty, the program will switch to transmit mode, and +depending on the mode of operation, will send idle characters or nothing at all +until characters are entered into the buffer. + +If you press +Pause+ or +Break+ while in transmit mode, the program will return +to receive mode. There may be a slight delay for some modes like MFSK, PSK and +others, that requires the transmitter to send a postamble at the end of a +transmission. The transmit text buffer stays intact, ready for the ++Pause+/+Break+ key to return you to the transmit mode . + +Pressing +Alt+ or +Meta+ and +R+ has the same effect as +Pause+/+Break+. You +could think of the +Pause+/+Break+ key as a software break-in capability. + +.Escape +Pressing +Esc+ while transmitting will abort the transmission. Transmission +stops as soon as possible, (any necessary postamble is sent), and the program +returns to receive. Any unsent text in the transmit buffer will be lost. + +[TIP] +================================================================================ +If you press +Esc Esc+ (i.e. twice in quick succession), transmission stops +immediately, without sending any postamble, and the program returns to +receive. Any unsent text in the transmit buffer will be lost. Use this feature +as an *emergency stop*. +================================================================================ + +.Return to Receive +Press +Ctrl+ and +R+ to insert the +^r+ command in the transmit buffer at the +current typing point. When transmission reaches this point, transmission will +stop. + +.Move Typing Cursor +Press +Tab+ to move the cursor (typing insertion point) to the end of the +transmit buffer. This will also pause transmission. A +Tab+ press at that +position moves the cursor back to the character following the last one +transmitted. Morse operation is slightly different. See the {docs} for CW. + +.Send Any ASCII Character +Press +Ctrl+ and (at the same time) any three-digit number (on the numeric +keypad or the normal numeric keys) to insert the ASCII character designated by +that entry value into the transmit buffer. For example, +Ctrl 177+ is ``±'' +(plus/minus) and +Ctrl 176+ is ``°'' (degree). If you press a key other than the +numeric keypad's 0-9 the sequence will be discarded. + + +[[ref-credits]] +[float] +== Credits == + +Copyright (C) 2008 Murray Greenman, +ZL1BPU+. + +Copyright (C) 2008-2009 David Freese, +W1HKJ+. + +Copyright (C) 2009 Stelios Bounanos, +M0GLD+. + +License GPLv2+: http://www.gnu.org/licenses/gpl-2.0.html[GNU GPL version 2 or later]. + +//////////////////////////////////////////////////////////////////////////////// +// Emacs settings +// Local Variables: +// mode: doc +// End: +//////////////////////////////////////////////////////////////////////////////// diff --git a/m4/ax_boost_base.m4 b/m4/ax_boost_base.m4 index 2e5afd09..e5e2145f 100644 --- a/m4/ax_boost_base.m4 +++ b/m4/ax_boost_base.m4 @@ -38,7 +38,7 @@ AC_DEFUN([AX_BOOST_BASE], [ AC_ARG_WITH([boost], - AS_HELP_STRING([--with-boost@<:@=DIR@:>@], [use boost (default is yes) - it is possible to specify the root directory for boost (optional)]), + AS_HELP_STRING([--with-boost@<:@=DIR@:>@], [specify the root directory for boost @<:@optional@:>@]), [ if test "$withval" = "no"; then want_boost="no" diff --git a/m4/ax_compare_version.m4 b/m4/ax_compare_version.m4 index 5ad0977e..40e99626 100644 --- a/m4/ax_compare_version.m4 +++ b/m4/ax_compare_version.m4 @@ -84,7 +84,7 @@ dnl ######################################################################### AC_DEFUN([AX_COMPARE_VERSION], [ - AC_PROG_AWK + AC_REQUIRE([AC_PROG_AWK]) # Used to indicate true or false condition ax_compare_version=false diff --git a/m4/docs.m4 b/m4/docs.m4 new file mode 100644 index 00000000..b424ab66 --- /dev/null +++ b/m4/docs.m4 @@ -0,0 +1,37 @@ +AC_DEFUN([AC_FLDIGI_DOCS], [ + AC_ARG_WITH([asciidoc], + AC_HELP_STRING([--with-asciidoc], [build documentation using asciidoc @<:@autodetect@:>@]), + [case "${withval}" in + yes|no) ac_cv_want_asciidoc="${withval}" ;; + *) AC_MSG_ERROR([bad value "${withval}" for --with-asciidoc]) ;; + esac], + [ac_cv_want_asciidoc=check]) + + if test "x$ac_cv_want_asciidoc" != "xno"; then + AC_PATH_PROG([ASCIIDOC], [asciidoc]) + asciidoc_min=8.2.0 + if test "x$ASCIIDOC" != "x"; then + AC_MSG_CHECKING([for asciidoc >= $asciidoc_min]) + asciidoc_ver=$($ASCIIDOC --version | sed -n '1 { s/.* //; p }') + AX_COMPARE_VERSION([$asciidoc_ver], [ge], [$asciidoc_min], + [AC_MSG_RESULT([yes ($asciidoc_ver)])], + [AC_MSG_RESULT([no ($asciidoc_ver)]); ASCIIDOC=""]) + fi + if test "x$ASCIIDOC" != "x"; then + AC_PATH_PROG([A2X], [a2x]) + AX_COMPARE_VERSION([$asciidoc_ver], [ge], [8.3.0], [no_xmllint=yes], [no_xmllint=no]) + fi + if test "x$ac_cv_want_asciidoc" = "xyes"; then + if test "x$ASCIIDOC" = "x" -o "x$A2X" = "x"; then + AC_MSG_FAILURE([--with-asciidoc was given, but check for asciidoc failed]) + elif test "x$A2X" = "x"; then + AC_MSG_FAILURE([--with-asciidoc was given, but check for a2x failed]) + fi + fi + fi + + AC_SUBST([ASCIIDOC]) + AC_SUBST([A2X]) + AM_CONDITIONAL([HAVE_ASCIIDOC], [test "x$ASCIIDOC" != "x" -a "x$A2X" != "x"]) + AM_CONDITIONAL([HAVE_ASCIIDOC_NO_XMLLINT], [test "$no_xmllint" = "yes"]) +]) diff --git a/src/Makefile.am b/src/Makefile.am index d3edf2ff..47c73d72 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,4 +1,4 @@ -# Copyright (C) 2007 Stelios Bounanos, M0GLD (m0gld AT enotty DOT net) +# Copyright (C) 2007-2009 Stelios Bounanos, M0GLD (m0gld AT enotty DOT net) # Copyright (c) 2008 Dave Freese, W1HKJ (w1hkj AT w1hkj DOT com) bin_PROGRAMS = fldigi @@ -69,8 +69,6 @@ nodist_fldigi_SOURCES = $(BUILT_SOURCES) # and deleted by the clean targets CLEANFILES = $(BUILT_SOURCES) -CLEAN_LOCAL_FILES = - if WIN32 if HAVE_WINDRES .rc.o: @@ -79,17 +77,26 @@ fldigi_SOURCES += $(WIN32_RES_SRC) endif endif +install-exec-local: +if ENABLE_XMLRPC + if test -f $(srcdir)/../scripts/fldigi-shell; then \ + $(mkinstalldirs) $(DESTDIR)/$(bindir); \ + $(INSTALL_SCRIPT) $(srcdir)/../scripts/fldigi-shell $(DESTDIR)/$(bindir); \ + fi +endif + install-data-local: if test -f $(srcdir)/../data/fldigi.xpm; then \ - $(mkinstalldirs) $(DESTDIR)$(datadir)/pixmaps; \ + $(mkinstalldirs) $(DESTDIR)/$(datadir)/pixmaps; \ $(INSTALL_DATA) $(srcdir)/../data/fldigi.xpm $(DESTDIR)/$(datadir)/pixmaps; \ fi if test -f $(srcdir)/../data/fldigi.desktop; then \ - $(mkinstalldirs) $(DESTDIR)$(datadir)/applications; \ + $(mkinstalldirs) $(DESTDIR)/$(datadir)/applications; \ $(INSTALL_DATA) $(srcdir)/../data/fldigi.desktop $(DESTDIR)/$(datadir)/applications; \ fi uninstall-local: + rm -f $(DESTDIR)$(bindir)/fldigi-shell rm -f $(DESTDIR)/$(datadir)/pixmaps/fldigi.xpm rm -f $(DESTDIR)/$(datadir)/applications/fldigi.desktop @@ -107,7 +114,7 @@ appbundle: fldigi sh $(srcdir)/../scripts/mkappbundle.sh "$(srcdir)/../data" . \ $(PACKAGE_TARNAME)-$(PACKAGE_VERSION)-nolibs \ $(PACKAGE_TARNAME)-$(PACKAGE_VERSION) -CLEAN_LOCAL_FILES += $(PACKAGE_TARNAME)-$(PACKAGE_VERSION)-nolibs \ + CLEANFILES += $(PACKAGE_TARNAME)-$(PACKAGE_VERSION)-nolibs \ $(PACKAGE_TARNAME)-$(PACKAGE_VERSION) \ $(PACKAGE_TARNAME)-$(PACKAGE_VERSION)*.dmg endif @@ -117,11 +124,24 @@ hamlib-static: $(fldigi_OBJECTS) sh $(srcdir)/../scripts/mkhamlibstatic.sh fldigi endif -clean-local: - @rm -rf $(CLEAN_LOCAL_FILES) - TESTS = $(srcdir)/../scripts/tests/config-h.sh $(srcdir)/../scripts/tests/cr.sh +if HAVE_ASCIIDOC +$(builddir)/../doc/guide.html: $(builddir)/../doc/guide.txt + $(MAKE) -C $(builddir)/../doc $(AM_MAKEFLAGS) guide.html + +$(builddir)/dialogs/guide.cxx: $(builddir)/../doc/guide.html + mkdir -p $(builddir)/dialogs + sed 's/"/\\"/g; s/$$/\\n\\/g; 1 s/.*/const char* szBeginner = "&/; $$ s/.*/&n";/' $< > $@ +dialogs/htmlstrings.cxx: $(builddir)/dialogs/guide.cxx + +distclean-local: + @if test "$(builddir)" != "$(srcdir)"; then \ + rm -f $(builddir)/dialogs/guide.cxx; \ + fi +endif + + # Sources that we build. It is OK to have headers here. fldigi_SOURCES += \ combo/combo.cxx \ @@ -397,7 +417,8 @@ EXTRA_fldigi_SOURCES += \ mt63/mt63intl.dat \ trx/tune.cxx \ rsid/rsid_fft.cxx \ - rsid/rsid_fft.h + rsid/rsid_fft.h \ + dialogs/guide.cxx # Additional non-source files that we distribute EXTRA_DIST = \ diff --git a/src/dialogs/guide.cxx b/src/dialogs/guide.cxx new file mode 100644 index 00000000..25061592 --- /dev/null +++ b/src/dialogs/guide.cxx @@ -0,0 +1,1700 @@ +const char* szBeginner = "\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +Beginners' Guide to Fldigi\n\ +\n\ +\n\ +
\n\ +

Beginners' Guide to Fldigi

\n\ +
\n\ +
Table of Contents
\n\ + \n\ +
\n\ +
\n\ +
\n\ +
\n\ +
\n\ +
\n\ +

Of necessity, this Beginners' Guide contains only as much as you need to know to\n\ +get started. You should learn how to make best use of the program by reading the\n\ +Online Documentation. You can also access it from within the Fldigi program from the Help\n\ +menu item.

\n\ +
\n\ +
\n\ +
\n\ +

1. Beginners' Questions Answered

\n\ +
\n\ +

1.1. What is Fldigi?

\n\ +

Fldigi is a computer program intended for Amateur Radio Digital Modes\n\ +operation using a PC (Personal Computer). Fldigi operates (as does most similar\n\ +software) in conjunction with a conventional HF SSB radio transceiver, and uses\n\ +the PC sound card as the main means of input from the radio, and output to the\n\ +radio. These are audio-frequency signals. The software also controls the radio\n\ +by means of another connection, typically a serial port.

\n\ +

Fldigi is multi-mode, which means that it is able to operate many popular\n\ +digital modes without switching programs, so you only have one program to\n\ +learn. Fldigi includes all the popular modes, such as DominoEX, MFSK16, PSK31,\n\ +and RTTY.

\n\ +

Unusually, Fldigi is available for multiple computer operating systems;\n\ +FreeBSD™; Linux™, OS X™ and Windows™.

\n\ +

1.2. What is a Digital Mode?

\n\ +

Digital Modes are a means of operating Amateur radio from the computer\n\ +keyboard. The computer acts as modem (modulator - demodulator), as well as\n\ +allowing you to type, and see what the other person types. It also controls the\n\ +transmitter, changes modes as required, and provides various convenient features\n\ +such as easy tuning of signals and prearranged messages.

\n\ +

In this context, we are talking about modes used on the HF (high frequency)\n\ +bands, specifically chat modes, those used to have a regular conversation in a\n\ +similar way to voice or Morse, where one operator talks for a minute or two,\n\ +then another does the same. These chat modes allow multiple operators to take\n\ +part in a net.

\n\ +

Because of sophisticated digital signal processing which takes place inside the\n\ +computer, digital modes can offer performance that cannot be achieved using\n\ +voice (and in some cases even Morse), through reduced bandwidth, improved\n\ +signal-to-noise performance and reduced transmitter power requirement. Some\n\ +modes also offer built-in automatic error correction.

\n\ +

Digital Mode operating procedure is not unlike Morse operation, and many of the\n\ +same abbreviations are used. Software such as Fldigi makes this very simple as\n\ +most of the procedural business is set up for you using the Function Keys at the\n\ +top of the keyboard. These are easy to learn.

\n\ +

1.3. Why all the different modes?

\n\ +

HF propagation is very dependent on the ionosphere, which reflects the signals\n\ +back to earth. There are strong interactions between different signals arriving\n\ +from different paths. Experience has shown that particular modulation systems,\n\ +speeds and bandwidths suit different operating conditions.

\n\ +

Other factors such as available band space, operating speed and convenience,\n\ +noise level, signal level and available power also affect the choice of\n\ +mode. While in many cases several different modes might be suitable, having a\n\ +choice adds to the operating pleasure. It is difficult to advise which mode is\n\ +best for each particular occasion, and experience plays an important role.\n\ +
[To gain a good insight into each mode and its capabilities, you might\n\ +consider purchasing Digital Modes for All Occasions (ISBN 1-872309-82-8) by\n\ +Murray Greenman ZL1BPU, published by the RSGB and also available from\n\ +FUNKAMATEUR and CQ Communications; or the ARRL's HF Digital Handbook (ISBN\n\ +0-87259-103-4) by Steve Ford, WB8IMY.]

\n\ +

1.4. How do I recognise and tune in the signals?

\n\ +

Recognising the different modes comes with experience. It is a matter of\n\ +listening to the signal, and observing the appearance of the signal on the\n\ +tuning display. You can also practise transmitting with the transceiver\n\ +disconnected, listening to the sound of the signals coming from the\n\ +computer. There is also (see later paragraph) an automatic tuning option which\n\ +can recognise and tune in most modes for you.

\n\ +

The software provides a tuning display which shows the radio signals that are\n\ +receivable within the transceiver passband. Using a point and click technique\n\ +with the mouse, you can click on the centre of a signal to select it, and the\n\ +software will tune it in for you. Some modes require more care than others, and\n\ +of course you need to have the software set for the correct mode first — not\n\ +always so easy!

\n\ +

The RSID (automatic mode detection and tuning) feature uses a\n\ +special sequence of tones transmitted at the beginning of each transmission to\n\ +identify and tune in the signals received. For this feature to work, not only do\n\ +you need to enable the feature in the receiver, but in addition the stations you\n\ +are wishing to tune in need to have this feature enabled on transmission. Other\n\ +programs also offer this RSID feature as an option.

\n\ +
\n\ +

2. Setting Up

\n\ +
\n\ +

2.1. Fldigi settings

\n\ +
Essentials
    \n\ +
  • \n\ +

    \n\ +Use the menu Configure→Operator item to set the operator name, callsign,\n\ + locator and so on.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +If you have more than one sound card, use the menu Configure→Sound Card,\n\ + Audio Devices tab, to select the sound card you wish to use. You can ignore\n\ + the other tabs for now.\n\ +

    \n\ +
    • \n\ +
\n\ +
Rig Control
    \n\ +
  • \n\ +

    \n\ +Use the menu Configure→Rig Control item to set how you will control the\n\ + rig. If you will key the rig via a serial port, in the Hardware PTT tab\n\ + select Use serial port PTT, the device name you will use, and which line\n\ + controls PTT. If in doubt, check both RTS and DTR. You must then press\n\ + the Initialize button.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +If you plan to use CAT control of the rig via the COM port, check Use Hamlib\n\ + in the Hamlib tab. Select your rig model from the drop-down menu and set the\n\ + serial port device name, baud rate, and RTS/CTS options as needed. If in\n\ + addition you wish to use PTT control via CAT, also check PTT via Hamlib\n\ + command. You must then press the Initialize button.\n\ +

    \n\ +
    • \n\ +
\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Note\"\n\ +\n\ +

If your rig is CAT-capable but not yet supported by\n\ +Hamlib, it may still be possible to control it via\n\ +Fldigi's RigCAT system. Refer to the Online Documentation for details.

\n\ +
\n\ +
\n\ +
CPU Speed
    \n\ +
  • \n\ +

    \n\ +When you start Fldigi for the very first time, it makes a series of\n\ + measurements to determine your computer's processing speed. Although these\n\ + measurements are usually accurate, if you have a very slow processor (under\n\ + 700MHz), you should verify that Slow CPU under Configure→Misc→CPU has\n\ + been enabled. The receiver decoding strategy of certain modems uses fewer\n\ + processor cycles in this mode.\n\ +

    \n\ +
    • \n\ +
\n\ +
Modems
    \n\ +
  • \n\ +

    \n\ +Each of the modems can be individually set up from the Configure→Modems\n\ + multi-tabbed dialog. You need not change anything here to start with, although\n\ + it might be a good idea to set the secondary text for DominoEX and THOR to\n\ + something useful, such as your call and locator.
    [Secondary text is\n\ + transmitted when the text you type does not keep up with the typing speed of\n\ + the mode — this handy text appears in a small window at the very bottom of the\n\ + screen.]
    Note that this set of tabs is also where you set the RTTY modem speed\n\ + and shift, although the default values should be fine for normal operation.\n\ +

    \n\ +
    • \n\ +
\n\ +
Other settings
    \n\ +
  • \n\ +

    \n\ +Use the menu Configure→UI, Restart tab, to set the aspect ratio of the\n\ + waterfall display and whether or not you want to dock a second digiscope to\n\ + the main window.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +Use the menu Configure→IDs item to set whether you wish to transmit RSID\n\ + data at the start of each over (this is for the benefit of others and does not\n\ + affect RSID reception). If you plan to regularly use the RSID feature on\n\ + receive, you should deselect the option that starts new modems at the “sweet\n\ + spot” frequencies in Misc→Sweet Spot.\n\ +

    \n\ +
    • \n\ +
\n\ +

Finally, use the menu item Configure→Save Config to save the new\n\ +configuration.

\n\ +

2.2. Sound Card Mixer

\n\ +
    \n\ +
  • \n\ +

    \n\ +Use your sound card Master Volume applet to select the sound card, the Wave\n\ + output and set the transmit audio level. You can check the level using the\n\ + Tune button, top right, beyond the Menu.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +On Windows, the Volume applet can usually be opened by clicking\n\ + Start→Run… and entering sndvol32, or from the Control Panel.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +Use your sound card Recording Control applet to select the sound card, the\n\ + Line or Mic input and set the receiver audio level. Watch the waterfall\n\ + display for receiver noise when setting the level. If you see any dark blue\n\ + noise, you have the right input and about the right level. The actual setting\n\ + is not very important, provided you see blue noise. If the audio level is too\n\ + high, the little diamond shaped indicator (bottom right) will show red. The\n\ + waterfall may also show red bands. Performance will be degraded if the level\n\ + is too high.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +On Windows, the Record applet can usually be opened by clicking\n\ + Start→Run… and entering sndvol32, or from the Control Panel. If opened\n\ + from the Control Panel, you'll end up with the Master Volume applet, and need\n\ + to switch using Options→Properties, and selecting the Recording radio\n\ + button.\n\ +

    \n\ +
    • \n\ +
\n\ +
\n\ +

3. Guided Tour

\n\ +
\n\ +

The main window consists of three main panes. Study it carefully as you read\n\ +these notes. From top to bottom, these are the Receive pane (navajo white), the\n\ +Transmit pane (light cyan), and the Waterfall pane (black). At the top is the\n\ +collection of entry items which form the Log Data, and at the very top, a\n\ +conventional drop-down Menu system, with entries for File, Op Mode, Configure,\n\ +View and Help.

\n\ +

Between the Transmit and the Waterfall panes is a line of boxes (buttons) which\n\ +represent the Function Keys F1 - F12. This is the Macro group. Below the\n\ +Waterfall pane is another line of boxes (buttons), which provide various control\n\ +features. This is the Controls group. The program and various buttons can mostly\n\ +be operated using the mouse or the keyboard, and users generally find it\n\ +convenient to use the mouse while tuning around, and the keyboard and function\n\ +keys during a QSO.

\n\ +

3.1. Receive Pane

\n\ +

This is where the text from decoded incoming signals is displayed, in black\n\ +text. When you transmit, the transmitted text is also displayed here, but in red,\n\ +so the Receive pane becomes a complete record of the QSO. The information in\n\ +this pane can also be logged to a file.

\n\ +

The line at the bottom of this pane can be dragged up and down with the\n\ +mouse. You might prefer to drag it down a bit to enlarge the Receive pane and\n\ +reduce the size of the Transmit pane.

\n\ +

3.2. Transmit Pane

\n\ +

This is where you type what you want to transmit. The mouse must click in here\n\ +before you type (to obtain focus) otherwise your text will go nowhere. You can\n\ +type in here while you are receiving, and when you start transmitting, the text\n\ +already typed will be sent first. This trick is a cool way to impress others\n\ +with your typing speed! As the text is transmitted, the text colour changes from\n\ +black to red. At the end of the over, all the transmitted text (and any as yet\n\ +not transmitted) will be deleted.

\n\ +

3.3. Waterfall Pane

\n\ +

This is the main tuning facility. There are three modes, Waterfall, FFT and\n\ +Signal, selected by a button in the Control group. For now, leave it in\n\ +Waterfall mode, as this is the easiest to tune with, and gives the best\n\ +identification of the signal.

\n\ +
\n\ +
\n\ +WF (Waterfall)\n\ +
\n\ +
\n\ +

\n\ + A spectrogram display of signal strength versus frequency over passing\n\ + time. The receiver passband is analysed and displayed with lower frequencies\n\ + to the left, higher to the right. Weak signals and background noise are dark\n\ + while stronger signals show as brighter colours. As time passes (over a few\n\ + seconds), the historic signals move downwards like a waterfall.\n\ +

\n\ +
\n\ +
\n\ +FFT (Fast Fourier Transform)\n\ +
\n\ +
\n\ +

\n\ + A spectrum display of the mean signal strength versus frequency. Again\n\ + frequency is displayed from left to right, but now the vertical direction\n\ + shows signal strength and there is no brightness or historic information.\n\ +

\n\ +
\n\ +
\n\ +SIG (Signal)\n\ +
\n\ +
\n\ +

\n\ + An oscilloscope type of display showing the raw audio being captured by the\n\ + sound card.\n\ +

\n\ +
\n\ +
\n\ +

At the top of the pane is a scale of frequency in Hz, which corresponds to the\n\ +frequency displayed immediately below it. This scale can be moved around and\n\ +zoomed using buttons in the Control group.

\n\ +

As you move the mouse around in this pane you will see a yellow group of tuning\n\ +marks following the mouse pointer. Tuning is achieved by left-clicking on a\n\ +signal displayed by the waterfall in this pane. Use these yellow marks to\n\ +exactly straddle the signal and then left-click on the centre of the signal. The\n\ +tuning marks change to red. The red vertical lines will show the approximate\n\ +width of the active signal area (the expected signal bandwidth), while a red\n\ +horizontal bar above will indicate the receiver software's active decoding\n\ +range. When you left-click, the red marks move to where you clicked, and will\n\ +attempt to auto-track the signal from there.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Tip\"\n\ +\n\ +
Audio history and “casual tuning”
\n\ +

You can temporarily “monitor” a different signal by right-clicking on it. As\n\ +long as you hold the mouse button down, the signal under it will be decoded; as\n\ +soon as you release the mouse, decoding will revert to the previously tuned spot\n\ +(where the red marks are). If you also hold the Control key down before\n\ +right-clicking, Fldigi will first decode all of its buffered audio at that\n\ +frequency.

\n\ +
\n\ +
\n\ +

3.4. Log Data

\n\ +

Fldigi provides two QSO entry views, one for casual QSO logging and the second\n\ +for contesting. The View→Contest fields menu item switches between the two\n\ +modes.

\n\ +

The Frequency, Time Off, and (when in contest mode) #Out fields are filled\n\ +by the program. All the others can be populated by manual keyboard entry or by\n\ +selection from the Receive pane. The Time Off field is\n\ +continuously updated with the current GMT time. The Time On field will be\n\ +filled in when the Call is updated, but can be modified later by the operator.

\n\ +

A right click on the Receive pane brings up a context sensitive menu that will\n\ +reflect which of the two QSO capture views you have open. If you highlight text\n\ +in the Receive pane then the menu selection will operate on that text. If you\n\ +simply point to a word of text and right click then the menu selection will\n\ +operate on the single word.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Tip\"\n\ +\n\ +
Quick log entry
\n\ +

Certain fields (Call, Name, RST In, QTH and Locator) may also be\n\ +populated semi-automatically. Point to a word in the Receive pane and either\n\ +double-left-click or hold a Shift key down and left-click. The program will\n\ +then use some simple heuristics to decide which log field will receive the text.

\n\ +
\n\ +
\n\ +

It is generally not possible to distinguish between Operator and QTH names. For\n\ +this reason, Fldigi will use the first non-Call and non-Locator word to fill the\n\ +Name field, and subsequent clicks will send text to the QTH field.\n\ +Likewise, a text string may be both a valid callsign and a valid\n\ +IARU locator. For best\n\ +results, you should attempt to fill the log fields in the order in which they\n\ +appear on the main window, and clear the log fields after logging the QSO. Of\n\ +course, text can always be manually typed or pasted into any of the log fields!

\n\ +

You can query online and local (e.g. CD) database systems for data regarding a\n\ +callsign. You make the query by either clicking on the globe button, or\n\ +selecting Look up call from the popup menu. The latter will also move the\n\ +call to the Call field.

\n\ +

When the Call field is filled in, the logbook will be searched for the most\n\ +recent QSO with that station and, if an entry is found, the Name, QTH and\n\ +other fields will be pre-filled. If the logbook dialog is open, that last QSO\n\ +will also be selected for viewing in the logbook.

\n\ +

You open the logbook by selecting from the View menu; View→Logbook. The\n\ +logbook title bar will show you which logbook you currently have open. Fldigi\n\ +can maintain an unlimited (except for disk space) number of logbooks.

\n\ +

3.5. Menu

\n\ +

At the very top of the program window is a conventional drop-down menu. If you\n\ +click on any of the items, a list of optional functions will appear. Keyboard\n\ +menu selection is also provided. Where underscored characters are shown in the\n\ +menu, you can select these menu items from the keyboard using the marked\n\ +character and Alt at the same time, then moving around with the\n\ +up/down/left/right keys. Press Esc to quit from the menu with no\n\ +change.

\n\ +

3.5.1. Menu functions

\n\ +
File

Allows you to open or save Macros (we won't get into that here), turn on/off\n\ +logging to file, record/play audio samples, and exit the program. You can also\n\ +exit the program by clicking on the X in the top right corner of the window,\n\ +in the usual manner.

\n\ +
Op Mode

This is where you select the operating modem used for transmission and\n\ +reception. Some modes only have one option. Where more are offered, drag the\n\ +mouse down the list and sideways following the arrow to a secondary list, before\n\ +releasing it. When you start the program next time, it will remember the last\n\ +mode you used.

\n\ +

Not all the modes are widely used, so choose a mode which (a) maximises your\n\ +chance of a QSO, and (b) is appropriate for the band, conditions, bandwidth\n\ +requirements and permissions relevant to your operating licence.

\n\ +

At the bottom of the list are two “modes” which aren't modes at all, and do not\n\ +transmit (see Online Documentation for details). WWV mode allows you to receive a\n\ +standard time signal so the beeps it transmits can be used for sound card\n\ +calibration. Freq Analysis provides just a waterfall display with a very\n\ +narrow cursor, and a frequency meter which indicates the received frequency in\n\ +Hz to two decimal places. This is useful for on-air frequency measurement.

\n\ +
Configure

This is where you set up the program to suit your computer, yourself and your\n\ +operating preferences. The operating settings of the program are grouped into\n\ +several categories and there are menu items in which you enter your personal\n\ +information, or define your computer sound card, for example. Modems can be\n\ +individually changed, each having different adjustments. The Modems dialog has\n\ +multiple tabs, so you can edit any one of them. Don't fool with the settings\n\ +until you know what you are doing! The final item, Save Config allows you to\n\ +save the altered configuration for next time you start the program (otherwise\n\ +changes are temporary).

\n\ +
View

This menu item allows you to open extra windows. Most will be greyed out, but\n\ +two that are available are the Digiscope, and the PSK Browser. The Digiscope\n\ +provides a mode-specific graphical analysis of the received signal, and can have\n\ +more than one view (left click in the new window to change the view), or maybe\n\ +none at all. The PSK Browser is a rather cool tool that allows you to monitor\n\ +several PSK31 signals all at the same time! These windows can be resized to\n\ +suit.

\n\ +
Help

Brings up the Online Documentation, the Fldigi Home Page, and various\n\ +information about the program.

\n\ +

3.5.2. Other controls

\n\ +
RSID

This button turns on the receive RSID (automatic mode detection and tuning)\n\ +feature. When in use, the button turns yellow and no text reception is possible\n\ +until a signal is identified, or the feature is turned off again. If you plan to\n\ +use the RSID feature on receive, you must leave the Start New Modem at Sweet\n\ +Spot item in the menu Configure→Defaults→Misc tab unchecked.

\n\ +
TUNE

This button transmits a continuous tone at the current audio frequency. The tone\n\ +level will be at the maximum signal level for any modem, which makes this\n\ +function useful for adjusting your transceiver's output power.

\n\ +

3.6. Macro buttons

\n\ +

This line of buttons provides user-editable QSO features. For example, the first\n\ +button on the left sends CQ for you. Both the function of these buttons (we call\n\ +them Macros) and the label on each button, can be changed.

\n\ +

Select each button to use it by pressing the corresponding Function Key (F1 -\n\ +F12, you'll notice the buttons are grouped in patterns four to a group, just as\n\ +the Function Keys are). You can also select them with a left-click of the\n\ +mouse. If you right-click on the button, you are able to edit the button's label\n\ +and its function. A handy dialog pops up to allow this to be done. There are\n\ +many standard shortcuts, such as <MYCALL>, which you can use within the\n\ +Macros. Notice that the buttons also turn the transmitter on and off as\n\ +necessary.

\n\ +

You can just about hold a complete QSO using these buttons from left to right\n\ +(but please don't!). Notice that at the right are two spare buttons you can set\n\ +as you wish, and then a button labelled 1. Yes, this is the first set of\n\ +four sets of Macros, and you can access the others using this button, which\n\ +changes to read 2, 3, 4 then 1 again (right-click to go backwards), or\n\ +by pressing Alt and the corresponding number (1-4, not F1-F4) at the same\n\ +time.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Note\"\n\ +\n\ +

If you really mess up the Macros and can't see how to fix them, just close the\n\ +program without saving them, and reopen it.

\n\ +
\n\ +
\n\ +

3.7. Controls

\n\ +

The line of buttons under the waterfall is used to control the program (as\n\ +opposed to the QSO). If you hover the mouse over these buttons, you'll see a\n\ +little yellow hint box appear which tells you what each button does.

\n\ +

The first button switches between Waterfall, FFT and Scope modes. The next two\n\ +buttons adjust the signal level over which the waterfall works. The default\n\ +range is from 0dB downwards 70dB (i.e. to -70dB). Both of these values can be\n\ +adjusted to suit your sound card and receiver audio level.

\n\ +

The next button sets the scale zoom factor (visible display width, ×1, ×2 or\n\ +×4), and the next three buttons move the visible waterfall area in relation to\n\ +the bandwidth cursor.

\n\ +

The next button selects the waterfall speed. NORM or SLOW setting is best unless\n\ +you have a very fast computer.

\n\ +

The next four buttons (two on either side of a number, the audio frequency in\n\ +Hz) control the receiving frequency (they move the red cursor lines).

\n\ +

The QSY button moves the signal under the bandwidth cursor to a preset audio\n\ +frequency (typically, the centre of the transceiver's passband). The Store\n\ +button allows you to store or recall the current frequency and mode. See the\n\ +Online Documentation for details on these functions.

\n\ +

The Lk button locks the transmit frequency (fixes the red cursors), and the\n\ +Rv button turns the signal decoding upside down (some modes are sideband\n\ +sensitive, and if they are the wrong way up, can't be received\n\ +correctly). Remember to turn this one off when you're done, or you won't receive\n\ +anything! If every signal you hear is upside down, check your transceiver\n\ +sideband setting.

\n\ +

The T/R button forces the transmitter on or off.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Caution\"\n\ +\n\ +

Use the T/R button with care, as it will stop transmission immediately, losing\n\ +whatever is in the buffer (what you have typed in the Transmit pane), or start\n\ +it immediately, even if nothing is ready to transmit.

\n\ +
\n\ +
\n\ +

There are two further controls in the bottom right corner of the program, to the\n\ +right of the Status line:

\n\ +
\n\ +
\n\ +AFC (AFC) control\n\ +
\n\ +
\n\ +

\n\ + When this button is pressed, an indicator on the button turns yellow, and the\n\ + program will automatically retune to drifting signals. When the button is\n\ + again pressed, AFC is off, and the tuning will stay where you leave it.\n\ +

\n\ +
\n\ +
\n\ +SQL (Squelch) control\n\ +
\n\ +
\n\ +

\n\ + When off (no coloured indicator on the button), the receiver displays all\n\ + “text” received, even if there is no signal present, and the receiver is\n\ + simply attempting to decode noise. When activated by pressing the button, the\n\ + indicator turns yellow. If the incoming signal strength exceeds that set by\n\ + the adjacent slider control (above the SQL button), the indicator turns\n\ + green and the incoming signal is decoded and printed. The signal strength is\n\ + indicated on the green bar beside the Squelch level slider. If nothing seems\n\ + to be printing, the first thing to do is check the Squelch!\n\ +

\n\ +
\n\ +
\n\ +

3.8. Status Line

\n\ +

At the very bottom line of the Fldigi window is a row of useful information. At\n\ +the left is the current operating mode. Next (some modes) is the measured\n\ +signal-to-noise ratio at the receiver, and (in some modes) the measured signal\n\ +intermodulation level (IMD).

\n\ +

The larger central box shows (in DominoEX and THOR modes) the received\n\ +Secondary Text. This is information (such as station identification) which is\n\ +transmitted automatically whenever the transmitter has completed all user text\n\ +that is available to send. It is transmitted using special characters, and is\n\ +automatically directed to this special window. Secondary text you transmit is\n\ +also shown here. This box changes size when you enlarge the program window.

\n\ +
\n\ +

4. Operating

\n\ +
\n\ +

4.1. Procedure

\n\ +

Operating procedure for digital modes is similar to that for Morse. Some of the\n\ +same abbreviations are used. For example, at the beginning of an over, you might\n\ +send VK3XYZ de WB8ABC or just RR Jack and so on. At the end of an over, it\n\ +is usual to send ZL1ABC de AA3AR K, and at the end of a QSO 73 F3XYZ de 3D2ZZ\n\ +SK. When operating in a group or net it is usual to sign AA3AE es gp de ZK8WW\n\ +K.

\n\ +

It is also considered a courtesy to send a blank line or two (press Enter)\n\ +before any text at the start of an over, and following the last text at the end\n\ +of an over. You can also place these in the macros. The purpose is to separate\n\ +your text from the previous text, and especially from any rubbish that was\n\ +printed between overs.

\n\ +

Fldigi does all of this for you. The Function Keys are set up to provide these\n\ +start and end of over facilities, and can be edited to suit your preferences. In\n\ +order that the other station's callsign can appear when these keys are used, you\n\ +need to set the other station's callsign in the log data — it does not matter if\n\ +you use the log facility or not.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Note\"\n\ +\n\ +
Macro symbols
\n\ +

Some Function Key Macro buttons have graphic symbols on them which imply\n\ +the following:

\n\ +
\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +\n\ +
\n\ +>>\n\ +\n\ +The transmitter comes on and stays on when you use this button/macro.\n\ +
\n\ +||\n\ +\n\ +The transmitter goes off when the text from this button/macro has been\n\ + sent.\n\ +
\n\ +>|\n\ +\n\ +The transmitter comes on, sends the text from this button/macro, and\n\ + goes off when the text from this button/macro has been sent.\n\ +
\n\ +
\n\ +
\n\ +

The Macros are set up to control the transmitter as necessary, but you can also\n\ +switch the transmitter on at the start of an over with Ctrl and T or the TX\n\ +macro button, and off again with Ctrl and R or the RX macro button. If you\n\ +have Macros copied into or text already typed in the Transmit pane when you\n\ +start the transmitter, this is sent first.

\n\ +

Calling another station you have tuned in is as simple as pushing a button. Put\n\ +his callsign into the log data (right click, select Call) and press the ANS\n\ +Macro button (or F2) when you are ready. If he replies, you are in business!\n\ +Then press QSO (F3) to start each over, and BTU (F4) to end it, and SK\n\ +(F5) to sign off.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Note\"\n\ +\n\ +

When typing text, the correct use of upper and lower case is important:

\n\ +
    \n\ +
  • \n\ +

    \n\ +Modes such as RTTY and THROB have no lower case capability.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +In most other modes, excessive use of upper case is considered impolite, like\n\ + SHOUTING!\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +Modes such as PSK31, MFSK16, DominoEX and THOR use character sets which are\n\ + optimised for lower case. You should use lower case as much as possible in\n\ + these modes to achieve maximum text speed. In these modes upper case\n\ + characters are noticeably slower to send and also slightly more prone to\n\ + errors.\n\ +

    \n\ +
    • \n\ +
\n\ +
\n\ +
\n\ +

4.2. Adjustment

\n\ +

Most digital modes do not require much transmitter power, as the receiver\n\ +software is very sensitive. Many modes (PSK31, THROB, MT63) also require very\n\ +high transmitter linearity, which is another reason to keep transmitter power\n\ +below 30% of maximum. Some modes (Hellschreiber, Morse) have high peak power\n\ +output, which may not indicate well on the conventional power meter, another\n\ +reason to keep the average transmitted power low to prevent a very broad signal\n\ +being transmitted.

\n\ +

Adjust the transmitter output power using the TUNE button, top right, beyond the\n\ +Menu. The output will be the same as the peak power in other modes. Adjust the\n\ +master Volume applet Wave Out and Master Volume controls to achieve the\n\ +appropriate power. Use of excessive drive will result in distortion (signal\n\ +difficult to tune in, and often poorer reception) and a very broad signal.

\n\ +

Some multi-carrier modes (MT63 for example) may require individual adjustment as\n\ +the average power may be rather low.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Tip\"\n\ +\n\ +

Where possible, use the area above 1200Hz on the waterfall.

\n\ +
    \n\ +
  • \n\ +

    \n\ +Below 1200Hz the second harmonic of the transmitted audio will pass through\n\ + the transmitter filters.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +When using lower frequency tones, adjust the transmitter and audio level with\n\ + great care, as the second (and even third) harmonic will appear in the\n\ + transmitter passband, causing excessive signal width.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +A narrow (CW) filter in the rig is no help in this regard, as it is only used\n\ + on receive. When you do use a narrow filter, this will restrict the area over\n\ + which the receiver and transmitter will operate (without retuning of\n\ + course). Try adjusting the passband tuning (if available).\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +Keep the sound card audio level to a minimum and set the transmitter gain to a\n\ + similar level used for SSB.\n\ +

    \n\ +
    • \n\ +
\n\ +
\n\ +
\n\ +

4.3. Waterfall Tuning

\n\ +

When using this program, as with most other digital modes programs, tuning is\n\ +generally accomplished by leaving the transceiver VFO at a popular spot (for\n\ +example 14.070MHz, USB), and performing all the tuning by moving around within\n\ +the software.

\n\ +

The Fldigi software has a second “VFO” which is tuned by clicking on the\n\ +waterfall. On a busy band, you may see many signals at the same time (especially\n\ +with PSK31 or Morse), and so you can click with the mouse on any one of these\n\ +signals to tune it in, receive it, and if the opportunity allows, reply to the\n\ +station.

\n\ +

The software “VFO” operates in a transceive mode, so the transmitter signal is\n\ +automatically and exactly tuned to the received frequency. If you click\n\ +correctly on the signal, your reply will always be in tune with the other\n\ +station.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Important\"\n\ +\n\ +

You must not use RIT (Clarifier) when using digital modes.

\n\ +
    \n\ +
  • \n\ +

    \n\ +With RIT on, you will probably have to retune after every over.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +Use of the RIT will also cause the other station to change frequency, and you\n\ + will chase each other across the band.\n\ +

    \n\ +
    • \n\ +
  • \n\ +

    \n\ +Older transceivers without digital synthesis may have an unwanted offset\n\ + (frequency difference) between transmit and receive frequencies. Such rigs\n\ + should not be used for digital modes.\n\ +

    \n\ +
    • \n\ +
\n\ +
\n\ +
\n\ +

Wider digital modes (MT63, Olivia) can be tuned using the rig if necessary, as\n\ +tuning is not at all critical. The software tuning still operates, but because\n\ +the signal is so wide, there is limited ability to move around in the waterfall\n\ +tuning.

\n\ +
\n\ +

5. Special Keys

\n\ +
\n\ +

Several special keyboard controls are provided to make operating easier.

\n\ +
Start Transmission

Press Ctrl and T to start transmission if there is text ready in the transmit\n\ +buffer.

\n\ +
Pause Transmission

Press Pause or Break while in receive, and the program will switch to\n\ +transmit mode. It will continue with the text in the transmit buffer (the\n\ +Transmit pane text) from the current point, i.e. where the red (previously sent)\n\ +text ends and the black (yet to be sent) text begins. If the buffer only\n\ +contains unsent text, then it will begin at the first character in the\n\ +buffer. If the buffer is empty, the program will switch to transmit mode, and\n\ +depending on the mode of operation, will send idle characters or nothing at all\n\ +until characters are entered into the buffer.

\n\ +

If you press Pause or Break while in transmit mode, the program will return\n\ +to receive mode. There may be a slight delay for some modes like MFSK, PSK and\n\ +others, that requires the transmitter to send a postamble at the end of a\n\ +transmission. The transmit text buffer stays intact, ready for the\n\ +Pause/Break key to return you to the transmit mode .

\n\ +

Pressing Alt or Meta and R has the same effect as Pause/Break. You\n\ +could think of the Pause/Break key as a software break-in capability.

\n\ +
Escape

Pressing Esc while transmitting will abort the transmission. Transmission\n\ +stops as soon as possible, (any necessary postamble is sent), and the program\n\ +returns to receive. Any unsent text in the transmit buffer will be lost.

\n\ +
\n\ +\n\ +\n\ +\n\ +
\n\ +\"Tip\"\n\ +\n\ +

If you press Esc Esc (i.e. twice in quick succession), transmission stops\n\ +immediately, without sending any postamble, and the program returns to\n\ +receive. Any unsent text in the transmit buffer will be lost. Use this feature\n\ +as an emergency stop.

\n\ +
\n\ +
\n\ +
Return to Receive

Press Ctrl and R to insert the ^r command in the transmit buffer at the\n\ +current typing point. When transmission reaches this point, transmission will\n\ +stop.

\n\ +
Move Typing Cursor

Press Tab to move the cursor (typing insertion point) to the end of the\n\ +transmit buffer. This will also pause transmission. A Tab press at that\n\ +position moves the cursor back to the character following the last one\n\ +transmitted. Morse operation is slightly different. See the Online Documentation for CW.

\n\ +
Send Any ASCII Character

Press Ctrl and (at the same time) any three-digit number (on the numeric\n\ +keypad or the normal numeric keys) to insert the ASCII character designated by\n\ +that entry value into the transmit buffer. For example, Ctrl 177 is “±”\n\ +(plus/minus) and Ctrl 176 is “°” (degree). If you press a key other than the\n\ +numeric keypad's 0-9 the sequence will be discarded.

\n\ +
\n\ +

6. Credits

\n\ +
\n\ +

Copyright © 2008 Murray Greenman, ZL1BPU.

\n\ +

Copyright © 2008-2009 David Freese, W1HKJ.

\n\ +

Copyright © 2009 Stelios Bounanos, M0GLD.

\n\ +

License GPLv2+: GNU GPL version 2 or later.

\n\ +
\n\ +
\n\ +
\n\ +Version 3.11
\n\ +Last updated 2009-04-09 23:38:02 BST\n\ +
\n\ +\n\ +
\n\ +\n\ +\n\n"; diff --git a/src/dialogs/htmlstrings.cxx b/src/dialogs/htmlstrings.cxx index 8c3856f7..56ba9935 100644 --- a/src/dialogs/htmlstrings.cxx +++ b/src/dialogs/htmlstrings.cxx @@ -24,1696 +24,9 @@ #include -char szBeginner[] = "\ -\n\ -\n\ -\n\ -\n\ -\n\ -\n\ -\n\ -Beginners' Guide to Fldigi\n\ -\n\ -\n\ -
\n\ -

Beginners' Guide to Fldigi

\n\ -
\n\ -
Table of Contents
\n\ - \n\ -
\n\ -
\n\ -
\n\ -
\n\ -
\n\ -
\n\ -

Of necessity, this Beginners' Guide contains only as much as you need to know to\n\ -get started. You should learn how to make best use of the program by reading the\n\ -Online Documentation. You can also access it from within the Fldigi program from the Help\n\ -menu item.

\n\ -
\n\ -
\n\ -
\n\ -

1. Beginners' Questions Answered

\n\ -
\n\ -

1.1. What is Fldigi?

\n\ -

Fldigi is a computer program intended for Amateur Radio Digital Modes\n\ -operation using a PC (Personal Computer). Fldigi operates (as does most similar\n\ -software) in conjunction with a conventional HF SSB radio transceiver, and uses\n\ -the PC sound card as the main means of input from the radio, and output to the\n\ -radio. These are audio-frequency signals. The software also controls the radio\n\ -by means of another connection, typically a serial port.

\n\ -

Fldigi is multi-mode, which means that it is able to operate many popular\n\ -digital modes without switching programs, so you only have one program to\n\ -learn. Fldigi includes all the popular modes, such as DominoEX, MFSK16, PSK31,\n\ -and RTTY.

\n\ -

Unusually, Fldigi is available for multiple computer operating systems;\n\ -FreeBSD™; Linux™, OS X™ and Windows™.

\n\ -

1.2. What is a Digital Mode?

\n\ -

Digital Modes are a means of operating Amateur radio from the computer\n\ -keyboard. The computer acts as modem (modulator - demodulator), as well as\n\ -allowing you to type, and see what the other person types. It also controls the\n\ -transmitter, changes modes as required, and provides various convenient features\n\ -such as easy tuning of signals and prearranged messages.

\n\ -

In this context, we are talking about modes used on the HF (high frequency)\n\ -bands, specifically chat modes, those used to have a regular conversation in a\n\ -similar way to voice or Morse, where one operator talks for a minute or two,\n\ -then another does the same. These chat modes allow multiple operators to take\n\ -part in a net.

\n\ -

Because of sophisticated digital signal processing which takes place inside the\n\ -computer, digital modes can offer performance that cannot be achieved using\n\ -voice (and in some cases even Morse), through reduced bandwidth, improved\n\ -signal-to-noise performance and reduced transmitter power requirement. Some\n\ -modes also offer built-in automatic error correction.

\n\ -

Digital Mode operating procedure is not unlike Morse operation, and many of the\n\ -same abbreviations are used. Software such as Fldigi makes this very simple as\n\ -most of the procedural business is set up for you using the Function Keys at the\n\ -top of the keyboard. These are easy to learn.

\n\ -

1.3. Why all the different modes?

\n\ -

HF propagation is very dependent on the ionosphere, which reflects the signals\n\ -back to earth. There are strong interactions between different signals arriving\n\ -from different paths. Experience has shown that particular modulation systems,\n\ -speeds and bandwidths suit different operating conditions.

\n\ -

Other factors such as available band space, operating speed and convenience,\n\ -noise level, signal level and available power also affect the choice of\n\ -mode. While in many cases several different modes might be suitable, having a\n\ -choice adds to the operating pleasure. It is difficult to advise which mode is\n\ -best for each particular occasion, and experience plays an important role.\n\ -
[To gain a good insight into each mode and its capabilities, you might\n\ -consider purchasing Digital Modes for All Occasions (ISBN 1-872309-82-8) by\n\ -Murray Greenman ZL1BPU, published by the RSGB and also available from\n\ -FUNKAMATEUR and CQ Communications; or the ARRL's HF Digital Handbook (ISBN\n\ -0-87259-103-4) by Steve Ford, WB8IMY.]

\n\ -

1.4. How do I recognise and tune in the signals?

\n\ -

Recognising the different modes comes with experience. It is a matter of\n\ -listening to the signal, and observing the appearance of the signal on the\n\ -tuning display. You can also practise transmitting with the transceiver\n\ -disconnected, listening to the sound of the signals coming from the\n\ -computer. There is also (see later paragraph) an automatic tuning option which\n\ -can recognise and tune in most modes for you.

\n\ -

The software provides a tuning display which shows the radio signals that are\n\ -receivable within the transceiver passband. Using a point and click technique\n\ -with the mouse, you can click on the centre of a signal to select it, and the\n\ -software will tune it in for you. Some modes require more care than others, and\n\ -of course you need to have the software set for the correct mode first — not\n\ -always so easy!

\n\ -

The RSID (automatic mode detection and tuning) feature uses a\n\ -special sequence of tones transmitted at the beginning of each transmission to\n\ -identify and tune in the signals received. For this feature to work, not only do\n\ -you need to enable the feature in the receiver, but in addition the stations you\n\ -are wishing to tune in need to have this feature enabled on transmission. Other\n\ -programs also offer this RSID feature as an option.

\n\ -
\n\ -

2. Setting Up

\n\ -
\n\ -

2.1. Fldigi settings

\n\ -
Essentials
    \n\ -
  • \n\ -

    \n\ -Use the menu Configure→Operator item to set the operator name, callsign,\n\ - locator and so on.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -If you have more than one soundcard, use the menu Configure→Sound Card,\n\ - Audio Devices tab, to select the sound card you wish to use. You can ignore\n\ - the other tabs for now.\n\ -

    \n\ -
    • \n\ -
\n\ -
Rig Control
    \n\ -
  • \n\ -

    \n\ -Use the menu Configure→Rig Control item to set how you will control the\n\ - rig. If you will key the rig via a serial port, in the Hardware PTT tab\n\ - select Use serial port PTT, the device name you will use, and which line\n\ - controls PTT. If in doubt, check both RTS and DTR. You must then press\n\ - the Initialize button.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -If you plan to use CAT control of the rig via the COM port, check Use Hamlib\n\ - in the Hamlib tab. Select your rig model from the drop-down menu and set the\n\ - serial port device name, baud rate, and RTS/CTS options as needed. If in\n\ - addition you wish to use PTT control via CAT, also check PTT via Hamlib\n\ - command. You must then press the Initialize button.\n\ -

    \n\ -
    • \n\ -
\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Note\"\n\ -\n\ -

If your rig is CAT-capable but not yet supported by\n\ -Hamlib, it may still be possible to control it via\n\ -Fldigi's RigCAT system. Refer to the Online Documentation for details.

\n\ -
\n\ -
\n\ -
CPU Speed
    \n\ -
  • \n\ -

    \n\ -When you start Fldigi for the very first time, it makes a series of\n\ - measurements to determine your computer's processing speed. These\n\ - measurements are usually accurate. However, if you have a very slow processor\n\ - (under 700MHz), you should verify that Slow CPU under Configure→Misc→CPU\n\ - has been enabled. The receiver decoding strategy of certain modems uses fewer\n\ - processor cycles in this mode.\n\ -

    \n\ -
    • \n\ -
\n\ -
Modems
    \n\ -
  • \n\ -

    \n\ -Each of the modems can be individually set up from the Configure→Modems\n\ - multi-tabbed dialog. You need not change anything here to start with, although\n\ - it might be a good idea to set the secondary text for DominoEX and THOR to\n\ - something useful, such as your call and locator.
    [Secondary text is\n\ - transmitted when the text you type does not keep up with the typing speed of\n\ - the mode — this handy text appears in a small window at the very bottom of the\n\ - screen.]
    Note that this set of tabs is also where you set the RTTY modem speed\n\ - and shift, although the default values should be fine for normal operation.\n\ -

    \n\ -
    • \n\ -
\n\ -
Other settings
    \n\ -
  • \n\ -

    \n\ -Use the menu Configure→UI, Restart tab, to set the aspect ratio of the\n\ - waterfall display and whether or not you want to dock a second digiscope to\n\ - the main window.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -Use the menu Configure→IDs item to set whether you wish to transmit RSID\n\ - data at the start of each over (this is for the benefit of others and does not\n\ - affect RSID reception). If you plan to regularly use the RSID feature on\n\ - receive, you should deselect the option that starts new modems at the “sweet\n\ - spot” frequencies in Misc→Sweet Spot.\n\ -

    \n\ -
    • \n\ -
\n\ -

Finally, use the menu item Configure→Save Config to save the new\n\ -configuration.

\n\ -

2.2. Sound Card Mixer

\n\ -
    \n\ -
  • \n\ -

    \n\ -Use your sound card Master Volume applet to select the sound card, the Wave\n\ - output and set the transmit audio level. You can check the level using the\n\ - Tune button, top right, beyond the Menu.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -On Windows, the Volume applet can usually be opened by clicking\n\ - Start→Run… and entering sndvol32, or from the Control Panel.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -Use your sound card Recording Control applet to select the sound card, the\n\ - Line or Mic input and set the receiver audio level. Watch the waterfall\n\ - display for receiver noise when setting the level. If you see any dark blue\n\ - noise, you have the right input and about the right level. The actual setting\n\ - is not very important, provided you see blue noise. If the audio level is too\n\ - high, the little diamond shaped indicator (bottom right) will show red. The\n\ - waterfall may also show red bands. Performance will be degraded if the level\n\ - is too high.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -On Windows, the Record applet can usually be opened by clicking\n\ - Start→Run… and entering sndvol32, or from the Control Panel. If opened\n\ - from the Control Panel, you'll end up with the Master Volume applet, and need\n\ - to switch using Options→Properties, and selecting the Recording radio\n\ - button.\n\ -

    \n\ -
    • \n\ -
\n\ -
\n\ -

3. Guided Tour

\n\ -
\n\ -

The main window consists of three main panes. Study it carefully as you read\n\ -these notes. From top to bottom, these are the Receive pane (navajo white), the\n\ -Transmit pane (light cyan), and the Waterfall pane (black). At the top is the\n\ -collection of entry items which form the Log Data, and at the very top, a\n\ -conventional drop-down Menu system, with entries for File, Op Mode, Configure,\n\ -View and Help.

\n\ -

Between the Transmit and the Waterfall panes is a line of boxes (buttons) which\n\ -represent the Function Keys F1 - F12. This is the Macro group. Below the\n\ -Waterfall pane is another line of boxes (buttons), which provide various control\n\ -features. This is the Controls group. The program and various buttons can mostly\n\ -be operated using the mouse or the keyboard, and users generally find it\n\ -convenient to use the mouse while tuning around, and the keyboard and function\n\ -keys during a QSO.

\n\ -

3.1. Receive Pane

\n\ -

This is where the text from decoded incoming signals is displayed, in black\n\ -text. When you transmit, the transmitted text is also displayed here, but in red,\n\ -so the Receive pane becomes a complete record of the QSO. The information in\n\ -this pane can also be logged to a file.

\n\ -

The line at the bottom of this pane can be dragged up and down with the\n\ -mouse. You might prefer to drag it down a bit to enlarge the Receive pane and\n\ -reduce the size of the Transmit pane.

\n\ -

3.2. Transmit Pane

\n\ -

This is where you type what you want to transmit. The mouse must click in here\n\ -before you type (to obtain focus) otherwise your text will go nowhere. You can\n\ -type in here while you are receiving, and when you start transmitting, the text\n\ -already typed will be sent first. This trick is a cool way to impress others\n\ -with your typing speed! As the text is transmitted, the text colour changes from\n\ -black to red. At the end of the over, all the transmitted text (and any as yet\n\ -not transmitted) will be deleted.

\n\ -

3.3. Waterfall Pane

\n\ -

This is the main tuning facility. There are three modes, Waterfall, FFT and\n\ -Signal, selected by a button in the Control group. For now, leave it in\n\ -Waterfall mode, as this is the easiest to tune with, and gives the best\n\ -identification of the signal.

\n\ -
\n\ -
\n\ -WF (Waterfall)\n\ -
\n\ -
\n\ -

\n\ -The waterfall is a spectrogram display, of signal strength versus frequency,\n\ -over passing time. The receiver passband is analysed and displayed with lower\n\ -frequencies to the left, higher to the right. Weak signals and background noise\n\ -are dark while stronger signals show as brighter colours. As time passes (over a\n\ -few seconds), the historic signals move downwards like a waterfall.\n\ -

\n\ -
\n\ -
\n\ -FFT (Fast Fourier Transform)\n\ -
\n\ -
\n\ -

\n\ -This is a spectrum display of the mean signal strength versus frequency. Again\n\ -frequency is displayed from left to right, but now the vertical direction shows\n\ -signal strength and there is no brightness or historic information.\n\ -

\n\ -
\n\ -
\n\ -SIG (Signal)\n\ -
\n\ -
\n\ -

\n\ -This is an oscilloscope type of display showing the raw audio being captured by\n\ -the sound card.\n\ -

\n\ -
\n\ -
\n\ -

At the top of the pane is a scale of frequency in Hz, which corresponds to the\n\ -frequency displayed immediately below it. This scale can be moved around and\n\ -zoomed using buttons in the Control group.

\n\ -

As you move the mouse around in this pane you will see a yellow group of tuning\n\ -marks following the mouse pointer. Tuning is achieved by left-clicking on a\n\ -signal displayed by the waterfall in this pane. Use these yellow marks to\n\ -exactly straddle the signal and then left-click on the centre of the signal. The\n\ -tuning marks change to red. The red vertical lines will show the approximate\n\ -width of the active signal area (the expected signal bandwidth), while a red\n\ -horizontal bar above will indicate the receiver software's active decoding\n\ -range. When you left-click, the red marks move to where you clicked, and will\n\ -attempt to auto-track the signal from there.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Tip\"\n\ -\n\ -
Audio history and “casual” tuning
\n\ -

You can temporarily “monitor” a different signal by right-clicking on it. As\n\ -long as you hold the mouse button down, the signal under it will be decoded; as\n\ -soon as you release the mouse, decoding will revert to the previously tuned spot\n\ -(where the red marks are). If you also hold the Control key down before\n\ -right-clicking, Fldigi will first decode all of its buffered audio at that\n\ -frequency.

\n\ -
\n\ -
\n\ -

3.4. Log Data

\n\ -

Fldigi provides two QSO entry views, one for casual QSO logging and the second\n\ -for contesting. The View→Contest fields menu item switches between the two\n\ -modes.

\n\ -

The Frequency, Time Off, and (when in contest mode) #Out fields are filled by\n\ -the program. All the others can be populated by manual keyboard entry or by\n\ -selection from the Receive pane. The Time Off field is\n\ -continuously updated with the current GMT time. The Time On field will be\n\ -filled in when the Call is updated, but can be modified later by the operator.

\n\ -

A right click on the Receive pane brings up a context sensitive menu that will\n\ -reflect which of the two QSO capture views you have open. If you highlight text\n\ -in the Receive pane then the menu selection will operate on that text. If you\n\ -simply point to a word of text and right click then the menu selection will\n\ -operate on the single word.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Tip\"\n\ -\n\ -
Quick log entry
\n\ -

Certain fields (Call, Name, RST In, QTH and Locator) may also be populated\n\ -semi-automatically. Point to a word in the Receive pane and either\n\ -double-left-click or hold a Shift key down and left-click. The program will\n\ -then use some simple heuristics to decide which log field will receive the text.

\n\ -
\n\ -
\n\ -

It is generally not possible to distinguish between Operator and QTH names. For\n\ -this reason, Fldigi will use the first non-Call and non-Locator word to fill the\n\ -Name field, and subsequent text will go into the QTH field. Likewise, a text\n\ -string may be both a valid callsign and a valid IARU locator. For best results,\n\ -you should attempt to fill the log fields in the order in which they appear on\n\ -the main window. Of course, text can always be manually typed or pasted into\n\ -any of the log fields!

\n\ -

You can query online and local (e.g. CD) database systems for data regarding a\n\ -Call. You make the query by either clicking on the globe button, or selecting\n\ -Look up call from the popup menu. The latter will also move the call to the\n\ -Call field.

\n\ -

When the Call field is filled in, the logbook will be searched for the most\n\ -recent QSO with that station and, if an entry is found, the Name, QTH and other\n\ -fields will be pre-filled. If the logbook dialog is open, that last QSO will\n\ -also be selected for viewing in the logbook.

\n\ -

You open the logbook by selecting from the View menu; View→Logbook. The\n\ -logbook title bar will show you which logbook you currently have open. Fldigi\n\ -can maintain an unlimited (except for disk space) number of logbooks.

\n\ -

3.5. Menu

\n\ -

At the very top of the program window is a conventional drop-down menu. If you\n\ -click on any of the items, a list of optional functions will appear. Keyboard\n\ -menu selection is also provided. Where underscored characters are shown in the\n\ -menu, you can select these menu items from the keyboard using the marked\n\ -character and Alt at the same time, then moving around with the\n\ -up/down/left/right keys. Press Esc to quit from the menu with no\n\ -change. These menu functions are:

\n\ -
File

Allows you to open or save Macros (we won't get into that here), turn on/off\n\ -logging to file, record/play audio samples, and exit the program. You can also\n\ -exit the program by clicking on the X in the top right corner of the window,\n\ -in the usual manner.

\n\ -
Op Mode

This is where you select the operating modem used for transmission and\n\ -reception. Some modes only have one option. Where more are offered, drag the\n\ -mouse down the list and sideways following the arrow to a secondary list, before\n\ -releasing it. When you start the program next time, it will remember the last\n\ -mode you used.

\n\ -

Not all the modes are widely used, so choose a mode which (a) maximizes your\n\ -chance of a QSO, and (b) is appropriate for the band, conditions, bandwidth\n\ -requirements and permissions relevant to your operating licence.

\n\ -

At the bottom of the list are two “modes” which aren't modes at all, and do not\n\ -transmit (see Online Documentation for details). WWV mode allows you to receive a\n\ -standard time signal so the beeps it transmits can be used for sound card\n\ -calibration. Freq Analysis provides just a waterfall display with a very\n\ -narrow cursor, and a frequency meter which indicates the received frequency in\n\ -Hz to two decimal places. This is useful for on-air frequency measurement.

\n\ -
Configure

This is where you set up the program to suit your computer, yourself and your\n\ -operating preferences. The operating settings of the program are grouped into\n\ -several categories and there are menu items in which you enter your personal\n\ -information, or define your computer sound card, for example. Modems can be\n\ -individually changed, each having different adjustments. The Modems dialog has\n\ -multiple tabs, so you can edit any one of them. Don't fool with the settings\n\ -until you know what you are doing! The final item, Save Config allows you to\n\ -save the altered configuration for next time you start the program (otherwise\n\ -changes are temporary).

\n\ -
View

This menu item allows you to open extra windows. Most will be greyed out, but\n\ -two that are available are the Digiscope, and the PSK Browser. The Digiscope\n\ -provides a mode-specific graphical analysis of the received signal, and can have\n\ -more than one view (left click in the new window to change the view), or maybe\n\ -none at all. The PSK Browser is a rather cool tool that allows you to monitor\n\ -several PSK31 signals all at the same time! These windows can be resized to\n\ -suit.

\n\ -
Help

Brings up the Online Documentation, the Fldigi Home Page, and various\n\ -information about the program.

\n\ -

The two non-menu functions are:

\n\ -
RSID

This button turns on the receive RSID (automatic mode detection and tuning)\n\ -feature. When in use, the button turns yellow and no text reception is possible\n\ -until a signal is identified, or the feature is turned off again. If you plan to\n\ -use the RSID feature on receive, you must leave the Start New Modem at Sweet\n\ -Spot item in the menu Configure→Defaults→Misc tab unchecked.

\n\ -
TUNE

This button transmits a continuous tone at the current audio frequency. The tone\n\ -level will be at the maximum signal level for any modem, which makes this\n\ -function useful for adjusting your transceiver's output power.

\n\ -

3.6. Functions

\n\ -

This line of buttons provides user-editable QSO features. For example, the first\n\ -button on the left sends CQ for you. Both the function of these buttons (we call\n\ -them Macros) and the label on each button, can be changed. Select each button to\n\ -use it by pressing the corresponding Function Key (F1 - F12, you'll notice the\n\ -buttons are grouped in patterns four to a group, just as the Function Keys\n\ -are). You can also select them with a left-click of the mouse. If you\n\ -right-click on the button, you are able to edit the buttons label and its\n\ -function. A handy dialog pops up to allow this to be done. There are many\n\ -standard shortcuts, such as <MYCALL> which you can use within the Macros. Notice\n\ -that the buttons also turn the transmitter on and off as necessary.

\n\ -

You can just about hold a complete QSO using these buttons from left to right\n\ -(but please don't!). Notice that at the right are two spare buttons you can set\n\ -as you wish, and then a button labelled 1. Yes, this is the first set of\n\ -four sets of Macros, and you can access the others using this button, which\n\ -changes to read 2, 3, 4 then 1 again (right-click to go backwards), or\n\ -by pressing Alt and the corresponding number (1-4, not F1-F4) at the same\n\ -time.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Note\"\n\ -\n\ -

If you really mess up the Macros and can't see how to fix them, just close the\n\ -program without saving them, and reopen it.

\n\ -
\n\ -
\n\ -

3.7. Controls

\n\ -

The line of buttons under the waterfall is used to control the program (as\n\ -opposed to the QSO). If you hover the mouse over these buttons, you'll see a\n\ -little yellow hint box appear which tells you what each button does.

\n\ -

The first button switches between Waterfall, FFT and Scope modes. The next two\n\ -buttons adjust the signal level over which the waterfall works. The default\n\ -range is from 0dB downwards 70dB (i.e. to -70dB). Both of these values can be\n\ -adjusted to suit your sound card and receiver audio level.

\n\ -

The next button sets the scale zoom factor (visible display width, ×1, ×2 or\n\ -×4), and the next three buttons move the visible waterfall area in relation to\n\ -the bandwidth cursor.

\n\ -

The next button selects the waterfall speed. NORM or SLOW setting is best unless\n\ -you have a very fast computer.

\n\ -

The next four buttons (two on either side of a number, the audio frequency in\n\ -Hz) control the receiving frequency (they move the red cursor lines).

\n\ -

The QSY button moves the signal under the bandwidth cursor to a preset audio\n\ -frequency (typically, the centre of the transceiver's passband). The Store\n\ -button allows you to store or recall the current frequency and mode. See the\n\ -Online Documentation for details on these functions.

\n\ -

The Lk button locks the transmit frequency (fixes the red cursors), and the Rv\n\ -button turns the signal decoding upside down (some modes are sideband sensitive,\n\ -and if they are the wrong way up, can't be received correctly). Remember to turn\n\ -this one off when you're done, or you won't receive anything! If every signal\n\ -you hear is upside down, check your transceiver sideband setting.

\n\ -

The T/R button forces the transmitter on or off.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Caution\"\n\ -\n\ -

Use this with care, as it will stop transmission immediately, losing whatever is\n\ -in the buffer (what you have typed in the Transmit pane), or start it\n\ -immediately, even if nothing is ready to transmit.

\n\ -
\n\ -
\n\ -

There are two further controls in the bottom right corner of the program, to the\n\ -right of the Status line:

\n\ -
\n\ -
\n\ -AFC (AFC) control\n\ -
\n\ -
\n\ -

\n\ - When this button is pressed, an indicator on the button turns yellow, and the\n\ - program will automatically retune to drifting signals. When the button is\n\ - again pressed, AFC is off, and the tuning will stay where you leave it.\n\ -

\n\ -
\n\ -
\n\ -SQL (Squelch) control\n\ -
\n\ -
\n\ -

\n\ - When off (no coloured indicator on the button), the receiver displays all\n\ - text received, even if there is no signal present, and the receiver is\n\ - simply attempting to decode noise. When activated by pressing the button, the\n\ - indicator turns yellow. If the incoming signal strength exceeds that set by\n\ - the adjacent slider control (above the SQL button), the indicator turns green\n\ - and the incoming signal is decoded and printed. The signal strength is\n\ - indicated on the green bar beside the Squelch level slider. If nothing seems\n\ - to be printing, the first thing to do is check the Squelch!\n\ -

\n\ -
\n\ -
\n\ -

3.8. Status Line

\n\ -

At the very bottom line of the Fldigi window is a row of useful information. At\n\ -the left is the current operating mode. Next (some modes) is the measured\n\ -signal-to-noise ratio at the receiver, and (in some modes) the measured signal\n\ -intermodulation level (IMD).

\n\ -

The larger central box shows (in DominoEX and THOR modes) the received\n\ -Secondary Text. This is information (such as station identification) which is\n\ -transmitted automatically whenever the transmitter has completed all user text\n\ -that is available to send. It is transmitted using special characters, and is\n\ -automatically directed to this special window. Secondary text you transmit is\n\ -also shown here. This box changes size when you enlarge the program window.

\n\ -
\n\ -

4. Operating

\n\ -
\n\ -

4.1. Procedure

\n\ -

Operating procedure for digital modes is similar to that for Morse. Some of the\n\ -same abbreviations are used. For example, at the beginning of an over, you might\n\ -send VK3XYZ de WB8ABC or just RR Jack and so on. At the end of an over, it\n\ -is usual to send ZL1ABC de AA3AR K, and at the end of a QSO 73 F3XYZ de 3D2ZZ\n\ -SK. When operating in a group or net it is usual to sign AA3AE es gp de ZK8WW\n\ -K.

\n\ -

It is also considered a courtesy to send a blank line or two (press Enter)\n\ -before any text at the start of an over, and following the last text at the end\n\ -of an over. You can also place these in the macros. The purpose is to separate\n\ -your text from the previous text, and especially from any rubbish that was\n\ -printed between overs.

\n\ -

Fldigi does all of this for you. The Function Keys are set up to provide these\n\ -start and end of over facilities, and can be edited to suit your preferences. In\n\ -order that the other station's callsign can appear when these keys are used, you\n\ -need to set the other station's callsign in the log data — it does not matter if\n\ -you use the log facility or not.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Note\"\n\ -\n\ -

Some Function Key Macro buttons have graphic symbols on them which imply\n\ -the following:

\n\ -
    \n\ -
  • \n\ -

    \n\ ->> The transmitter comes on and stays on when you use this button/macro.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -|| The transmitter goes off when the text from this button/macro has been\n\ - sent.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ ->| The transmitter comes on, sends the text from this button/macro, and\n\ - goes off when the text from this button/macro has been sent.\n\ -

    \n\ -
    • \n\ -
\n\ -
\n\ -
\n\ -

The Macros are set up to control the transmitter as necessary, but you can also\n\ -switch the transmitter on at the start of an over with Ctrl and T or the TX\n\ -macro button, and off again with Ctrl and R or the RX macro button. If you\n\ -have Macros copied into or text already typed in the Transmit pane when you\n\ -start the transmitter, this is sent first.

\n\ -

Calling another station you have tuned in is as simple as pushing a button. Put\n\ -his callsign into the log data (right click, select Call) and press the ANS\n\ -Macro button (or F2) when you are ready. If he replies, you are in business!\n\ -Then press QSO (F3) to start each over, and BTU (F4) to end it, and SK\n\ -(F5) to sign off.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Note\"\n\ -\n\ -

When typing text, the correct use of upper and lower case is important:

\n\ -
    \n\ -
  • \n\ -

    \n\ -Modes such as RTTY and THROB have no lower case capability.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -In most other modes, excessive use of upper case is considered impolite, like\n\ - SHOUTING!\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -Modes such as PSK31, MFSK16, DominoEX and THOR use character sets which are\n\ - optimised for lower case. You should use lower case as much as possible in\n\ - these modes to achieve maximum text speed. In these modes upper case\n\ - characters are noticeably slower to send and also slightly more prone to\n\ - errors.\n\ -

    \n\ -
    • \n\ -
\n\ -
\n\ -
\n\ -

4.2. Adjustment

\n\ -

Most digital modes do not require much transmitter power, as the receiver\n\ -software is very sensitive. Many modes (PSK31, THROB, MT63) also require very\n\ -high transmitter linearity, which is another reason to keep transmitter power\n\ -below 30% of maximum. Some modes (Hellschreiber, Morse) have high peak power\n\ -output, which may not indicate well on the conventional power meter, another\n\ -reason to keep the average transmitted power low to prevent a very broad signal\n\ -being transmitted.

\n\ -

Adjust the transmitter output power using the TUNE button, top right, beyond the\n\ -Menu. The output will be the same as the peak power in other modes. Adjust the\n\ -master Volume applet Wave Out and Master Volume controls to achieve the\n\ -appropriate power. Use of excessive drive will result in distortion (signal\n\ -difficult to tune in, and often poorer reception) and a very broad signal.

\n\ -

Some multi-carrier modes (MT63 for example) may require individual adjustment as\n\ -the average power may be rather low.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Tip\"\n\ -\n\ -

Where possible, use the area above 1200Hz on the waterfall.

\n\ -
    \n\ -
  • \n\ -

    \n\ -Below 1200Hz the second harmonic of the transmitted audio will pass through\n\ - the transmitter filters.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -When using lower frequency tones, adjust the transmitter and audio level with\n\ - great care, as the second (and even third) harmonic will appear in the\n\ - transmitter passband, causing excessive signal width.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -A narrow (CW) filter in the rig is no help in this regard, as it is only used\n\ - on receive. When you do use a narrow filter, this will restrict the area over\n\ - which the receiver and transmitter will operate (without retuning of\n\ - course). Try adjusting the passband tuning (if available).\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -Keep the sound card audio level to a minimum and set the transmitter gain to a\n\ - similar level used for SSB.\n\ -

    \n\ -
    • \n\ -
\n\ -
\n\ -
\n\ -

4.3. Waterfall Tuning

\n\ -

When using this program, as with most other digital modes programs, tuning is\n\ -generally accomplished by leaving the transceiver VFO at a popular spot (for\n\ -example 14.070MHz, USB), and performing all the tuning by moving around within\n\ -the software.

\n\ -

The Fldigi software has a second “VFO” which is tuned by clicking on the\n\ -waterfall. On a busy band, you may see many signals at the same time (especially\n\ -with PSK31 or Morse), and so you can click with the mouse on any one of these\n\ -signals to tune it in, receive it, and if the opportunity allows, reply to the\n\ -station.

\n\ -

The software “VFO” operates in a transceive mode, so the transmitter signal is\n\ -automatically and exactly tuned to the received frequency. If you click\n\ -correctly on the signal, your reply will always be in tune with the other\n\ -station.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Important\"\n\ -\n\ -

You must not use RIT (Clarifier) when using digital modes.

\n\ -
    \n\ -
  • \n\ -

    \n\ -With RIT on, you will probably have to retune after every over.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -Use of the RIT will also cause the other station to change frequency, and you\n\ - will chase each other across the band.\n\ -

    \n\ -
    • \n\ -
  • \n\ -

    \n\ -Older transceivers without digital synthesis may have an unwanted offset\n\ - (frequency difference) between transmit and receive frequencies. Such rigs\n\ - should not be used for digital modes.\n\ -

    \n\ -
    • \n\ -
\n\ -
\n\ -
\n\ -

Wider digital modes (MT63, Olivia) can be tuned using the rig if necessary, as\n\ -tuning is not at all critical. The software tuning still operates, but because\n\ -the signal is so wide, there is limited ability to move around in the waterfall\n\ -tuning.

\n\ -
\n\ -

5. Special Keys

\n\ -
\n\ -

Several special keyboard controls are provided to make operating easier.

\n\ -
Start Transmission

Press Ctrl and T to start transmission if there is text ready in the transmit\n\ -buffer.

\n\ -
Pause Transmission

Press Pause or Break while in receive, and the program will switch to\n\ -transmit mode. It will continue with the text in the transmit buffer (the\n\ -Transmit pane text) from the current point, i.e. where the red (previously sent)\n\ -text ends and the black (yet to be sent) text begins. If the buffer only\n\ -contains unsent text, then it will begin at the first character in the\n\ -buffer. If the buffer is empty, the program will switch to transmit mode, and\n\ -depending on the mode of operation, will send idle characters or nothing at all\n\ -until characters are entered into the buffer.

\n\ -

If you press Pause or Break while in transmit mode, the program will return\n\ -to receive mode. There may be a slight delay for some modes like MFSK, PSK and\n\ -others, that requires the transmitter to send a postamble at the end of a\n\ -transmission. The transmit text buffer stays intact, ready for the\n\ -Pause/Break key to return you to the transmit mode .

\n\ -

Pressing Alt or Meta and R has the same effect as Pause/Break. You\n\ -could think of the Pause/Break key as a software break-in capability.

\n\ -
Escape

Pressing Esc while transmitting will abort the transmission. Transmission\n\ -stops as soon as possible, (any necessary postamble is sent), and the program\n\ -returns to receive. Any unsent text in the transmit buffer will be lost.

\n\ -
\n\ -\n\ -\n\ -\n\ -
\n\ -\"Tip\"\n\ -\n\ -

If you press Esc Esc (i.e. twice in quick succession), transmission stops\n\ -immediately, without sending any postamble, and the program returns to\n\ -receive. Any unsent text in the transmit buffer will be lost. Use this feature\n\ -as an emergency stop.

\n\ -
\n\ -
\n\ -
Return to Receive

Press Ctrl and R to insert the ^r command in the transmit buffer at the\n\ -current typing point. When transmission reaches this point, transmission will\n\ -stop.

\n\ -
Move Typing Cursor

Press Tab to move the cursor (typing insertion point) to the end of the\n\ -transmit buffer. This will also pause transmission. A Tab press at that\n\ -position moves the cursor back to the character following the last one\n\ -transmitted. Morse operation is slightly different. See the Online Documentation for CW.

\n\ -
Send any ASCII character

Press Ctrl and (at the same time) any three-digit number (on the numeric\n\ -keypad or the normal numeric keys) to insert the ASCII character designated by\n\ -that entry value into the transmit buffer. For example, Ctrl 177 is ±\n\ -(plus/minus) and Ctrl 176 is ° (degree). If you press a key other than the\n\ -numeric keypad's 0-9 the sequence will be discarded.

\n\ -
\n\ -

6. Credits

\n\ -
\n\ -

Copyright © 2008 Murray Greenman, ZL1BPU

\n\ -

Copyright © 2008, 2009 David Freese, W1HKJ

\n\ -

Copyright © 2009 Stelios Bounanos, M0GLD

\n\ -

License GPLv2+: GNU GPL version 2 or later

\n\ -
\n\ -
\n\ -
\n\ -Version 3.11
\n\ -Last updated 2009-03-27 02:48:28 BST\n\ -
\n\ -\n\ -
\n\ -\n\ -\n\ -"; +#include "dialogs/guide.cxx" -char szAbout[] = +const char* szAbout = "\n\ \n\ \n\ diff --git a/src/include/htmlstrings.h b/src/include/htmlstrings.h index 304c9142..1fe6e88f 100644 --- a/src/include/htmlstrings.h +++ b/src/include/htmlstrings.h @@ -25,7 +25,7 @@ #ifndef HTMLSTRINGS_H #define HTMLSTRINGS_H -extern char szBeginner[]; -extern char szAbout[]; +extern const char* szBeginner; +extern const char* szAbout; #endif diff --git a/src/logger/rx_extract.cxx b/src/logger/rx_extract.cxx index 83c3a9e7..e2407b38 100644 --- a/src/logger/rx_extract.cxx +++ b/src/logger/rx_extract.cxx @@ -22,6 +22,8 @@ // // ==================================================================== +#include + #include #include #include diff --git a/src/logger/speak.cxx b/src/logger/speak.cxx index 2a931035..7716a33e 100644 --- a/src/logger/speak.cxx +++ b/src/logger/speak.cxx @@ -22,6 +22,8 @@ // // ==================================================================== +#include + #include #include #include diff --git a/src/main.cxx b/src/main.cxx index f6486874..7a117093 100644 --- a/src/main.cxx +++ b/src/main.cxx @@ -182,7 +182,7 @@ int main(int argc, char ** argv) generate_version_text(); int arg_idx; if (Fl::args(argc, argv, arg_idx, parse_args) != argc) { - cerr << PACKAGE_NAME << ": unrecognized option `" << argv[arg_idx] + cerr << PACKAGE_NAME << ": bad option `" << argv[arg_idx] << "'\nTry `" << PACKAGE_NAME << " --help' for more information.\n"; exit(EXIT_FAILURE);