GNU Typist @VERSION Installation instructions This program is designed for UNIXes and Microsoft Windows, but it can be compiled in various environments provided that there is a standard compiler and required libraries. Compilation under Unix ---------------------- In order to compile this program, you must have: - A reasonably standard C compiler (and standard C library with corresponding header files of course). - The 'ncursesw' library (with wide-character support) with corresponding header files installed in convenient places. The instructions are general for most Unix software in source form: * Uncompress the sources distribution: $ tar jxvf gtypist-@VERSION.tar.bz2 or $ tar zxvf gtypist-@VERSION.tar.gz * Change to the sources directory: $ cd gtypist-@VERSION * Configure the package: $ ./configure This default configuration will probably be just fine. However, you may add some configuration options to the end of that line. Run configure with `--help' to get full list of them, like this: $ ./configure --help By default the program executable will be installed in /usr/local/bin and the lessons and internationalization support files in /usr/local/share/gtypist (you can change this with the `--prefix' option). By default Native Language Support will be installed (but you can disable this with the `--disable-nls' option). * Build the package: $ make * Get required permissions and install the package: $ sudo make install The sudo program will ask you for the root password to install gtypist system-wide. If you do not have the root password, you will not be able to install it system-wide. Instead, you should run configure with something like '--prefix=~/opt' to install it in your home directory. * To test your installation type $ gtypist If you already had a version of gtypist installed on the system before you installed this one,you may need to explicitly state which one you want to run. So you may need to type: $ /usr/local/bin/gtypist Compilation under Windows NT/2000/XP ------------------------------------ First, please check to see if there is a Windows build of this version before going through the trouble of compiling it yourself! http://ftp.gnu.org/gnu/gtypist/w32_binaries/ If you're still here, then... You must have: - MinGW compiler package, available at http://sourceforge.net/projects/mingw/files/ It is advised that you download the "Automated MinGW Installer" package (ming-get-inst) if you are not familiar with MinGW. When installing, make sure you turn on the options to install "MSYS Basic System" and "MinGW Developer Toolkit". If you don't use the atomated installer, note that you will also need mingw32-make or MSYS. More information about MinGW can be found at http://www.mingw.org/ - A recent version of PDCurses, available at http://pdcurses.sourceforge.net/ The current official binaries of gtypist are compiled using PDCurses 3.4. We build a static version of the library with Unicode and forced UTF-8 support. Although building PDCurses is outside the scope of this document, here is a quick run-through of what to do... - copy the PDCurses-3.4.tar.gz file to C:\dev - open a MinGW shell, co to C:\dev and unpack PDCurses $ cd /c/dev $ tar -xvf PDCurses-3.4.tar.gz - cd to the win32 directory $ cd PDCurses-3.4/win32 - there's a README in there if you need help - build PDCurses $ make -f mingwin32.mak WIDE=Y UTF8=Y - rename the resulting pdcurses.a to libpdcurses.a $ mv pdcurses.a libpdcurses.a To build GNU Typist: * Open a MinGW Shell (not a Windows command prompt), create a working doirectory and change to it. $ mkdir /c/dev $ cd /c/dev * In a file explorer window, copy gtypist-@VERSION.tar.xz to C:\dev * Uncompress gtypist-@VERSION.tar.xz $ tar -xvf gtypist-@VERSION.tar.xz * Change to the gtypist directory and configure the build by running configure-w32 $ cd gtypist-@VERSION $ configure-w32 * If you are using PDCurses 3.4 and you unpacked it and built it in the C:\dev\PDCurses-3.4 directory (as suggested in the instructions above), you will not need to change the Makefile created by the previous step. You can skip to the next step. Otherwise, open the Makefile and specify the path to your PDCurses directory as directed by the comments. $ notepad Makefile * Compile gtypist using make $ make * To install it, you should create a directory (in this example we use C:\GTypist) and copy into it the lessons, documentation, UI translations and the program itsself (gtypist.exe). $ mkdir /c/gtypist $ cp gtypist.exe /c/gtypist $ mkdir /c/gtypist/{doc,lessons} $ cp lessons/*.typ /c/gtypist/lessons $ cp doc/*.html /c/gtypist/doc $ cp -r locale /c/gtypist * To use GNU Typist, go to the directory where you installed it and run gtypist.exe. You can do this in a file explorer, or from the MinGW shell, like this $ cd /c/gtypist $ gtypist Problems and their solution --------------------------- Configuration with Native Language Support under Unix: * If you configured first without NLS and now you want NLS, go to directory intl remove libintl.h and configure again. * If your Unix doesn't have Native Language Support, the sources of gtypist come with a limited version, to use it configure with: ./configure --with-included-gettext And before running gtypist set the environment variable LC_ALL/LANG to your language and country codes (LL_CC, as described in the manual, node "Environment Variables"). See the manual for the list of supported languages. Using this option it was possible to compile and run gtypist under AIX. Dvorak Keyboard under GNU/Linux (Ben Armstrong ): * To get Dvorak keymaps, run the 'loadkeys' command on the appropriate keymap file. For example if your keymaps are at /usr/share/keymaps > loadkeys /usr/share/keymaps/i386/dvorak/dvorak.kmap.gz * To switch to your default keyboard mappings, run loadkeys on the default keymap file: $ loadkeys /etc/console-tools/default.map.gz * If you are in X, please visit the Dvorak home page at http://www.mwbrooks.com/dvorak/ for more information. Keyboard under Windows: * You could experience some problems with the keyboard under DOS/Windows. The [Return] key should now work, but the function keys (F1, F2... F12) may not. However, this should not affect usage for most users.