diff --git a/Make.rules.in b/Make.rules.in index c341ba4ce75..0b4fbd1610a 100644 --- a/Make.rules.in +++ b/Make.rules.in @@ -67,8 +67,9 @@ exec_prefix = @exec_prefix@ bindir = @bindir@ libdir = @libdir@ infodir = @infodir@ -mandir = @mandir@/man1 -manext = .1 +mandir = @mandir@ +prog_manext = 1 +conf_manext = 5 includedir = @includedir@/wine OBJS = $(C_SRCS:.c=.o) $(GEN_ASM_SRCS:.s=.o) $(ASM_SRCS:.S=.o) $(RC_SRCS:.rc=.o) \ diff --git a/README b/README index 47092114426..f70feaf5ef3 100644 --- a/README +++ b/README @@ -11,8 +11,18 @@ Wine is free software, and its license (contained in the file LICENSE) is BSD style. Basically, you can do anything with it except claim that you wrote it. +2. QUICK START -2. REQUIREMENTS +For the impatient, use the Wine Installer to build and install wine. +From the top-level Wine directory (which contains this file), run: + +./tools/wineinstall + +Run programs as "wine [options] program". For more information and +problem resolution, read the rest of this file, the Wine manpage, +and the files in the documentation directory in the Wine source. + +3. REQUIREMENTS To compile and run Wine, you must have one of the following: @@ -26,25 +36,33 @@ threads were not implemented until kernel version 2.2. If you get consistent thread-related crashes, you may want to upgrade to 2.2. You also need to have libXpm installed on your system. The sources for -it are probably available on the FTP site where you got Wine. They can -also be found on ftp.x.org and all its mirror sites. If you are using -RedHat, install the xpm and xpm-devel packages. Debian users need -xpm4.7, xpm4g, and xpm4g-dev 3.4j. +it are available at ftp.x.org and all its mirror sites in the directory +/contrib/libraries. If you are using RedHat, libXpm is distributed as the +xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g, +and xpm4g-dev 3.4j. SuSE calls these packages xpm and xpm-devel. On x86 Systems gcc >= 2.7.2 is required. You also need flex version 2.5 or later and yacc. Bison will work as a replacement for yacc. If you are using RedHat, install the flex and bison packages. -3. COMPILATION +4. COMPILATION -To build Wine, first run "./configure" and then run "make depend; make". -This will build the library "libwine.a" and the program "wine". +To build Wine, run the following commands: +./configure +make depend +make + +This will build the library "libwine.a" and the program "wine". The program "wine" will load and run Windows executables. The library "libwine.a" can be used to compile and link Windows source -code under Unix. If you have an ELF compiler, you can use -"./configure --enable-dll" to build a shared library instead. To see -other configuration options, do ./configure --help. +code under Unix. + +If you do not intend to compile Windows source code, use +"./configure --disable-lib" to skip building the library and reduce disk +space requirements. If you have an ELF compiler (which you probably do), +you can use "./configure --enable-dll" to build a shared library instead. +To see other configuration options, do ./configure --help. To upgrade to a new release by using a patch file, first cd to the top-level directory of the release (the one containing this README @@ -54,27 +72,28 @@ file). Then do a "make clean", and patch the release with: where "patch-file" is the name of the patch file (something like Wine-yymmdd.diff.gz). You can then re-run "./configure", and then -run "make depend; make". +run "make depend && make". -4. SETUP +5. SETUP Once Wine has been built correctly, you can do "make install"; this will install the wine executable, the Wine man page, and a few other needed files. -Wine requires you to have a file /usr/local/etc/wine.conf (you can -supply a different name when configuring wine) or a file called .winerc -in your home directory. +Wine requires a configuration file named wine.conf. Its default location is +/usr/local/etc, but you can supply a different name when configuring wine by +using the --prefix or --sysconfdir options to ./configure. You can also override +the global configuration file with a .winerc file in your home directory. The format of this file is explained in the man page. The file -wine.ini contains a config file example which has to be adapted +wine.ini contains an example configuration file which has to be adapted and copied to one of the two locations mentioned above. -See www.winehq.com/config.html for further configuration hints. +See http://www.winehq.com/config.html for further configuration hints. -5. RUNNING PROGRAMS +6. RUNNING PROGRAMS When invoking Wine, you may specify the entire path to the executable, or a filename only. @@ -98,7 +117,7 @@ If you post a bug report, please read the file documentation/bugreports to see what information is required. -6. GETTING MORE INFORMATION +7. GETTING MORE INFORMATION FAQ: The Wine FAQ is located at http://www.winehq.com/faq.html. diff --git a/configure b/configure index 1cd7392ad05..4960c44004d 100755 --- a/configure +++ b/configure @@ -5352,6 +5352,7 @@ dlls/winaspi/Makefile dlls/winspool/Makefile dlls/wnaspi32/Makefile documentation/Makefile +documentation/wine.conf.man documentation/wine.man files/Makefile graphics/Makefile @@ -5524,6 +5525,7 @@ dlls/winaspi/Makefile dlls/winspool/Makefile dlls/wnaspi32/Makefile documentation/Makefile +documentation/wine.conf.man documentation/wine.man files/Makefile graphics/Makefile diff --git a/configure.in b/configure.in index c3032872953..28cefc4fdfb 100644 --- a/configure.in +++ b/configure.in @@ -775,6 +775,7 @@ dlls/winaspi/Makefile dlls/winspool/Makefile dlls/wnaspi32/Makefile documentation/Makefile +documentation/wine.conf.man documentation/wine.man files/Makefile graphics/Makefile diff --git a/documentation/.cvsignore b/documentation/.cvsignore index e66451a343f..fe958b90967 100644 --- a/documentation/.cvsignore +++ b/documentation/.cvsignore @@ -1,2 +1,3 @@ Makefile +wine.conf.man wine.man diff --git a/documentation/Makefile.in b/documentation/Makefile.in index 37fd8af708a..0729d341091 100644 --- a/documentation/Makefile.in +++ b/documentation/Makefile.in @@ -51,10 +51,12 @@ $(INCLUDES): install:: [ -d $(mandir) ] || mkdir -p $(mandir) - $(INSTALL_DATA) wine.man $(mandir)/wine$(manext) + $(INSTALL_DATA) wine.man $(mandir)/man$(prog_manext)/wine.$(prog_manext) + $(INSTALL_DATA) wine.conf.man $(mandir)/man$(conf_manext)/wine.conf.$(conf_manext) uninstall:: - $(RM) $(mandir)/wine$(manext) + $(RM) $(mandir)/man($prog_manext)/wine.$(prog_manext) + $(RM) $(mandir)/man($conf_manext)/wine.conf.$(conf_manext) # Not done by default because of makeinfo bugs install_info: $(INFOFILES) diff --git a/documentation/wine.conf.man.in b/documentation/wine.conf.man.in new file mode 100644 index 00000000000..d159c27799f --- /dev/null +++ b/documentation/wine.conf.man.in @@ -0,0 +1,269 @@ +.\" -*- nroff -*- +.TH WINE.CONF 5 "July 16, 1999" "Version 990704" "Wine Configuration File" +.SH NAME +wine.conf \- Wine configuration file +.SH DESCRIPTION +.B wine +expects a configuration file ( +.I @sysconfdir@/wine.conf +), which should +conform to the following rules (the format is just like a Windows .ini +file). Common locations are /usr/local/etc/wine.conf or +(in some distributions) /etc/wine.conf. The actual directory +where that file resides may be specified during the execution of the +.B configure +script with the --sysconfdir option. Alternatively, you may have a +.I .winerc +file of this format in your home directory or have the environment variable +.B WINE_INI +pointing to a configuration file, or use the -config option on the command +line. +A sample configuration file is available as wine.ini in the base directory +of the Wine source distribution. +.SH CONFIGURATION FILE FORMAT +All entries are grouped in sections; a section begins with the line +.br +.I [section name] +.br +and continues until the next section starts. Individual entries +consist of lines of the form +.br +.I entry=value +.br +The value can be any text string, optionally included in single or +double quotes; it can also contain references to environment variables +surrounded by +.I ${}. +Supported section names and entries are listed below. +.PP +.B [Drive X] +.br +This section is used to specify the root directory and type of each +.B DOS +drive, since most Windows applications require a DOS/MS-Windows based +disk drive & directory scheme. There is one such section for every +drive you want to configure. +.PP +.I format: Path = +.br +default: none +.br +If you mounted your dos partition as +.I /dos +and installed Microsoft Windows in +C:\\WINDOWS then you should specify +.I Path=/dos +in the +.I [Drive C] +section. +.PP +.I format: Type = +.br +default: hd +.br +Used to specify the drive type this drive appears as in Windows +or DOS programs; supported types are floppy, hd, cdrom +and network. +.PP +.I format: Label =