1 GNU Typist @VERSION Installation instructions 2 3This program is designed for UNIXes and Microsoft Windows, but it can 4be compiled in various environments provided that there is a standard 5compiler and required libraries. 6 7Compilation under Unix 8---------------------- 9 10In order to compile this program, you must have: 11 12 - A reasonably standard C compiler (and standard C library with 13 corresponding header files of course). 14 15 - The 'ncursesw' library (with wide-character support) with 16 corresponding header files installed in convenient places. 17 18The instructions are general for most Unix software in source form: 19 20 * Uncompress the sources distribution: 21 22 $ tar jxvf gtypist-@VERSION.tar.bz2 23 or 24 $ tar zxvf gtypist-@VERSION.tar.gz 25 26 * Change to the sources directory: 27 28 $ cd gtypist-@VERSION 29 30 * Configure the package: 31 32 $ ./configure 33 34 This default configuration will probably be just fine. However, you 35 may add some configuration options to the end of that line. Run 36 configure with `--help' to get full list of them, like this: 37 38 $ ./configure --help 39 40 By default the program executable will be installed in 41 /usr/local/bin and the lessons and internationalization support 42 files in /usr/local/share/gtypist (you can change this with the 43 `--prefix' option). By default Native Language Support will be 44 installed (but you can disable this with the `--disable-nls' 45 option). 46 47 * Build the package: 48 49 $ make 50 51 * Get required permissions and install the package: 52 53 $ sudo make install 54 55 The sudo program will ask you for the root password to install 56 gtypist system-wide. If you do not have the root password, you will 57 not be able to install it system-wide. Instead, you should run 58 configure with something like '--prefix=~/opt' to install it in your 59 home directory. 60 61 * To test your installation type 62 63 $ gtypist 64 65 If you already had a version of gtypist installed on the system 66 before you installed this one,you may need to explicitly state which 67 one you want to run. So you may need to type: 68 69 $ /usr/local/bin/gtypist 70 71 72Compilation under Windows NT/2000/XP 73------------------------------------ 74 75First, please check to see if there is a Windows build of this version before 76going through the trouble of compiling it yourself! 77 78 http://ftp.gnu.org/gnu/gtypist/w32_binaries/ 79 80If you're still here, then... 81 82You must have: 83 84 - MinGW compiler package, available at 85 86 http://sourceforge.net/projects/mingw/files/ 87 88 It is advised that you download the "Automated MinGW Installer" 89 package (ming-get-inst) if you are not familiar with MinGW. When 90 installing, make sure you turn on the options to install "MSYS 91 Basic System" and "MinGW Developer Toolkit". 92 93 If you don't use the atomated installer, note that you will also 94 need mingw32-make or MSYS. 95 96 More information about MinGW can be found at 97 98 http://www.mingw.org/ 99 100 - A recent version of PDCurses, available at 101 102 http://pdcurses.sourceforge.net/ 103 104 The current official binaries of gtypist are compiled using 105 PDCurses 3.4. We build a static version of the library with 106 Unicode and forced UTF-8 support. Although building PDCurses is 107 outside the scope of this document, here is a quick run-through of 108 what to do... 109 110 - copy the PDCurses-3.4.tar.gz file to C:\dev 111 - open a MinGW shell, co to C:\dev and unpack PDCurses 112 $ cd /c/dev 113 $ tar -xvf PDCurses-3.4.tar.gz 114 - cd to the win32 directory 115 $ cd PDCurses-3.4/win32 116 - there's a README in there if you need help 117 - build PDCurses 118 $ make -f mingwin32.mak WIDE=Y UTF8=Y 119 - rename the resulting pdcurses.a to libpdcurses.a 120 $ mv pdcurses.a libpdcurses.a 121 122To build GNU Typist: 123 124 * Open a MinGW Shell (not a Windows command prompt), create a working 125 doirectory and change to it. 126 127 $ mkdir /c/dev 128 $ cd /c/dev 129 130 * In a file explorer window, copy gtypist-@VERSION.tar.xz to C:\dev 131 132 * Uncompress gtypist-@VERSION.tar.xz 133 134 $ tar -xvf gtypist-@VERSION.tar.xz 135 136 * Change to the gtypist directory and configure the build by running 137 configure-w32 138 139 $ cd gtypist-@VERSION 140 $ configure-w32 141 142 * If you are using PDCurses 3.4 and you unpacked it and built it in 143 the C:\dev\PDCurses-3.4 directory (as suggested in the instructions 144 above), you will not need to change the Makefile created by the 145 previous step. You can skip to the next step. 146 147 Otherwise, open the Makefile and specify the path to your PDCurses 148 directory as directed by the comments. 149 150 $ notepad Makefile 151 152 * Compile gtypist using make 153 154 $ make 155 156 * To install it, you should create a directory (in this example we 157 use C:\GTypist) and copy into it the lessons, documentation, UI 158 translations and the program itsself (gtypist.exe). 159 160 $ mkdir /c/gtypist 161 $ cp gtypist.exe /c/gtypist 162 $ mkdir /c/gtypist/{doc,lessons} 163 $ cp lessons/*.typ /c/gtypist/lessons 164 $ cp doc/*.html /c/gtypist/doc 165 $ cp -r locale /c/gtypist 166 167 * To use GNU Typist, go to the directory where you installed it and 168 run gtypist.exe. You can do this in a file explorer, or from the 169 MinGW shell, like this 170 171 $ cd /c/gtypist 172 $ gtypist 173 174 175Problems and their solution 176--------------------------- 177 178Configuration with Native Language Support under Unix: 179 180 * If you configured first without NLS and now you want NLS, go 181 to directory intl remove libintl.h and configure again. 182 183 * If your Unix doesn't have Native Language Support, the sources of 184 gtypist come with a limited version, to use it configure with: 185 186 ./configure --with-included-gettext 187 188 And before running gtypist set the environment variable LC_ALL/LANG 189 to your language and country codes (LL_CC, as described in the 190 manual, node "Environment Variables"). See the manual for the list 191 of supported languages. Using this option it was possible to 192 compile and run gtypist under AIX. 193 194Dvorak Keyboard under GNU/Linux (Ben Armstrong 195<synrg@sanctuary.nslug.ns.ca>): 196 197 * To get Dvorak keymaps, run the 'loadkeys' command on the 198 appropriate keymap file. For example if your keymaps are at 199 /usr/share/keymaps 200 201 > loadkeys /usr/share/keymaps/i386/dvorak/dvorak.kmap.gz 202 203 * To switch to your default keyboard mappings, run loadkeys on the 204 default keymap file: 205 206 $ loadkeys /etc/console-tools/default.map.gz 207 208 * If you are in X, please visit the Dvorak home page at 209 http://www.mwbrooks.com/dvorak/ for more information. 210 211Keyboard under Windows: 212 213 * You could experience some problems with the keyboard under 214 DOS/Windows. The [Return] key should now work, but the function 215 keys (F1, F2... F12) may not. However, this should not affect 216 usage for most users. 217