mirror of
https://github.com/saitohirga/WSJT-X.git
synced 2024-11-24 21:28:41 -05:00
User Guide Docs Update
* Moved doc/source/*.txt to AsciiDoc ext source/*.adoc - Correctly identifies AsciiDoc files * wsjtx-main.adoc - Updated links and include:: for *.adoc name change * Added and updated rig-config-* files. * Added inital draft of quick-reference.adoc * build-doc.sh - Updated the script to build new files and .adoc name change * Removed: - yaesu.txt rigtemplate.txt rig-configuration.txt git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3662 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Greg Beam
parent
b932baef5b
commit
23aff84fbb
@ -3,8 +3,8 @@
|
||||
# Description : WSJT-X Documentation build script
|
||||
# Author : KI7MT
|
||||
# Email : ki7mt@yahoo.com
|
||||
# Date : JAN-21-2014
|
||||
# Version : 0.2
|
||||
# Date : JAN-24-2014
|
||||
# Version : 0.3
|
||||
# Usage : ./build-doc.sh [ option ]
|
||||
# Notes : requires asciidoc, source-highlight
|
||||
#==============================================================================
|
||||
@ -26,60 +26,86 @@ c_asciidoc="asciidoc -b xhtml11 -a max-width=1024px"
|
||||
script_name=$(basename $0)
|
||||
doc_version="1.2.2"
|
||||
|
||||
|
||||
# build functions
|
||||
function build_no_toc() { # no toc
|
||||
echo -e ${yellow}'Building Without TOC'${no_col}
|
||||
$c_asciidoc -o wsjtx-main.html $src_dir/wsjtx-main.txt
|
||||
echo -e ${green}'. Finished wsjtx-main.html'${no_col}
|
||||
echo -e ${yellow}'Building Main With No TOC'${no_col}
|
||||
$c_asciidoc -o wsjtx-main.html $src_dir/wsjtx-main.adoc
|
||||
echo -e ${green}'.. wsjtx-main.html'${no_col}
|
||||
}
|
||||
|
||||
function build_toc1() { # top toc
|
||||
echo -e ${yellow}'Building with Top TOC'${no_col}
|
||||
$c_asciidoc -a toc -o wsjtx-main-toc1.html $src_dir/wsjtx-main.txt
|
||||
echo -e ${green}'. Finished wsjtx-main-toc1.html'${no_col}
|
||||
echo -e ${yellow}'Building Main with Top TOC'${no_col}
|
||||
$c_asciidoc -a toc -o wsjtx-main-toc1.html $src_dir/wsjtx-main.adoc
|
||||
echo -e ${green}'.. wsjtx-main-toc1.html'${no_col}
|
||||
}
|
||||
|
||||
function build_toc2() { # left toc
|
||||
echo -e ${yellow}'Building with Left TOC'${no_col}
|
||||
$c_asciidoc -a toc2 -o wsjtx-main-toc2.html $src_dir/wsjtx-main.txt
|
||||
echo -e ${green}'. Finished wsjtx-main-toc2.html'${no_col}
|
||||
echo -e ${yellow}'Building Main with Left TOC'${no_col}
|
||||
$c_asciidoc -a toc2 -o wsjtx-main-toc2.html $src_dir/wsjtx-main.adoc
|
||||
echo -e ${green}'.. wsjtx-main-toc2.html'${no_col}
|
||||
}
|
||||
|
||||
function build_support_pages() { # build all remaining pages
|
||||
echo
|
||||
echo -e ${yellow}'Building Support Pages'${no_col}
|
||||
$c_asciidoc -o rig-config-main.html $src_dir/rig-config-main.adoc
|
||||
echo -e ${green}'.. rig-config-main.html'${no_col}
|
||||
|
||||
# setup rig file array
|
||||
declare -a subpage=('adat' 'alinco' 'aor' 'drake' 'electro' 'flexrad' 'icom' \
|
||||
'kenwood' 'softrock' 'tentec' 'yaesu')
|
||||
|
||||
# loop through rig-config pages
|
||||
for rig in "${subpage[@]}"
|
||||
do
|
||||
$c_asciidoc -a toc2 -o rig-config-$rig.html $src_dir/rig-config-$rig.adoc
|
||||
echo -e ${green}".. rig-config-$rig.html"${no_col}
|
||||
done
|
||||
|
||||
$c_asciidoc -o rig-config-template.html $src_dir/rig-config-template.adoc
|
||||
echo -e ${green}'.. rig-config-template.html'${no_col}
|
||||
|
||||
$c_asciidoc -a toc2 -o quick-reference.html $src_dir/quick-reference.adoc
|
||||
echo -e ${green}'.. quick-reference.html'${no_col}
|
||||
}
|
||||
|
||||
# start the main script
|
||||
clear
|
||||
# Hard coded version info to build outside of source tree.
|
||||
echo -e ${yellow}"*** Building WSJT-X User Guide for:" ${cyan}$doc_version${no_col}${yellow}" ***\n" ${no_col}
|
||||
echo -e ${yellow}"*** Building WSJT-X User Guide for:" ${cyan}$doc_version\
|
||||
${no_col}${yellow}" ***\n" ${no_col}
|
||||
|
||||
# without TOC
|
||||
if [[ $1 = "" ]]
|
||||
then
|
||||
build_no_toc
|
||||
build_support_pages
|
||||
|
||||
# top TOC
|
||||
elif [[ $1 = "toc1" ]]
|
||||
then
|
||||
build_toc1
|
||||
build_support_pages
|
||||
|
||||
# left TOC
|
||||
elif [[ $1 = "toc2" ]]
|
||||
then
|
||||
build_toc2
|
||||
build_support_pages
|
||||
|
||||
# all toc versions
|
||||
elif [[ $1 = "all" ]]
|
||||
then
|
||||
echo -e ${yellow}'Building all TOC versions'${no_col}
|
||||
echo
|
||||
build_no_toc
|
||||
echo
|
||||
build_toc1
|
||||
echo
|
||||
build_toc2
|
||||
build_support_pages
|
||||
|
||||
# if something other than "", toc1, toc2 or all is entered as $1 display usage
|
||||
# message and exit. this should be re-written to redirect the user to select
|
||||
# 1 of 4 proper options v.s. exiting.
|
||||
# Usage: if something other than "", toc1, toc2 or all is entered as $1 display usage
|
||||
# message and exit.
|
||||
#
|
||||
# To-Do: this should be re-written to redirect the user to select
|
||||
# 1 of 4 proper options v.s. exiting. Future version should provide
|
||||
# a terminal GUI, Whiptail, Dialog, Zenity etc.
|
||||
else
|
||||
clear
|
||||
echo -e ${red}" * INPUT ERROR *\n"${no_col}
|
||||
@ -94,22 +120,9 @@ else
|
||||
echo
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# build the rig template page
|
||||
echo
|
||||
echo -e ${yellow}'Building Rig Template'${no_col}
|
||||
$c_asciidoc -o rigtemplate.html $src_dir/rigtemplate.txt
|
||||
echo -e ${green}'. Finished'${no_col}
|
||||
|
||||
# build the rig sheets
|
||||
# this section will should be modified to loop through rig template(s) either by
|
||||
# name or directory ./rig/rig_* could be used.
|
||||
echo
|
||||
echo -e ${yellow}'Building Rig Configuration Sheets'${no_col}
|
||||
$c_asciidoc -o yaesu.html $src_dir/yaesu.txt
|
||||
echo -e ${green}'. Finished'${no_col}
|
||||
echo
|
||||
echo -e ${yellow}'All HTML files have been saved to:'${no_col}${cyan} "$base_dir" ${no_col}
|
||||
echo
|
||||
|
||||
exit 0
|
||||
|
||||
|
||||
142
doc/source/quick-reference.adoc
Normal file
142
doc/source/quick-reference.adoc
Normal file
@ -0,0 +1,142 @@
|
||||
// Status=DRAFT
|
||||
// this is intentionally left as a single file v.s. multiple sections to allow
|
||||
// users to brows the Page Source
|
||||
= AsciiDoc Quick Reference
|
||||
:Author: WSJT-X Documetation Team
|
||||
:Date: January 22, 2014, Copyright © CC-BY-SA 3.0 Unported
|
||||
:Revision: 0.0.1
|
||||
:badges:
|
||||
:icons:
|
||||
:numbered:
|
||||
:image_dir:
|
||||
|
||||
// web-links
|
||||
: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 ]
|
||||
:devsvn: http://developer.berlios.de/projects/wsjt/[Devel-SVN]
|
||||
:download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ]
|
||||
:homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ]
|
||||
:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup]
|
||||
:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ]
|
||||
:page_source: ./source/quick-reference.txt[ Page Source ]
|
||||
:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ]
|
||||
|
||||
// mail-to links
|
||||
:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ]
|
||||
:alex_efros: mailto:powerman@powerman.name[ Alex Efros ]
|
||||
:devmail: mailto:wsjt-devel@lists.berlios.de[WSJT-Devel-List]
|
||||
|
||||
[[X1]]
|
||||
== Introduction
|
||||
The purpose of this guide is to provide a quick reference to commonly used
|
||||
markup-up items for writing the {wsjtx} User Guide. Additional resources and
|
||||
examples can be found at:
|
||||
|
||||
* {asciidoc_help} by {stuart_rackman}
|
||||
* {asciidoc_questions} by {stuart_rackman}
|
||||
* {asciidoc_cheatsheet} by {alex_efros}
|
||||
|
||||
[[X2]]
|
||||
== Asciidoc Install
|
||||
|
||||
For WSJT-X documentation, only (2) dependencies are generally required:
|
||||
|
||||
* Python v2.7+
|
||||
* Gnu source-highlight
|
||||
|
||||
Each OS has its own unique method of solving the dependencies. The following
|
||||
sub-sections will assist in the basic installation and setup.
|
||||
|
||||
[[X21]]
|
||||
=== Windows
|
||||
|
||||
Install Instructions:
|
||||
|
||||
|
||||
==== Vista, Win7, Win8
|
||||
|
||||
Install Instructions:
|
||||
|
||||
[[X22]]
|
||||
=== Linux
|
||||
|
||||
==== Ubuntu, Debian, Mint and relatives
|
||||
|
||||
Install Instructions:
|
||||
|
||||
==== RedHat, Fedora, CentOS, and relatives
|
||||
|
||||
Install Instructions:
|
||||
|
||||
==== Slackware
|
||||
|
||||
Install Instructions:
|
||||
|
||||
==== Linux Other
|
||||
|
||||
Install Instructions:
|
||||
|
||||
[[X23]]
|
||||
=== OS X
|
||||
|
||||
Install Instructions:
|
||||
|
||||
[[X3]]
|
||||
== Code Examples
|
||||
.Under Construction
|
||||
|
||||
Code examples for frequently used itmes in WSJT-X Documentaion.
|
||||
|
||||
[[X31]]
|
||||
=== Blocks
|
||||
.Under Construction
|
||||
|
||||
Content needed.
|
||||
|
||||
[[X32]]
|
||||
=== Headers
|
||||
.Under Construction
|
||||
|
||||
Content needed.
|
||||
|
||||
[[X33]]
|
||||
=== Links
|
||||
.Under Construction
|
||||
|
||||
Content needed.
|
||||
|
||||
[[X34]]
|
||||
=== Lists
|
||||
.Under Construction
|
||||
|
||||
Content needed.
|
||||
|
||||
[[X35]]
|
||||
=== Notes
|
||||
.Under Construction
|
||||
|
||||
Content needed.
|
||||
|
||||
[[X36]]
|
||||
=== Text
|
||||
.Under Construction
|
||||
|
||||
Content needed.
|
||||
|
||||
[[XA1]]
|
||||
== Appendix A: Credits
|
||||
.Authors, Editors, Commiters
|
||||
If you worked on the documentation, add yourself to the list.
|
||||
|
||||
* Authors: <call-sign>, <call-sign>
|
||||
|
||||
* Editors: <call-sign>, <call-sign>
|
||||
|
||||
* Commiters: <call-sign>, <call-sign>
|
||||
|
||||
|
||||
== Appendix B: License
|
||||
|
||||
This work is licensed under {cc_by_sa}.
|
||||
|
||||
104
doc/source/rig-config-adat.adoc
Normal file
104
doc/source/rig-config-adat.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,ADAT1>>|<<X2,ADAT2>>|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
|
||||
|
||||
104
doc/source/rig-config-alinco.adoc
Normal file
104
doc/source/rig-config-alinco.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,Alinco1>>|<<X2,Alinco2>>|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
|
||||
|
||||
103
doc/source/rig-config-aor.adoc
Normal file
103
doc/source/rig-config-aor.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,AOR1>>|<<X2,AOR2>>|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
|
||||
104
doc/source/rig-config-drake.adoc
Normal file
104
doc/source/rig-config-drake.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,Drake1>>|<<X2,Drake2>>|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
|
||||
|
||||
104
doc/source/rig-config-electro.adoc
Normal file
104
doc/source/rig-config-electro.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,ElectroCraft1>>|<<X2,ElectroCraft2>>|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
|
||||
|
||||
104
doc/source/rig-config-flexrad.adoc
Normal file
104
doc/source/rig-config-flexrad.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,Flex1>>|<<X2,Flex2>>|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
|
||||
|
||||
104
doc/source/rig-config-icom.adoc
Normal file
104
doc/source/rig-config-icom.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,Icom1>>|<<X2,Icom2>>|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
|
||||
|
||||
104
doc/source/rig-config-kenwood.adoc
Normal file
104
doc/source/rig-config-kenwood.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,Kenwood1>>|<<X2,Kenwood2>>|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
|
||||
|
||||
33
doc/source/rig-config-main.adoc
Normal file
33
doc/source/rig-config-main.adoc
Normal file
@ -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 ]
|
||||
:electro: link:rig-config-electro.html[ ElectroCraft ]
|
||||
: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.
|
||||
|
||||
NOTE: 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}|{electro}
|
||||
|{flexrad}|{kenwood}|{icom}|{softrock}|{tentec}
|
||||
|{yaesu}|{rig_template}|||
|
||||
|========
|
||||
|
||||
104
doc/source/rig-config-softrock.adoc
Normal file
104
doc/source/rig-config-softrock.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,SR1>>|<<X2,SR2>>|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
|
||||
|
||||
60
doc/source/rig-config-template.adoc
Normal file
60
doc/source/rig-config-template.adoc
Normal file
@ -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
|
||||
----------
|
||||
|
||||
104
doc/source/rig-config-tentec.adoc
Normal file
104
doc/source/rig-config-tentec.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,TenTec1>>|<<X2,TenTec2>>|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
|
||||
|
||||
102
doc/source/rig-config-yaesu.adoc
Normal file
102
doc/source/rig-config-yaesu.adoc
Normal file
@ -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
|
||||
|========
|
||||
|<<X1,FT-1000>>|<<X2,FT-2000>>|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
|
||||
|
||||
@ -1,33 +0,0 @@
|
||||
// Status=review
|
||||
.Rig Specific Configuration
|
||||
|
||||
Some rigs work with DTR, RTS, Polling, CAT, and PTT while others do
|
||||
not. The number of possible combinations is virtually endless. The
|
||||
intent of this Appendix is to provide configuration information for
|
||||
specific rig models, e.g. Icom 756 Pro-III, Kenwood TS-2000, Yaesu
|
||||
FT-1000MP, Flex-5000, etc., in order to make installation and
|
||||
configuration easier. This is a work-in-progress, and some rigs may
|
||||
never be covered.
|
||||
|
||||
The table below will link manufacturer names (Icom, Kenwood, Yaesu,
|
||||
etc.) to specific models within each brand. If a model is not
|
||||
available, please consider drafting a configuration file (a simple
|
||||
text file), using the template provided, and submit it to the
|
||||
development team for inclusion in future documentation releases.
|
||||
|
||||
:yaesu: link:yaesu.html[Yaesu]
|
||||
:rigtemplate: link:rigtemplate.html[Template]
|
||||
|
||||
NOTE: If your manufacturer is not listed, it means we do not have
|
||||
configuration files for any of the models for that particular
|
||||
manufacturer. Please consider using the Rig Template and submit to
|
||||
the development team at: {devmail}
|
||||
|
||||
.Select Manufacturer
|
||||
[align="center",valign="middle",halign="center"]
|
||||
|========
|
||||
|ADAT|AOR|Alinco|Drake|Electro Craft
|
||||
|Kenwood|Icom|SoftRock|Ten-Tec|{YAESU}
|
||||
|{rigtemplate}||||
|
||||
|========
|
||||
|
||||
@ -1,58 +0,0 @@
|
||||
// Status=review
|
||||
= Rig Template
|
||||
:Author: Greg Beam, KI7MT
|
||||
:Date: September 22, 2013, Copyleft © 2013
|
||||
:Revision: 0.1
|
||||
:icons:
|
||||
:badges:
|
||||
|
||||
- This is a simple guide / template for including configuration data to the
|
||||
WSJT-X Documentation Try to fill out as much as possible, but do not stress over
|
||||
having empty fields. OS Specific & Interface Notes are a Bonus, if you coud
|
||||
provide what you have, that would be much appreciated.
|
||||
|
||||
- Just copy and paste the following into a text file, saving it as the rig's
|
||||
model.txt, then email email it to the dev/doc team for inclusion.
|
||||
|
||||
- Alternatively, join the team and submit the update directly.
|
||||
|
||||
.Copy & Paste the following:
|
||||
----------
|
||||
== Manufacture:
|
||||
== Model:
|
||||
- MyCall:
|
||||
- MyGrid:
|
||||
- PTT Method:
|
||||
- Pskreporter:
|
||||
- CW Id After 73:
|
||||
- CW Interval:
|
||||
- CAT NOTES:
|
||||
** Note-1/2/3
|
||||
- DTR:
|
||||
- RTS:
|
||||
- CAT Port Settings:
|
||||
- Split:
|
||||
- CAT Port:
|
||||
- Polling:
|
||||
- Audio-In:
|
||||
- Audio-In Mono:
|
||||
- Audio-Out:
|
||||
- Audio-Out:
|
||||
|
||||
=== OS Specific Notes
|
||||
.Notes Relating To Operating Systems
|
||||
- Windows:
|
||||
- Linux:
|
||||
- Mac OSx:
|
||||
|
||||
=== Interface Notes
|
||||
.Notes Relating To Rig-To-Computer Interfaces
|
||||
- Navigator
|
||||
- SignaLink
|
||||
- ShackLan
|
||||
- Kam
|
||||
- DX-Doubler
|
||||
- Array Solutions (6-Pack)
|
||||
- Home-Brew
|
||||
----------
|
||||
|
||||
@ -37,11 +37,11 @@
|
||||
// be section 1.1.1. This method is used throughout the document.
|
||||
[[X1]]
|
||||
== Introduction
|
||||
include::introduction.txt[]
|
||||
include::introduction.adoc[]
|
||||
|
||||
[[X2]]
|
||||
== System Requirements
|
||||
include::system-requirments.txt[]
|
||||
include::system-requirments.adoc[]
|
||||
|
||||
[[X3]]
|
||||
== Installation
|
||||
@ -51,16 +51,16 @@ include::system-requirments.txt[]
|
||||
link(s) for your operating system.
|
||||
|
||||
=== Windows
|
||||
include::install-windows.txt[]
|
||||
include::install-windows.adoc[]
|
||||
|
||||
[[X31]]
|
||||
=== Linux
|
||||
include::install-ubuntu.txt[]
|
||||
include::install-ubuntu.adoc[]
|
||||
|
||||
// The Mac Section need to be written. The file is a placeholder only.
|
||||
[[X32]]
|
||||
=== OS X
|
||||
include::install-mac.txt[]
|
||||
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.
|
||||
@ -69,104 +69,104 @@ include::install-mac.txt[]
|
||||
// Rreviewd.
|
||||
[[X33]]
|
||||
=== Source Code
|
||||
include::install-from-source.txt[]
|
||||
include::install-from-source.adoc[]
|
||||
|
||||
[[X4]]
|
||||
== Setup and Configuration
|
||||
|
||||
[[X41]]
|
||||
=== Station Tab
|
||||
include::configuration-station.txt[]
|
||||
include::configuration-station.adoc[]
|
||||
|
||||
[[X42]]
|
||||
=== Tx Macros Tab
|
||||
include::configuration-txmacros.txt[]
|
||||
include::configuration-txmacros.adoc[]
|
||||
|
||||
[[X43]]
|
||||
=== Band Settings Tab
|
||||
include::configuration-band-settings.txt[]
|
||||
include::configuration-band-settings.adoc[]
|
||||
|
||||
[[X44]]
|
||||
=== Main Window
|
||||
include::configuration-main-window.txt[]
|
||||
include::configuration-main-window.adoc[]
|
||||
|
||||
[[X45]]
|
||||
=== Font Sizes
|
||||
include::font-sizes.txt[]
|
||||
include::font-sizes.adoc[]
|
||||
|
||||
[[X5]]
|
||||
== Basic Operating Tutorial
|
||||
[[X51]]
|
||||
=== Main Window Settings
|
||||
include::tutorial-main-window.txt[]
|
||||
include::tutorial-main-window.adoc[]
|
||||
|
||||
[[X52]]
|
||||
=== Wide Graph Settings
|
||||
include::tutorial-wide-graph-settings.txt[]
|
||||
include::tutorial-wide-graph-settings.adoc[]
|
||||
|
||||
[[X53]]
|
||||
=== Sample File 1
|
||||
include::tutorial-example1.txt[]
|
||||
include::tutorial-example1.adoc[]
|
||||
|
||||
[[X54]]
|
||||
=== Sample File 2
|
||||
include::tutorial-example2.txt[]
|
||||
include::tutorial-example2.adoc[]
|
||||
|
||||
[[X55]]
|
||||
=== Transceiver Setup
|
||||
include::transceiver-setup.txt[]
|
||||
include::transceiver-setup.adoc[]
|
||||
|
||||
[[X6]]
|
||||
== Making QSOs
|
||||
include::make-qso.txt[]
|
||||
include::make-qso.adoc[]
|
||||
|
||||
[[X7]]
|
||||
== Controls & Functions
|
||||
include::controls-functions.txt[]
|
||||
include::controls-functions.adoc[]
|
||||
|
||||
[[X71]]
|
||||
=== Wide Graph Controls
|
||||
include::controls-functions-wide-graph.txt[]
|
||||
include::controls-functions-wide-graph.adoc[]
|
||||
|
||||
[[X72]]
|
||||
=== Main Window
|
||||
include::controls-functions-main-window.txt[]
|
||||
include::controls-functions-main-window.adoc[]
|
||||
|
||||
[[X73]]
|
||||
=== Misc Controls Left
|
||||
include::controls-functions-left.txt[]
|
||||
include::controls-functions-left.adoc[]
|
||||
|
||||
[[X74]]
|
||||
=== Misc Controls Center
|
||||
include::controls-functions-center.txt[]
|
||||
include::controls-functions-center.adoc[]
|
||||
|
||||
[[X75]]
|
||||
=== Tx Messages
|
||||
include::controls-functions-messages.txt[]
|
||||
include::controls-functions-messages.adoc[]
|
||||
|
||||
[[X76]]
|
||||
=== Status Bar
|
||||
include::controls-functions-status-bar.txt[]
|
||||
include::controls-functions-status-bar.adoc[]
|
||||
|
||||
[[X77]]
|
||||
=== Menus
|
||||
include::controls-functions-menus.txt[]
|
||||
include::controls-functions-menus.adoc[]
|
||||
|
||||
[[X78]]
|
||||
=== Keyboard Shortcuts
|
||||
include::controls-functions-kb-shortcuts.txt[]
|
||||
include::controls-functions-kb-shortcuts.adoc[]
|
||||
|
||||
[[X79]]
|
||||
=== Mouse Commands
|
||||
include::controls-functions-special-mouse-cmds.txt[]
|
||||
include::controls-functions-special-mouse-cmds.adoc[]
|
||||
|
||||
[[X8]]
|
||||
== JT65 & JT9 Differences
|
||||
include::jt65-jt9-differences.txt[]
|
||||
include::jt65-jt9-differences.adoc[]
|
||||
|
||||
[[X9]]
|
||||
== The JT9 Protocol
|
||||
include::jt9-protocol.txt[]
|
||||
include::jt9-protocol.adoc[]
|
||||
|
||||
[[XA10]]
|
||||
== Appendix A
|
||||
@ -174,17 +174,19 @@ include::jt9-protocol.txt[]
|
||||
// Note to Dev-Team, this list of files needs to be updated.
|
||||
[[XA11]]
|
||||
=== Installed Files
|
||||
include::installed-files.txt[]
|
||||
include::installed-files.adoc[]
|
||||
|
||||
[[XA12]]
|
||||
=== Runtime Files
|
||||
include::runtime-files.txt[]
|
||||
include::runtime-files.adoc[]
|
||||
|
||||
[[XB10]]
|
||||
== Appendix B
|
||||
include::rig-configuration.txt[]
|
||||
[[XB11]]
|
||||
=== Rig Configuration
|
||||
include::rig-config-main.adoc[]
|
||||
|
||||
[[XACK10]]
|
||||
== Acknowledgments
|
||||
include::acknowledgements.txt[]
|
||||
include::acknowledgements.adoc[]
|
||||
|
||||
@ -1,99 +0,0 @@
|
||||
// Status=review
|
||||
// This is a comment line, anything with // is ignored at process time.
|
||||
= Yaesu Configuration Guide
|
||||
:Author: Greg Beam, KI7MT
|
||||
:Date: September 22, 2013, Copyleft © 2013
|
||||
:Revision: 0.1
|
||||
:icons:
|
||||
:badges:
|
||||
|
||||
.Available Configurations
|
||||
[align="center",valign="middle",halign="center"]
|
||||
|
||||
// 5 Models per line please
|
||||
|========
|
||||
|<<X1,FT-1000>>|<<X2,FT-2000>>|FT-5000|FT-9000
|
||||
|========
|
||||
|
||||
[[X1]]
|
||||
== FT-1000
|
||||
.Configuration Covers FT-1000, FT-1000MP, FT-1000D
|
||||
- MyCall: <Enter Your Call-Sign>
|
||||
- MyGrid: <Enter Grid Locator>
|
||||
- PTT Method: ( CAT, DTR, RTS, VOX )
|
||||
- Pskreporter (optional): Check to Enable, default is off
|
||||
- CW Id After 73 (optional): Check to Enable, Default is off
|
||||
- CW Interval: Set if ID after 73 is evanbled
|
||||
- CAT NOTES (recommended method):
|
||||
** Note-1/2/3
|
||||
- DTR: Unchecked
|
||||
- RTS: Unchecked
|
||||
- CAT Port Settings: 4800, 8, none, 2
|
||||
- Split: Unchecked
|
||||
- CAT Port: Select which port CAT is located on
|
||||
- Polling: 3
|
||||
- Audio-In: Select Desirted Input Device
|
||||
- Audio-In Mono: Mono, Left, Right
|
||||
- Audio-Out: Select Output Device
|
||||
- Audio-Out: Select Output Device
|
||||
|
||||
=== OS Specific Notes
|
||||
.Notes Relating To Operating Systems
|
||||
- Windows: XP, Vista, 7,9, etc.
|
||||
- Linux / *Nix: Slackaware, Fedora, FreeBSD, Ubuntu/Debian, etc
|
||||
- Mac OSx:
|
||||
|
||||
=== Interface Notes
|
||||
.Notes Relating To Rig-To-Computer Interfaces
|
||||
- Navigator
|
||||
- SignaLink
|
||||
- ShackLan
|
||||
- Kam
|
||||
- DX-Doubler
|
||||
- Array Solutions (6-Pack)
|
||||
- Home-Brew
|
||||
|
||||
[[X2]]
|
||||
== FT-2000
|
||||
.Configuration Covers FT-2000, FT-2000D
|
||||
- MyCall: <Enter Your Call-Sign>
|
||||
- MyGrid: <Enter Grid Locator>
|
||||
- PTT Method: ( CAT, DTR, RTS, VOX )
|
||||
- Pskreporter (optional): Check to Enable, default is off
|
||||
- CW Id After 73 (optional): Check to Enable, Default is off
|
||||
- CW Interval: Set if ID after 73 is evanbled
|
||||
- CAT NOTES (recommended method):
|
||||
** Note-1/2/3
|
||||
- DTR: Unchecked
|
||||
- RTS: Unchecked
|
||||
- CAT Port Settings: 4800, 8, none, 2
|
||||
- Split: Unchecked
|
||||
- CAT Port: Select which port CAT is located on
|
||||
- Polling: 3
|
||||
- Audio-In: Select Desirted Input Device
|
||||
- Audio-In Mono: Mono, Left, Right
|
||||
- Audio-Out: Select Output Device
|
||||
- Audio-Out: Select Output Device
|
||||
|
||||
=== OS Specific Notes
|
||||
.Notes Relating To Operating Systems
|
||||
- Windows: XP, Vista, 7,9, etc.
|
||||
- Linux / *Nix: Slackaware, Fedora, FreeBSD, Ubuntu, Debian, etc
|
||||
- Mac OSx:
|
||||
|
||||
=== Interface Notes
|
||||
.Notes Relating To Rig-To-Computer Interfaces
|
||||
- Navigator
|
||||
- SignaLink
|
||||
- ShackLan
|
||||
- Kam
|
||||
- DX-Doubler
|
||||
- Array Solutions (6-Pack)
|
||||
- Home-Brew
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user