WSJT-X/doc/user_guide/en/wsjtx-main.adoc

// This is a comment line, anything with // is ignored at process time.
= _WSJT-X {VERSION_MAJOR}.{VERSION_MINOR}_ User Guide
Joseph H Taylor, Jr, K1JT
:revnumber: {VERSION}
// 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:
:docinfo1:
:imagesdir: {docdir}/images
:icons: font
:numbered:
:keywords: amateur radio weak signal communication K1JT WSJT JT65 JT9
: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[]

[[NEW_FEATURES]]
include::new_features.adoc[]

[[SYSREQ]]
== System Requirements
include::system-requirements.adoc[]

[[INSTALL]]
== Installation

Installation packages for released versions on Windows, Linux, and OS
X are found on the {homepage}. Click on the _WSJT-X_ link at the
left margin and select the appropriate package for your operating
system.

[[INSTALL_WIN]]
=== Windows
include::install-windows.adoc[]

[[INSTALL_LINUX]]
=== Linux
include::install-linux.adoc[]

[[INSTALL_OSX]]
=== OS X and macOS
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 select *Preferences* from the _WSJT-X_ menu, or use the
keyboard shortcut *Cmd+,*).  The following sections describe setup
options available on eight 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[]

[[REPORTING]]
=== Reporting
include::settings-reporting.adoc[]

[[BAND_SETTINGS]]
=== Frequencies
include::settings-frequencies.adoc[]

[[COLORS]]
=== Colors
include::settings-colors.adoc[]

[[ADVANCED]]
=== Advanced
include::settings-advanced.adoc[]

[[DARK_STYLE]]
=== Dark Style

An optional *Dark* style is available.  To make it effective you will
probably want to redefine your color settings.  In Windows or Linux,
start the program from a command-prompt window using the following
command, or modify the _WSJT-X_ desktop shortcut accordingly:

 wsjtx --stylesheet :/qdarkstyle/style.qss

In macOS, enter the following command from a terminal:

 open /Applications/wsjtx.app --args -stylesheet :/qdarkstyle/style.qss

Depending on your operating system, the main _WSJT-X_ window will look
something like this:

image::Windows_Dark.png[align="center"]

[[TRANSCEIVER]]
== Transceiver Setup
include::transceiver-setup.adoc[]

[[TUTORIAL]]
== Basic Operating Tutorial

This section introduces the basic user controls and program behavior
of _WSJT-X_, with particular emphasis on the JT9, JT65, and FT8 modes.
We suggest that new users should go through the full HF-oriented
tutorial, preferably while at your radio.  Note that as of late 2018,
digital usage on the HF bands has mostly moved from JT65 and JT9 to FT8.  So
you may wish to pay particular attention to *FT8*, in Section 6.6.

Subsequent sections cover additional details on <<MAKE_QSOS,Making
QSOs>>, <<WSPR,WSPR mode>> and <<VHF_AND_UP,VHF+ Features>>.

[[TUT_MAIN]]
=== Main Window Settings
include::tutorial-main-window.adoc[]

[[TUT_WIDE_GRAPH]]
=== Wide Graph Settings
include::tutorial-wide-graph-settings.adoc[]

[[TUT_EX1]]
=== JT9
include::tutorial-example1.adoc[]

[[TUT_EX2]]
=== JT9+JT65
include::tutorial-example2.adoc[]

[[TUT_EX3]]
=== FT8
include::tutorial-example3.adoc[]

[[TUT_EX4]]
=== FT4
include::tutorial-example4.adoc[]

[[MAKE_QSOS]]
== Making QSOs
include::make-qso.adoc[]

[[VHF_AND_UP]]
== VHF+ Features
include::vhf-features.adoc[]

[[WSPR]]
== WSPR Mode
include::wspr.adoc[]

[[COMMAND_REF]]
== On-Screen Controls

[[MENUS]]
=== Menus
include::controls-functions-menus.adoc[]

[[CONTROLS_MAIN]]
=== Button Row
include::controls-functions-main-window.adoc[]

[[CONTROLS_LEFT]]
=== Left
include::controls-functions-left.adoc[]

[[CONTROLS_CENTER]]
=== 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[]

[[CONTROLS_WIDE]]
=== Wide Graph
include::controls-functions-wide-graph.adoc[]

[[LOGGING]]
== Logging
include::logging.adoc[]

[[DECODER_NOTES]]
== Decoder Notes
include::decoder_notes.adoc[]

[[MEASUREMENT_TOOLS]]
== Measurement Tools
include::measurement_tools.adoc[]

[[COOP_PGMS]]
== Cooperating Programs
include::cooperating-programs.adoc[]

[[PLATFORM]]
== Platform Dependencies
include::platform-dependencies.adoc[]


[[FAQ]]
== Frequently Asked Questions
include::faq.adoc[]

[[PROTOCOLS]]
== Protocol Specifications
include::protocols.adoc[]

[[ASTRODATA]]
== Astronomical Data
include::astro_data.adoc[]

[[UTIL]]
== Utility Programs
include::utilities.adoc[]

[[SUPPORT]]
== Support
include::support.adoc[]

[[ACK]]
== Acknowledgements
include::acknowledgements.adoc[]

[[LICENSE]]
== License
include::../../common/license.adoc[]

ifeval::["{backend}" != "html5"]
[index]
== Index
endif::[]