wrc: Fix symbol was not declared and using plain integer as NULL pointer sparse warnings.
[wine] / tools / winegcc / winegcc.man.in
1 .\" -*- nroff -*-
2 .TH WINEGCC 1 "October 2005" "@PACKAGE_STRING@" "Wine Developers Manual"
3 .SH NAME
4 winegcc \- Wine C and C++ MinGW Compatible Compiler
5 .SH SYNOPSIS
6 .BR "winegcc "\fI[options]\fR " \fIinfile\fR"...
7 .SH DESCRIPTION
8 .B winegcc 
9 is a gcc wrapper which tries to provide a MinGW compatible compiler 
10 under Linux. This is most useful to Win32 developers who can simply 
11 take their MinGW code from Windows, and recompile it without 
12 modifications under Winelib on Linux. 
13 wineg++ accepts mostly the same options as winegcc.
14 .PP
15 The goal of winegcc is to be able to simply replace gcc/g++/windres
16 with winegcc/wineg++/wrc in a MinGW Makefile, and just recompile
17 the application using Winelib under Wine. While typically there are 
18 small adjustments that must be made to the application source code 
19 and/or Makefile, it is quite easy to do them in a fashion that is
20 compatible between the MinGW and Wine environments.
21 .PP
22 This manual will document only the differences from gcc; please consult
23 the gcc manual for more information on those options.
24 .PP
25 .SH OPTIONS
26 .B gcc options:
27 All gcc options are supported, and are passed along to the backend
28 compiler.
29 .IP "\fB-B\fIprefix\fR"
30 This option specifies where to find the executables, libraries,
31 include files, and data files of the compiler itself. This is a 
32 standard gcc option that has been extended to recognize a 
33 \fIprefix\fR ending with '/tools/winebuild', in which case winegcc 
34 enters a special mode for building Wine itself. Developers should 
35 avoid prefixes ending with the magic suffix, or if that is not 
36 possible, simply express it differently, such as '/tools/winebuild/',
37 to avoid the special behaviour.
38 .IP \fB-fno-short-wchar\fR
39 Override the underlying type for wchar_t to be the default for the 
40 target, instead of using short unsigned int, which is the default 
41 for Win32.
42 .IP \fB-mconsole\fR
43 This option passes '--subsystem console' to winebuild, to build
44 console applications. It is the default.
45 .IP \fB-mno-cygwin\fR
46 Use Wine's implementation of MSVCRT, instead of linking against
47 the host system's libc. This is necessary for the vast majority
48 of Win32 applications, as they typically depend on various features
49 of MSVCRT. This switch is also used by the MinGW compiler to link
50 against MSVCRT on Windows, instead of linking against Cygwin's
51 libc. Sharing the syntax with MinGW makes it very easy to write 
52 Makefiles that work under Wine, MinGW+MSYS, or MinGW+Cygwin.
53 .IP \fB-municode\fR
54 Set the default entry point of the application to be the Unicode
55 \fBwmain()\fR instead of the standard \fBmain()\fR.
56 .IP \fB-mwindows\fR
57 This option adds -lgdi32, -lcomdlg32, and -lshell32 to the list of
58 default libraries, and passes '--subsystem windows' to winebuild
59 to build graphical applications.
60 .IP \fB-nodefaultlibs\fR
61 Do not use the standard system libraries when linking. These
62 include at a minimum -lkernel32, -luser32, -ladvapi32, and 
63 any default libraries used by the backend compiler. The -mwindows
64 option augments the list of default libraries as described above.
65 .IP \fB-nostartfiles\fR
66 Do not add the winecrt0 library when linking.
67 .IP \fB-Wb,option\fR
68 Pass option as an option to winebuild.  If option contains 
69 commas, it is split into multiple options at the commas.
70 .SH DEFINES
71 winegcc defines __WINE__, for code that needs to know when it is
72 being compiled under Wine. It also defines WIN32, _WIN32, __WIN32, 
73 __WIN32__, __WINNT, and __WINNT__ for compatibility with MinGW.
74 .SH BUGS
75 The dllimport/dllexport attributes are not supported at the moment,
76 due to lack of support for these features in the ELF version of gcc.
77 .PP
78 Static linking is not currently supported against Wine's DLL. As a
79 result, the -static, --static, and -Wl,-static options will generate
80 an error.
81 .SH AUTHORS
82 .B winegcc
83 was written by Dimitrie O. Paun.
84 .SH "SEE ALSO"
85 .BR gcc(1),
86 .BR winebuild(1),
87 .BR wrc(1),
88 .BR wine(1),
89 .BR "Winelib User Guide",
90 .BR "Wine Developers Guide".