WSJT-X/doc/source/wsjtx-main.adoc

// Status=review
// This is a comment line, anything with // is ignored at process time.
= WSJT-X User's Guide
:Author: Joe Taylor, K1JT
:Date: January 30, 2014, Copyright © 2012-2014
:Revision: 1.3
:badges:
:icons:
:numbered:
:image_dir:

// If the list of links gets too long, we can add a url-file that is pulled
// in when and where needed with the following:
// include::<file-name> for example: include::url-list.txt

// WEB links - List is getting pretty long, time to use include::file-name ??
:asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ]
:asciidoc_cheatsheet: http://powerman.name/doc/asciidoc[ AsciiDoc Cheatsheet ]
:asciidoc_questions: http://www.methods.co.nz/asciidoc/faq.html[ AsciiDoc FAQ ]
:debian: http://www.debian.org/[ Debian ]
:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ]
:devsvn: http://developer.berlios.de/projects/wsjt/[wsjt-svn]
:download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ]
:dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ]
:homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ]
:hrd: http://www.hrdsoftwarellc.com/[ Ham Radio Deluxe ]
:jtalert: http://ham-apps.com[JT-ALERT-X]
:jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX]
:launchpadurl: https://launchpad.net/~jnogatch/+archive/wsjtx[ WSJT-X Linux Packages ]
:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup]
:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter]
:osx_instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here]
:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ]

// DOWNLOAD links
:cty_dat: http://www.country-files.com/cty/[here].
:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd]
:osx_108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ]
:osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[ OS X 10.9 ]

// MAIL-TO links
:alex_efros: mailto:powerman@powerman.name[ Alex Efros ]
:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel]
:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ]


// These [[xxxx]] labels are HTML anchors, and can be used to
// navigate though the document easily: <<[INTRO],See Introduction]>> will
// place a hyper-link in your text to take you too the anchored section.
// All major sections or points of interest should have one.

// == is level (2), section 1.0, === would mean section 1.1, === would
// be section 1.1.1. This method is used throughout the document.

[[INTRO]]
== Introduction
include::introduction.adoc[]

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

[[INSTALL]]
== Installation

- Download _WSJT-X_ from the {homepage}. Click on _WSJT-X_ at the left
margin and then on the appropriate link(s) for your operating system.

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

[[INSTALL_UBU]]
=== Linux
include::install-ubuntu.adoc[]

[[INSTALL_OSX]]
=== OS X
include::install-mac.adoc[]

// Note to developers. The URL http://developer.berlios.de/projects/wsjt/. is
// to a very old src version of WSJT 5.7 or so. WSJTX is not listed at all.
// Also, all the Qt4 stuff is now obsolete, and needs to be updated.
// Instructions for source builds Win, *Nix & Mac all need to be written / 
// Rreviewd.

[[SRC_CODE]]
=== Source Code
include::install-from-source.adoc[]

[[CONFIG]]
== Setup and Configuration

[[STATION]]
=== Station Tab
include::configuration-station.adoc[]

[[TXMACROS]]
=== Tx Macros Tab
include::configuration-txmacros.adoc[]

[[BAND_SETTINGS]]
=== Band Settings Tab
include::configuration-band-settings.adoc[]

[[CONFIG_MAIN]]
=== Main Window
include::configuration-main-window.adoc[]

[[FONTS]]
=== Font Sizes
include::font-sizes.adoc[]

[[TUTORIAL]]
== Basic Operating Tutorial

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

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

[[TUT_EX1]]
=== Sample File 1
include::tutorial-example1.adoc[]

[[TUT_EX2]]
=== Sample File 2
include::tutorial-example2.adoc[]

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

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

[[CONTROLS]]
== Controls & Functions

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

[[CONTROLS_MAIN]]
=== Main Window
include::controls-functions-main-window.adoc[]

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

[[CONTROLS_CENTER]]
=== Misc Controls Center
include::controls-functions-center.adoc[]

[[CONTROLS_MSGS]]
=== Tx Messages
include::controls-functions-messages.adoc[]

[[STATUS_BAR]]
=== Status Bar
include::controls-functions-status-bar.adoc[]

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

[[SHORTCUTS]]
=== Keyboard Shortcuts
include::controls-functions-kb-shortcuts.adoc[]

[[MOUSE_COMMANDS]]
=== Mouse Commands
include::controls-functions-special-mouse-cmds.adoc[]

[[COOP_PGMS]]
== Cooperating Programs
To be added ...

[[JT65PRO]]
== The JT65 Protocol
include::jt65-protocol.adoc[]

[[JT9PRO]]
== The JT9 Protocol
include::jt9-protocol.adoc[]

[[JT65_JT9]]
== JT65 & JT9 Differences
include::jt65-jt9-differences.adoc[]

[[TXRX]]
== Transmitting and Receiving in _WSJT-X_
include::tx-rx.adoc[]

[[TROUBLE_SHOOTING]]
== Troubleshooting
To be added ...

[[FAQ]]
== Frequently Asked Questions
To be added ...

[[FILES]]
== File Names

// Note to Dev-Team, this list of files needs to be updated.
[[FILES1]]
=== Installed Files
include::installed-files.adoc[]

[[FILES2]]
=== Runtime Files
include::runtime-files.adoc[]

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

[[COMPILING]]
== Compiling WSJT-X
include::compiling.adoc[]

[[RIG_CONFIG]]
== Rig Configuration
include::rig-config-main.adoc[]

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