// Status=DRAFT // this is intentionally left as a single file v.s. multiple sections to allow // users to browse the Page Source = AsciiDoc Quick Reference :Author: WSJT-X Documetation Team :Date: January 22, 2014, (C) copyright, CC-BY-SA 3.0 Unported :Revision: 0.0.1 :badges: :icons: :numbered: // WEB links - List is getting pretty long, time to use include::file-name ?? :asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ] :asciidoc_cheatsheet: http://powerman.name/doc/asciidoc[ AsciiDoc Cheatsheet ] :asciidoc_questions: http://www.methods.co.nz/asciidoc/faq.html[ AsciiDoc FAQ ] :debian: http://www.debian.org/[ Debian ] :cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ] :devsvn: http://developer.berlios.de/projects/wsjt/[ Devel-SVN ] :devsvn: http://developer.berlios.de/projects/wsjt/[wsjt-svn] :download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ] :dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ] :homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ] :hrd: http://www.hrdsoftwarellc.com/[ Ham Radio Deluxe ] :jtalert: http://ham-apps.com[JT-ALERT-X] :jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX] :launchpadurl: https://launchpad.net/~jnogatch/+archive/wsjtx[ WSJT-X Linux Packages ] :ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] :pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] :osx_instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here] :wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ] // DOWNLOAD links :cty_dat: http://www.country-files.com/cty/[here]. :cygwin: http://cygwin.com/install.html[here] :kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd] :osx_108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ] :osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[ OS X 10.9 ] // MAIL-TO links :alex_efros: mailto:powerman@powerman.name[ Alex Efros ] :devmail: mailto:wsjt-devel@lists.berlios.de[ wsjt-devel ] :stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ] [[X1]] == Introduction The purpose of this guide is to provide a quick reference to commonly used items while working with the _WSJT-X Documentation_ project. === AsciiDoc Examples * {asciidoc_help} by {stuart_rackman} * {asciidoc_questions} by {stuart_rackman} * {asciidoc_cheatsheet} by {alex_efros} [[X2]] == AsciiDoc installation For most packages, the normal method of installation is through their respective package manager. There are several reasons why we do not want this for the _WSJT-X User Guide_: * Most package applications are installed system-wide, which means standard privileged (non Root / RootSudo) users update their binaries. * Often times, distro packages are (1) or more revisions behind. * Updating to the latest stable _AsciiDoc_ version, using Mercurial, is a simple one line command. * Using $HOME makes working on the _WSJT-X User Guide_ portable, such as, installing to a USB Key allows testing of your work on virtually any system which has _Python_ {amp}{amp} _Bash Enviroment_ installed. [[X21]] === Windows .WinXP thru Win8 The preferred method of installing _AsciiDoc_ on Windows is through _Cygwin_. TIP: You can install _Cygwin_ anywhere you like, hard drive, internal, external or to a USB Key. ==== Download the _Cygwin_ Installer * For a 32-bit system, download http://cygwin.com/setup-x86.exe[Setup-x86.exe] * For a 64-bit system, download http://cygwin.com/setup-x86_64.exe[Setup-x86-64.exe] * For additional information, see http://cygwin.com/install.html[Cygwin.com] * Saving the installer to desktop makes updating quick {amp} easy ==== Running the installer * Double click the _Cygwin Installer_ * Select Install from Internet * Root Directory: C:\cygwin * Select for All Users * Package Download Directory: C:\cygdownloads * Select Direct Connection * I use ftp://mirrors.kernel.org ==== Cygwin package selection At the top left corner of the install GUI, you will find a search box. Enter the package name, then select it from the areas indicated below. Only the primary packages are needed, [red]#not# additional modules. * Use *Search Box*: ** *python* => Interpreters => Python language interpreter ** *mercurical* => Devel => Python based DVCS ** *subversion* => Devel => A version control system ** *source-highlight* => Text => Syntax highlighting utilities ** *openssh* => Net => The OpenSSH server and client programs ** *nano* => Editors => Enhanced clone of Pico editor ** *ncurses* => Utils => Utilities for terminal handling * Then, next to start installation * At create icons and short-cuts, I select desktop only ==== Verify package installation When _Cygwin_ finishes the installation, you will have a very capable base system to work with. From this point onward, all actions are performed in the _Cygwin Terminal_. To launch a terminal session, simply double click the desktop icon as you would any other Windows application. ==== Package Verification [source,bash] ----- # one line per action python -V hg --version |head -n1 svn --version |head -n1 source-highlight --version |head -n1 # Your versions may vary slightly Python 2.7.6 svn, version 1.7.14 Mercurial Distributed SCM (version 2.8.2) GNU Source-highlight 3.1.6 ----- CAUTION: If any package check returns with an error, resolve before continuing !! ==== Configure _Bash Environment_ [source,bash] ----- # Edit ./.bash_profile, uncomment if statement: nano ./.bash_profile # Find and Change too: (remove # sign for all 3 lines) if [ -d "$HOME/bin" ] ; then PATH="$HOME/bin:$PATH" fi # Ctrl+X to exit, Y to confirm, then Enter to save # Create directories, source .bash_profile, check $PATH: mkdir -p $HOME/bin $HOME/Projects/documentation/wsjtx source ./.bash_profile echo $PATH # You should see /home/$USER/bin at the beginning of the string. ----- ==== Download and Configure _AsciiDoc_ [source,bash] ----- # one action per line cd ~/bin # get latest AsciiDoc build hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9 # pull updates and upgrade packages cd asciidoc-8.6.9 && hg pull && hg update && hg upgrade && cd .. # link binaries to $HOME/bin ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc # check AsciiDoc runs properly asciidoc --version # Should return: asciidoc 8.6.9 ----- ==== Test build _WSJT-X User Guide_ [source,bash] ----- cd ~/Projects/documentation/wsjtx # then; cd ~/Projects/documentation/wsjtx && ./build-doc.sh toc2 ----- ==== Open _WSJT-X User Guide_ in a browser [source,bash] ----- # for chromium cygstart chrope wsjtx-main-toc2.html # for FireFox cygstart firefox wsjtx-main-toc2.html ----- [[X22]] === Linux .Debian, Ubuntu, Mint {amp} Relatives There are many relatives of Debian {amp} Ubuntu, and most shells are _Bash_. For all but the package-manager commands, you should be able to _Copy {amp} Paste_ directly into the terminal. It is a good idea to always start from a fresh repository list, and to have the install up to date before adding new packages. ==== Install Dependencies [source,bash] ----- # For Debian and relatives, update && Upgrade first sudo apt-get update && sudo apt-get upgrade # Install Dependencies sudo apt-get install mercurial source-highlight subversion # Verify the packages installed properly python -V hg --version |head -n1 svn --version |head -n1 source-highlight --version |head -n1 # Your versions may vary slightly Python 2.7.6 svn, version 1.7.14 Mercurial Distributed SCM (version 2.8.2) GNU Source-highlight 3.1.6 ----- CAUTION: If any package check returns with an error, resolve before continuing !! ==== Check for Previous AsciiDoc Installation [source,bash] ----- # check if AsciiDoc is already installed: asciidoc --version # If Bash returns any version, remove it: sudo apt-get purge asciidoc ----- ==== Add Directories and source profile [source,bash] ----- mkdir -p $HOME/bin $HOME/Projects/documentation/wsjtx source ~/.bashrc && source ~/.profile echo $PATH # should return something like: /home/$USER/bin:/usr/local/sbin: .. .. .. ----- TIP: You may have to log out and back in for the addition to take place. If need be, add the following to your shell profile, then source or log out / back in: ==== Add conditional to ~/.bashrc [source,bash] ----- if [ -d "$HOME/bin" ] then PATH="$HOME/bin:$PATH" fi ----- ==== Download and Configure _AsciiDoc_ [source,bash] ----- # one action per line cd ~/bin # get latest AsciiDoc build hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9 # pull updates and upgrade packages cd asciidoc-8.6.9 && hg pull && hg update && hg upgrade && cd .. # link binaries to $HOME/bin ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc # check AsciiDoc runs properly asciidoc --version # Should return: asciidoc 8.6.9 ----- ==== Test build _WSJT-X User Guide_ [source,bash] ----- cd ~/Projects/documentation/wsjtx # then; cd ~/Projects/documentation/wsjtx && ./build-doc.sh toc2 ----- ==== Open _WSJT-X User Guide_ in a browser [source,bash] ----- # for chromium chromium-browser wsjtx-main-toc2.html # for FireFox firefox wsjtx-main-toc2.html ----- === OS X .10.8 {amp} 10.9 content needed == Using the Terminal .Tips {amp} Tricks to make things easier Add content === Alias - Short cuts add content === Add Some Color add content === Search Documents add content === Recursive Replace add content === Document Status add content == SVN Basics .Commonly used svn commands Add content === Devel Accounts .Developer and normal users add content === Check-In/Out .Commonly used commands add content === Using Patches .How to create and apply patches add content === Log Usage .How to get the most from svn logs add content == Appendix A: Credits .Authors, Editors, Commiters If you worked on the documentation, add yourself to the list. * Authors: , * Editors: , * Commiters: , == Appendix B: License This work is licensed under {cc_by_sa}.