diff --git a/CMakeLists.txt b/CMakeLists.txt index 9fe022210..42ac3185d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -113,6 +113,7 @@ option (WSJT_HAMLIB_TRACE "Debugging option that turns on minimal Hamlib interna option (WSJT_SOFT_KEYING "Apply a ramp to CW keying envelope to reduce transients." ON) option (WSJT_SKIP_MANPAGES "Skip *nix manpage generation.") option (WSJT_EMBED_SAMPLES "Embed sample files into WSJT-X resources." ON) +option (WSJT_GENERATE_DOCS "Generate documentation files." OFF) CMAKE_DEPENDENT_OPTION (WSJT_HAMLIB_VERBOSE_TRACE "Debugging option that turns on full Hamlib internal diagnostics." OFF WSJT_HAMLIB_TRACE OFF) CMAKE_DEPENDENT_OPTION (WSJT_QDEBUG_IN_RELEASE "Leave Qt debugging statements in Release configuration." OFF @@ -518,7 +519,9 @@ endif (APPLE) # find_program(CTAGS ctags) find_program(ETAGS etags) - +if (WSJT_GENERATE_DOCS) + add_subdirectory (doc) +endif (WSJT_GENERATE_DOCS) # # C & C++ setup @@ -611,13 +614,13 @@ FortranCInterface_HEADER (FC.h MACRO_NAMESPACE "FC_" SYMBOL_NAMESPACE "FC_" # # fetch latest HTML manual # -set (WSJT_MANUAL_DIRECTORY "${PROJECT_MANUAL_DIRECTORY_URL}" - CACHE STRING "Can be overridden to a local URI") -add_custom_target (user_manual ALL - ${CMAKE_COMMAND} -D URL=${WSJT_MANUAL_DIRECTORY} -D NAME=${PROJECT_MANUAL} -P ${CMAKE_SOURCE_DIR}/CMake/download_html_manual.cmake - COMMENT "Downloading ${PROJECT_NAME} HTML manual" - VERBATIM - ) +#set (WSJT_MANUAL_DIRECTORY "${PROJECT_MANUAL_DIRECTORY_URL}" +# CACHE STRING "Can be overridden to a local URI") +#add_custom_target (user_manual ALL +# ${CMAKE_COMMAND} -D URL=${WSJT_MANUAL_DIRECTORY} -D NAME=${PROJECT_MANUAL} -P ${CMAKE_SOURCE_DIR}/CMake/download_html_manual.cmake +# COMMENT "Downloading ${PROJECT_NAME} HTML manual" +# VERBATIM +# ) # # Setup RPATH so that built executable targets will run in both the @@ -970,7 +973,6 @@ install (PROGRAMS ) install (FILES - ${CMAKE_BINARY_DIR}/contrib/${PROJECT_MANUAL} README COPYING AUTHORS diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 000000000..2f20f39aa --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,132 @@ +set (UG_SRCS + user_guide/acknowledgements.adoc + user_guide/install-from-source.adoc + user_guide/rig-config-drake.adoc + user_guide/settings-radio.adoc + user_guide/compiling.adoc + user_guide/install-linux.adoc + user_guide/rig-config-elecraft.adoc + user_guide/settings-reporting.adoc + user_guide/config-details.adoc + user_guide/install-mac.adoc + user_guide/rig-config-flexrad.adoc + user_guide/settings-txmacros.adoc + user_guide/controls-functions-center.adoc + user_guide/install-windows.adoc + user_guide/rig-config-icom.adoc + user_guide/system-requirements.adoc + user_guide/controls-functions-left.adoc + user_guide/introduction.adoc + user_guide/rig-config-kenwood.adoc + user_guide/transceiver-setup.adoc + user_guide/controls-functions-main-window.adoc + user_guide/jt65-jt9-differences.adoc + user_guide/rig-config-main.adoc + user_guide/tutorial-example1.adoc + user_guide/controls-functions-menus.adoc + user_guide/jt65-protocol.adoc + user_guide/rig-config-softrock.adoc + user_guide/tutorial-example2.adoc + user_guide/controls-functions-messages.adoc + user_guide/jt9-protocol.adoc + user_guide/rig-config-template.adoc + user_guide/tutorial-main-window.adoc + user_guide/controls-functions-status-bar.adoc + user_guide/make-qso.adoc + user_guide/rig-config-tentec.adoc + user_guide/tutorial-wide-graph-settings.adoc + user_guide/controls-functions-wide-graph.adoc + user_guide/platform-dependencies.adoc + user_guide/rig-config-yaesu.adoc + user_guide/tx-rx.adoc + user_guide/coop-prgrms.adoc + user_guide/rig-config-adat.adoc + user_guide/settings-audio.adoc + user_guide/utilities.adoc + user_guide/faq.adoc + user_guide/rig-config-alinco.adoc + user_guide/settings-frequencies.adoc + user_guide/wsjtx-main.adoc + user_guide/font-sizes.adoc + user_guide/rig-config-aor.adoc + user_guide/settings-general.adoc + ) + +set (UG_IMGS + user_guide/images/130610_2343-wav-80.png + user_guide/images/freemsg.png + user_guide/images/misc-main-ui.png + user_guide/images/r4148-rpt-ui.png + user_guide/images/status-bar-a.png + user_guide/images/MacAppMenu.png + user_guide/images/help-menu.png + user_guide/images/mode-menu.png + user_guide/images/r4148-txmac-ui.png + user_guide/images/traditional-msg-box.png + user_guide/images/RadioTab.png + user_guide/images/keyboard-shortcuts.png + user_guide/images/new-msg-box.png + user_guide/images/save-menu.png + user_guide/images/tx-macros.png + user_guide/images/band-settings.png + user_guide/images/log-qso.png + user_guide/images/r3666-config-screen-80.png + user_guide/images/settings-audio.png + user_guide/images/view-menu.png + user_guide/images/decode-menu.png + user_guide/images/main-ui-1.4.png + user_guide/images/r3666-main-ui-80.png + user_guide/images/settings-ui.png + user_guide/images/wide-graph-controls.png + user_guide/images/decodes.png + user_guide/images/main-ui-controls.png + user_guide/images/r4148-cat-ui.png + user_guide/images/setup-menu.png + user_guide/images/file-menu.png + user_guide/images/misc-controls-center.png + user_guide/images/r4148-freq-ui.png + user_guide/images/special-mouse-commands.png +) + +find_program (ASCIIDOC NAMES asciidoc asciidoc.py) +if (NOT ASCIIDOC) + message (FATAL_ERROR "Asciidoc is required to build the documentation") +endif (NOT ASCIIDOC) + +include (CMakeParseArguments) + +# generate an HTML document from asciidoc text files(s) +# +# HTML - variable for output file ${CMAKE_CURRENT_BINARY_DIR}/`$basename ${SOURCE}`.html +# SOURCE - top level asciidoc file +# ASCIIDOC_OPTIONS - asciidoc command options +# DEPENDS - dependent files +function (html_document) + cmake_parse_arguments (args "" "SOURCE;HTML" "ASCIIDOC_OPTIONS;DEPENDS" ${ARGN}) + get_filename_component (_output_name_we ${args_SOURCE} NAME_WE) + get_filename_component (_path ${args_SOURCE} PATH) + set (_xml_file ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.xml) + set (_doc_file ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.html) + add_custom_command ( + OUTPUT ${_doc_file} ${_xml_file} + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${path} + COMMAND ${ASCIIDOC} ARGS ${args_ASCIIDOC_OPTIONS} -o ${CMAKE_CURRENT_BINARY_DIR}/${_output_name_we}.html ${args_SOURCE} + DEPENDS ${args_DEPENDS} + COMMENT "Generating ${_doc_file}" + ) + set (${args_HTML} ${_doc_file} PARENT_SCOPE) +endfunction (html_document) + +html_document( + HTML user_guide + SOURCE user_guide/wsjtx-main.adoc + ASCIIDOC_OPTIONS -a data-uri -a toc2 -a max-width=1024px -b xhtml11 + DEPENDS ${UG_SRCS} ${UG_IMGS} + ) +add_custom_target (docs ALL DEPENDS ${user_guide}) + +install (FILES + ${user_guide} + DESTINATION ${WSJT_SHARE_DESTINATION}/${WSJT_DOC_DESTINATION} + #COMPONENT runtime + ) diff --git a/doc/common/communication.adoc b/doc/common/communication.adoc new file mode 100644 index 000000000..219794038 --- /dev/null +++ b/doc/common/communication.adoc @@ -0,0 +1,14 @@ +The following are established communication channels for the WSJT Group. + +.General Information +* Main Site: {homepage} +* Development Site: {projsummary} + +.Development Related +[horizontal] +* Project Manager, email: {joe_taylor} +* Development Mailing List, join: {dev_mail_list} +* Repository Updates, join: {dev_mail_svn} + +.Community Related +* Discussion Board: {wsjt_yahoo_group} \ No newline at end of file diff --git a/doc/common/license.adoc b/doc/common/license.adoc new file mode 100644 index 000000000..2d1d32cc0 --- /dev/null +++ b/doc/common/license.adoc @@ -0,0 +1,16 @@ +// include links, but different path ./links.adoc v.s. ../../global/links.adoc +include::./links.adoc[] +_{prog}_ is free software: you can redistribute it and/or modify +under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +_{prog}_ is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this documentation. If not, see {gnu_gpl}. + +Copyright (C) 2001-2014 Joseph H Taylor, Jr, {joe_taylor}. diff --git a/doc/common/links.adoc b/doc/common/links.adoc new file mode 100644 index 000000000..28648119c --- /dev/null +++ b/doc/common/links.adoc @@ -0,0 +1,103 @@ +//// +Link file to hold all links +File Location: ./doc/global/links.adoc +Usage example: include::../../global/links.adoc[] +Syntax: [link-id] [link][displayed test] + +Example: +:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] + +[link-id] = :pskreporter: +[link] http://pskreporter.info/pskmap.html +[displayed test] PSK Reporter + +Perform searches from the doc root directory: C:\JTSDK-DOC\doc +Search: grep -rl --exclude-dir="*\.svn" {pskreporter} . + grep -rl --exclude-dir="*\.svn" PSK Reporter . + grep -rl --exclude-dir="*\.svn" {devsvn} . + grep -rl --exclude-dir="*\.svn" {kvasd} . + grep -rl --exclude-dir="*\.svn" {ntpsetup} . + +Include links.adoc: grep -rl --exclude-dir="*\.svn" pskreporter . +Exclude links.adoc: grep -rl --exclude-dir="*\.svn" {pskreporter} . + +Note(s): +a). Don't forget a space then "." at the end. +b). To include links.adoc file itself, remove the brackets {} from +the pattern search: +c). Look at each of the files listed to ensure the [displayed test] +still makes sense in the caption. If not, just add another link. +d). Edit lines as needed. Keeping them in alphabetic order help see dupes. + +//// +:asciidoc_cheatsheet: http://powerman.name/doc/asciidoc[AsciiDoc Cheatsheet] +:asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[AsciiDoc User Guide] +:asciidoc_questions: http://www.methods.co.nz/asciidoc/faq.html[AsciiDoc FAQ] +:asciidoc_syntax: http://xpt.sourceforge.net/techdocs/nix/tool/asciidoc-syn/ascs01-AsciiDocMarkupSyntaxQuickSummary/single/[AsciiDoc Syntax] +:asciidoctor_style: http://asciidoctor.org/docs/asciidoc-writers-guide/#delimited-blocks[AsciiDoctor Styles Guide] +:asciidoctor_syntax: http://asciidoctor.org/docs/asciidoc-writers-guide/#delimited-blocks[AsciiDoctor Syntax Guide] +:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[Commons Attribution-ShareAlike 3.0 Unported License] +:debian32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2_i386.deb[wsjtx-1.4.0-rc2_i386.deb] +:debian64: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2_amd64.deb[wsjtx-1.4.0-rc2_amd64.deb] +:debian: http://www.debian.org/[Debian] +:dev_guide: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjt-dev-guide.html[Dev-Guide] +:devsvn1: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[Devel-SVN] +:devsvn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[SourceForge] +:dimension4: http://www.thinkman.com/dimension4/[Dimension4] +:download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[Download Page] +:dxatlas: http://www.dxatlas.com/[Afreet Software, Inc.] +:dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ] +:fedora32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2_i686.rpm[wsjtx-1.4.0-rc2_i686.rpm] +:fedora64: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2_x86_64.rpm[wsjtx-1.4.0-rc2_x86_64.rpm] +:fmt_arrl: http://www.arrl.org/frequency-measuring-test[ARRL FMT Info] +:fmt_group: https://groups.yahoo.com/neo/groups/FMT-nuts/info[FMT Group] +:fmt_k5cm: http://www.k5cm.com/[FMT Event Info] +:gnu_gpl: http://www.gnu.org/licenses/gpl-3.0.txt[GNU General Public License] +:homepage: http://physics.princeton.edu/pulsar/K1JT/[WSJT Home Page] +:hrd: http://www.hrdsoftwarellc.com/[Ham Radio Deluxe] +:jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX] +:jtalert: http://hamapps.com[JT-ALERT-X] +//:launchpadac6sl: https://launchpad.net/~jnogatch/+archive/wsjtx[WSJT-X Linux Packages] +:launchpadki7mt: https://launchpad.net/~ki7mt[KI7MT PPA's] +:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] +:msys_url: http://sourceforge.net/projects/mingwbuilds/files/external-binary-packages/[MSYS Download] +:osx_instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here] +:ppa: http://en.wikipedia.org/wiki/Personal_Package_Archive[PPA] +:projsummary: http://sourceforge.net/projects/wsjt/[Project Summary] +:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] +:sourceforge: https://sourceforge.net/user/registration[SourceForge] +:ubuntu_sdk: https://launchpad.net/~ubuntu-sdk-team/+archive/ppa[Ubuntu SDK Notice] +:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[WSJT-X] +:wsjt_yahoo_group: https://groups.yahoo.com/neo/groups/wsjtgroup/info[WSJT Group] +:wspr: http://physics.princeton.edu/pulsar/K1JT/wspr.html[WSPR Home Page] +:wsprnet: http://wsprnet.org/drupal/[WSPRnet] +:wsprnet_activity: http://wsprnet.org/drupal/wsprnet/activity[WSPRnet Activity page] +:wspr0_guide: http://www.physics.princeton.edu/pulsar/K1JT/WSPR0_Instructions.TXT[WSPR0 Guide] + +// Download Links +:cty_dat: http://www.country-files.com/cty/[here] +:hamlib3: https://dl.dropboxusercontent.com/u/4192709/Hamlib-integration-wsjtx.zip[Download] +:jtsdk_doc: http://physics.princeton.edu/pulsar/K1JT/JTSDK-DOC.exe[Download] +:jtsdk_py: http://physics.princeton.edu/pulsar/K1JT/JTSDK-PY.exe[Download] +:jtsdk_qt: http://physics.princeton.edu/pulsar/K1JT/JTSDK-QT.exe[Download] +:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd] +:nh6z: http://www.nh6z.net/Amatuer_Radio_Station_NH6Z/Other_Peoples_Software.html[here] +:omnirig: http://www.dxatlas.com/OmniRig/Files/OmniRig.zip[Download] +:osx_107: http://physics.princeton.edu/pulsar/K1JT/wsjtx_01feb14.tar.gz[WSJT-X_rc1_10.7.dmg] +:osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_01feb14.tar.gz[WSJT-X_rc1_10.9.dmg] +:svn: http://subversion.apache.org/packages.html#windows[Subversion] +:win32: http://physics.princeton.edu/pulsar/K1JT/wsjtx-1.4.0-rc2-win32.exe[wsjtx-1.4.0-rc2-win32.exe] +:wsjt_svn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/[here] +:wsjtx_rc2_tag: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/tags/wsjtx-1.4.0-rc2/[Tag: WSJT-X v1.4 RC2] +:wspr_code: http://physics.princeton.edu/pulsar/K1JT/WSPRcode.exe[WSPRcode.exe] +:wspr_svn: http://sourceforge.net/p/wsjt/wsjt/HEAD/tree/branches/wspr/[here] + +// MAIL-TO links +:alex_efros: mailto:powerman@powerman.name[Alex Efros] +:bill_somerville: mailto:g4wjs -at- c l a s s d e s i g n -dot- com [G4WJS] +:devmail: mailto:wsjt-devel@lists.sourceforge.net[wsjt-devel] +:dev_mail_list: http://sourceforge.net/mailarchive/forum.php?forum_name=wsjt-devel[WSJT Developers Email List] +:dev_mail_svn: https://sourceforge.net/auth/subscriptions/[WSJT SVN Archives] +:greg_beam: mailto:ki7mt@yahoo.com[KI7MT] +:joe_taylor: mailto:joe@princeton.edu[K1JT] +:stuart_rackman: mailto:srackham@gmail.com[Stuart Rackham] diff --git a/doc/user_guide/acknowledgements.adoc b/doc/user_guide/acknowledgements.adoc new file mode 100644 index 000000000..d5f03ee51 --- /dev/null +++ b/doc/user_guide/acknowledgements.adoc @@ -0,0 +1,19 @@ +// 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, W4TV, and W9MDB*. 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/user_guide/compiling.adoc b/doc/user_guide/compiling.adoc new file mode 100644 index 000000000..13a8550ec --- /dev/null +++ b/doc/user_guide/compiling.adoc @@ -0,0 +1,20 @@ +// 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. + +// Web Links +// Source File is: dev-guide/source/wsjtx-dev/wsjtx-dev.adoc +// At some point, compiling_wsjtx_linux.html needs a name change to: wsjtx-dev.html +// These files can only be built on Linux, due to source-highlight being removed +// From the windows build batch file. +:dev-guide: http://www.physics.princeton.edu/pulsar/K1JT/wsjtx-doc/wsjt-dev-guide.html[WSJT Developers Guide] + +// mail-to links + +A Developer's Guide for WSJT and its sister programs is itself under +development. The present draft contains full instructions for +compiling _WSJT-X_ in Linux, and an outline of steps required in +Windows. + +{dev-guide} diff --git a/doc/user_guide/config-details.adoc b/doc/user_guide/config-details.adoc new file mode 100644 index 000000000..635e27d8f --- /dev/null +++ b/doc/user_guide/config-details.adoc @@ -0,0 +1,4 @@ +// Status=review +[[CONFIG_DETAILS]] + +Are we here? diff --git a/doc/user_guide/controls-functions-center.adoc b/doc/user_guide/controls-functions-center.adoc new file mode 100644 index 000000000..a15f5d4bc --- /dev/null +++ b/doc/user_guide/controls-functions-center.adoc @@ -0,0 +1,32 @@ +// 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> for details. + +* Click on the pull-down arrow for message #5 to select one of the +pre-stored free-text messages entered on the *Settings | Tx Macros* +tab. Pressing *Enter* on a modified message #5 automatically adds +that message to the stored macros. + +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, the Tx message is changed +immediately. + +//* Both message fields are editable. You can enter and transmit +* You can enter and transmit +anything (up to 13 characters) in the *Free Msg* box. + +* Click on the pull-down arrow in the *Free Msg* box to select a +pre-stored macro. Pressing *Enter* on a modified message here +automatically adds that message to the table of stored 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/user_guide/controls-functions-status-bar.adoc b/doc/user_guide/controls-functions-status-bar.adoc new file mode 100644 index 000000000..1aa812d9a --- /dev/null +++ b/doc/user_guide/controls-functions-status-bar.adoc @@ -0,0 +1,17 @@ +// 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 such information as the program's +current operating state, operating mode, the content of your most +recent transmitted message, and whether *Double-click on call sets Tx +enable* has been selected on the *Settings | General* tab. The first +label (operating state) can be Receiving, Tx (for Transmitting), Tune, +or the name of file opened from the *File* menu; this label is +highlighted in green for Receiving, yellow for Tx, and red for Tune. +When transmitting, the Tx message is displayed exactly as it will be +decoded by receiving stations. diff --git a/doc/user_guide/controls-functions-wide-graph.adoc b/doc/user_guide/controls-functions-wide-graph.adoc new file mode 100644 index 000000000..1605bb258 --- /dev/null +++ b/doc/user_guide/controls-functions-wide-graph.adoc @@ -0,0 +1,45 @@ +// 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. + +- A dropdown list below the *Palette* label lets you select from a +wide range of waterfall color palettes. + +- Click *Adjust* to activate a window that allows you to create a +user-defined palette. + +- 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/user_guide/coop-prgrms.adoc b/doc/user_guide/coop-prgrms.adoc new file mode 100644 index 000000000..b76a9897f --- /dev/null +++ b/doc/user_guide/coop-prgrms.adoc @@ -0,0 +1,5 @@ +There is one program and one service that compliment _WSJT-X_ greatly. They are as follows: + +- {pskreporter} + +- {jtalert} \ No newline at end of file diff --git a/doc/user_guide/faq.adoc b/doc/user_guide/faq.adoc new file mode 100644 index 000000000..597a5e89c --- /dev/null +++ b/doc/user_guide/faq.adoc @@ -0,0 +1,55 @@ +[qanda] +Why does the *Flatten* feature cause my displayed spectrum to curve steeply upward near the edges, before falling where the 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. Either +use a wider IF filter or reduce the displayed passband by decreasing +*Bins/Pixel*, increasing *Start*, or reducing the width of the *Wide +Graph*. You might also choose to re-center the filter passband, if +such control is available. + + +My rig has only a single SSB filter, about 2700 Hz bandwidth. Can I use split mode?:: + +Set the radio to *Split* mode and _Split Operation_ to *Rig* (or if +necessary, *Fake It*) on the *Settings | Radio* tab. To operate +primarily in the JT9 frequency range, check the *{plus}2 kHz* +box. VFO-A will then be moved up to 14.078 MHz. The JT9 sub-band now +falls between about 500 Hz and 2000Hz on the waterfall display. As +described above, VFO-B will be adjusted so as to keep your Tx audio +always between 1500 and 2000 Hz. To operate JT65, simply uncheck the +*{plus}2 kHz* option. If your rig has an IF shift control or +equivalent (``passband tuning''), you can operate as if you had 4 kHz +Rx bandwidth and use the IF shift control to focus on any 2.7 kHz +portion of the JT65 and JT9 sub-bands. + +How should I configure _WSJT-X_ to run multiple instances?:: + +Start _WSJT-X_ from a command-prompt window, passing each instance a +unique identifier as in the following two-instance example. This +procedure will isolate the *Settings* file and the writable file +location for each instance of _WSJT-X_. + + wsjtx --rig-name=TS2000 + wsjtx --rig-name=FT847 + +When setting up rig control through _OmniRig_, something goes wrong when I click *Test CAT*. What can I do about it?:: + +_OmniRig_ apparently has a bug that appears when you click *Test CAT*. +Forget using *Test CAT* and just click *OK*. _OmniRig_ then behaves +normally. + +I am using _WSJT-X_ with _Ham Radio Deluxe_. All seems well until I start HRD Logbook or DM780 running in parallel; then CAT control becomes unreliable.:: + +You may see delays up to 20 seconds or so in frequency changes or +other radio commands, due to a bug in HRD. HRD folks are aware of the +problem, and are working to resolve it. + +I am running _WSJT-X_ under Ubuntu 14.04. The program starts, but menu bar is missing from the top of the main window and the hot-keys don't work.:: + +The new ``Unity'' desktop puts the menu for the currently active +window at the top of the primary display screen. You can restore menu +bars to their traditional locations by typing the following in a +command-prompt window: + + sudo apt-get remove appmenu-qt5 diff --git a/doc/user_guide/font-sizes.adoc b/doc/user_guide/font-sizes.adoc new file mode 100644 index 000000000..af8fd64de --- /dev/null +++ b/doc/user_guide/font-sizes.adoc @@ -0,0 +1,15 @@ +// 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/user_guide/images/130610_2343-wav-80.png b/doc/user_guide/images/130610_2343-wav-80.png new file mode 100644 index 000000000..7ee43120f Binary files /dev/null and b/doc/user_guide/images/130610_2343-wav-80.png differ diff --git a/doc/user_guide/images/MacAppMenu.png b/doc/user_guide/images/MacAppMenu.png new file mode 100644 index 000000000..bd3f2c224 Binary files /dev/null and b/doc/user_guide/images/MacAppMenu.png differ diff --git a/doc/user_guide/images/RadioTab.png b/doc/user_guide/images/RadioTab.png new file mode 100644 index 000000000..ce75caa2e Binary files /dev/null and b/doc/user_guide/images/RadioTab.png differ diff --git a/doc/user_guide/images/band-settings.png b/doc/user_guide/images/band-settings.png new file mode 100644 index 000000000..9b8dd080b Binary files /dev/null and b/doc/user_guide/images/band-settings.png differ diff --git a/doc/user_guide/images/decode-menu.png b/doc/user_guide/images/decode-menu.png new file mode 100644 index 000000000..1b23834e7 Binary files /dev/null and b/doc/user_guide/images/decode-menu.png differ diff --git a/doc/user_guide/images/decodes.png b/doc/user_guide/images/decodes.png new file mode 100644 index 000000000..ddf586768 Binary files /dev/null and b/doc/user_guide/images/decodes.png differ diff --git a/doc/user_guide/images/file-menu.png b/doc/user_guide/images/file-menu.png new file mode 100644 index 000000000..b38c7b5aa Binary files /dev/null and b/doc/user_guide/images/file-menu.png differ diff --git a/doc/user_guide/images/freemsg.png b/doc/user_guide/images/freemsg.png new file mode 100644 index 000000000..c0fc06d43 Binary files /dev/null and b/doc/user_guide/images/freemsg.png differ diff --git a/doc/user_guide/images/help-menu.png b/doc/user_guide/images/help-menu.png new file mode 100644 index 000000000..8b1d33a0a Binary files /dev/null and b/doc/user_guide/images/help-menu.png differ diff --git a/doc/user_guide/images/keyboard-shortcuts.png b/doc/user_guide/images/keyboard-shortcuts.png new file mode 100644 index 000000000..4e1413b30 Binary files /dev/null and b/doc/user_guide/images/keyboard-shortcuts.png differ diff --git a/doc/user_guide/images/log-qso.png b/doc/user_guide/images/log-qso.png new file mode 100644 index 000000000..9fefe563b Binary files /dev/null and b/doc/user_guide/images/log-qso.png differ diff --git a/doc/user_guide/images/main-ui-1.4.png b/doc/user_guide/images/main-ui-1.4.png new file mode 100644 index 000000000..4ae5f2ae4 Binary files /dev/null and b/doc/user_guide/images/main-ui-1.4.png differ diff --git a/doc/user_guide/images/main-ui-controls.png b/doc/user_guide/images/main-ui-controls.png new file mode 100644 index 000000000..a5fa58011 Binary files /dev/null and b/doc/user_guide/images/main-ui-controls.png differ diff --git a/doc/user_guide/images/misc-controls-center.png b/doc/user_guide/images/misc-controls-center.png new file mode 100644 index 000000000..6d952f140 Binary files /dev/null and b/doc/user_guide/images/misc-controls-center.png differ diff --git a/doc/user_guide/images/misc-main-ui.png b/doc/user_guide/images/misc-main-ui.png new file mode 100644 index 000000000..9516ab82d Binary files /dev/null and b/doc/user_guide/images/misc-main-ui.png differ diff --git a/doc/user_guide/images/mode-menu.png b/doc/user_guide/images/mode-menu.png new file mode 100644 index 000000000..c65353fd3 Binary files /dev/null and b/doc/user_guide/images/mode-menu.png differ diff --git a/doc/user_guide/images/new-msg-box.png b/doc/user_guide/images/new-msg-box.png new file mode 100644 index 000000000..ec74e25b9 Binary files /dev/null and b/doc/user_guide/images/new-msg-box.png differ diff --git a/doc/user_guide/images/r3666-config-screen-80.png b/doc/user_guide/images/r3666-config-screen-80.png new file mode 100644 index 000000000..315aad7b8 Binary files /dev/null and b/doc/user_guide/images/r3666-config-screen-80.png differ diff --git a/doc/user_guide/images/r3666-main-ui-80.png b/doc/user_guide/images/r3666-main-ui-80.png new file mode 100644 index 000000000..b693b73b2 Binary files /dev/null and b/doc/user_guide/images/r3666-main-ui-80.png differ diff --git a/doc/user_guide/images/r4148-cat-ui.png b/doc/user_guide/images/r4148-cat-ui.png new file mode 100644 index 000000000..50280647f Binary files /dev/null and b/doc/user_guide/images/r4148-cat-ui.png differ diff --git a/doc/user_guide/images/r4148-freq-ui.png b/doc/user_guide/images/r4148-freq-ui.png new file mode 100644 index 000000000..d5679e5bc Binary files /dev/null and b/doc/user_guide/images/r4148-freq-ui.png differ diff --git a/doc/user_guide/images/r4148-rpt-ui.png b/doc/user_guide/images/r4148-rpt-ui.png new file mode 100644 index 000000000..adcc3ac6c Binary files /dev/null and b/doc/user_guide/images/r4148-rpt-ui.png differ diff --git a/doc/user_guide/images/r4148-txmac-ui.png b/doc/user_guide/images/r4148-txmac-ui.png new file mode 100644 index 000000000..865b3149d Binary files /dev/null and b/doc/user_guide/images/r4148-txmac-ui.png differ diff --git a/doc/user_guide/images/save-menu.png b/doc/user_guide/images/save-menu.png new file mode 100644 index 000000000..c9b48ffff Binary files /dev/null and b/doc/user_guide/images/save-menu.png differ diff --git a/doc/user_guide/images/settings-audio.png b/doc/user_guide/images/settings-audio.png new file mode 100644 index 000000000..a22d979b6 Binary files /dev/null and b/doc/user_guide/images/settings-audio.png differ diff --git a/doc/user_guide/images/settings-ui.png b/doc/user_guide/images/settings-ui.png new file mode 100644 index 000000000..0f38fda51 Binary files /dev/null and b/doc/user_guide/images/settings-ui.png differ diff --git a/doc/user_guide/images/setup-menu.png b/doc/user_guide/images/setup-menu.png new file mode 100644 index 000000000..fdf242345 Binary files /dev/null and b/doc/user_guide/images/setup-menu.png differ diff --git a/doc/user_guide/images/special-mouse-commands.png b/doc/user_guide/images/special-mouse-commands.png new file mode 100644 index 000000000..ca7ef8a76 Binary files /dev/null and b/doc/user_guide/images/special-mouse-commands.png differ diff --git a/doc/user_guide/images/status-bar-a.png b/doc/user_guide/images/status-bar-a.png new file mode 100644 index 000000000..f7b84cfe9 Binary files /dev/null and b/doc/user_guide/images/status-bar-a.png differ diff --git a/doc/user_guide/images/traditional-msg-box.png b/doc/user_guide/images/traditional-msg-box.png new file mode 100644 index 000000000..15b17712c Binary files /dev/null and b/doc/user_guide/images/traditional-msg-box.png differ diff --git a/doc/user_guide/images/tx-macros.png b/doc/user_guide/images/tx-macros.png new file mode 100644 index 000000000..d5a536f40 Binary files /dev/null and b/doc/user_guide/images/tx-macros.png differ diff --git a/doc/user_guide/images/view-menu.png b/doc/user_guide/images/view-menu.png new file mode 100644 index 000000000..23230f0f7 Binary files /dev/null and b/doc/user_guide/images/view-menu.png differ diff --git a/doc/user_guide/images/wide-graph-controls.png b/doc/user_guide/images/wide-graph-controls.png new file mode 100644 index 000000000..bad2a7c2a Binary files /dev/null and b/doc/user_guide/images/wide-graph-controls.png differ diff --git a/doc/user_guide/install-from-source.adoc b/doc/user_guide/install-from-source.adoc new file mode 100644 index 000000000..98834e2a0 --- /dev/null +++ b/doc/user_guide/install-from-source.adoc @@ -0,0 +1,25 @@ +// Status=review + +Source code for _WSJT-X_ is available from a public repository at +{devsvn}. To compile the program you will need to install at least the +following packages: + +- Subversion 1.8 or later +- Qt 5.2 or later +- g++ 4.8 or later +- gfortran 4.8 or later +- fftw3 +- MinGW (for Windows only) + +Source code for _WSJT-X_ 1.4.0-rc2 can be downloaded with the command: + + svn co svn://svn.code.sf.net/p/wsjt/wsjt/tags/wsjtx-1.4.0-rc2 + +and for the current development branch, + + svn co svn://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx + +If you are interested in contributing to the development and +documentation of _WSJT_ and its sister programs, please join the +developer's email list {devmail} and let us know of your areas of +interest. diff --git a/doc/user_guide/install-linux.adoc b/doc/user_guide/install-linux.adoc new file mode 100644 index 000000000..0684ce267 --- /dev/null +++ b/doc/user_guide/install-linux.adoc @@ -0,0 +1,40 @@ +// Status=review + +* For Debian, Ubuntu, and other Debian-based systems: +** 32-bit: {debian32} +- To install: +sudo dpkg -i wsjtx_1.4.0-rc2_i386.deb+ +- Uninstall: +sudo dpkg -P wsjtx+ +** 64-bit: {debian64} +- To install: +sudo dpkg -i wsjtx_1.4.0-rc2_amd64.deb+ +- Uninstall: +sudo dpkg -P wsjtx+ +** You may also need to execute the following commands in a terminal: + + sudo apt-get install libqt5multimediawidgets5 + sudo apt-get install libfftw3-single3 + +** On a 64-bit system also execute: + + sudo apt-get install libgfortran3:i386 + +* For Fedora, Red Hat, and other rpm-based systems: +** 32-bit: {fedora32} +- To install: +sudo rpm -i wsjtx-1.4.0-rc2_i686.rpm+ +- Uninstall: +sudo rpm -e wsjtx+ +** 64-bit: {fedora64} +- To install: +sudo rpm -i wsjtx-1.4.0-rc2_x86_64.rpm+ +- Uninstall: +sudo rpm -e wsjtx+ +** You may also need to execute the following commands in a terminal: + + sudo yum install qt5-qtmultimedia + sudo yum install fftw-libs-single + +** On a 64-bit system also execute: + + sudo yum install libgfortran.i686 + +//// +// Move to FAQ section? +- Should you choose to use the integrated logger, you can locate your logs, and other writeable files, using the following path: +$HOME/.local/share/WSJT-X+ +//// + +// Add instructions about ntpd and sound setup. diff --git a/doc/user_guide/install-mac.adoc b/doc/user_guide/install-mac.adoc new file mode 100644 index 000000000..9f847b3b9 --- /dev/null +++ b/doc/user_guide/install-mac.adoc @@ -0,0 +1,20 @@ +// These instructions are up-to-date for WSJT-X v1.4 + +* OS X 10.7, 10.8: {osx_107} +* OS X 10.9: {osx_109} + +* After downloading it to your desktopo, double-click on the dmg file +and consult its +ReadMe+ file for important installation notes. + +* If you have already installed a previous version, you can retain it by +changing its name in the *Applications* folder (say, from _WSJT-X_ to +_WSJT-X_previous_). You can then proceed to the installation phase. + +* Remember to use the Mac's *Audio MIDI Setup* utility to configure +your sound card for 48000 Hz, two-channel, 16-bit format. + +* Use *System Preferences* to select an external time source to keep +your system clock synchronized to UTC. + +* To uninstall simply drag the _WSJT-X_ application from *Applications* +to the *Trash Can*. diff --git a/doc/user_guide/install-windows.adoc b/doc/user_guide/install-windows.adoc new file mode 100644 index 000000000..8980315b4 --- /dev/null +++ b/doc/user_guide/install-windows.adoc @@ -0,0 +1,28 @@ +// Status=review + +Download and execute the package file {win32}, following these +instructions: + +- Install _WSJT-X_ into its own directory rather than in the conventional +location +C:\Program Files\WSJTX+. Suggested installation directories are ++C:\WSJTX+ or +C:\WSJT\WSJTX+. + +- All program files relating to _WSJT-X_ will be stored in the chosen +installation directory and its subdirectories. + +- Logs and other writeable files will normally be found in the +directory +C:\Users\\AppData\Local\WSJT-X+. + +- The built-in Windows facility for time synchronization is usually +not adequate. We recommend the program _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)*. + +- You can uninstall _WSJT-X_ by clicking its *Uninstall* link in the +Windows *Start* menu, or by using *Uninstall a Program* on the +Windows Control Panel. diff --git a/doc/user_guide/introduction.adoc b/doc/user_guide/introduction.adoc new file mode 100644 index 000000000..6f2df4571 --- /dev/null +++ b/doc/user_guide/introduction.adoc @@ -0,0 +1,43 @@ +// 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,” while +the suffix “-X” indicates that _WSJT-X_ started as an extended (and +experimental) branch of the 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 (“moonbounce”) on the +VHF/UHF bands and has also proven very effective for worldwide QRP +communication on the HF bands. JT9 is optimized for the LF, MF, and +lower 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 passband as large as 5 kHz and 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_gpl} (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}. User-level questions and answers, and general +communication among users is found on the {wsjt_yahoo_group} email +reflector. + diff --git a/doc/user_guide/jt65-jt9-differences.adoc b/doc/user_guide/jt65-jt9-differences.adoc new file mode 100644 index 000000000..b358174e7 --- /dev/null +++ b/doc/user_guide/jt65-jt9-differences.adoc @@ -0,0 +1,41 @@ +// Status=review + +The most striking difference between JT65 and JT9 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 perform +better. + +JT9 is an order of magnitude better in spectral efficiency. On a busy +HF band, the conventional 2-kHz-wide JT65 sub-band is often filled +with overlapping signals. Ten times as many JT9 signals can fit into +the same frequency range, without collisions. + +JT65 signals often decode correctly even when they overlap. Such +behavior is much less likely with JT9 signals, which fill their occupied +bandwidth more densely. JT65 may also be more forgiving of small +frequency drifts. diff --git a/doc/user_guide/jt65-protocol.adoc b/doc/user_guide/jt65-protocol.adoc new file mode 100644 index 000000000..54139a30a --- /dev/null +++ b/doc/user_guide/jt65-protocol.adoc @@ -0,0 +1,50 @@ +// 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 basic aim is to +compress the common messages used for minimally valid 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 +transmitting and receiving stations. Each transmission is divided into 126 +contiguous time intervals or symbols, each of length 4096/11025 = +0.372 seconds. 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 seconds. 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. JT65A is the submode always used at HF. + +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/user_guide/jt9-protocol.adoc b/doc/user_guide/jt9-protocol.adoc new file mode 100644 index 000000000..c35cc5095 --- /dev/null +++ b/doc/user_guide/jt9-protocol.adoc @@ -0,0 +1,21 @@ +// Status=review +//Needs work! + +JT9 is designed for making minimally valid 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 seconds. 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. diff --git a/doc/user_guide/make-qso.adoc b/doc/user_guide/make-qso.adoc new file mode 100644 index 000000000..15ee40a95 --- /dev/null +++ b/doc/user_guide/make-qso.adoc @@ -0,0 +1,166 @@ +// Status=review +=== Standard Exchange +By longstanding tradition, a minimally 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. In uncompressed form (as displayed +on-screen) they may contain as many as 22 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 at UTC 0003 above, K1ABC is telling G0XYZ that his +signal is 19 dB below the noise power in bandwidth 2500 Hz. In the +message at 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, and values are significantly compressed +above about -10 dB. JT9 supports the extended range –50 to +49 dB and +assigns more reliable numbers to relatively strong signals. + +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 decodability are around –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. +In general you should avoid the character / in free-text nessages, as +the program may then try to interpret your construction as part of a +compound callsign. + +TIP: It should be obvious that the JT9 and JT65 protocols are not well +suited for extensive conversations or rag-chewing. + +[[COMP-CALL]] +=== 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 the full compound callsign is sent and received in the +first two transmissions. After that, the operators 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. In this case 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 + QRZ K1ABC/VE6 DO33 + DE W4/G0XYZ FM18 + DE W4/G0XYZ -22 + DE W4/G0XYZ R-22 + DE W4/G0XYZ RRR + DE W4/G0XYZ 73 + +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 will +receive it. Be sure to check that you are actually transmitting the +message you wish to send! + +QSOs involving *Type 2* compound callsigns might look like either +of the following sequences + + CQ K1ABC/VE1 FN75 + K1ABC G0XYZ IO91 + G0XYZ K1ABC –19 + K1ABC G0XYZ R–22 + G0XYZ K1ABC RRR + K1ABC/VE1 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 filters centered and set to widest available passband (up to 5 kHz). +- Radio's Split mode activated or not, consistent with your choice + on the *Radio* tab of the *Settings* window. Verify both VFOs + are set to USB if your rig allows each VFO an independent mode setting. + +IMPORTANT: Remember that JT9 and J65 generally do not require high +power. Under most HF propagation conditions, QRP is the norm. diff --git a/doc/user_guide/platform-dependencies.adoc b/doc/user_guide/platform-dependencies.adoc new file mode 100644 index 000000000..fc1eaeff7 --- /dev/null +++ b/doc/user_guide/platform-dependencies.adoc @@ -0,0 +1,83 @@ +// Status=review + +A few _WSJT-X_ features behave differently in Windows, Linux, or OS X, +or may not be relevant to all operating platforms. + +.File locations +* *Windows* +Settings:: + +%APPDATA%\..\Local\WSJT-X\WSJT-X.ini+ +Log files:: + +%APPDATA%\..\Local\WSJT-X\+ +Default save:: + +%APPDATA%\..\Local\WSJT-X\save\+ + +* *Windows, when using "--rig-name=xxx"* +Settings:: + +%APPDATA%\..\Local\WSJT-X - xxx+ +Log files:: + +%APPDATA%\..\Local\WSJT-X - xxx\WSJT-X - xxx.ini+ + +* *Linux* +Settings:: + +~/.config/WSJT-X.ini+ +Log files:: + +~/.local/share/WSJT-X/+ +Default save:: + +~/.local/share/WSJT-X/save/+ + +* *Linux, when using "--rig-name=xxx"* +Log files:: + +~/.local/share/WSJT-X - xxx/+ +Default save:: + +~/.config/WSJT-x - xxx.ini+ + +* *Macintosh* +Settings:: + +~/Library/Preferences/WSJT-X.ini+ +Log files:: + +~/Library/Application Support/WSJT-X/+ +Default save:: + +~/Library/Application Support/WSJT-X/save/+ + +* *Macintosh, when using "--rig-name=xxx"* +Log files:: + +~/Library/Application Support/WSJT-X - xxx/+ +Default save:: + +~/Library/Preferences/WSJT-X - xxx.ini+ + +.Show DXCC entity and worked before status + +This program option (selected on the *Settings | General* tab) is +intended mostly for use on non-Windows platforms. Windows users +should use VK3AMA's excellent {jtalert} utility instead. + +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. + +_WSJT-X_ includes a built-in +cty.dat+ file containing DXCC prefix +information. Updated files can be downloaded from {cty_dat} when +required. If an updated +cty.dat+ is present in the logs folder +and readable, it will be used in preference to the built-in one. + + +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. + diff --git a/doc/user_guide/rig-config-adat.adoc b/doc/user_guide/rig-config-adat.adoc new file mode 100644 index 000000000..a556a60ac --- /dev/null +++ b/doc/user_guide/rig-config-adat.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-alinco.adoc b/doc/user_guide/rig-config-alinco.adoc new file mode 100644 index 000000000..bf42e3d10 --- /dev/null +++ b/doc/user_guide/rig-config-alinco.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-aor.adoc b/doc/user_guide/rig-config-aor.adoc new file mode 100644 index 000000000..11cb9436f --- /dev/null +++ b/doc/user_guide/rig-config-aor.adoc @@ -0,0 +1,103 @@ +// 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/user_guide/rig-config-drake.adoc b/doc/user_guide/rig-config-drake.adoc new file mode 100644 index 000000000..5310ff59b --- /dev/null +++ b/doc/user_guide/rig-config-drake.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-elecraft.adoc b/doc/user_guide/rig-config-elecraft.adoc new file mode 100644 index 000000000..34a05f253 --- /dev/null +++ b/doc/user_guide/rig-config-elecraft.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-flexrad.adoc b/doc/user_guide/rig-config-flexrad.adoc new file mode 100644 index 000000000..dd17de563 --- /dev/null +++ b/doc/user_guide/rig-config-flexrad.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-icom.adoc b/doc/user_guide/rig-config-icom.adoc new file mode 100644 index 000000000..2e626adee --- /dev/null +++ b/doc/user_guide/rig-config-icom.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-kenwood.adoc b/doc/user_guide/rig-config-kenwood.adoc new file mode 100644 index 000000000..708d2695f --- /dev/null +++ b/doc/user_guide/rig-config-kenwood.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-main.adoc b/doc/user_guide/rig-config-main.adoc new file mode 100644 index 000000000..4701d936a --- /dev/null +++ b/doc/user_guide/rig-config-main.adoc @@ -0,0 +1,33 @@ +// 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/user_guide/rig-config-softrock.adoc b/doc/user_guide/rig-config-softrock.adoc new file mode 100644 index 000000000..a2319d8b5 --- /dev/null +++ b/doc/user_guide/rig-config-softrock.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-template.adoc b/doc/user_guide/rig-config-template.adoc new file mode 100644 index 000000000..474dc1a93 --- /dev/null +++ b/doc/user_guide/rig-config-template.adoc @@ -0,0 +1,60 @@ +// 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/user_guide/rig-config-tentec.adoc b/doc/user_guide/rig-config-tentec.adoc new file mode 100644 index 000000000..7d4f14e57 --- /dev/null +++ b/doc/user_guide/rig-config-tentec.adoc @@ -0,0 +1,104 @@ +// 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/user_guide/rig-config-yaesu.adoc b/doc/user_guide/rig-config-yaesu.adoc new file mode 100644 index 000000000..e71d4909a --- /dev/null +++ b/doc/user_guide/rig-config-yaesu.adoc @@ -0,0 +1,102 @@ +// 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/user_guide/settings-audio.adoc b/doc/user_guide/settings-audio.adoc new file mode 100644 index 000000000..79c7323b9 --- /dev/null +++ b/doc/user_guide/settings-audio.adoc @@ -0,0 +1,26 @@ +// Status=review +Select the *Audio* tab to configure your sound system. + +image::images/settings-audio.png[align="center",alt="WSJT-X Audio Configuration Screen"] + +- _Soundcard_: Select the audio devices to be used for *Input* and +*Output*. Usually the *Mono* settings will suffice, but in special +cases you can choose *Left*, *Right*, or *Both* stereo channels. + +IMPORTANT: If you are select the audio output device that is also your +computer's default audio device, be sure to turn off all system sounds +to prevent transmitting them over the air. + +- _Save Directory_: _WSJT-X_ can save its received audio sequences as ++.wav+ files. A default directory for these files is provided; you +can select another location if desired. + +- _JT9W Settings_: JT9W is an experimental mode designed for EME on +the microwave bands. Values of *Bandwidth Multiplier* greater than 1 +increase the tone spacing. You can also select nonstandard values of +*DT min* and *DT max* to define the range of DT searched by the +decoder. Most users will not want to change these settings from their +default values of -1, 2.5, and 5.0, respectively. + +IMPORTANT: JT9W mode is presently enabled only in special test versions +of _WSJT-X_. diff --git a/doc/user_guide/settings-frequencies.adoc b/doc/user_guide/settings-frequencies.adoc new file mode 100644 index 000000000..7f996aafe --- /dev/null +++ b/doc/user_guide/settings-frequencies.adoc @@ -0,0 +1,39 @@ +// Status=review + +[[FIG_BAND_SETTINGS]] +image::images/r4148-freq-ui.png[align="center",alt="Frequency Screen"] + +_Working Frequencies_: By default the *Frequency* table lists the +currently recommended dial frequencies for JT65. JT9 frequencies +generally start 2 kHz higher. You can modify the frequency table as +desired. + +- To change an existing entry, click to select it, type a desired +frequency in MHz, and hit *Enter* on the keyboard. The program will +format your frequency value appropriately and add a band designator. + +- To add a new entry, right-click anywhere on the frequency table and +select *Insert*. Enter a frequency in MHz in the popup box, then +click *OK*. The table may include more than one frequency for a given +band. + +- To delete an entry, right-click it and select *Delete*. + +_Station Information_: You can save *Band*, *Offset* and *Antenna +Description* information for your station. The antenna information +will be included in reception reports sent to {pskreporter}. By +default the frequency *Offset* for each band is zero. Nonzero offsets +may be added if (for example) a transverter is in use. + +- For a simple setup approach you might want to delete any unwanted +bands -- for example, bands where you have no equipment. Then click +on a *Frequency* entry and type *Ctrl+A* to ``select all,'' and +drag-and-drop the entries onto the _Station Information_ table. You +can then add any transverter offsets and antenna details. + +- To avoid typing the same information multiple times, you can +drag-and-drop entries between the lines of the _Station Information_ +table. + +- When all settings have been configured to your liking, click *OK* to +dismiss the *Settings* window. diff --git a/doc/user_guide/settings-general.adoc b/doc/user_guide/settings-general.adoc new file mode 100644 index 000000000..1dd661df0 --- /dev/null +++ b/doc/user_guide/settings-general.adoc @@ -0,0 +1,12 @@ +// Status=review +[[FIG_CONFIG_STATION]] +image::images/settings-ui.png[align="center",alt="Settings Window"] + +Select the *General* tab on the *Settings* window. Under _Station +Details_, enter your call sign and 4-digit or 6-digit grid locator. +This information will be sufficient for initial tests. + +Meanings of the remaining options on the *General* tab will become +self-explanatory after you have made some QSOs using _WSJT-X_. You +may return to set these options later. + diff --git a/doc/user_guide/settings-radio.adoc b/doc/user_guide/settings-radio.adoc new file mode 100644 index 000000000..7a26593de --- /dev/null +++ b/doc/user_guide/settings-radio.adoc @@ -0,0 +1,90 @@ +// Status=review + +_WSJT-X_ offers CAT (Computer Aided Transceiver) control of the +relevant features of most modern transceivers. To configure the +program for your radio, select the *Radio* tab. + +//image::images/RadioTab.png[align="center",alt="Radio Tab"] +image::images/r4148-cat-ui.png[align="center",alt="Radio Tab"] + +//// +IMPORTANT: Unless you have selected *Monitor off at startup* under the +above tab, _WSJT-X_ expects to seize exclusive rig control upon +startup. You can prevent this by either selecting that option or by +selecting the *Monitor* button on the main window and toggle it. Once +done, _WSJT-X_ relinquishes exclusive rig control (but not the control +port or client connection itself). Since it is extremely convenient to +have all your required station programs running, which can include +radio control software, it is imperative that the operator understand +that any change in a separate radio control program can induce +unwanted effects in _WSJT-X_. If you would like to switch to another +operating mode while leaving _WSJT-X_ on in the background, simply +toggle the *Monitor* button so that _WSJT-X_ is no longer active. +//// + +- Select your radio type from the drop-down list labeled *Rig*, or +*None* if you do not wish to use CAT control. + +- Alternatively, if you have configured your station for control by +*DX Lab Suite Commander*, *Ham Radio Deluxe*, *Hamlib NET rigctl*, or +*OmniRig*, you may select one of those program names. In those cases +the entry field immediately under _CAT Control_ will be relabeled as +*Network Server*. Leave this field blank to access the default +instance of your control program, running on the same computer. If the +control program runs on a different machine and/or port, specify it +here. Hover the mouse pointer over the entry field to see the +required formatting details. + +- Select *OmniRig Rig 1* or *OmniRig Rig 2* to connect to an _OmniRig_ +server running on the same computer. Note that _OmniRig_ is available +only under Windows. + +- Set *Poll Interval* to the desired interval for _WSJT-X_ to query +your radio. For most radios a small number (say, 1 – 3 s) is +suitable. + +- _CAT Control_: To have _WSJT-X_ control the radio directly rather +than though another program, make the following settings: + +* Select the *Serial Port* used to communicate with your radio. + +* _Serial Port Parameters_: Set values for *Baud Rate*, *Data Bits*, +*Stop Bits*, and *Handshake* method. Consult your radio's user guide +for the proper parameter values. + +* _Force Control Lines_: A few station setups require the serial +port's *RTS* and/or *DTR* control lines to be forced high. Check +these boxes only if you are sure they are needed. + +- _PTT Method_: select *VOX*, *CAT*, *DTR*, or *RTS* as the desired +method for T/R switching. If your choice is *DTR* or *RTS*, select +the desired serial port. + +- _Transmit Audio Source_: some radios permit you to choose the +connector that will accept Tx audio. If this choice is enabled, +select *Rear/Data* or *Front/Mic*. + +- _Mode_: _WSJT-X_ uses upper sideband mode for both transmitting and +receiving. Select *USB*, or choose *Data/Pkt* if your radio offers +such an option and uses it to enable the rear-panel audio line input. +Some radios also offer wider and/or flatter passbands when set to +*Data/Pkt* mode. Select *None* if you do not want _WSJT-X_ to change +the radio's Mode setting. + +- _Split Operation_: Significant advantages result from using *Split* +mode (separate VFOs for Rx and Tx) if your radio supports it. If it +does not, _WSJT-X_ can simulate such behavior. Either method will +result in a cleaner transmitted signal, by keeping the Tx audio always +in the range 1500 to 2000 Hz so that audio harmonics cannot pass +through the Tx sideband filter. Select *Rig* to use the radio's Split +mode, or *Fake It* to have _WSJT-X_ adjust the VFO frequency as +needed, just before T/R switching occurs. Choose *None* if you do not +wish to use split operation. + +When all required settings have been made, click *Test CAT* to test +communication between _WSJT-X_ and your radio. The button should turn +green to indicate that proper communication has been established. +Failure of the CAT-control test turns the button red and displays an +error message. After a succesful CAT test, toggle the *Test PTT* +button to confirm that your selected method of T/R control is working +properly. diff --git a/doc/user_guide/settings-reporting.adoc b/doc/user_guide/settings-reporting.adoc new file mode 100644 index 000000000..8f2e11279 --- /dev/null +++ b/doc/user_guide/settings-reporting.adoc @@ -0,0 +1,10 @@ +// Status=review +[[FIG_CONFIG_RPT]] +image::images/r4148-rpt-ui.png[align="center",alt="Reporting Screen"] + +- _Logging_: Choose any desired options from this group. For detailed +descriptions of their effects, see <> +in the <> section. + +- _Network_: Check *Enable PSK Reporter Spotting* to send reception +reports to the {pskreporter} mapping facility. diff --git a/doc/user_guide/settings-txmacros.adoc b/doc/user_guide/settings-txmacros.adoc new file mode 100644 index 000000000..787f2a4bb --- /dev/null +++ b/doc/user_guide/settings-txmacros.adoc @@ -0,0 +1,16 @@ +// Status=review + +[[FigTxMacros]] +image::images/r4148-txmac-ui.png[align="center",alt="Tx Macros Screen"] + +*Tx Macros* are an aid for sending brief, frequently used free-text + messages. + +- To add a new message to the list, enter the desired text (up to 13 +characters) in the entry field at top, then click *Add*. + +- To remove an unwanted message, click on the message and then on +*Delete*. + +- You can reorder your macro messages by using drag-and-drop. The +new order will be preserved over program invocations. diff --git a/doc/user_guide/system-requirements.adoc b/doc/user_guide/system-requirements.adoc new file mode 100644 index 000000000..68a256727 --- /dev/null +++ b/doc/user_guide/system-requirements.adoc @@ -0,0 +1,12 @@ +// 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 +- Computer-to-radio interface using a serial port for T/R switching, + or CAT control, or VOX, as required for your radio-to-computer connections +- Audio input and output devices supported by the operating system and + capable of 48 kHz sample rate or an integer multiple thereof +- Audio or equivalent USB connections between transceiver and computer +- A means for synchronizing the computer clock to UTC within ±1 second diff --git a/doc/user_guide/transceiver-setup.adoc b/doc/user_guide/transceiver-setup.adoc new file mode 100644 index 000000000..d0dbca50c --- /dev/null +++ b/doc/user_guide/transceiver-setup.adoc @@ -0,0 +1,55 @@ +// Status=review +.Receiver Noise Level + +- Click the *Monitor* button to return to normal receive operation. +The button will be highlighted in green. + +- Be sure your transceiver is set to *USB* (or *USB Data*) mode. + +- Use the receiver gain controls and/or the computer's audio 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 + +- If your transceiver offers more than one bandwidth setting in USB +mode, you should normally choose the widest one possible, up to about +5 kHz. This choice has the desirable effect of allowing the *Wide +Graph* to display the JT65 and JT9 sub-bands simultaneously on most HF +bands. Further details are provided in the <> +section. + +- If you have only a standard SSB filter you won’t be able to display +more than about 2.7 kHz bandwidth. Depending on the exact dial +frequency setting, you can display the full sub-band generally used +for one mode (JT65 or JT9) and part of the sub-band for the other +mode. + +- Of course, you might prefer to concentrate on one mode at a time, +setting your dial frequency to (say) 14.076 for JT65 or 14.078 for +JT9. Present conventions have the nominal JT9 dial frequency 2 kHz +higher than the JT65 dial frequency. A checkbox labeled *+2 kHz*, +just below the *Band* selector, makes the appropriate frequency +settings easy. + +.Transmitter Audio Level + +* Click the *Tune* button on the main screen 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 transmitted 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 Tx audio level 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/user_guide/tutorial-example1.adoc b/doc/user_guide/tutorial-example1.adoc new file mode 100644 index 000000000..6e2c35491 --- /dev/null +++ b/doc/user_guide/tutorial-example1.adoc @@ -0,0 +1,97 @@ +// Status=review + +For this step and the next, you may want to pretend you are K1JT +by entering that callsign temporarily as *My Call* on the +*Settings | General* tab. Your results should then be identical to +those shown in the screen shot below. + +.Open a Wave File: + +- Select *File | Open* and select the file ++...\save\samples\130418_1742.wav+. When the file opens you should see +something similar to the to the following screen shot: + +[[X12]] +image::images/main-ui-1.4.png[align="center",alt="Main UI and Wide Graph"] + +.Decoding Overview + +Notice the red and green and markers on the Wide Graph (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 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 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, and lines with *My Call* (in this case K1JT) in red. + +[[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. Results will be similar to those in the +previous step, except the Tx frequency (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 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/user_guide/tutorial-example2.adoc b/doc/user_guide/tutorial-example2.adoc new file mode 100644 index 000000000..7f0a5bb17 --- /dev/null +++ b/doc/user_guide/tutorial-example2.adoc @@ -0,0 +1,116 @@ +// 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 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 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 first. 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. + +IMPORTANT: When finished with this Tutorial, don’t forget to re-enter +your own callsign as *My Call* on the *Settings | General* tab. diff --git a/doc/user_guide/tutorial-main-window.adoc b/doc/user_guide/tutorial-main-window.adoc new file mode 100644 index 000000000..bfc947eca --- /dev/null +++ b/doc/user_guide/tutorial-main-window.adoc @@ -0,0 +1,6 @@ +// 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/user_guide/tutorial-wide-graph-settings.adoc b/doc/user_guide/tutorial-wide-graph-settings.adoc new file mode 100644 index 000000000..c42eafb4f --- /dev/null +++ b/doc/user_guide/tutorial-wide-graph-settings.adoc @@ -0,0 +1,14 @@ +// 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/user_guide/tx-rx.adoc b/doc/user_guide/tx-rx.adoc new file mode 100644 index 000000000..f999534e1 --- /dev/null +++ b/doc/user_guide/tx-rx.adoc @@ -0,0 +1,77 @@ +// 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 +audio waveform is computed on-the-fly, sending 16-bit integer samples +to the audio output device at a 48000 Hz rate. Generated JT65 and JT9 +signals have continuous phase and constant amplitude, and there are no +key clicks. The transmitter's power amplifier need not be highly +linear. + + +.Receiving + +_WSJT-X_ acquires 16-bit integer samples from the audio input device +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. + +.Decoding + +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. The functional blocks are different +for the JT65 and JT9 modes. + +The basic decoding algorithm for JT65 mode is described in the 2005 +{jt65protocol} paper. The following list summarizes the corresponding +algorithm for JT9 mode. Blocks are labeled here 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 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 interleaving imposed at the + transmitter + ++decode9+:: Retrieve a 72-bit user message using the sequential + Fano algorithm + + ++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 Fano algorithm +can take exponentially long times. If the +sync9+ step in the above +sequence finds many seemingly worthy candidate signals and 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/user_guide/utilities.adoc b/doc/user_guide/utilities.adoc new file mode 100644 index 000000000..2afa4d2a3 --- /dev/null +++ b/doc/user_guide/utilities.adoc @@ -0,0 +1,59 @@ +// 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. These programs can be useful to someone +designing a beacon generator for JT9 or JT65, for understanding the +permissible structure of transmitted messages, and 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 in a transmitted message is +85. To run +jt9code+, enter the program name followed by a JT9 +message enclosed in quotes. In Windows the command and program output +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 here 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 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+ in the JT65 message: + + 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/user_guide/wsjtx-main.adoc b/doc/user_guide/wsjtx-main.adoc new file mode 100644 index 000000000..9390ed846 --- /dev/null +++ b/doc/user_guide/wsjtx-main.adoc @@ -0,0 +1,196 @@ +// Status=review +// This is a comment line, anything with // is ignored at process time. += WSJT-X User Guide +//:Date: October 1, 2014 +:Revision: 1.4 +// For web-pages, adding :badges: is ok, but is a security issue for +// package building .deb, .rpm, etc as it exposes the IP address and the images +// are non-free, so can't be included as part of the Debian package. +// :badges: +:icons: +:numbered: +:keywords: amateur radio weak signal communication K1JT WSJT FSK441 JT65 JT6M +:description: Software for Amateur Radio Weak-Signal Communication +:prog: WSJT-X + +// use global link file +include::../common/links.adoc[] + +// 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-requirements.adoc[] + +[[INSTALL]] +== Installation + +Installation packages are found on the the {homepage}. Click on the +_WSJT-X_ link at the left margin, and then select the appropriate +package for your operating system. + +[[INSTALL_WIN]] +=== Windows +include::install-windows.adoc[] + +[[INSTALL_LINUX]] +=== Linux +include::install-linux.adoc[] + +[[INSTALL_OSX]] +=== Macintosh OS X +include::install-mac.adoc[] + +[[SRC_CODE]] +=== Source Code +include::install-from-source.adoc[] + +[[CONFIG]] +== Settings + +Select *Settings* from the *File* menu or by typing *F2* (on +Macintosh, *Cmd+,*). The following sections describe setup optiions +available on each of six tabs selectable near the top of the window. + +[[GENERAL]] +=== General +include::settings-general.adoc[] + +[[RADIO]] +=== Radio +include::settings-radio.adoc[] + +[[AUDIO]] +=== Audio +include::settings-audio.adoc[] + +[[TXMACROS]] +=== Tx Macros +include::settings-txmacros.adoc[] + +[[LOGGING]] +=== Reporting +include::settings-reporting.adoc[] + +[[BAND_SETTINGS]] +=== Frequencies +include::settings-frequencies.adoc[] + +[[TRANSCEIVER]] +== Transceiver Setup +include::transceiver-setup.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[] + +[[MAKE_QSOS]] +== Making QSOs +include::make-qso.adoc[] + +[[COMMAND_REF]] +== Command Reference + +[[CONTROLS_WIDE]] +=== Wide Graph +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[] + +[[PLATFORM]] +== Platform Dependencies +include::platform-dependencies.adoc[] + +[[COOP_PGMS]] +== Cooperating Programs +To be added: brief descriptions of _JTAlert-X_ and _PSK Reporter_, and +how to use them with _WSJT-X_. + +[[FAQ]] +== Frequently Asked Questions +include::faq.adoc[] + +[[PROTOCOLS]] +== Protocol Specifications + +[[JT65PRO]] +=== JT65 +include::jt65-protocol.adoc[] + +[[JT9PRO]] +=== JT9 +include::jt9-protocol.adoc[] + +[[JT65_JT9]] +=== JT65 & JT9 Differences +include::jt65-jt9-differences.adoc[] + +[[TXRX]] +== Implementation Details +include::tx-rx.adoc[] + +//// +[[TROUBLE_SHOOTING]] +== Troubleshooting +To be added (?) ... +//// + +[[UTIL]] +== Utility Programs +include::utilities.adoc[] + +[[ACK]] +== Acknowledgements +include::acknowledgements.adoc[] + +[[LICENSE]] +== License +include::../common/license.adoc[] +