win32/tcc-win32.txt

   1
   2     TinyCC
   3     ======
   4
   5     This file contains specific information for usage of TinyCC
   6     under MS-Windows.  See tcc-doc.html to have all the features.
   7
   8
   9     Installation from the binary ZIP package:
  10     -----------------------------------------
  11     Unzip the package to a directory of your choice.
  12
  13
  14     Set the system PATH:
  15     --------------------
  16     To be able to invoke the compiler from everywhere on your computer by
  17     just typing "tcc", please add the directory containing tcc.exe to your
  18     system PATH.
  19
  20
  21     Examples:
  22     ---------
  23     Open a console window (DOS box) and 'cd' to the examples directory.
  24
  25     For the 'Fibonacci' example type:
  26
  27         tcc fib.c
  28
  29     For the 'Hello Windows' GUI example type:
  30
  31         tcc hello_win.c
  32
  33     For the 'Hello DLL' example type
  34
  35         tcc -shared dll.c
  36         tiny_impdef dll.dll (optional)
  37         tcc hello_dll.c dll.def
  38
  39
  40     Using libtcc as JIT compiler in your program
  41     --------------------------------------------
  42     Check out the 'libtcc_test' example:
  43
  44     - Running it from source:
  45         tcc -I libtcc libtcc/libtcc.def -run examples/libtcc_test.c
  46
  47     - Compiling with TCC:
  48         tcc examples/libtcc_test.c -I libtcc libtcc/libtcc.def
  49
  50     - Compiling with MinGW:
  51         gcc examples/libtcc_test.c -I libtcc libtcc.dll
  52
  53     - Compiling with MSVC:
  54         lib /def:libtcc\libtcc.def /out:libtcc.lib
  55         cl /MD examples/libtcc_test.c -I libtcc libtcc.lib
  56
  57
  58     Import Definition Files:
  59     ------------------------
  60     To link with Windows system DLLs, TCC uses import definition
  61     files (.def) instead of libraries.
  62
  63     The included 'tiny_impdef' program may be used to make additional
  64     .def files for any DLL. For example:
  65
  66         tiny_impdef.exe opengl32.dll
  67
  68     Put opengl32.def into the tcc/lib directory.  Specify -lopengl32 at
  69     the TCC commandline to link a program that uses opengl32.dll.
  70
  71
  72     Header Files:
  73     -------------
  74     The system header files (except _mingw.h) are from the MinGW
  75     distribution:
  76
  77         http://www.mingw.org/
  78
  79     From the windows headers, only a minimal set is included.  If you need
  80     more,  get MinGW's "w32api" package.  Extract the files from "include"
  81     into your "tcc/include/winapi" directory.
  82
  83
  84     Resource Files:
  85     ---------------
  86     TCC can link windows resources in coff format as generated by MinGW's
  87     windres.exe.  For example:
  88
  89         windres -O coff app.rc -o appres.o
  90         tcc app.c appres.o -o app.exe
  91
  92
  93     Tiny Libmaker:
  94     --------------
  95     The included tiny_libmaker tool by Timovj Lahde can be used as
  96     'ar' replacement to make a library from several object files:
  97
  98         tiny_libmaker [rcs] library objectfiles ...
  99
 100
 101     Compilation from source:
 102     ------------------------
 103     * You can use the MinGW and MSYS tools available at
 104
 105         http://www.mingw.org
 106
 107       Untar the TCC archive and type in the MSYS shell:
 108
 109         ./configure [--prefix installpath]
 110         make
 111         make install
 112
 113     The default install location is c:\Program Files\tcc
 114
 115     * Alternatively you can compile TCC with just GCC from MinGW using
 116
 117         build-tcc.bat (from the win32 directory)
 118
 119       To install, copy the entire contents of the win32 directory to
 120       where you want.
 121
 122
 123     Limitations:
 124     ------------
 125     - On the object file level, currently TCC supports only the ELF format,
 126       not COFF as used by MinGW and MSVC.  It is not possible to exchange
 127       object files or libraries between TCC and these compilers.  However
 128       libraries for TCC from objects by TCC can be made using tiny_libmaker
 129       or MinGW's ar.
 130
 131     - No leading underscore is generated in the ELF symbols.
 132
 133     - Bounds checking (option -b) is not supported on 64-bit OS.
 134
 135
 136     Documentation and License:
 137     --------------------------
 138     TCC is distributed under the GNU Lesser General Public License. (See
 139     COPYING file or http://www.gnu.org/licenses/lgpl-2.1.html)
 140
 141     TinyCC homepage is at:
 142
 143         http://fabrice.bellard.free.fr/tcc/
 144
 145
 146     WinAPI Help and 3rd-party tools:
 147     --------------------------------
 148     The Windows API documentation (Win95) in a single .hlp file is
 149     available on the lcc-win32 site as "win32hlp.exe" or from other
 150     locations as "win32hlp_big.zip".
 151
 152     A nice RAD tool to create windows resources (dialog boxes etc.) is
 153     "ResEd", available at the RadASM website.
 154
 155
 156     --- grischka