Commit e9911b09 authored by Frédéric Delanoy's avatar Frédéric Delanoy Committed by Alexandre Julliard

winemaker: Make manpage conform to common manpages conventions.

parent 8b2ad6ad
...@@ -42,7 +42,7 @@ winemaker \- generate a build infrastructure for compiling Windows programs on U ...@@ -42,7 +42,7 @@ winemaker \- generate a build infrastructure for compiling Windows programs on U
is a perl script designed to help you bootstrap the is a perl script designed to help you bootstrap the
process of converting your Windows sources to Winelib programs. process of converting your Windows sources to Winelib programs.
.PP .PP
In order to do this winemaker can perform the following operations: In order to do this \fBwinemaker\fR can perform the following operations:
.PP .PP
- rename your source files and directories to lowercase in the event they - rename your source files and directories to lowercase in the event they
got all uppercased during the transfer. got all uppercased during the transfer.
...@@ -52,23 +52,23 @@ got all uppercased during the transfer. ...@@ -52,23 +52,23 @@ got all uppercased during the transfer.
- scan the include statements and resource file references to replace the - scan the include statements and resource file references to replace the
backslashes with forward slashes. backslashes with forward slashes.
.PP .PP
- during the above step winemaker will also perform a case insensitive search - during the above step \fBwinemaker\fR will also perform a case insensitive search
of the referenced file in the include path and rewrite the include statement of the referenced file in the include path and rewrite the include statement
with the right case if necessary. with the right case if necessary.
.PP .PP
- winemaker will also check other more exotic issues like '#pragma pack' - \fBwinemaker\fR will also check other more exotic issues like \fI#pragma pack\fR
usage, use of "afxres.h" in non MFC projects, and more. Whenever it usage, use of \fIafxres.h\fR in non MFC projects, and more. Whenever it
encounters something out of the ordinary, winemaker will warn you about it. encounters something out of the ordinary, it will warn you about it.
.PP .PP
- winemaker can also scan a complete directory tree at once, guess what are - \fBwinemaker\fR can also scan a complete directory tree at once, guess what are
the executables and libraries you are trying to build, match them with the executables and libraries you are trying to build, match them with
source files, and generate the corresponding Makefile. source files, and generate the corresponding \fIMakefile\fR.
.PP .PP
- finally winemaker will generate a global Makefile for normal use. - finally \fBwinemaker\fR will generate a global \fIMakefile\fR for normal use.
.PP .PP
- winemaker knows about MFC-based project and will generate customized files. - \fBwinemaker\fR knows about MFC-based project and will generate customized files.
.PP .PP
- winemaker can read existing project files. It supports dsp, dsw, vcproj and sln files. - \fBwinemaker\fR can read existing project files. It supports dsp, dsw, vcproj and sln files.
.PP .PP
.SH OPTIONS .SH OPTIONS
.TP .TP
...@@ -130,7 +130,7 @@ Specify that targets are not MFC-based. This option disables use of MFC librarie ...@@ -130,7 +130,7 @@ Specify that targets are not MFC-based. This option disables use of MFC librarie
even if \fBwinemaker\fR encounters files \fIstdafx.cpp\fR or \fIstdafx.h\fR that would cause it even if \fBwinemaker\fR encounters files \fIstdafx.cpp\fR or \fIstdafx.h\fR that would cause it
to enable MFC automatically if neither \fB--nomfc\fR nor \fB--mfc\fR was specified. to enable MFC automatically if neither \fB--nomfc\fR nor \fB--mfc\fR was specified.
.TP .TP
.BI -D macro "\fR[=\fIdefn\fR]" .BI -D macro "\fR[\fB=\fIdefn\fR]"
Add the specified macro definition to the global list of macro definitions. Add the specified macro definition to the global list of macro definitions.
.TP .TP
.BI -I dir .BI -I dir
...@@ -178,16 +178,16 @@ Without that option the default architecture is used. ...@@ -178,16 +178,16 @@ Without that option the default architecture is used.
.SH EXAMPLES .SH EXAMPLES
.PP .PP
Here is a typical winemaker use: Here is a typical \fBwinemaker\fR use:
.PP .PP
$ winemaker --lower-uppercase -DSTRICT . $ winemaker --lower-uppercase -DSTRICT .
.PP .PP
The above tells winemaker to scan the current directory and its The above tells \fBwinemaker\fR to scan the current directory and its
subdirectories for source files. Whenever if finds a file or directory which subdirectories for source files. Whenever if finds a file or directory which
name is all uppercase, it should rename it to lowercase. It should then fix name is all uppercase, it should rename it to lowercase. It should then fix
all these source files for compilation with Winelib and generate Makefiles. all these source files for compilation with Winelib and generate \fIMakefile\fRs.
The '-DSTRICT' specifies that the STRICT macro must be set when compiling The \fB-DSTRICT\fR specifies that the \fBSTRICT\fR macro must be set when compiling
these sources. Finally winemaker will create a Makefile. these sources. Finally a \fIMakefile\fR will be created.
.PP .PP
The next step would be: The next step would be:
.PP .PP
...@@ -214,16 +214,16 @@ $ make ...@@ -214,16 +214,16 @@ $ make
In some cases you will have to edit the \fIMakefile\fR or source files manually. In some cases you will have to edit the \fIMakefile\fR or source files manually.
.PP .PP
Assuming that the windows executable/library is available, we could Assuming that the windows executable/library is available, we could
use winedump to determine what kind of executable it is (graphical use \fBwinedump\fR to determine what kind of executable it is (graphical
or console), which libraries it is linked with, and which functions it or console), which libraries it is linked with, and which functions it
exports (for libraries). We could then restore all these settings for the exports (for libraries). We could then restore all these settings for the
corresponding Winelib target. corresponding Winelib target.
.PP .PP
Furthermore winemaker is not very good at finding the library containing the Furthermore \fBwinemaker\fR is not very good at finding the library containing the
executable: it must either be in the current directory or in the executable: it must either be in the current directory or in the
.IR LD_LIBRARY_PATH . .BR LD_LIBRARY_PATH .
.PP .PP
Winemaker does not support message files and the message compiler yet. \fBwinemaker\fR does not support message files and the message compiler yet.
.PP .PP
Bugs can be reported on the Bugs can be reported on the
.UR http://bugs.winehq.org .UR http://bugs.winehq.org
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment