diff --git a/doc/build-doc.sh b/doc/build-doc.sh deleted file mode 100755 index 55847a259..000000000 --- a/doc/build-doc.sh +++ /dev/null @@ -1,330 +0,0 @@ -#!/usr/bin/env bash -# Title : build-doc.sh -# Description : WSJT-X Documentation build script -# Author : KI7MT -# Email : ki7mt@yahoo.com -# Date : FEB-02-2014 -# Version : 0.5 -# Usage : ./build-doc.sh [ option ] -# Notes : requires asciidoc, source-highlight -#============================================================================== - -# exit on error -set -e - -#add some color -red='\033[01;31m' -green='\033[01;32m' -yellow='\033[01;33m' -cyan='\033[01;36m' -no_col='\033[01;37m' - -# misc var's -base_dir=$(pwd) -src_dir="$base_dir/source" -c_asciidoc="asciidoc -b xhtml11 -a max-width=1024px" -script_name=$(basename $0) -doc_version="1.3" - -# declare build array's -declare -a no_toc_ary=('head_wording' 'build_no_toc') -declare -a top_toc_ary=('head_wording' 'build_toc1') -declare -a left_toc_ary=('head_wording' 'build_toc2') -declare -a all_docs_ary=('head_wording' 'build_no_toc' 'build_toc1' 'build_toc2' \ -'build_quick_ref' 'build_dev_guide') -declare -a web_package_ary=('package_wording' 'build_toc2') - -####################### -# clean-exit -####################### - -function clean_exit() { - clear - echo -e ${yellow}'Signal caught, cleaning up and exiting.'${no_col} - sleep 1 - [ -d "$base_dir/tmp" ] && rm -r $base_dir/tmp - echo -e ${yellow}'. Done'${no_col} - exit 0 -} - -# Trap Ctrl+C, Ctrl+Z and quit signals -trap clean_exit SIGINT SIGQUIT SIGTSTP - -####################### -# general functions -####################### - -# build with no table of contents -function build_no_toc() { # no toc - echo -e ${yellow}'Building Main With No TOC'${no_col} - $c_asciidoc -o wsjtx-main.html $src_dir/wsjtx-main.adoc - echo -e ${green}'.. wsjtx-main.html'${no_col} -} - -# build with top table of contents -function build_toc1() { - echo -e ${yellow}'Building Main with Top TOC'${no_col} - $c_asciidoc -a toc -o wsjtx-main-toc1.html $src_dir/wsjtx-main.adoc - echo -e ${green}'.. wsjtx-main-toc1.html'${no_col} -} - -# build with left table of contents -function build_toc2() { - echo -e ${yellow}'Building Main with Left TOC'${no_col} - $c_asciidoc -a toc2 -o wsjtx-main-toc2.html $src_dir/wsjtx-main.adoc - echo -e ${green}'.. wsjtx-main-toc2.html'${no_col} -} # end left toc - -# build all table of content versions -function build_support_pages() { - echo - echo -e ${yellow}'Building Rig Pages'${no_col} - $c_asciidoc -o rig-config-main.html $src_dir/rig-config-main.adoc - echo -e ${green}'.. rig-config-main.html'${no_col} - -# setup rig file array - declare -a rig_page_ary=('adat' 'alinco' 'aor' 'drake' 'elecraft' 'flexrad' 'icom' \ -'kenwood' 'softrock' 'tentec' 'yaesu') - -} # end all toc version - -# build quick-reference guide -function build_quick_ref() { - echo -e ${yellow}'Building Quick Reference Guide'${no_col} - $c_asciidoc -a toc2 -o quick-reference.html $src_dir/quick-reference.adoc - echo -e ${green}'.. quick-reference.html'${no_col} -} # end quick-ref - -# build dev-guide -function build_dev_guide() { - echo -e ${yellow}'Building Development Guide'${no_col} - $c_asciidoc -a toc2 -o dev-guide.html $src_dir/dev-guide.adoc - echo -e ${green}'.. dev-guide.html'${no_col} -} # end dev-guide - -function head_wording() { -clear -echo -e ${yellow}"Building WSJT-X Documentation "${cyan}'v'$doc_version"\n" ${no_col} -} - -function quick_ref_wording() { -clear -echo -e ${yellow}"Building Quick Reference Documentation\n"${no_col} -} - -function dev_guide_wording() { -clear -echo -e ${yellow}"Building Quick Reference Documentation\n"${no_col} -} - -function package_wording() { -clear -echo -e ${yellow}"Building Transfer Package\n"${no_col} -} - -# help menu options -function help_menu() { - clear - echo -e ${green}"BUILD SCRIPT HELP MENU\n"${no_col} - echo 'USAGE: build-doc.sh [ option ]' - echo - echo 'OPTIONS: toc1 toc2 all dev-guide quick-ref help web' - echo - echo -e ${yellow}'WSJT-X User Guide Options:'${no_col} - echo ' [1] No Table of Contents' - echo ' [2] Top Table of Contents ' - echo ' [3] Left Table of Contents' - echo ' [4] All Guide Versions' - echo -e ${yellow}"\nSingle Guide Builds"${no_col} - echo ' [5] Development Guide' - echo ' [6] Quick Reference Guide' - echo ' [0] Exit' - echo -} - -# WSJT-X User Guide transfer for Joe -function build_index_html(){ - -# create re-direct index.html -cat << EOF > ./index.html - - - - - WSJT-X User Guide - - - - - - -EOF -} - -function build_transfer_package() { - -[ -d ./tmp ] && rm -r ./tmp - -# check if wsjtx-main-toc2.html exists -build_file="wsjtx-main-toc2.html" - -if [[ $(ls -1 ./*.html 2>/dev/null | wc -l) > 0 ]] -then - echo "The docs's directory has previous build files" - echo - read -p "Would you like a clean User Guide build before packaging? [ Y/N ]: " yn - case $yn in - [Yy]* ) - clear - echo "Removing old html files, and rebuilding" - sleep 1 - rm ./*.html - package_wording - build_index_html - mkdir -p ./tmp - cp -r $base_dir/images/ $base_dir/tmp/ - for f in "${web_package_ary[@]}"; do $f; done - mv ./*.html $base_dir/tmp - echo - echo -e ${yellow}"Preparing Archive File"${no_col} - sleep 1 - cd $base_dir/tmp && tar -czf ../wsjtx-doc.tar.gz . - cd .. && rm -r $base_dir/tmp/ - break;; - [Nn]* ) - clear - echo "Ok, will package without rebuilding." - sleep 1 - break;; - * ) - clear - echo "Please answer with "Y" yes or "N" No.";; - esac -else - # continue packaging - package_wording - mkdir -p ./tmp - cp -r $base_dir/images/ $base_dir/tmp/ - build_index_html - for f in "${web_package_ary[@]}"; do $f; done - cp ./*.html $base_dir/tmp - echo - echo -e ${yellow}"Preparing Archive File"${no_col} - sleep 1 - cd $base_dir/tmp && tar -czf ../wsjtx-doc.tar.gz . - cd .. && rm -r $base_dir/tmp/ -fi - -# check that a file was actually created -web_file="wsjtx-doc.tar.gz" -if [ -e "$web_file" ] -then - clear - echo - echo -e ${green}"$PWD/$web_file is ready for transfer" - echo - exit 0 -else - clear - echo - echo -e ${red}'Whoopsie!!' - echo -e "$web_file was not found, check for script errors."${no_col} - echo - exit 1 -fi -} - -####################### -# start the main script -####################### - -# COMMAND LINE OPTIONS -if [[ $1 = "" ]] - then - head_wording - for f in "${no_toc_ary[@]}"; do $f; done - -# build top table of contents -elif [[ $1 = "toc1" ]] - then - head_wording - for f in "${top_toc_ary[@]}"; do $f; done - -# build left table of contents -elif [[ $1 = "toc2" ]] - then - head_wording - for f in "${left_toc_ary[@]}"; do $f; done - -# build all table of content versions -elif [[ $1 = "all" ]] - then - head_wording - for f in "${all_docs_ary[@]}"; do $f; done - -# build quick-reference only -elif [[ $1 = "quick-ref" ]] - then - clear - build_quick_ref - -# build dev-guide only -elif [[ $1 = "dev-guide" ]] - then - clear - build_dev_guide - -# bundle web_package -elif [[ $1 = "web" ]] - then - package_wording - build_transfer_package - -# For HELP and undefined option entries -# NOTE: The case $SELECTIOIN should mirror the if [ .. ] statements -# to allow for menu and direct call builds -else - while [ 1 ] - do - help_menu - read -p "Enter Selection [ 1-6 or 0 to Exit ]: " SELECTION - case "$SELECTION" in - "1") # no table of contents build - clear - for f in "${no_toc_ary[@]}"; do $f; done - exit 0 - ;; - "2") # top table of contents build - for f in "${top_toc_ary[@]}"; do $f; done - exit 0 - ;; - "3") - for f in "${left_toc_ary[@]}"; do $f; done - exit 0 - ;; - "4") - for f in "${all_docs_ary[@]}"; do $f; done - exit 0 - ;; - "5") - build_dev_guide - exit 0 - ;; - "6") - build_quick_ref - exit 0 - ;; - "0") - exit 0 - ;; - esac - done -fi - echo - echo -e ${yellow}'HTML files saved to:'${no_col}${cyan} "$base_dir" ${no_col} - echo - exit 0 diff --git a/doc/images/130610_2343-wav-80.png b/doc/images/130610_2343-wav-80.png deleted file mode 100644 index 55f1ec074..000000000 Binary files a/doc/images/130610_2343-wav-80.png and /dev/null differ diff --git a/doc/images/band-settings.png b/doc/images/band-settings.png deleted file mode 100644 index 9b8dd080b..000000000 Binary files a/doc/images/band-settings.png and /dev/null differ diff --git a/doc/images/decode-menu.png b/doc/images/decode-menu.png deleted file mode 100644 index 5f0826cfd..000000000 Binary files a/doc/images/decode-menu.png and /dev/null differ diff --git a/doc/images/decodes.png b/doc/images/decodes.png deleted file mode 100644 index ddf586768..000000000 Binary files a/doc/images/decodes.png and /dev/null differ diff --git a/doc/images/file-menu.png b/doc/images/file-menu.png deleted file mode 100644 index 547d2c1df..000000000 Binary files a/doc/images/file-menu.png and /dev/null differ diff --git a/doc/images/help-menu.png b/doc/images/help-menu.png deleted file mode 100644 index b0aa8039e..000000000 Binary files a/doc/images/help-menu.png and /dev/null differ diff --git a/doc/images/icons/caution.png b/doc/images/icons/caution.png deleted file mode 100644 index 9a8c515a1..000000000 Binary files a/doc/images/icons/caution.png and /dev/null differ diff --git a/doc/images/icons/example.png b/doc/images/icons/example.png deleted file mode 100644 index 1199e864f..000000000 Binary files a/doc/images/icons/example.png and /dev/null differ diff --git a/doc/images/icons/important.png b/doc/images/icons/important.png deleted file mode 100644 index be685cc4e..000000000 Binary files a/doc/images/icons/important.png and /dev/null differ diff --git a/doc/images/icons/note.png b/doc/images/icons/note.png deleted file mode 100644 index 7c1f3e2fa..000000000 Binary files a/doc/images/icons/note.png and /dev/null differ diff --git a/doc/images/icons/tip.png b/doc/images/icons/tip.png deleted file mode 100644 index f087c73b7..000000000 Binary files a/doc/images/icons/tip.png and /dev/null differ diff --git a/doc/images/log-qso.png b/doc/images/log-qso.png deleted file mode 100644 index 9fefe563b..000000000 Binary files a/doc/images/log-qso.png and /dev/null differ diff --git a/doc/images/main-ui-controls.png b/doc/images/main-ui-controls.png deleted file mode 100644 index a5fa58011..000000000 Binary files a/doc/images/main-ui-controls.png and /dev/null differ diff --git a/doc/images/misc-controls-center.png b/doc/images/misc-controls-center.png deleted file mode 100644 index 033c57899..000000000 Binary files a/doc/images/misc-controls-center.png and /dev/null differ diff --git a/doc/images/misc-main-ui.png b/doc/images/misc-main-ui.png deleted file mode 100644 index 619f2e366..000000000 Binary files a/doc/images/misc-main-ui.png and /dev/null differ diff --git a/doc/images/mode-menu.png b/doc/images/mode-menu.png deleted file mode 100644 index ec09a7658..000000000 Binary files a/doc/images/mode-menu.png and /dev/null differ diff --git a/doc/images/new-msg-box.png b/doc/images/new-msg-box.png deleted file mode 100644 index 4b4cd9876..000000000 Binary files a/doc/images/new-msg-box.png and /dev/null differ diff --git a/doc/images/r3666-config-screen-80.png b/doc/images/r3666-config-screen-80.png deleted file mode 100644 index 315aad7b8..000000000 Binary files a/doc/images/r3666-config-screen-80.png and /dev/null differ diff --git a/doc/images/r3666-main-ui-80.png b/doc/images/r3666-main-ui-80.png deleted file mode 100644 index b693b73b2..000000000 Binary files a/doc/images/r3666-main-ui-80.png and /dev/null differ diff --git a/doc/images/save-menu.png b/doc/images/save-menu.png deleted file mode 100644 index c9b48ffff..000000000 Binary files a/doc/images/save-menu.png and /dev/null differ diff --git a/doc/images/setup-menu.png b/doc/images/setup-menu.png deleted file mode 100644 index fdf242345..000000000 Binary files a/doc/images/setup-menu.png and /dev/null differ diff --git a/doc/images/status-bar-a.png b/doc/images/status-bar-a.png deleted file mode 100644 index e7a8b424c..000000000 Binary files a/doc/images/status-bar-a.png and /dev/null differ diff --git a/doc/images/traditional-msg-box.png b/doc/images/traditional-msg-box.png deleted file mode 100644 index ba1cb1053..000000000 Binary files a/doc/images/traditional-msg-box.png and /dev/null differ diff --git a/doc/images/tx-macros.png b/doc/images/tx-macros.png deleted file mode 100644 index d5a536f40..000000000 Binary files a/doc/images/tx-macros.png and /dev/null differ diff --git a/doc/images/view-menu.png b/doc/images/view-menu.png deleted file mode 100644 index c3b9d8edf..000000000 Binary files a/doc/images/view-menu.png and /dev/null differ diff --git a/doc/images/wide-graph-controls.png b/doc/images/wide-graph-controls.png deleted file mode 100644 index f806b7c34..000000000 Binary files a/doc/images/wide-graph-controls.png and /dev/null differ diff --git a/doc/source/acknowledgements.adoc b/doc/source/acknowledgements.adoc deleted file mode 100644 index 2c3db07fe..000000000 --- a/doc/source/acknowledgements.adoc +++ /dev/null @@ -1,19 +0,0 @@ -// Status=review - -Since 2005 the _WSJT_ project (including programs _WSJT_, _MAP65_, -_WSPR_, _WSJT-X_, and _WSPR-X_) has been ``open source'', with all -code licensed under the GNU Public License (GPL). Many users of these -programs, too numerous to mention here individually, have contributed -suggestions and advice that have greatly aided the development of -_WSJT_ and its sister programs. - -For _WSJT-X_ in particular, we acknowledge contributions from *AC6SL, -AE4JY, DJ0OT, G4KLA, G4WJS, K3WYC, KA6MAL, KA9Q, KB1ZMX, KI7MT, KK1D, -PY2SDR, VK3ACF, VK4BDJ, W4TI, and W4TV*. Each of these amateurs has -helped to bring the program’s design, code, and documentation to its -present state. - -Most of the color palettes for the _WSJT-X_ waterfall were copied from -the excellent, well documented, open-source program _fldigi_, by *W1HKJ* -and friends. - diff --git a/doc/source/compiling.adoc b/doc/source/compiling.adoc deleted file mode 100644 index aa82ba455..000000000 --- a/doc/source/compiling.adoc +++ /dev/null @@ -1,143 +0,0 @@ -// Status=review -// Note to developers. The URL http://developer.berlios.de/projects/wsjt/. is -// to a very old src version of WSJT 5.7 or so. WSJTX is not listed at all. -// Also, all the Qt4 stuff is now obsolete, and needs to be updated. - -This section is under development. Please send feedback to -mailto:ki7mt@yahoo.com[KI7MT]. - -=== Linux Makefile - -CAUTION: The WSJT-X developers provide Makefile.linux for source compiling. It -should be understood, this method of installation is for development testing -only. There is no guarantee the build will be successful each revision, nor -provide a stable binary if the build is successful. - -The following process has been tested against Ubuntu 12.04 and 14.04-DEV 64-bit -desktop installation. Additional Linux/BSD build guidance will be added as -and when it becomes available. - -.Ubuntu 12.04 specific notes -* Reference: https://launchpad.net/~ubuntu-sdk-team/+archive/ppa[Ubuntu SDK Notice] -* Ubuntu 12.04 requires an [ PPA ] in order to download and install the required -Qt5 libraries. - -==== For Ubuntu 12.04 Only -[source,bash] ------ -# Add the following PPA, and upgrade your system -sudo add-apt-repository ppa:ubuntu-sdk-team/ppa -sudo apt-get update -sudo apt-get dist-upgrade -sudo apt-get install ubuntu-sdk ------ - -==== Build dependencies -[horizontal] -+gcc+:: GNU C Compiler -+g{plus}{plus}+:: GNU C{plus}{plus} Compiler -+gfortran+:: GNU FOrtran or F90 -+make+:: GNU Make -+libqt5multimedia5-plugins+:: QT5 Media Plugins -+libfftw3-dev+:: Fast Fourier Transformation -+libpulse-dev+:: Headers and Files for Pulse AUdio -+libhamlib-dev+:: Headers and Files for Hamlib -+qtbase5-dev+:: QT5 Base Dev Files -+qtmultimedia5-dev+:: Qt5 Multimedsia Dev Files -+pulseaudio+:: Pulse Audio Sound Driver -+subversion+:: Version Control Software - -.Install dependencies -[source,bash] ------ -sudo apt-get install gcc g++ gfortran make libqt5multimedia5-plugins \ -libfftw3-dev libpulse-dev libhamlib-dev qtbase5-dev qtmultimedia5-dev \ -pulseaudio subversion ------ - -.kvasd 32-bit dependencies -[horizontal] -+libgfortran.so.3+:: from => libgfortran3:i386 -+libc.so.6+:: from => libc6-i386 -+libm.so.6+:: from => libc6-i386 -+libgcc_s.so.1+:: from => lib32gcc1:i386 -+libquadmath.so.0+:: from => lib32quadmath0 - -.Install kvasd 32-bit dependencies -[source,bash] ------ -sudo apt-get install libgfortran3:i386 libc6-i386 ------ - -.Set up and build -[source,bash] ------ -# In a terminal Ctrl+Alt+T -# Each line is seperate action - Copy & Paste - -mkdir -p ~/Projects/wsjtx-build && cd ~/Projects/wsjtx-build -svn co svn://svn.berlios.de/wsjt/branches/wsjtx -cd ./wsjtx/lib && make -f Makfile.linux -cd ../ && export QT_SELECT=qt5 && qmake -j_c=$(grep -c ^processor /proc/cpuinfo) && make -j$j_c - -# mv wsjtx_intall to the new rev-number -rev_num=$(svn log -l1 |awk 'FNR==2 {print $1}') -mv ./wsjtx_install ./wsjtx-$rev_num - ------ - -TIP: You should now have (3) files in ./wjstx-$rev_num (jt9, jt9code -and wsjtx). By moving the directory, your ready for the next build cycle. - -.Final configuraiton -Before running _WSJT-X_, download _kvasd_, and link required run files. - -[source,bash] ------ -# cd to the launch directory -cd ./wsjtx-$rev_num - -wget http://www.physics.princeton.edu/pulsar/K1JT/kvasd -chmod +x ./kvasd - -# IMPORTANT: You can copy or link the files / folders, but make sure -# they are in the same directory as the wsjtx binary. - -# Link or cp the following files & folders -ln -s ../wsjtx/kvasd ./kvasd -ln -s ../wsjtx/kvasd.dat ./kvasd.dat -ln -s ../wsjtx/CALL3.TXT ./CALL3.TXT -ln -s ../wsjtx/cty.dat ./cty.dat -ln -s ../wsjtx/Palettes ./Palettes -ln -s ../wsjtx/samples ./samples -ln -s ../wsjtx/mouse_commands.txt ./mouse_commands.txt -ln -s ../wsjtx/shortcuts.txt ./shortcuts.txt -ln -s ../wsjtx/prefixes.txt ./prefixes.txt ------ - -.Test kvasd -Before you run _WSJT-X_, ensure _kvasd_ has its required libraries. - -[source,bash] ------ -cd wsjtx-$rev_num -ldd ./kvasd - -# If there were no missing links, test _kvasd_ -./kvasd - -# If sucessful, the K1JT copyright message will be displayed. - ------ - -.Run the new binary -[source,bash] ------ -./wsjtx ------ - -// Need example using CMakefile -//=== Linux, CMake Example - -// Need further compiling Instructions diff --git a/doc/source/configuration-band-settings.adoc b/doc/source/configuration-band-settings.adoc deleted file mode 100644 index 008f22a25..000000000 --- a/doc/source/configuration-band-settings.adoc +++ /dev/null @@ -1,9 +0,0 @@ -// Status=review - -The Band Settings tab allows you to define the default frequency and -enter a brief description of your antenna for each amateur band. The -antenna information will be included with reception reports to -{pskreporter}, if enabled. - -[[FigBandSettings]] -image::images/band-settings.png[align="left"] diff --git a/doc/source/configuration-main-window.adoc b/doc/source/configuration-main-window.adoc deleted file mode 100644 index 2e3dcb373..000000000 --- a/doc/source/configuration-main-window.adoc +++ /dev/null @@ -1,19 +0,0 @@ -// Status=review -To set the proper level of audio drive from _WSJT-X_ to your radio: - -* Click the *Tune* button on the main screen._WSJT-X_ to switch the -radio into transmit mode and generate a steady audio tone. - -* Listen to the generated audio tone using your radio’s Monitor -facility. The pure sinusoidal tone should be perfectly smooth, with no -clicks or glitches. - -* Open the computer’s audio mixer controls for output (“Playback”) -devices and adjust the volume slider downward from its maximum until -the RF output from your transmitter falls by around ten percent. This -will be a good level for audio drive. - -* Alternatively, you can make the same adjustment using the digital -slider labeled *Pwr* at the right edge of the main window. - -* Toggle the *Tune* button once more to stop your test transmission. diff --git a/doc/source/configuration-station.adoc b/doc/source/configuration-station.adoc deleted file mode 100644 index d03295cda..000000000 --- a/doc/source/configuration-station.adoc +++ /dev/null @@ -1,61 +0,0 @@ -// Status=review -- Start _WSJT-X_ and select *Configuration* from its *Setup* menu. Enter -the following information: - -* *Call Sign*: -* *Grid*: -* *PTT method*: choose from RTS, DTR, CAT, VOX, or None. -* *PTT port*: if you will use RTS or DTR, choose a serial port. -* *PSK Reporter*: check to enable sending reception reports to the -{pskreporter} mapping facility. -* *CW ID*: Check to send your callsign in CW after sending 73. -* *CW Interval*: set the time interval for sending your CW identification. -Default is 0 (never). - -_WSJT-X_ does not implement full transceiver control, but it provides a -way to ensure that _WSJT-X_ can read and set the radio’s dial -frequency. To enable this capability: - -- Check the box *Enable CAT* -- Select your radio type from a drop-down list -- Select a *CAT port* (not the same port selected for PTT control) - -TIP: If you need an additional item in the list of devices for the -CAT port, edit the configuration file +wsjtx.ini+ and add your -requirement as +CATdriver=+ (for example, -+CATdriver=/dev/tty.usbserial+) in the group of entries marked -+[Common]+. - -- Set the port parameters *Serial rate*, *Handshake*, *Data bits*, -*Stop bits* as required for your radio -- If you use {dxlcommander} or {hrd} to control your transceiver, you -can configure _WSJT-X_ to communicate with the radio through that -program. Entries for these programs appear at the end of the -drop-down list of supported rigs. - -[[FIG_CONFIG_STATION]] -image::images/r3666-config-screen-80.png[align="center",alt="Configuration Screen"] - -Leave *Split Tx* unchecked for now. If you are using CAT control, most -radios will allow you to set *PTT method* = CAT. Some radios support -two types of PTT assertion via CAT control: one takes audio input from -the Mic connector, the other from a rear-panel Data connector. The -simplest CAT configuration sets *Polling interval* = 0 (no polling the -radio for dial frequency). _WSJT-X_ can then set the radio’s -frequency, but the program will be unaware of subsequent changes made -using the radio’s panel controls. - -With most radios you can set *Polling interval* to a small number (say -1 – 3 s) and the program will follow any frequency changes made at the -radio. Note that you may not be able simultaneously to control the -radio from _WSJT-X_ and from another program. Some experimentation -may be required; refer to the documentation for your rig-control -software and your radio. It is best to have the radio and any -interface equipment turned on and connected before starting _WSJT-X_, -and to exit the program before turning the equipment off. - -- Click the *Test CAT Control* and *Test PTT* buttons to see that you -have established the desired control of station functions. -- Select the devices you will use for *Audio In* and *Audio Out*. -- Click *OK* to dismiss the *Configuration* window. - diff --git a/doc/source/configuration-txmacros.adoc b/doc/source/configuration-txmacros.adoc deleted file mode 100644 index 54d65cc93..000000000 --- a/doc/source/configuration-txmacros.adoc +++ /dev/null @@ -1,9 +0,0 @@ -// Status=review - -*Tx Macros* are an aid for sending commonly used free-text messages. -To enable a pull-down selection, add your custom messages to the entry -fields provided. In JT65 and JT9 the maximum free-text message length -is 13 characters, including spaces. - -[[FigTxMacros]] -image::images/tx-macros.png[align="left"] diff --git a/doc/source/controls-functions-center.adoc b/doc/source/controls-functions-center.adoc deleted file mode 100644 index e05a6f7a1..000000000 --- a/doc/source/controls-functions-center.adoc +++ /dev/null @@ -1,33 +0,0 @@ -// Status=review - -At the center of the main window are a number of controls used when -making QSOs: - -//.Misc Controls Center -image::images/misc-controls-center.png[align="center",alt="Misc Controls Center"] - -* Check *Tx even* to transmit in even-numbered UTC minutes. Uncheck -this box to transmit in the odd minutes. This selection is made -automatically when you double-click on a decoded text line as -described in the <>. - -* The Tx and Rx audio frequencies are usually set automatically by -double-clicking on decoded text or a signal in the waterfall. They -can also be adjusted with spinner controls. - -* You can force Tx frequency to the current Rx frequency by clicking -the *Tx=Rx* button, and vice-versa for *Rx=Tx*. (Copy across the = -sign is from right to left.) Check the box *Lock Tx=Rx* to make the -frequencies always track one another. The on-the-air frequency of -your lowest JT9 or JT65 tone is the sum of dial frequency and audio Tx -frequency. - -* The *Report* control lets you change a signal report that has been -inserted automatically. Most reports will fall in the range –26 to +10 -dB. Remember that JT65 reports are clamped at an upper limit of -1 -dB. - -IMPORTANT: When signals are close to or above 0 dB, you and your QSO -partner should probably reduce power. JT65 and JT9 are supposed to be -weak signal modes! - diff --git a/doc/source/controls-functions-kb-shortcuts.adoc b/doc/source/controls-functions-kb-shortcuts.adoc deleted file mode 100644 index cafd06f99..000000000 --- a/doc/source/controls-functions-kb-shortcuts.adoc +++ /dev/null @@ -1,95 +0,0 @@ -// Status=review -The following keyboard shortcuts give quick access to some -frequently used program functions. - -[horizontal] -*Key*:: *Action performed* -F1:: -Display online User's Guide in browser -Ctrl+F1:: -About WSJT-X -F2:: -Open the Setup >> Configuration window -F3:: -Display keyboard shortcuts -F4:: -Clear Dx Call and Dx Grid entries -Alt+F4:: -Exit program -F5:: -Display special mouse commands -F6:: -Open next file in directory -Shift+F6:: -Decode all remaining files in directory -F11:: -Move Rx frequency down 1 Hz -Ctrl+F11:: -Move Rx and Tx frequencies down 1 Hz -F12:: -Move Rx frequency up 1 Hz -Ctrl+F12:: -Move Rx and Tx frequencies up 1 Hz -Alt+1-6:: -Set next transmission to this number on Tab 1 -Alt+D:: -Decode again at Rx frequency -Shift+D:: -Full decode (both windows) -Alt+E:: -Erase -Ctrl+F:: -Edit the free text message box -Alt+G:: -Generate standard messages -Alt+H:: -Halt Tx -Ctrl+L:: -Lookup callsign in database, generate standard messages -Alt M:: -Monitor -Alt+N:: -Enable Tx -Alt+Q:: -Log QSO -Alt+S:: -Stop monitoring -Alt+T:: -Tune -Alt+V:: -Save the most recently completed `*.wav'' file - -//// -//.Keyboard Shortcuts -[width="70%",cols="2,30",options="header",align="center"] -|===== -|Key|Action Performed -|F1|Display online User's Guide in browser -|Ctrl+F1|About WSJT-X -|F2|Open the Setup >> Configuration window -|F3|Display keyboard shortcuts -|F4|Clear Dx Call and Dx Grid entries -|Alt+F4|Exit program -|F5|Display special mouse commands -|F6|Open next file in directory -|Shift+F6|Decode all remaining files in directory -|F11|Move Rx frequency down 1 Hz -|Ctrl+F11|Move Rx and Tx frequencies down 1 Hz -|F12|Move Rx frequency up 1 Hz -|Ctrl+F12|Move Rx and Tx frequencies up 1 Hz -|Alt+1-6|Set next transmission to this number on Tab 1 -|Alt+D|Decode again at Rx frequency -|Shift+D|Full decode (both windows) -|Alt+E|Erase -|Ctrl+F|Edit the free text message box -|Alt+G|Generate standard messages -|Alt+H|Halt Tx -|Ctrl+L|Lookup callsign in database, generate standard messages -|Alt M|Monitor -|Alt+N|Enable Tx -|Alt+Q|Log QSO -|Alt+S|Stop monitoring -|Alt+T|Tune -|Alt+V|Save the most recently completed `*.wav'' file -|===== -//// diff --git a/doc/source/controls-functions-left.adoc b/doc/source/controls-functions-left.adoc deleted file mode 100644 index 594759119..000000000 --- a/doc/source/controls-functions-left.adoc +++ /dev/null @@ -1,28 +0,0 @@ -// Status=review - -Controls related to frequency selection, received audio level, the -station being called, and date and time are found at lower left of the -main window: - -//.Misc Controls Left -image::images/misc-main-ui.png[align="center",alt="Mist Menu Items"] - -* A drop-down list of bands at upper left lets you select the -operating band and sets dial frequency to a value taken from -the *Default Frequencies* tab on the *Setup | Configuration* screen. -If CAT control is active the radio's dial frequency will be set -accordingly; if not, you must tune the radio manually. - -* If you are using CAT control, a small colored square appears in -green if the CAT control is two-way between _WSJT-X_ and your radio, or -orange if the control is only from program to radio. (You can request -a one-time interrogation of the radio’s dial frequency by clicking on -the orange square.) The square becomes red if you have requested CAT -control but communication with the radio has been lost. If the -locator *Dx Grid* is known, the great-circle azimuth and distance are -displayed. - -* The program can maintain a database of callsigns and locators for -future reference. Click *Add* to insert the present call and locator -in the database; click *Lookup* to retrieve the locator for a -previously stored call. diff --git a/doc/source/controls-functions-main-window.adoc b/doc/source/controls-functions-main-window.adoc deleted file mode 100644 index 34e052623..000000000 --- a/doc/source/controls-functions-main-window.adoc +++ /dev/null @@ -1,47 +0,0 @@ -// Status=review -The following buttons appear just under the decoded text windows on -the main screen: - -//.Main UI Controls -image::images/main-ui-controls.png[align="left",alt="Main UI Controls"] - -* *Log QSO* raises a dialog window pre-filled with known information -about a QSO you have nearly completed. You can edit or add to this -information before clicking *OK* to log the QSO. If you check *Prompt -me to log QSO* on the *Setup* menu, the program will raise the -confirmation screen automatically when you send a 73 or free-text -message. - -//.Log QSO Window -image::images/log-qso.png[align="center",alt="Log QSO"] - -* *Stop* will terminate normal data acquisition in case you want to -freeze the waterfall or open and explore a previously recorded audio -file. - -* *Monitor* restarts normal receive operation. This button is -highlighted in green when the _WSJT-X_ is receiving. - -* *Erase* clears the right-hand decoded text window. -Double-clicking *Erase* clears both text windows. - -* *Decode* tells the program to repeat the decoding procedure at the -Rx frequency ([green]*GREEN* marker on waterfall), using the most recently -completed sequence of received data. - -* *Enable Tx* toggles the program into automatic T/R sequencing mode -and highlights the button in [red]*RED*. A transmission will start at -the beginning of the selected (odd or even) sequence, or immediately -if appropriate. A transmission will not be started any later than 24 -s into a UTC minute. - -* *Halt Tx* terminates a transmission in progress and disables -automatic T/R sequencing. - -* *Tune* may be used to switch into Tx mode and generate an -unmodulated carrier at the specified Tx frequency ([red]*RED* marker -on waterfall). This process may be useful for adjusting an antenna -tuner. The button is highlighted in [red]*RED* while *Tune* is -active. Toggle the button a second time to terminate the *Tune* -process. - diff --git a/doc/source/controls-functions-menus.adoc b/doc/source/controls-functions-menus.adoc deleted file mode 100644 index e965adcc3..000000000 --- a/doc/source/controls-functions-menus.adoc +++ /dev/null @@ -1,68 +0,0 @@ -// Status=review - -Program menus offer many options for configuration and operation. -Most of the items are self-explanatory; a few additional details -are provided below. - -[[FILE_MENU]] -==== File menu -image::images/file-menu.png[align="left",alt="File Menu"] - -[[SETUP_MENU]] -==== Setup Menu -image::images/setup-menu.png[align="left",alt="Setup Menu"] - -.Show DXCC entity and worked B4 status - -When this option is checked _WSJT-X_ appends some useful information -to all CQ messages displayed in the *Band Activity* window. The name of -the DXCC entity is shown, abbreviated if necessary. Your ``worked -before'' status (according to log file +wsjtx_log.adi+) is flagged -with a single character and a change of background color, as follows: - -[horizontal] -!:: (bright green) -- New DXCC entity -~:: (mid green) -- You have already worked this DXCC entity but not -this station - :: (dull green) -- You have previously worked the calling station - -The program does not distinguish between modes, but it does -differentiate between bands. - -This option is mainly intended for use -on non-Windows platforms; Windows users can (and should) use VK3AMA's -excellent {jtalert} utility instead. - -.Requirements: - -_WSJT-X_ expects the file +cty.dat+ to be in your installation -directory. It contains DXCC prefix information, and updated copies -can be downloaded from {cty_dat} when required. - -The log file +wsjtx_log.adi+ is updated whenever you log a QSO from -_WSJT-X_ (but note that it can also be erased from the file menu). You -can append or overwrite this file by exporting your QSO history as an -ADIF file from another logging program. Turning *Show DXCC entity and -worked B4 status* off and on again will cause _WSJT-X_ to re-read the -log file. Very large log files may cause _WSJT-X_ to slow down when -searching for calls. - -[[VIEW_MENY]] -==== View Menu -image::images/view-menu.png[align="left",alt="View Menu"] - -[[MODE_MENU]] -==== Mode Menu -image::images/mode-menu.png[align="left",alt="Mode Menu"] - -[[DECODE_MENU]] -==== Decode Menu -image::images/decode-menu.png[align="left",alt="Decode Menu"] - -[[SAVE_MENU]] -==== Save Menu -image::images/save-menu.png[align="left",alt="Save Menu"] - -[[HELP_MENU]] -==== Help Menu -image::images/help-menu.png[align="left",alt="Help Menu"] diff --git a/doc/source/controls-functions-messages.adoc b/doc/source/controls-functions-messages.adoc deleted file mode 100644 index de129606d..000000000 --- a/doc/source/controls-functions-messages.adoc +++ /dev/null @@ -1,42 +0,0 @@ -// Status=review - -Two arrangements of controls are provided for generating and selecting -Tx messages. Traditional controls carried over from program _WSJT_ -appear on *Tab 1*, providing six fields for message entry. -Pre-formatted messages for the standard minimal QSO are generated when -you click *Generate Std Msgs* or double-click on an appropriate line -in one of the decoded text windows. - -//.Traditional Message Menu -image::images/traditional-msg-box.png[align="center",alt="Traditional Message Menu"] - -* Select the next message to be transmitted (at the start of your next -Tx sequence) by clicking on the circle under *Next*. - -* To change to a specified Tx message immediately, click on a -rectangular button under the *Now* label. Changing a Tx message in -mid-stream will slightly reduce the chance of a correct decode, but it -is usually OK if done in the first 10 s of a transmission. - -* Right-clicking on the entry field for message #5 pops up a list of -free-text messages entered on the *Setup | Configuration | Tx Macros* -screen. Select any of your pre-stored messages by using the left -mouse button. - -The second arrangement of controls for generating and selecting -Tx messages appears on *Tab 2* of the Message Control Panel: - -//.New Message Menu -image::images/new-msg-box.png[align="center",alt="New Message Menu"] - -With this setup you normally follow a top-to-bottom sequence of -transmissions from the left column if you are calling CQ, or the right -column if answering a CQ. Clicking a button puts the appropriate -message in the *Gen Msg* box. If you are already transmitting, it -changes the Tx message immediately. You can enter anything (up to 13 -characters) in the *Free Msg* box. Right-clicking on this entry field -pops up your previously defined list of *Tx Macros*. - -IMPORTANT: During a transmission the actual message being sent always -appears highlighted in yellow in the first box of the status bar -(bottom left of the main screen). diff --git a/doc/source/controls-functions-special-mouse-cmds.adoc b/doc/source/controls-functions-special-mouse-cmds.adoc deleted file mode 100644 index 198245755..000000000 --- a/doc/source/controls-functions-special-mouse-cmds.adoc +++ /dev/null @@ -1,22 +0,0 @@ -// Status=review -The following special mouse commands are available: - -//.Special Mouse Commands -[width="80%",cols="13,50",options="header",align="center"] -|===== -|Click on|Action Performed -|Waterfall|*Click*: set Rx frequency + -*Double-click*: set Rx frequency and decode there + -*Ctrl-click*: set Rx and Tx frequencies + -*Ctrl-double-click*: set Rx and Tx frequencies and decode there -|Decoded text|*Double-click*: copy second callsign to Dx Call, -locator to Dx Grid; change Rx and Tx frequencies to decoded -signal's frequency; generate standard messages. If first -callsign is your own, change Tx frequency only it Ctrl is -held down when double-clicking. -|*Erase* Button|*Click*: erase QSO window + -*Double-click*: erase QSO and Band Activity windows -|*Tx5* or + -*Free Msg* box|*Right-click*: display the Tx macros + -*Left-click*: select one of the Tx macros -|===== diff --git a/doc/source/controls-functions-status-bar.adoc b/doc/source/controls-functions-status-bar.adoc deleted file mode 100644 index 0bd8a35db..000000000 --- a/doc/source/controls-functions-status-bar.adoc +++ /dev/null @@ -1,12 +0,0 @@ -// Status=review - -A Status Bar at the bottom edge of the main window provides -information about operating conditions. - -//.Status Bar -image::images/status-bar-a.png[align="left",alt="New Message Menu"] - -Labels on the Status Bar display the program's current operating state, -operating mode, and content of your most recent transmitted message. The -operating state can be Receiving, Transmitting, Tune, or the name of -file opened from the *File* menu. diff --git a/doc/source/controls-functions-wide-graph.adoc b/doc/source/controls-functions-wide-graph.adoc deleted file mode 100644 index 0d664b195..000000000 --- a/doc/source/controls-functions-wide-graph.adoc +++ /dev/null @@ -1,42 +0,0 @@ -// Status=review - -The following controls appear at the bottom of the Wide Graph window. -With the exception of *JT65 nnnn JT9*, they affect only the graphical -displays — they have no effect on the decoding process. - -image::images/wide-graph-controls.png[align="center",alt="Wide Graph Controls"] - -- *Bins/Pixel* controls the displayed frequency resolution. Set this -value to 1 for the highest possible resolution, or to higher numbers -to compress the spectral display. Normal operation with a convenient -window size works well at 2 to 8 bins per pixel. - -- *JT65 nnnn JT9* sets the dividing point for wide-band decoding of -JT65 and JT9 signals in *JT9+JT65* mode. The decoder looks for JT65 -signals below the specified frequency and JT9 signals above it. - -- *Start nnn Hz* sets the low-frequency starting point of the -waterfall frequency scale. - -- *N Avg* is the number of successive FFTs to be averaged before -updating the spectral display. Values around 5 are suitable for -normal JT9 and JT65 operation. Adjust *N Avg* to make the waterfall -move faster or slower, as desired. - -- *Zero* and *Gain* control the scaling and reference level for -waterfall colors. Values around 0 for both parameters are usually -about right, depending on the input signal level and your own -preferences. - -- *Palette* lets you select from a wide range of waterfall color -palettes. - -- Check *Flatten* if you want _WSJT-X_ to compensate for a sloping or -uneven response across the received passband. - -- Select *Current* or *Cumulative* for the spectrum displayed in the -bottom one-third of the Wide Graph window. *Current* is the average -spectrum over the most recent *N Avg* FFT calculations. *Cumulative* -is the average spectrum since the start of the present UTC minute. - - diff --git a/doc/source/dev-guide.adoc b/doc/source/dev-guide.adoc deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/source/example1-decoding-controls.adoc b/doc/source/example1-decoding-controls.adoc deleted file mode 100644 index 16119aeae..000000000 --- a/doc/source/example1-decoding-controls.adoc +++ /dev/null @@ -1,51 +0,0 @@ -// Status=review -- To gain some feeling for the controls you will use when making QSOs, try -clicking with the mouse on the decoded text lines and on the waterfall spectral -display. You should be able to confirm the following behavior: - -- Double-click on either of the decoded lines highlighted in green. This action -should produce the following: - -** Copies call-sign and locater of a station calling CQ to the “DX Call” -and “DX grid” entry fields. - -** Generates suitable messages for a minimal QSO and checks or clears the Tx -even box so that you will transmit in the proper (odd or even) minutes. - -** Rx and Tx frequency markers will be moved to the CQ-ing station’s frequency, -and the Gen Msg (“generated message”) radio button at bottom right of the main -window will be selected. - -** If you had checked “Double-click on call sets Tx Enable” on the Setup menu, -Enable Tx would also be activated, and you would start to transmit automatically, -at the appropriate time. - -- Double-click on the decoded line with the message “K1JT N5KDV EM41”, -highlighted in [red]*RED*. - -- Results will be similar to (a), except the Tx frequency ([red]*RED* marker) is -not moved. Such messages are usually in response to your own CQ, or from a -tail-ender, and you probably want your Tx frequency to stay where it was. - -- By holding down the Ctrl key when double-clicking on the decoded line -(or checking Lock Tx=Rx) you can cause both Tx and Rx frequencies to be moved. - -- Double-click on the message from KF4RWA in either window. He is -sending “73” to K1JT, signifying that the QSO is over. Most likely you -want to send 73 to him, so the message “KF4RWA K1JT 73” is automatically -generated and selected for your next transmission. (Alternatively, you might -choose to send a free text message or to call CQ again.) - -- Clicking on the waterfall moves the Rx frequency ([green]*GREEN* marker) to the -selected frequency. - -- Ctrl-click on waterfall moves both Rx and Tx frequencies. - -- Double-click on the waterfall moves the Rx frequency and causes a -narrow-band decode there at the new QSO frequency. Decoded text appears in the -right window only. Ctrl-double-click moves both Rx and Tx frequencies and -decodes at the new frequency. - -- Clicking Erase clears the right window. Double-click on Erase to clear both -text windows. - diff --git a/doc/source/example1-decoding-overview.adoc b/doc/source/example1-decoding-overview.adoc deleted file mode 100644 index 6497423d8..000000000 --- a/doc/source/example1-decoding-overview.adoc +++ /dev/null @@ -1,25 +0,0 @@ -// Status=review -- Notice the [green]*GREEN* and [red]*RED* markers on the waterfall -frequency scale. Decoding takes place at the end of a receive -sequence and is organized in two stages. The first decodes take place -at the selected Rx frequency, indicated by the green marker. Results -appear in both the left (“Band Activity”) and right (“Rx Frequency”) -text windows on the main screen. The decoder then finds and decodes -all signals in the selected mode(s) and the displayed frequency range. -The red marker indicates your Tx frequency. - -.Signal Presence - -TIP: At least eight JT9 signals are present in the example file; all -but one of them are decodable. When this file was recorded KF4RWA was -finishing a QSO with K1JT. Since the green marker was placed at his -audio frequency, 1224 Hz, his message “K1JT KF4RWA 73” appears in both -decoded text windows. The “Band Activity” window shows this message -as well as all the other decodes at nearby frequencies. The CQ lines -are highlighted in [green]*GREEN*, and lines containing “My Call”, in -this case K1JT, are highlighted in [red]*RED*. - -- For this step and the next, you may want to pretend you are K1JT by -entering that call temporarily as “My Call” on the <>. Your results should then be identical to those shown in the -<>. diff --git a/doc/source/example2-check-decodes.adoc b/doc/source/example2-check-decodes.adoc deleted file mode 100644 index 224a6f50a..000000000 --- a/doc/source/example2-check-decodes.adoc +++ /dev/null @@ -1,35 +0,0 @@ -// Status=review -- Double-click on the waterfall near 815 Hz: a signal originating -from W7VP will be decoded and appear in the Rx Frequency Box: - -.W7VP Decode -[width="70%",cols="3,^3,^3,^4,^4,30",options="header"] -|================================= -|UTC|db|dt|Freq|Mode|Message -|2343|-7|0.3|815|#|KK4DSD W7VP -16 -|================================= - -- Double-click on the waterfall at 3196 Hz and the program will decode a JT9 -message from IZ0MIT: - -.IZ0MIT Decode -[width="70%",cols="3,^3,^3,^4,^4,30",options="header"] -|===================================== -|UTC|db|dt|Freq|Mode|Message -|2343|-7|0.3|3196|@|WB8QPG IZ0MIT -11 -|===================================== - -TIP: Notice that when a signal is decoded in this way the Tx mode -automatically switches to that of the decoded signal. The Rx and Tx -frequency markers on the waterfall scale resize themselves -accordingly. - -- Scroll back in the Band Activity window (if necessary) and -double-click on the message CQ DL7ACA JO40. The program will set Tx -mode to JT65 and Tx and Rx frequencies to that of DL7ACA, 975 Hz. If -you had checked *Double-click on call sets Tx Enable* on the Setup menu, -the program would set up to start a QSO with DL7ACA. - -- Double-click on the decoded JT65 message CQ TA4A KM37. The program -will set Tx mode to JT9 and the Rx and Tx frequencies to 3567 Hz. -You’re now configured properly for a JT9 QSO with TA4A. diff --git a/doc/source/example2-main-window.adoc b/doc/source/example2-main-window.adoc deleted file mode 100644 index 26f927984..000000000 --- a/doc/source/example2-main-window.adoc +++ /dev/null @@ -1,5 +0,0 @@ -// Status=review -- Select JT9+JT65 on the Mode menu -- Toggle the Tx mode button to read Tx JT65, and set the Tx and Rx frequencies -to 1718 Hz. -- Double-click on Erase to clear both text windows diff --git a/doc/source/example2-wave-1742.adoc b/doc/source/example2-wave-1742.adoc deleted file mode 100644 index 4e8a09c4f..000000000 --- a/doc/source/example2-wave-1742.adoc +++ /dev/null @@ -1,20 +0,0 @@ -// Status=review -.Navigate and Open Wave File: - -***** - -Select File | Open and navigate to ...\save\samples\130418_1742.wav. - -***** - -- You can immediately see that these data were recorded with a much -narrower Rx bandwidth, roughly 200 to 2600 Hz. If you have no Rx -filter wider than about 2.7 kHz, you will be using data similar to -this sample. For best viewing of such data adjust Bins/Pixel and the -width of the Wide Graph so that only the active part of the spectrum -shows, say 0 to 2600 Hz. (Re-open the example file after any change -of Bins/Pixel or Wide Graph width, to refresh the waterfall.) The -signals in this file are all JT9 signals. To decode them in JT9+JT65 -mode you’ll need to move the JT65 nnnn JT9 delimiter down to 1000 Hz -or less. - diff --git a/doc/source/example2-wave-2343.adoc b/doc/source/example2-wave-2343.adoc deleted file mode 100644 index 7a7071369..000000000 --- a/doc/source/example2-wave-2343.adoc +++ /dev/null @@ -1,29 +0,0 @@ -// Status=review -.Navigate and Open Wave File: - -***** - -Select File | Open and navigate to ...\save\samples\130610_2343.wav. - -***** - -* The waterfall and main window should look like the figure below. -This sample file contains 17 decodable signals — nine in JT65 mode -(flagged with the character # in the decoded text windows), and eight -in JT9 mode (flagged with @). Since the Tx mode was set to Tx JT65, -signals in that mode were decoded first. If you had selected Tx JT9, -JT9 signals would have been decoded first. - -.130610_2343.wav Decode -[[X544]] -image::images/130610_2343-wav-80.png[align="left",alt="Wide Graph Decode 130610_2343"] - -TIP: Notice the [blue]*BLUE* marker on the waterfall scale, by -default set at 2500 Hz. Its position is set by the spinner control -JT65 nnnn JT9, where nnnn is a frequency in Hz. In JT9+JT65 mode the -program will decode JT65 signals below this frequency and JT9 signals -above it. - -- Confirm that mouse-click behavior is similar to that described in -the single-mode instructions at <>. The program -automatically determines the mode of each JT9 or JT65 signal. diff --git a/doc/source/example2-wide-graph-settings.adoc b/doc/source/example2-wide-graph-settings.adoc deleted file mode 100644 index 42b1c2abf..000000000 --- a/doc/source/example2-wide-graph-settings.adoc +++ /dev/null @@ -1,8 +0,0 @@ -// Status=review -- Bins/Pixel = 7 -- Zero = -3 - -[NOTE] -If necessary, adjust the width of the Wide Graph Window so that the upper -frequency limit is 4000 Hz. - diff --git a/doc/source/faq.adoc b/doc/source/faq.adoc deleted file mode 100644 index 691a1a948..000000000 --- a/doc/source/faq.adoc +++ /dev/null @@ -1,30 +0,0 @@ -// Status=review - -[qanda] -WSJT-X v1.3 seems to run properly in receive mode, with signals appearing on the waterfall, but *Decode* starts later than expected and nothing is decoded.:: - -Some earlier soundcard drivers fail to work properly at 48 kHz sample -rate, the default in WSJT-X r3590 and above. You can force _WSJT-X_ -to sample at 12000 Hz by inserting two lines at the end of file -+wsjtx.ini+. Use Windows Notepad to open +wsjtx.ini+, in your -_WSJT-X_ installation directory. Then copy-and-paste the following -two lines into the file, save the file, and restart _WSJT-X_. - - [Tune] - Audio\DisableInputResampling=true - -The *Flatten* feature causes my displayed spectrum to curve steeply upward near its edges, before falling where the radio's IF filter cuts off.:: - -_WSJT-X_ does not expect a steep filter edge within the displayed -passband, except perhaps a low-frequency cutoff below 200 Hz. Use a -wider IF filter or reduce the displayed passband by decreasing -*Bins/Pixel*, increasing *Start*, and/or reducing the width of the -*Wide Graph*. You might also need to re-center the filter's passband, -if such control is available. - -When I set *Polling interval* to a nonzero value, _WSJT-X_ sometimes terminates abnormally.:: - -A few radios do not interact properly with the +hamlib+ calls used in -_WSJT-X_. We are working to resolve these issues. In the meantime, -you can run with *Polling interval* = 0, or control your radio through -_DX Labs Commander_ or _Ham Radio Deluxe_. diff --git a/doc/source/font-sizes.adoc b/doc/source/font-sizes.adoc deleted file mode 100644 index af8fd64de..000000000 --- a/doc/source/font-sizes.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// Status=review - -- You can control the program's font sizes by using a text editor -(e.g., Windows Notepad or similar) to create a one-line file named -+fonts.txt+ in the _WSJT-X_ installation directory. Enter a single -line of text with four numbers separated by spaces. The first two -numbers control the font size (in points) and weight (on a 0 – 100 -scale) of most labels on the user interface. The last two numbers -control size and weight of text in the *Band Activity* and *Rx -Frequency* windows. - -- By default the four numbers are ``8 50 10 50''. If you need larger -fonts in the user interface and bold text in the decode windows, try -something like ``10 50 12 100'' (without the quotes). - diff --git a/doc/source/install-from-source.adoc b/doc/source/install-from-source.adoc deleted file mode 100644 index eb198ecdb..000000000 --- a/doc/source/install-from-source.adoc +++ /dev/null @@ -1,24 +0,0 @@ -// Status=review -// Note to developers. The URL http://developer.berlios.de/projects/wsjt/. is -// to a very old src version of WSJT 5.7 or so. WSJTX is not listed at all. -// Also, all the Qt4 stuff is now obsolete, and needs to be updated. - -Source code is available from the public repository at {devsvn}. To -compile the program you will need to install the following packages: - -- Subversion -- Qt 5.x -- g++ -- gfortran or g95 -- fftw3 -- hamlib -- MinGW (for Windows only) - -With Subversion installed, the full source code for _WSJT-X_ can be -downloaded with the command: - - svn co svn://svn.berlios.de/wsjt/branches/wsjtx - -// Need further compiling Instructions -For some basic instructions on building _WSJT-X_ from source code, see the -section <> near the end of this Guide. diff --git a/doc/source/install-mac.adoc b/doc/source/install-mac.adoc deleted file mode 100644 index 8b514a4d0..000000000 --- a/doc/source/install-mac.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// Status=review - -Two different packages are available: one for OS X 10.6 through 10.8, -and one for OS X 10.9. The two packages are _not_ interchangeable. - -- Select the correct package for your OS X and download it to your desktop. -** {osx_108} -** {osx_109} - -- Double-click on the file to see a new folder, +WSJT-X+. Drop down -into that folder, where a +Readme+ file provides detailed instructions -on how to configure your system for _WSJT-X_. - -- Additional information from package developer G4KLA -can be found {osx_instructions}. - -// Any necessary instructions about time synchronization or sound setup ?? diff --git a/doc/source/install-ubuntu.adoc b/doc/source/install-ubuntu.adoc deleted file mode 100644 index 1d957e62e..000000000 --- a/doc/source/install-ubuntu.adoc +++ /dev/null @@ -1,22 +0,0 @@ -// Status=review - -- Installation packages for Ubuntu 12.04, 12.10, 13.04, 13.10 are -maintained by AC6SL and available at {launchpadurl}. - -- If you have not before obtained packages from the Personal Package -Archive (PPA) at the above link, open a terminal window and execute -the following command: - - sudo add-apt-repository ppa:jnogatch/wsjtx - -- Accept the PPA Key, then issue these commands: - - sudo apt-get update - sudo apt-get install wsjtx - -- Download the soft-decision Reed Solomon decoder, {kvasd}, and put it -in the same directory as the executable binaries +wsjtx+ and -+jt9+. Normally (after you have run the script +/usr/bin/wsjtx+ at -least once) this directory will be +$HOME/.wsjtx+. - -// Add instructions about ntpd and sound setup. diff --git a/doc/source/install-windows.adoc b/doc/source/install-windows.adoc deleted file mode 100644 index d003eea37..000000000 --- a/doc/source/install-windows.adoc +++ /dev/null @@ -1,25 +0,0 @@ -// Status=review -- Execute the downloaded file and follow its installation -instructions. - -- Install _WSJT-X_ into its own directory rather than the conventional -location +C:\Program Files\WSJTX+. The suggested default directory is -+C:\WSJTX+. - -- All files relating to _WSJT-X_ will be stored in the chosen -installation directory and its subdirectories. You can uninstall -_WSJT-X_ by removing the installation directory and its contents. - -- The built-in Windows facility for time synchronization is usually -not adequate. We recommend Meinberg NTP: see {ntpsetup} for -downloading and installation instructions. - -- _WSJT-X_ expects your sound card to do its raw sampling at 48000 Hz. -To ensure that this will be so when running under recent versions of -Windows, open the system's *Sound* control panel and select in turn the -*Recording* and *Playback* tabs. Click on *Properties*, then -*Advanced*, and select ``16 bit, 48000 Hz (DVD Quality).'' - -CAUTION: If you are using a sound card that is also the Windows -default audio device, be sure to turn off all Windows sounds so they -are not transmitted over the air. diff --git a/doc/source/installed-files.adoc b/doc/source/installed-files.adoc deleted file mode 100644 index 4d769bc24..000000000 --- a/doc/source/installed-files.adoc +++ /dev/null @@ -1,47 +0,0 @@ -// Status=review - -After a clean install of _WSJT-X_ the following files should be -present in the installation directory: - -[horizontal] -+CALL3.TXT+:: Callsign database -+HRDInterface001.dll+:: Ham Radio Deluxe interface library -+Palettes+:: directory for waterfall palettes -+Qt5Core.dll+:: Qt5 library -+Qt5Gui.dll+:: Qt5 library -+Qt5Multimedia.dll+:: Qt5 library -+Qt5Network.dll+:: Qt5 library -+Qt5Widgets.dll+:: Qt5 library -+cty.dat+:: DXCC countries list -+hamlib-alinco.dll+:: Hamlib, Alinco library -+hamlib-amsat.dll+:: Hamlib, Amsat library -+hamlib-dummy.dll+:: Hamlib library -+hamlib-flexradio.dll+:: Hamlib Flex radio library -+hamlib-icom.dll+:: Hamlib Icom library -+hamlib-jrc.dll+:: Hamlib JRC library -+hamlib-kachina.dll+:: Hamlib Kachina library -+hamlib-kenwood.dll+:: Hamlib Kenwood library -+hamlib-kit.dll+:: Hamlib Kit library -+hamlib-tapr.dll+:: Hamlib TAPR library -+hamlib-tentec.dll+:: Hamlib TenTec library -+hamlib-winradio.dll+:: Hamlib WinRadio library -+hamlib-yaesu.dll+:: Hamlib Yaesu library -+icudt51.dll+:: ICU library -+icuin51.dll+:: ICU library -+icuuc51.dll+:: ICU library -+jt9.exe+:: Executable for JT9 and JT65 decoder -+kvasd.exe+:: Executable for Koetter-Vardy decoder -+libgcc_s_dw2-1.dll+:: gcc runtime library -+libhamlib-2.dll+:: Hamlib base library -+libstdc++-6.dll+:: Standard C function library -+libwinpthread-1.dll+:: Windows pthreads library -+mouse_commands.txt+:: Special mouse commands -+platforms+:: Directory for platform-specific libraries -+prefixes.txt+:: Add-on prefixes and suffixes (*Type 1*) -+qt.conf+:: Qt configuration file -+save+:: Directory for saved *.wav files -+shortcuts.txt+:: Keyboard shortcuts -+unins000.dat+:: Uninstall data file -+unins000.exe+:: Executable for uninstalling _WSJT-X_ -+wsjt.ico+:: _WSJT_ icon -+wsjtx.exe+:: Executable for _WSJT-X_ diff --git a/doc/source/introduction.adoc b/doc/source/introduction.adoc deleted file mode 100644 index 63206795b..000000000 --- a/doc/source/introduction.adoc +++ /dev/null @@ -1,41 +0,0 @@ -// Status=review - -_WSJT-X_ is a computer program designed to facilitate basic amateur -radio communication using very weak signals. The first four letters -in the program name stand for ``Weak Signal communication by K1JT'', -and the “-X” suffix indicates that _WSJT-X_ started as an extended -(and experimental) branch of program _WSJT_. - -_WSJT-X_ currently offers two protocols or “modes,” JT65 and JT9. -Both are designed for making reliable, confirmed QSOs under extreme -weak-signal conditions. They use nearly identical message structure -and source encoding. JT65 was designed for EME (“moon-bounce”) on the -VHF/UHF bands and has proved very effective for worldwide QRP -communication on the HF bands, too. JT9 is optimized for the LF, MF, and HF bands. -It is about 2 dB more sensitive than JT65 while using less than 10% of -the bandwidth. Both modes use one-minute timed sequences of -alternating transmission and reception, so a minimal QSO takes four to -six minutes — two or three transmissions by each station, one sending -in odd UTC minutes and the other even. On the HF bands, world-wide -QSOs are possible with power levels of a few watts and compromise -antennas. - -_WSJT-X_ can display a bandpass as large as 5 kHz and transparently -provides dual-mode reception of both JT65 and JT9 signals. If your -receiver can be configured with at least 4 kHz bandwidth in USB mode, -you can set the dial frequency to one of the standard JT65 frequencies -— for example, 14.076 MHz for the 20-meter band — and display the full -JT65 and JT9 sub-bands simultaneously on the waterfall. You can then -make QSOs in both modes using nothing more than mouse clicks. - -Plans for future program development call for _WSJT-X_ and _WSJT_ to -merge together. _WSJT-X_ will gradually acquire the additional modes -JT4, FSK441, and ISCAT that are now supported in _WSJT_. The entire -WSJT-related effort is an open-source project, released under the GNU -General Public License (GPL). If you have programming or -documentation skills or would like to contribute to the project in -other ways, please make your interests known to the development team. -The project’s source-code repository can be found at {devsvn}, and -most communication among the developers takes place on the email -reflector {devmail}. - diff --git a/doc/source/jt65-jt9-differences.adoc b/doc/source/jt65-jt9-differences.adoc deleted file mode 100644 index 631759dd1..000000000 --- a/doc/source/jt65-jt9-differences.adoc +++ /dev/null @@ -1,44 +0,0 @@ -// Status=review - -The JT65 protocol was described in a {jt65protocol} in 2005; details -of the JT9 protocol are presented in the next section of this Guide. -To users already familiar with JT65, the most striking difference -between the two modes is the much smaller occupied bandwidth of JT9: -15.6 Hz, compared with 177.6 Hz for JT65A. Transmissions in the two -modes are essentially the same length, and both modes use exactly 72 -bits to carry message information. At the user level the two modes -support nearly identical message structures. - -JT65 signal reports are constrained to the range –1 to –30 dB. This -range is more than adequate for EME purposes, but not really enough -for optimum use at HF and below. S/N values displayed by the JT65 -decoder are clamped at an upper limit –1 dB. Moreover, the S/N scale -in present JT65 decoders is nonlinear above –10 dB. - -By comparison, JT9 allows for signal reports in the range –50 to +49 -dB. It manages this by taking over a small portion of ``message -space'' that would otherwise be used for grid locators within 1 degree -of the south pole. The S/N scale of the present JT9 decoder is -reasonably linear (although it’s not intended to be a precision -measurement tool). - -With clean signals and a clean nose background, JT65 achieves nearly -100% decoding down to S/N = –22 dB and about 50% at –24 dB. JT9 is -about 2 dB better, achieving 50% decoding at about –26 dB. Both modes -produce extremely low false-decode rates. - -Early experience suggests that under most HF propagation conditions -the two modes have comparable reliability. The tone spacing of JT9 is -about two-thirds that of JT65, so in some disturbed ionospheric -conditions in the higher portion of the HF spectrum, JT65 may do -better. - -JT9 is an order of magnitude better in spectral efficiency. On a busy -HF band, we often find the 2-kHz-wide JT65 sub-band filled -wall-to-wall with signals. Ten times as many JT9 signals can fit into -the same frequency range, without overlap. - -JT65 signals often decode correctly even when they overlap. Such -behavior is much less likely with JT9 signals, which fill their occupied -bandwisth more densely. JT65 may also be more forgiving of small -frequency drifts. diff --git a/doc/source/jt65-protocol.adoc b/doc/source/jt65-protocol.adoc deleted file mode 100644 index 5d8d1d4d0..000000000 --- a/doc/source/jt65-protocol.adoc +++ /dev/null @@ -1,50 +0,0 @@ -// Status=review - -JT65 was designed for making minimal QSOs via EME (``moon-bounce'') on -the VHF and UHF bands. A detailed description of the protocol and its -implementation in program _WSJT_ was published in {jt65protocol} for -September-October, 2005. Briefly stated, JT65 uses 60 s T/R sequences -and carefully structured messages. Standard messages are compressed -so that two callsigns and a grid locator can be transmitted with just -71 bits. A 72nd bit serves as a flag to indicate that the message -consists of arbitrary text (up to 13 characters) instead of callsigns -and a grid locator. Special formats allow other information such as -add-on callsign prefixes (e.g., ZA/K1ABC) or numerical signal reports -(in dB) to be substituted for the grid locator. The aim of source -encoding is to compress the common messages used for minimal QSOs into -a minimum fixed number of bits. After compression, a Reed Solomon -(63,12) error-control code converts 72-bit user messages into -sequences of 63 six-bit channel symbols. - -JT65 requires tight synchronization of time and frequency between -transmitter and receiver. Each transmission is divided into 126 -contiguous time intervals or symbols, each of length 4096/11025 = -0.372 s. Within each interval the waveform is a constant-amplitude -sinusoid at one of 65 pre-defined frequencies. Frequency steps -between intervals are accomplished in a phase-continuous manner. Half -of the channel symbols are devoted to a pseudo-random synchronizing -vector interleaved with the encoded information symbols. The sync -vector allows calibration of time and frequency offsets between -transmitter and receiver. A transmission nominally begins at t = 1 s -after the start of a UTC minute and finishes at t = 47.8 s. The -synchronizing tone is at 11025 × 472/4096 = 1270.5 Hz, and is normally -sent in each interval having a “1” in the following pseudo-random -sequence: - - 100110001111110101000101100100011100111101101111000110101011001 - 101010100100000011000000011010010110101010011001001000011111111 - -Encoded user information is transmitted during the 63 intervals not -used for the sync tone. Each channel symbol generates a tone at -frequency 1275.8 + 2.6917 × N × m Hz, where N is the value of the -six-bit symbol, 0 ≤ N ≤ 63, and m is 1, 2, or 4 for JT65 sub-modes A, -B, or C. - -For EME (but conventionally not on the HF bands) the signal report OOO -is sometimes used instead of numerical signal reports. It is conveyed -by reversing sync and data positions in the transmitted sequence. -Shorthand messages for RO, RRR, and 73 dispense with the sync vector -entirely and use time intervals of 1.486 s (16,384 samples) for pairs -of alternating tones. The lower frequency is always 1270.5 Hz, the -same as that of the sync tone, and the frequency separation is 26.92 × -n × m Hz with n = 2, 3, 4 for the messages RO, RRR, and 73. diff --git a/doc/source/jt9-protocol.adoc b/doc/source/jt9-protocol.adoc deleted file mode 100644 index e508ca312..000000000 --- a/doc/source/jt9-protocol.adoc +++ /dev/null @@ -1,24 +0,0 @@ -// Status=review -//Needs work! - -JT9 is designed for making minimal QSOs at LF, MF, and HF. It uses -72-bit structured messages nearly identical (at the user level) to -those in JT65. Error control coding (ECC) uses a strong convolutional -code with constraint length K=32, rate r=1/2, and a zero tail, leading -to an encoded message length of (72+31) × 2 = 206 information-carrying -bits. Modulation is nine-tone frequency-shift keying, 9-FSK. -Eight tones are used for data, one for synchronization. Eight data -tones means that three data bits are conveyed by each transmitted -information symbol. Sixteen symbol intervals are devoted to -synchronization, so a transmission requires a total of 206 / 3 -+ 16 = 85 (rounded up) channel symbols. The sync symbols are those -numbered 1, 2, 5, 10, 16, 23, 33, 35, 51, 52, 55, 60, 66, 73, 83, and -85 in the transmitted sequence. - -Each symbol lasts for 6912 sample intervals at 12000 samples per -second, or about 0.576 s. Tone spacing of the 9-FSK modulation is -12000/6912 = 1.736 Hz, the inverse of the symbol duration. The total -occupied bandwidth is 9 × 1.736 = 15.6 Hz. A generated JT9 signal has -continuous phase and constant amplitude, and there are no key clicks. -The transmitter's power amplifier need not be highly linear. - diff --git a/doc/source/make-qso.adoc b/doc/source/make-qso.adoc deleted file mode 100644 index bb9aaca4c..000000000 --- a/doc/source/make-qso.adoc +++ /dev/null @@ -1,151 +0,0 @@ -// Status=review -=== Standard Exchange -By longstanding tradition, a minimal valid QSO requires the exchange -of callsigns, a signal report or some other information, and -acknowledgments. _WSJT-X_ is designed to facilitate making such -minimal QSOs using short, structured messages. The process works best -if you use these formats and follow standard operating practices. The -recommended basic QSO goes something like this: - -[width="90%",cols="3,7,12",options="header"] -|======================================= -|UTC|Transmitted Message|Comment -|0001|CQ K1ABC FN42|K1ABC calls CQ -|0002|K1ABC G0XYZ IO91|G0XYZ answers -|0003|G0XYZ K1ABC –19|K1ABC sends report -|0004|K1ABC G0XYZ R–22|G0XYZ sends acknowledgment and report -|0005|G0XYZ K1ABC RRR|K1ABC sends acknowledgment -|0006|K1ABC G0XYZ 73|G0XYZ sends 73 -|======================================= - -*Standard messages* consist of two callsigns (or CQ, QRZ, or DE and -one callsign) followed by the transmitting station’s grid locator, a -signal report, R plus a signal report, or the final acknowledgements -RRR or 73. These messages are compressed and encoded in a highly -efficient and reliable way, and in uncompressed form may contain -as many as 18 characters. - -*Signal reports* are specified as signal-to-noise ratio (S/N) in dB, -using a standard reference noise bandwidth of 2500 Hz. Thus, in -example message #0003 above, K1ABC is telling G0XYZ that his signal is -19 dB below the noise power in bandwidth 2500 Hz. In message #0004, -G0XYZ acknowledges receipt of that report and responds with a –22 dB -signal report. JT65 reports are constrained to lie in the range –30 -to –1 dB, while JT9 supports the extended range –50 to +49 dB. - -TIP: Signals become visible on the waterfall around S/N = –26 dB and -audible (to someone with very good hearing) around –15 dB. Thresholds -for signal decodability are approximately –24 dB for JT65, –26 dB for -JT9. - -*Free Text Messages*: Users often add some friendly chit-chat at the -end of a QSO. Free-format messages such as ``TNX ROBERT 73'' or -``5W VERT 73 GL'' are supported, up to a maximum of 13 characters -(including spaces). It should be obvious that the JT9 and JT65 -protocols are not well suited for extensive conversations or rag-chewing. - -=== Compound Callsigns - -Compound callsigns such as xx/K1ABC or K1ABC/x are handled in -one of two possible ways. - -.Type 1 Compound-Callsign Messages - -A list of about 350 of the most common prefixes and suffixes can be -displayed from the *Help* menu. A single compound callsign involving -one item from this list can be used in place of the standard third -message word (normally a locator, signal report, RRR, or 73). Thus, -the following examples are all acceptable *Type 1* messages with -compound callsigns: - - CQ ZA/K1ABC - CQ K1ABC/4 - ZA/K1ABC G0XYZ - G0XYZ K1ABC/4 - -The following messages are _not_ valid, because a third word is not -permitted in a *Type 1* message: - - ZA/K1ABC G0XYZ -22 #These messages will be sent - G0XYZ K1ABC/4 73 #without the third "word" - -A QSO between two stations using *Type 1* compound-callsign messages -might look like this: - - CQ ZA/K1ABC - ZA/K1ABC G0XYZ - G0XYZ K1ABC –19 - K1ABC G0XYZ R–22 - G0XYZ K1ABC RRR - K1ABC G0XYZ 73 - -Notice that both operators send and receive the full compound -callsign in the first two transmissions. After that, they omit the -add-on prefix or suffix and use the standard structured messages. - -.Type 2 Compound-Callsign Messages - -Prefixes and suffixes _not_ found in the short displayable list can be -handled with a *Type 2* message. The compound callsign must be the -second word in a two- or three-word message, and the first word must -be CQ, DE, or QRZ. Prefixes can be 1 to 4 characters, suffixes 1 to 3 -characters. A third word conveying a locator, report, RRR, or 73 is -permitted. The following are valid *Type 2* messages with compound -callsigns: - - CQ W4/G0XYZ FM07 - DE W4/G0XYZ -22 - QRZ K1ABC/VE6 DO33 - -In each case, the message is treated as *Type 2* because the add-on -prefix or suffix is _not_ one of those in the fixed list. Note -that a second callsign is never permissible in these messages. - -TIP: Remember that during a transmission your transmitted message is -always displayed in the first label on the *Status Bar*, highlighted -in yellow. It is displayed there exactly as another station would -receive it. - -QSOs involving *Type 2* compound callsigns might look like either -of the following sequences - - CQ KP4/K1ABC FK68 - K1ABC G0XYZ IO91 - G0XYZ K1ABC –19 - K1ABC G0XYZ R–22 - G0XYZ K1ABC RRR - K1ABC G0XYZ 73 - - - CQ K1ABC FN42 - DE G0XYZ/W4 FM18 - G0XYZ K1ABC –19 - K1ABC G0XYZ R–22 - G0XYZ K1ABC RRR - DE G0XYZ/W4 73 - -Each operator sends his own compound callsign in the first (and -possibly also last) transmission, as may be required by licensing -authorities. Subsequent transmissions may use the standard structured -messages without callsign prefix or suffix. - -IMPORTANT: It's up to you, the operator, to ensure that messages with -compound callsigns are composed in the manner described above. -Double-clicking on a line of decoded text may not always produce the -desired result. - -=== Pre-QSO Checklist - -Before attempting your first QSO with JT9 or JT65, be sure to go -through the <> above, as well as the following -checklist: - -- Your callsign and grid locator set to correct values -- PTT and CAT control (if used) properly configured and tested -- Computer clock properly synchronized to UTC within ±1 s -- Radio set to *USB* (upper sideband) mode -- Radio's Split mode selected or not, consistent with your choice -on *Station* tab of the *Setup | Configuration* window. - -IMPORTANT: Remember that JT9 and J65 generally do not require high -power. Under most propagation conditions, QRP is the norm. diff --git a/doc/source/quick-reference.adoc b/doc/source/quick-reference.adoc deleted file mode 100644 index 8369566dc..000000000 --- a/doc/source/quick-reference.adoc +++ /dev/null @@ -1,383 +0,0 @@ -// Status=DRAFT -// this is intentionally left as a single file v.s. multiple sections to allow -// users to browse the Page Source -= AsciiDoc Quick Reference -:Author: WSJT-X Documetation Team -:Date: January 22, 2014, (C) copyright, CC-BY-SA 3.0 Unported -:Revision: 0.0.1 -:badges: -:icons: -:numbered: - -// WEB links - List is getting pretty long, time to use include::file-name ?? -:asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ] -:asciidoc_cheatsheet: http://powerman.name/doc/asciidoc[ AsciiDoc Cheatsheet ] -:asciidoc_questions: http://www.methods.co.nz/asciidoc/faq.html[ AsciiDoc FAQ ] -:debian: http://www.debian.org/[ Debian ] -:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ] -:devsvn: http://developer.berlios.de/projects/wsjt/[ Devel-SVN ] -:devsvn: http://developer.berlios.de/projects/wsjt/[wsjt-svn] -:download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ] -:dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ] -:homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ] -:hrd: http://www.hrdsoftwarellc.com/[ Ham Radio Deluxe ] -:jtalert: http://ham-apps.com[JT-ALERT-X] -:jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX] -:launchpadurl: https://launchpad.net/~jnogatch/+archive/wsjtx[ WSJT-X Linux Packages ] -:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] -:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] -:osx_instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here] -:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ] - -// DOWNLOAD links -:cty_dat: http://www.country-files.com/cty/[here]. -:cygwin: http://cygwin.com/install.html[here] -:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd] -:osx_108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ] -:osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[ OS X 10.9 ] - -// MAIL-TO links -:alex_efros: mailto:powerman@powerman.name[ Alex Efros ] -:devmail: mailto:wsjt-devel@lists.berlios.de[ wsjt-devel ] -:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ] - -[[X1]] -== Introduction -The purpose of this guide is to provide a quick reference to commonly used items -while working with the _WSJT-X Documentation_ project. - -=== AsciiDoc Examples -* {asciidoc_help} by {stuart_rackman} -* {asciidoc_questions} by {stuart_rackman} -* {asciidoc_cheatsheet} by {alex_efros} - -[[X2]] -== AsciiDoc installation - -For most packages, the normal method of installation is through their -respective package manager. There are several reasons why we do not -want this for the _WSJT-X User Guide_: - -* Most package applications are installed system-wide, which means standard -privileged (non Root / RootSudo) users update their binaries. -* Often times, distro packages are (1) or more revisions behind. -* Updating to the latest stable _AsciiDoc_ version, using Mercurial, is a simple -one line command. -* Using $HOME makes working on the _WSJT-X User Guide_ portable, such as, -installing to a USB Key allows testing of your work on virtually any system -which has _Python_ {amp}{amp} _Bash Enviroment_ installed. - -[[X21]] -=== Windows -.WinXP thru Win8 - -The preferred method of installing _AsciiDoc_ on Windows is through _Cygwin_. - -TIP: You can install _Cygwin_ anywhere you like, hard drive, internal, external -or to a USB Key. - -==== Download the _Cygwin_ Installer -* For a 32-bit system, download http://cygwin.com/setup-x86.exe[Setup-x86.exe] -* For a 64-bit system, download http://cygwin.com/setup-x86_64.exe[Setup-x86-64.exe] -* For additional information, see http://cygwin.com/install.html[Cygwin.com] -* Saving the installer to desktop makes updating quick {amp} easy - -==== Running the installer -* Double click the _Cygwin Installer_ -* Select Install from Internet -* Root Directory: C:\cygwin -* Select for All Users -* Package Download Directory: C:\cygdownloads -* Select Direct Connection -* I use ftp://mirrors.kernel.org - -==== Cygwin package selection - -At the top left corner of the install GUI, you will find a search box. Enter the -package name, then select it from the areas indicated below. Only the primary -packages are needed, [red]#not# additional modules. - -* Use *Search Box*: -** *python* => Interpreters => Python language interpreter -** *mercurical* => Devel => Python based DVCS -** *subversion* => Devel => A version control system -** *source-highlight* => Text => Syntax highlighting utilities -** *openssh* => Net => The OpenSSH server and client programs -** *nano* => Editors => Enhanced clone of Pico editor -** *ncurses* => Utils => Utilities for terminal handling -* Then, next to start installation -* At create icons and short-cuts, I select desktop only - -==== Verify package installation - -When _Cygwin_ finishes the installation, you will have a very capable base -system to work with. From this point onward, all actions are performed in the -_Cygwin Terminal_. To launch a terminal session, simply double click the -desktop icon as you would any other Windows application. - -==== Package Verification -[source,bash] ------ -# one line per action -python -V -hg --version |head -n1 -svn --version |head -n1 -source-highlight --version |head -n1 - -# Your versions may vary slightly -Python 2.7.6 -svn, version 1.7.14 -Mercurial Distributed SCM (version 2.8.2) -GNU Source-highlight 3.1.6 ------ - -CAUTION: If any package check returns with an error, resolve before -continuing !! - -==== Configure _Bash Environment_ -[source,bash] ------ -# Edit ./.bash_profile, uncomment if statement: -nano ./.bash_profile - -# Find and Change too: (remove # sign for all 3 lines) -if [ -d "$HOME/bin" ] ; then - PATH="$HOME/bin:$PATH" -fi - -# Ctrl+X to exit, Y to confirm, then Enter to save -# Create directories, source .bash_profile, check $PATH: -mkdir -p $HOME/bin $HOME/Projects/documentation/wsjtx -source ./.bash_profile -echo $PATH - -# You should see /home/$USER/bin at the beginning of the string. - ------ - -==== Download and Configure _AsciiDoc_ - -[source,bash] ------ -# one action per line -cd ~/bin - -# get latest AsciiDoc build -hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9 - -# pull updates and upgrade packages -cd asciidoc-8.6.9 && hg pull && hg update && hg upgrade && cd .. - -# link binaries to $HOME/bin -ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc - -# check AsciiDoc runs properly -asciidoc --version - -# Should return: asciidoc 8.6.9 - ------ - -==== Test build _WSJT-X User Guide_ -[source,bash] ------ -cd ~/Projects/documentation/wsjtx - -# then; - -cd ~/Projects/documentation/wsjtx && ./build-doc.sh toc2 ------ - -==== Open _WSJT-X User Guide_ in a browser -[source,bash] ------ -# for chromium -cygstart chrope wsjtx-main-toc2.html - -# for FireFox -cygstart firefox wsjtx-main-toc2.html ------ - -[[X22]] -=== Linux -.Debian, Ubuntu, Mint {amp} Relatives - -There are many relatives of Debian {amp} Ubuntu, and most shells are _Bash_. For -all but the package-manager commands, you should be able to _Copy {amp} Paste_ -directly into the terminal. - -It is a good idea to always start from a fresh repository list, and to have the -install up to date before adding new packages. - -==== Install Dependencies -[source,bash] ------ -# For Debian and relatives, update && Upgrade first -sudo apt-get update && sudo apt-get upgrade - -# Install Dependencies -sudo apt-get install mercurial source-highlight subversion - -# Verify the packages installed properly -python -V -hg --version |head -n1 -svn --version |head -n1 -source-highlight --version |head -n1 - -# Your versions may vary slightly -Python 2.7.6 -svn, version 1.7.14 -Mercurial Distributed SCM (version 2.8.2) -GNU Source-highlight 3.1.6 ------ - -CAUTION: If any package check returns with an error, resolve before -continuing !! - -==== Check for Previous AsciiDoc Installation -[source,bash] ------ -# check if AsciiDoc is already installed: -asciidoc --version - -# If Bash returns any version, remove it: -sudo apt-get purge asciidoc - ------ - -==== Add Directories and source profile -[source,bash] ------ -mkdir -p $HOME/bin $HOME/Projects/documentation/wsjtx -source ~/.bashrc && source ~/.profile -echo $PATH - -# should return something like: /home/$USER/bin:/usr/local/sbin: .. .. .. - ------ - -TIP: You may have to log out and back in for the addition to take place. -If need be, add the following to your shell profile, then source or -log out / back in: - -==== Add conditional to ~/.bashrc -[source,bash] ------ -if [ -d "$HOME/bin" ] -then - PATH="$HOME/bin:$PATH" -fi ------ - -==== Download and Configure _AsciiDoc_ -[source,bash] ------ -# one action per line -cd ~/bin - -# get latest AsciiDoc build -hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9 - -# pull updates and upgrade packages -cd asciidoc-8.6.9 && hg pull && hg update && hg upgrade && cd .. - -# link binaries to $HOME/bin -ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc - -# check AsciiDoc runs properly -asciidoc --version - -# Should return: asciidoc 8.6.9 - ------ - -==== Test build _WSJT-X User Guide_ -[source,bash] ------ -cd ~/Projects/documentation/wsjtx - -# then; - -cd ~/Projects/documentation/wsjtx && ./build-doc.sh toc2 ------ - -==== Open _WSJT-X User Guide_ in a browser -[source,bash] ------ -# for chromium -chromium-browser wsjtx-main-toc2.html - -# for FireFox -firefox wsjtx-main-toc2.html ------ - -=== OS X -.10.8 {amp} 10.9 - -content needed - -== Using the Terminal -.Tips {amp} Tricks to make things easier - -Add content - -=== Alias - Short cuts - -add content - -=== Add Some Color - -add content - -=== Search Documents - -add content - -=== Recursive Replace - -add content - -=== Document Status - -add content - -== SVN Basics -.Commonly used svn commands - -Add content - -=== Devel Accounts -.Developer and normal users - -add content - -=== Check-In/Out -.Commonly used commands - -add content - -=== Using Patches -.How to create and apply patches - -add content - -=== Log Usage -.How to get the most from svn logs - -add content - -== Appendix A: Credits -.Authors, Editors, Commiters -If you worked on the documentation, add yourself to the list. - -* Authors: , - -* Editors: , - -* Commiters: , - - -== Appendix B: License - -This work is licensed under {cc_by_sa}. - diff --git a/doc/source/rig-config-adat.adoc b/doc/source/rig-config-adat.adoc deleted file mode 100644 index a556a60ac..000000000 --- a/doc/source/rig-config-adat.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= ADAT Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|ADAT3|ADAT4|ADAT5 -|======== - -[[X1]] -== ADAT-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== ADAT-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-alinco.adoc b/doc/source/rig-config-alinco.adoc deleted file mode 100644 index bf42e3d10..000000000 --- a/doc/source/rig-config-alinco.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= Alinco Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|Alinco3|Alinco4|Alinco5 -|======== - -[[X1]] -== Alinco-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== Alinco-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-aor.adoc b/doc/source/rig-config-aor.adoc deleted file mode 100644 index 11cb9436f..000000000 --- a/doc/source/rig-config-aor.adoc +++ /dev/null @@ -1,103 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= AOR Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|AOR3|AOR4|AOR5 -|======== - -[[X1]] -== AOR-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== AOR-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew diff --git a/doc/source/rig-config-drake.adoc b/doc/source/rig-config-drake.adoc deleted file mode 100644 index 5310ff59b..000000000 --- a/doc/source/rig-config-drake.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= Drake Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|Drake3|Drake4|Drake5 -|======== - -[[X1]] -== Drake-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== Drake-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-elecraft.adoc b/doc/source/rig-config-elecraft.adoc deleted file mode 100644 index 34a05f253..000000000 --- a/doc/source/rig-config-elecraft.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= ElectroCraft Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|ElectroCraft3|ElectroCraft4|ElectroCraft5 -|======== - -[[X1]] -== ElectroCraft-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== ElectroCraft-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-flexrad.adoc b/doc/source/rig-config-flexrad.adoc deleted file mode 100644 index dd17de563..000000000 --- a/doc/source/rig-config-flexrad.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= Flex Radio Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|Flex3|Flex4|Flex5 -|======== - -[[X1]] -== Flex-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== Flex-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-icom.adoc b/doc/source/rig-config-icom.adoc deleted file mode 100644 index 2e626adee..000000000 --- a/doc/source/rig-config-icom.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= Icom Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|Icom3|Icom4|Icom5 -|======== - -[[X1]] -== Icom-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== Icom-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-kenwood.adoc b/doc/source/rig-config-kenwood.adoc deleted file mode 100644 index 708d2695f..000000000 --- a/doc/source/rig-config-kenwood.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= Kenwood Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|Kenwood3|Kenwood4|Kenwood5 -|======== - -[[X1]] -== Kenwood-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== Kenwood-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-main.adoc b/doc/source/rig-config-main.adoc deleted file mode 100644 index 4701d936a..000000000 --- a/doc/source/rig-config-main.adoc +++ /dev/null @@ -1,33 +0,0 @@ -// Status=review -:adat: link:rig-config-adat.html[ ADAT] -:alinco: link:rig-config-alinco.html[ Alinco ] -:aor: link:rig-config-aor.html[ AOR ] -:drake: link:rig-config-drake.html[ Drake ] -:elecraft: link:rig-config-elecraft.html[ Elecraft ] -:flexrad: link:rig-config-flexrad.html[ Flex Radio ] -:kenwood: link:rig-config-kenwood.html[ Kenwood ] -:icom: link:rig-config-icom.html[ Icom ] -:rig_template: link:rig-config-template.html[Template] -:softrock: link:rig-config-softrock.html[ Soft Rock ] -:tentec: link:rig-config-tentec.html[ Ten Tec ] -:yaesu: link:rig-config-yaesu.html[Yaesu] - -Some rigs work with DTR, RTS, Polling, CAT, and PTT while others do -not. The number of possible combinations is virtually endless. The -purpose of this section is to provide configuration information for -specific rig models, e.g. Icom 756 Pro-III, Kenwood TS-2000, Yaesu -FT-1000MP, Flex-5000, etc. This is a work-in-progress, and some rigs -may never be covered. - -TIP: If you have configuration data for a rig that is not listed, or -comments about a particular rig configuration, please use the -{rig_template} and send it to {devmail}. - -.Select Manufacturer -[align="center",valign="middle",halign="center"] -|======== -|{adat}|{aor}|{alinco}|{drake}|{elecraft} -|{flexrad}|{kenwood}|{icom}|{softrock}|{tentec} -|{yaesu}|{rig_template}||| -|======== - diff --git a/doc/source/rig-config-softrock.adoc b/doc/source/rig-config-softrock.adoc deleted file mode 100644 index a2319d8b5..000000000 --- a/doc/source/rig-config-softrock.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= SoftRock Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|SR3|SR4|SR5 -|======== - -[[X1]] -== SR-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== SR-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-template.adoc b/doc/source/rig-config-template.adoc deleted file mode 100644 index 474dc1a93..000000000 --- a/doc/source/rig-config-template.adoc +++ /dev/null @@ -1,60 +0,0 @@ -// Status=review -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] -= Rig Template - -This is a simple guide for providing rig configuration data for the WSJT-X -User Guide. Try to fill out as much as possible, but do not worry if you cannot -fill in all the fields. OS Specific & Interface Notes are a bonus. - -* Copy and paste the template into a text file. -* Save as the rig's model.txt: rig-confg-ic756p3.txt -* Email the file to {devmail} for inclusion. -* Alternatively, join the team and submit the updates directly. - -.Copy & Paste the following: ----------- -Manufacturer: -Model: -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew ----------- - diff --git a/doc/source/rig-config-tentec.adoc b/doc/source/rig-config-tentec.adoc deleted file mode 100644 index 7d4f14e57..000000000 --- a/doc/source/rig-config-tentec.adoc +++ /dev/null @@ -1,104 +0,0 @@ -// Status=needsupdate -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= Ten Tec Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|TenTec3|TenTec4|TenTec5 -|======== - -[[X1]] -== TenTec-1 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== TenTec-2 -.Configuration Covers: - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -- Note-1/2/3 -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio --In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/rig-config-yaesu.adoc b/doc/source/rig-config-yaesu.adoc deleted file mode 100644 index e71d4909a..000000000 --- a/doc/source/rig-config-yaesu.adoc +++ /dev/null @@ -1,102 +0,0 @@ -// Status=review -// This is a comment line, anything with // is ignored at process time. -// because the page is not a main page include, we need to add -// ref-links again, as they are not global. -:icons: -:badges: -:rig_template: link:rig-config-template.html[Template] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] - -= Yaesu Configuration Guide -Available Configurations - -If you have configuration data for a rig that is not listed, or comments about a -particular rig configuration, please use the {rig_template} and send it to -{devmail}. - -[align="center",valign="middle",halign="center"] -// 5 Models per line please -|======== -|<>|<>|FT-3000|FT-5000|FT-9000 -|======== - -[[X1]] -== FT-1000 -.Configuration Covers FT-1000, FT-1000MP, FT-1000D - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - -[[X2]] -== FT-2000 -.Configuration Covers FT-2000, FT-2000D - -* MyCall: -* MyGrid: -* PTT Method: -* Pskreporter: -* CW Id After 73: -* CW Interval: -* CAT NOTES: -* DTR: -* RTS: -* CAT Port: -* CAT Port Settings: -* Split: -* Polling: -* Audio-In: -* Audio-In Mono: -* Audio-Out: -* Audio-Out: - -=== OS Specific Notes -.Notes Relating To Operating System - -* Windows: XP, Vista, Win7, Win8, etc. -* Linux: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc -* Mac OSx: - -=== Interface Notes -.Notes Relating To Rig Interface - -* Navigator -* SignaLink -* ShackLan -* Kam -* DX-Doubler -* Array Solutions -* Home-Brew - diff --git a/doc/source/runtime-files.adoc b/doc/source/runtime-files.adoc deleted file mode 100644 index 45cdfca13..000000000 --- a/doc/source/runtime-files.adoc +++ /dev/null @@ -1,14 +0,0 @@ -// Status=review - -You might be curious about additional files that appear in the WSJTX -installation directory after using the program. These include the -following: - -[horizontal] -.Files created when running WSJT-X -+ALL.TXT+:: Log of all received and transmitted messages -+decoded.txt+:: Decoded text from the most recent Rx interval -+timer.out+:: Diagnostic information for decoder optimization -+wsjtx.ini+:: Saved configuration parameters -+wsjtx_log.adi+:: ADIF log -+wsjtx_status.txt+:: Information sent to companion program JT-Alert diff --git a/doc/source/system-requirments.adoc b/doc/source/system-requirments.adoc deleted file mode 100644 index bc38a9a84..000000000 --- a/doc/source/system-requirments.adoc +++ /dev/null @@ -1,10 +0,0 @@ -// Status=review -- SSB transceiver and antenna -- Computer running Windows (XP or later), Linux, or OS X -- 1.5 GHz or faster CPU and 100 MB of available memory -- Monitor with at least 1024 x 780 resolution (more is better) -- Computer-to-radio interface using a serial port for T/R switching, or CAT -control, or VOX -- Audio input and output devices supported by the operating system -- Audio or equivalent USB connections between transceiver and computer -- A means for synchronizing the computer clock to UTC within ±1 s diff --git a/doc/source/transceiver-setup.adoc b/doc/source/transceiver-setup.adoc deleted file mode 100644 index 168fd0ebc..000000000 --- a/doc/source/transceiver-setup.adoc +++ /dev/null @@ -1,42 +0,0 @@ -// Status=review -.Receiver Noise Level - -- Click the *Monitor* button to return to normal receive operation -(button should be highlighted in [green]*GREEN*). - -- Set your transceiver to *USB* (or *USB Data*) mode. - -- Use the receiver gain controls and/or Windows mixer controls to set -the background noise level (scale at lower left of main window) to -around 30 dB when no signals are present. If necessary you can also use -the slider next to the scale, but note that the overall dynamic range -will be best with this slider not too far from its mid-point. - -.Bandwidth and Frequency Setting - -Many SSB transceivers have a fixed-width Tx filter that will not pass -audio frequencies higher than about 2700 Hz. _WSJT-X_ takes care of -this by offering a *Split Tx* mode, receiving with *VFO A* and -transmitting with *VFO B*. Under CAT control _WSJT-X_ offsets the Tx -dial frequency (*VFO B*) in 500 Hz steps, adjusting the generated -audio frequency so that it always falls in the range 1500 – 2000 -Hz. With *CAT* and *Split Tx* enabled on the configuration screen and -your transceiver set to *Split* mode, this frequency control will be -handled automatically. - -If your transceiver has only a standard SSB filter you won’t be able -to use more than about 2.7 kHz bandwidth. You can still have all of -the JT9 sub-band and part of the JT65 sub-band available on screen, -however. On 20m, say, set dial frequency (*VFO A*) to 14.0774 and the -*JT9 nnnn JT65* dividing line at 1600 Hz. JT9 signals in their -conventional sub-band will then appear at 1600 – 2600 Hz, while JT65 -signals will be below 1000 Hz. Of course, you might prefer to -concentrate on one mode at a time, setting your dial frequency to -(say) 14.076 for JT65 and 14.078 for JT9. Present conventions have -the nominal JT9 dial frequency 2 kHz higher than the JT65 dial -frequency, and the checkbox labeled *+2 kHz*, just below the *Band* -selector, makes the appropriate settings easy. - -IMPORTANT: When you are finished with this Tutorial, don’t forget to -re-enter your own callsign as *My Call*. - diff --git a/doc/source/tutorial-example1.adoc b/doc/source/tutorial-example1.adoc deleted file mode 100644 index 4a1ccffe9..000000000 --- a/doc/source/tutorial-example1.adoc +++ /dev/null @@ -1,99 +0,0 @@ -// Status=review -.Open a Wave File: - -- Select *File | Open* and navigate to -+...\save\samples\130418_1742.wav+ under the _WSJT-X_ installation -directory. When the file opens you should see something similar to -the to the following screen shot: - -[[X12]] -image::images/r3666-main-ui-80.png[align="center",alt="Main UI and Wide Graph"] - -.Decoding Overview - -Notice the [green]*GREEN* and [red]*RED* markers on the waterfall -frequency scale. Decoding takes place at the end of a receive -sequence and is organized in two stages. The first decodes take place -at the selected Rx frequency, indicated by the [green]*GREEN* marker -on the waterfall scale. Results appear in both the left (*Band -Activity*) and right (*Rx Frequency*) text windows on the main -screen. The program then finds and decodes all signals in the selected -mode(s) over the displayed frequency range. The [red]*RED* marker -indicates your Tx frequency. - -Seven JT9 signals are present in the example file, all decodable. -When this file was recorded KF4RWA was finishing a QSO with K1JT. -Since the green marker was placed at his audio frequency, 1224 Hz, his -message ``K1JT KF4RWA 73'' is decoded first and appears in the *Rx -Frequency* window. The *Band Activity* window shows this message plus -all decodes at other frequencies. Lines containing CQ are highlighted -in [green]*GREEN*, and lines with *My Call* (in this case K1JT) in -[red]*RED*. - -TIP: For this step and the next, you may want to pretend you are K1JT -by entering that callsign temporarily as *My Call* on the <> screen. Your results should then be identical to -those shown in the screen shot above. - -[[X13]] -.Decoding Controls - -To gain some feeling for controls frequently used when making QSOs, -try clicking with the mouse on the decoded text lines and on the -waterfall spectral display. You should be able to confirm the -following behavior: - -- Double-click on either of the decoded lines highlighted in -green. This action produces the following results: - -** Callsign and locator of a station calling CQ are copied to the *DX -Call* and *DX Grid* entry fields. - -** Messages are generated for a standard minimal QSO. - -** The *Tx even* box is checked or cleared appropriately, so that you -will transmit in the proper (odd or even) minutes. - -** The Rx and Tx frequency markers are moved to the frequency of the -CQing station. - -** The *Gen Msg* (``generated message'') radio button at bottom right -of the main window is selected. - -** If you had checked *Double-click on call sets Tx Enable* on the -*Setup* menu, *Enable Tx* would be activated and a transmission would -start automatically at the proper time. - -- Double-click on the decoded message ``K1JT N5KDV EM41'', -highlighted in [red]*RED*. Results will be similar to those in the -previous step, except the Tx frequency ([red]*RED* marker) is not -moved. Such messages are usually in response to your own CQ, or from -a tail-ender, and you probably want your Tx frequency to stay where it -was. - -- By holding down the *Ctrl* key when double-clicking on a decoded -line you can cause both Tx and Rx frequencies to be moved. This -behavior can also be forced by checking *Lock Tx=Rx*. - -- Double-click on the message from KF4RWA in either window. He is -sending ``73'' to K1JT, signifying that the QSO is over. Most likely -you want to send 73 to him, so the message ``KF4RWA K1JT 73'' is -automatically generated and selected for your next transmission. -(Alternatively, you might choose to send a free text message or to -call CQ again.) - -- Click somewhere on the waterfall to set Rx frequency ([green]*GREEN* -marker). - -- Ctrl-click on the waterfall to set both Rx and Tx frequencies. - -- Double-click on a signal in the waterfall to set Rx frequency and -start a narrow-band decode there. Decoded text will appear in the -right window only. - -- Ctrl-double-click on a signal to set both Rx and Tx frequencies and -decode at the new frequency. - -- Click *Erase* to clear the right window. - -- Double-click *Erase* to clear both text windows. diff --git a/doc/source/tutorial-example2.adoc b/doc/source/tutorial-example2.adoc deleted file mode 100644 index bb4e80fca..000000000 --- a/doc/source/tutorial-example2.adoc +++ /dev/null @@ -1,113 +0,0 @@ -// Status=review -.Wide Graph Settings: - -- Set *Bins/Pixel* = 7 -- Adjust the width of the Wide Graph window so that the upper -frequency limit is approximately 4000 Hz. - -.Main Window: -- Select *JT9+JT65* on the *Mode* menu. -- Toggle the *Tx mode* button to read *Tx JT65*, and set the Tx and Rx -frequencies to 1718 Hz. -- Double-click on *Erase* to clear both text windows. - -.Open a Wave File: - -- Select *File | Open* and navigate to +...\save\samples\130610_2343.wav+. -The waterfall should look like this: - -//.130610_2343.wav Decode -[[X14]] -image::images/130610_2343-wav-80.png[align="left",alt="Wide Graph Decode 130610_2343"] - -TIP: Notice the [blue]*BLUE* marker on the waterfall scale, here -set at 2400 Hz. Its position is set by the spinner control *JT65 nnnn -JT9*, where nnnn is a frequency in Hz. In *JT9+JT65* mode the program -will automatically decode JT65 signals below this frequency and JT9 -signals above it. - -JT9 signals appear in the *Cumulative* spectrum as nearly -rectangular shapes about 16 Hz wide. Although there is no clearly -visible sync tone like the one at the low-frequency edge of JT65 -signals, by convention the nominal frequency of a JT9 signal is taken -to be that of its lowest tone, at the left edge of its spectrum. - -This sample file contains 17 decodable signals — nine in JT65 mode -(flagged with the character # in the decoded text windows), and eight -in JT9 mode (flagged with @). The *Band Activity* window should -contain these decodes (you may need to scroll back in the window to -see them all): - -// ... Figure here showing the text windows ? -[[FigDecodes]] -image::images/decodes.png[align="center"] - -Since the Tx mode was set to *Tx JT65*, signals in that mode were -decoded next. If you had selected *Tx JT9*, JT9 signals would have -been decoded first. - -- Confirm that mouse-click behavior is similar to that described -<>, in Example 1. The program automatically determines -the mode of each JT9 or JT65 signal. - -TIP: When you double-click on a signal in the waterfall it will be -properly decoded even if on the ``wrong'' side of the *JT65 nnnn JT9* -marker. The Tx mode automatically switches to that of the decoded -signal and the Rx and Tx frequency markers on the waterfall scale -resize themselves accordingly. When selecting a JT65 signal, click on -the sync tone at its left edge. - -- Double-click on the waterfall near 815 Hz: a JT65 message -originating from W7VP will be decoded and appear in the *Rx Frequency* -window. - -[width="70%",cols="3,^3,^3,^4,^4,30",options="header"] -|================================= -|UTC|db|dt|Freq|Mode|Message -|2343|-7|0.3|815|#|KK4DSD W7VP -16 -|================================= - -- Double-click on the waterfall at 3196 Hz. The program will decode a -JT9 message from IZ0MIT: - -[width="70%",cols="3,^3,^3,^4,^4,30",options="header"] -|===================================== -|UTC|db|dt|Freq|Mode|Message -|2343|-7|0.3|3196|@|WB8QPG IZ0MIT -11 -|===================================== - -- Scroll back in the *Band Activity* window and double-click on the -message CQ DL7ACA JO40. The program will set *Tx mode* to JT65 and Tx -and Rx frequencies to that of DL7ACA, 975 Hz. If you had checked -*Double-click on call sets Tx Enable* on the *Setup* menu, the program -would configure itself to start a QSO with DL7ACA. - -- Double-click on the decoded JT65 message CQ TA4A KM37. The program -will set Tx mode to JT9 and the Rx and Tx frequencies to 3567 Hz. The -program is now configured properly for a JT9 QSO with TA4A. - -.Reopen the First Sample File: -- Select *File | Open* and navigate to +...\save\samples\130418_1742.wav+. - -Taking full advantage of the wide-band, dual-mode capability of -_WSJT-X_ requires a receiver bandwidth of at least 4 kHz. These -data were recorded with a much narrower Rx bandwidth, roughly 200 to -2600 Hz. If you have no Rx filter wider than about 2.7 kHz, you will -be using data like this. For best viewing, adjust *Bins/Pixel* and the -width of the Wide Graph so that only the active part of the spectrum -shows, say 0 to 2600 Hz. Re-open the example file after any change of -*Bins/Pixel* or Wide Graph width, to refresh the waterfall. - -The signals in this file are all JT9 signals. To decode them -automatically in *JT9+JT65* mode you’ll need to move the *JT65 nnnn JT9* -delimiter down to 1000 Hz or less. - -.Start, Zero, and Gain - -Now is a good time to experiment with the *Start*, *Zero*, and *Gain* -parameters. *Start* determines the frequency displayed at the left -side of the waterfall scale. *Zero* sets the baseline level for -colors, and *Gain* sets the sensitivity for color changes. For the -receiver setup of this file good values are close to *Zero*=0, -*Gain*=0. Re-open the wave file after each change, to see the new -results. diff --git a/doc/source/tutorial-main-window.adoc b/doc/source/tutorial-main-window.adoc deleted file mode 100644 index bfc947eca..000000000 --- a/doc/source/tutorial-main-window.adoc +++ /dev/null @@ -1,6 +0,0 @@ -// Status=review - -- Click the *Stop* button on the main window to halt any data acquisition. -- Select *JT9* from the *Mode* menu and *Deepest* from the *Decode* menu. -- Set the audio frequencies to *Tx 1224 Hz* and *Rx 1224 Hz*. - diff --git a/doc/source/tutorial-wide-graph-settings.adoc b/doc/source/tutorial-wide-graph-settings.adoc deleted file mode 100644 index c42eafb4f..000000000 --- a/doc/source/tutorial-wide-graph-settings.adoc +++ /dev/null @@ -1,14 +0,0 @@ -// Status=review - -- *Bins/Pixel* = 4 -- *JT65 .... JT9* = 2500 -- *Start* = 0 -- *N Avg* = 5 -- *Zero* = 0 -- *Gain* = 0, -- *Palette* = Digipan -- *Flatten* = checked -- Select *Cumulative* for data display. -- Select *Tab 2* (below the *Decode* button on the main window) to -choose the alternative set of controls for generating and selecting -Tx messages. diff --git a/doc/source/tx-rx.adoc b/doc/source/tx-rx.adoc deleted file mode 100644 index ff24392b2..000000000 --- a/doc/source/tx-rx.adoc +++ /dev/null @@ -1,75 +0,0 @@ -// Status=review -.Transmitting - -Immediately before the start of a transmission _WSJT-X_ encodes a -user's message and computes the sequence of tones to be sent. The -transmitted audio waveform is then computed on-the-fly, using 16-bit -integer samples at a 48000 Hz rate. Digital samples are converted to -an analog waveform in the sound card or equivalent D/A interface. - -.Receiving - -_WSJT-X_ acquires 16-bit integer samples from the sound card at a 48000 -Hz rate and immediately downsamples the stream to 12000 Hz. Spectra -from overlapping segments are computed for the waterfall display and -saved at intervals of 0.188 s, half the JT9 symbol length. - -At the end of a reception sequence, about 50 seconds into the UTC -minute, received data samples are forwarded to the decoder. For -operator convenience the decoder goes through its full procedure -twice: first at the selected Rx frequency, and then over the full -displayed frequency range. Each decoding pass can be described as a -sequence of discrete blocks. These functional blocks are different -for the JT65 and JT9 modes. - -.Decoding - -The basic decoding algorithm for JT65 mode was described in the -{jt65protocol} paper. The following list summarizes the corresponding -algorithm for JT9 mode, with blocks labeled with the names of -functional procedures in the code. - -[horizontal] -+sync9+:: Use sync symbols to find candidate JT9 signals - in the specified frequency range - -Then, at the frequency of each plausible candidate: - -[horizontal] -+downsam9+:: Mix, filter and downsample to 16 complex - samples/symbol - -+peakdt9+:: Using sync symbols, time-align to start of JT9 symbol - sequence - -+afc9+:: Measure frequency offset and any possible drift - -+twkfreq+:: Remove frequency offset and drift - -+symspec2+:: Compute 8-bin spectra for 69 information-carrying - symbols, using the time- and frequency-aligned data; - transform to yield 206 single-bit soft symbols - -+interleave9+:: Remove single-bit symbol interleaving imposed at the - transmitter - -+decode9+:: Retrieve a 72-bit user message using the sequential - Fano algorithm for convolutional codes - - -+unpackmsg+:: Unpack a human-readable message from the 72-bit - compressed format - -Decoding of clean JT9 signals in a white-noise background starts to -fail below signal-to-noise ratio -25 dB and reaches 50% copy at -26 -dB. - -With marginal or unrecognizable signals the sequential decoding -algorithm can take exponentially long times. If the +sync9+ step in -the above sequence finds many seemingly worthy candidate signals, and -if many of them turn out to be undecodable the decoding loop can take -an inconveniently long time. For this reason the step labeled -+decode9+ is programmed to ``time out'' and report failure if it is -taking too long. The choices *Fast | Normal | Deepest* on the Decode -menu provide the user with a three-step adjustment of this timeout -limit. diff --git a/doc/source/utilities.adoc b/doc/source/utilities.adoc deleted file mode 100644 index afa48a097..000000000 --- a/doc/source/utilities.adoc +++ /dev/null @@ -1,58 +0,0 @@ -// Status=review - -Utility programs +jt9code+ and +jt65code+ let you explore the -conversion of user-level messages into channel symbols or ``tone -numbers,'' and back again into user-readable text. These programs can -be especially useful to someone designing a beacon generator for JT9 -or JT65, or for studying behavior of the error-control codes. - -Channel-symbol values for JT9 run from 0 to 8, with 0 representing the -sync tone. The total number of symbols is 85. To run +jt9code+, -enter the program name followed by a JT9 message enclosed in quotes. -In Windows the result might look like this: - - C:\WSJTX> jt9code "G0XYZ K1ABC FN42" - Message: G0XYZ K1ABC FN42 - Channel symbols: - 0 0 7 3 0 3 2 5 4 0 1 7 7 7 8 0 4 8 8 2 2 1 0 1 1 3 5 4 5 6 - 8 7 0 6 0 1 8 3 3 7 8 1 1 2 4 5 8 1 5 2 0 0 8 6 0 5 8 5 1 0 - 5 8 7 7 2 0 4 6 6 6 7 6 0 1 8 8 5 7 2 5 1 5 0 4 0 - Decoded message: G0XYZ K1ABC FN42 - -For the corresponding program +jt65code+ only the information-carrying -channel symbols are shown, and the symbol values range from 0 to 63. -Sync synbols lie two tone intervals below data tone 0, and the -sequential locations of sync symbols are described in the -<> section of this Guide. - - -A typical execution of jt65code is shown below. The program displays -the packed message of 72 bits (shown as 12 six-bit symbol values), -followed by the channel symbols: - - C:\WSJTX> jt65code "G0XYZ K1ABC FN42" - Message: G0XYZ K1ABC FN42 - Packed message, 6-bit symbols: 61 36 45 30 3 55 3 2 14 5 33 40 - Information-carrying channel symbols: - 56 40 8 40 51 47 50 34 44 53 22 53 28 31 13 60 46 2 14 58 43 - 41 58 35 8 35 3 24 1 21 41 43 0 25 54 9 41 54 7 25 21 9 - 62 59 7 43 31 21 57 13 59 41 17 49 19 54 21 39 33 42 18 2 60 - Decoded message: G0XYZ K1ABC FN42 - -For an interesting illustration of the power of the strong -error-control coding in JT9 and JT65, try looking at the channel -symbols after changing a single character in the message. For -example, change the grid locator from FN42 to FN43: - - C:\Users\joe\wsjt\wsjtx_install>jt65code "G0XYZ K1ABC FN43" - Message: G0XYZ K1ABC FN43 - Packed message, 6-bit symbols: 61 36 45 30 3 55 3 2 14 5 33 41 - Information-carrying channel symbols: - 25 35 47 8 13 9 61 40 44 9 51 6 8 40 38 34 8 2 21 23 30 - 51 32 56 39 35 3 50 48 30 8 5 40 18 54 9 24 30 26 61 23 11 - 3 59 7 7 39 1 25 24 4 50 17 49 52 19 34 7 4 34 61 2 61 - Decoded message: G0XYZ K1ABC FN43 - -You will discover that every possible JT65 message differs from every -other possible JT65 message in at least 52 of the 63 -information-carrying channel symbols. diff --git a/doc/source/wsjtx-main.adoc b/doc/source/wsjtx-main.adoc deleted file mode 100644 index 227da197a..000000000 --- a/doc/source/wsjtx-main.adoc +++ /dev/null @@ -1,229 +0,0 @@ -// Status=review -// This is a comment line, anything with // is ignored at process time. -= WSJT-X User Guide -:Author: Joe Taylor, K1JT -:Date: January 30, 2014, Copyright © 2012-2014 -:Revision: 1.3 -:badges: -:icons: -:numbered: - -// If the list of links gets too long, we can add a url-file that is pulled -// in when and where needed with the following: -// include:: for example: include::url-list.txt - -// WEB links - List is getting pretty long, time to use include::file-name ?? -:asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ] -:asciidoc_cheatsheet: http://powerman.name/doc/asciidoc[ AsciiDoc Cheatsheet ] -:asciidoc_questions: http://www.methods.co.nz/asciidoc/faq.html[ AsciiDoc FAQ ] -:debian: http://www.debian.org/[ Debian ] -:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ] -:devsvn: http://developer.berlios.de/projects/wsjt/[wsjt-svn] -:download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ] -:dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ] -:homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ] -:hrd: http://www.hrdsoftwarellc.com/[ Ham Radio Deluxe ] -:jtalert: http://ham-apps.com[JT-ALERT-X] -:jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX] -:launchpadurl: https://launchpad.net/~jnogatch/+archive/wsjtx[ WSJT-X Linux Packages ] -:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] -:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] -:osx_instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here] -:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ] - -// DOWNLOAD links -:cty_dat: http://www.country-files.com/cty/[here]. -:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd] -:osx_108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ] -:osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[ OS X 10.9 ] - -// MAIL-TO links -:alex_efros: mailto:powerman@powerman.name[ Alex Efros ] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] -:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ] - - -// These [[xxxx]] labels are HTML anchors, and can be used to -// navigate though the document easily: <<[INTRO],See Introduction]>> will -// place a hyper-link in your text to take you too the anchored section. -// All major sections or points of interest should have one. - -// == is level (2), section 1.0, === would mean section 1.1, === would -// be section 1.1.1. This method is used throughout the document. - -[[INTRO]] -== Introduction -include::introduction.adoc[] - -[[SYSREQ]] -== System Requirements -include::system-requirments.adoc[] - -[[INSTALL]] -== Installation - -- Download _WSJT-X_ from the {homepage}. Click on _WSJT-X_ at the left -margin and then on the appropriate link(s) for your operating system. - -[[INSTALL_WIN]] -=== Windows -include::install-windows.adoc[] - -[[INSTALL_UBU]] -=== Linux -include::install-ubuntu.adoc[] - -[[INSTALL_OSX]] -=== OS X -include::install-mac.adoc[] - -// Note to developers. The URL http://developer.berlios.de/projects/wsjt/. is -// to a very old src version of WSJT 5.7 or so. WSJTX is not listed at all. -// Also, all the Qt4 stuff is now obsolete, and needs to be updated. -// Instructions for source builds Win, \*Nix & Mac all need to be written / -// Rreviewd. - -[[SRC_CODE]] -=== Source Code -include::install-from-source.adoc[] - -[[CONFIG]] -== Setup and Configuration - -[[STATION]] -=== Station Tab -include::configuration-station.adoc[] - -[[TXMACROS]] -=== Tx Macros Tab -include::configuration-txmacros.adoc[] - -[[BAND_SETTINGS]] -=== Band Settings Tab -include::configuration-band-settings.adoc[] - -[[CONFIG_MAIN]] -=== Main Window -include::configuration-main-window.adoc[] - -[[FONTS]] -=== Font Sizes -include::font-sizes.adoc[] - -[[TUTORIAL]] -== Basic Operating Tutorial - -[[TUT_MAIN]] -=== Main Window Settings -include::tutorial-main-window.adoc[] - -[[TUT_WIDE_GRAPH]] -=== Wide Graph Settings -include::tutorial-wide-graph-settings.adoc[] - -[[TUT_EX1]] -=== Sample File 1 -include::tutorial-example1.adoc[] - -[[TUT_EX2]] -=== Sample File 2 -include::tutorial-example2.adoc[] - -[[TUT_XCVR]] -=== Transceiver Setup -include::transceiver-setup.adoc[] - -[[MAKE_QSOS]] -== Making QSOs -include::make-qso.adoc[] - -[[CONTROLS]] -== Controls & Functions - -[[CONTROLS_WIDE]] -=== Wide Graph Controls -include::controls-functions-wide-graph.adoc[] - -[[CONTROLS_MAIN]] -=== Main Window -include::controls-functions-main-window.adoc[] - -[[CONTROLS_LEFT]] -=== Misc Controls Left -include::controls-functions-left.adoc[] - -[[CONTROLS_CENTER]] -=== Misc Controls Center -include::controls-functions-center.adoc[] - -[[CONTROLS_MSGS]] -=== Tx Messages -include::controls-functions-messages.adoc[] - -[[STATUS_BAR]] -=== Status Bar -include::controls-functions-status-bar.adoc[] - -[[MENUS]] -=== Menus -include::controls-functions-menus.adoc[] - -[[SHORTCUTS]] -=== Keyboard Shortcuts -include::controls-functions-kb-shortcuts.adoc[] - -[[MOUSE_COMMANDS]] -=== Mouse Commands -include::controls-functions-special-mouse-cmds.adoc[] - -[[COOP_PGMS]] -== Cooperating Programs -To be added ... - -[[JT65PRO]] -== The JT65 Protocol -include::jt65-protocol.adoc[] - -[[JT9PRO]] -== The JT9 Protocol -include::jt9-protocol.adoc[] - -[[JT65_JT9]] -== JT65 & JT9 Differences -include::jt65-jt9-differences.adoc[] - -[[TXRX]] -== Transmitting and Receiving in _WSJT-X_ -include::tx-rx.adoc[] - -[[TROUBLE_SHOOTING]] -== Troubleshooting -To be added ... - -[[FAQ]] -== Frequently Asked Questions -include::faq.adoc[] - -[[FILES]] -== File Names - -// Note to Dev-Team, this list of files needs to be updated. -[[FILES1]] -=== Installed Files -include::installed-files.adoc[] - -[[FILES2]] -=== Runtime Files -include::runtime-files.adoc[] - -[[UTIL]] -== Utility Programs -include::utilities.adoc[] - -[[COMPILING]] -== Compiling WSJT-X -include::compiling.adoc[] - -[[ACK]] -== Acknowledgments -include::acknowledgements.adoc[]