From 473d7ac0dd7dc94e86a8710dde4a47bb7b3e85a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vincent=20B=C3=A9ron?= Date: Mon, 21 Jul 2003 22:23:38 +0000 Subject: [PATCH] Begin to uniformize sample commands in documentation. --- documentation/configuring.sgml | 245 +++++++++++++------------------- documentation/getting.sgml | 122 +++++++--------- documentation/installing.sgml | 54 +++---- documentation/introduction.sgml | 2 +- documentation/registry.sgml | 26 ++-- 5 files changed, 190 insertions(+), 259 deletions(-) diff --git a/documentation/configuring.sgml b/documentation/configuring.sgml index 1655a706aa7..587169fde6d 100644 --- a/documentation/configuring.sgml +++ b/documentation/configuring.sgml @@ -114,9 +114,9 @@ If you're using Debian, simply install the winesetuptk package (as root): - + # apt-get install winesetuptk - + If you're using another distribution, search for the package on the net. @@ -138,9 +138,9 @@ tree, change to the main directory of it and then run (as user): - + $ ./tools/wineinstall - + Doing so will compile Wine, install Wine and configure the Wine environment (either by providing access to a Windows @@ -176,10 +176,10 @@ To run it, run in a terminal in the Wine source tree directory: - + $ cd tools $ perl ./winecheck - + The winecheck output will be a percentage score indicating Wine configuration correctness. @@ -288,10 +288,10 @@ need to copy over our sample configuration file to the standard Wine configuration file location, do in a terminal: - + $ mkdir ~/.wine/ $ cp dir_to_wine_source_code/documentation/samples/config ~/.wine/config - + Otherwise, simply use the already existing configuration file at ~/.wine/config. @@ -519,8 +519,6 @@ "DefaultLoadOrder" =" native, builtin" - - This setting is a comma-delimited list of the order in which to attempt loading DLLs. If the first option fails, it will try the second, and so on. The order specified @@ -546,75 +544,59 @@ The [DllOverrides] Section The format for this section is the same for each line: - - <DLL>{,<DLL>,<DLL>...} = <FORM>{,<FORM>,<FORM>...} - - - + <DLL>{,<DLL>,<DLL>...} = <FORM>{,<FORM>,<FORM>...} For example, to load built-in KERNEL pair (case doesn't matter here): - - "kernel,kernel32" = "builtin" - - - + "kernel,kernel32" = "builtin" To load the native COMMDLG pair, but if that doesn't work try built-in: - - "commdlg,comdlg32" = "native, builtin" - - - + "commdlg,comdlg32" = "native, builtin" To load the native COMCTL32: - - "comctl32" = "native" - - - + "comctl32" = "native" Here is a good generic setup (As it is defined in config that was included with your wine package): - [DllOverrides] - "rpcrt4" = "builtin, native" - "oleaut32" = "builtin, native" - "ole32" = "builtin, native" - "commdlg" = "builtin, native" - "comdlg32" = "builtin, native" - "ver" = "builtin, native" - "version" = "builtin, native" - "shell" = "builtin, native" - "shell32" = "builtin, native" - "shfolder" = "builtin, native" - "shlwapi" = "builtin, native" - "shdocvw" = "builtin, native" - "lzexpand" = "builtin, native" - "lz32" = "builtin, native" - "comctl32" = "builtin, native" - "commctrl" = "builtin, native" - "advapi32" = "builtin, native" - "crtdll" = "builtin, native" - "mpr" = "builtin, native" - "winspool.drv" = "builtin, native" - "ddraw" = "builtin, native" - "dinput" = "builtin, native" - "dsound" = "builtin, native" - "opengl32" = "builtin, native" - "msvcrt" = "native, builtin" - "msvideo" = "builtin, native" - "msvfw32" = "builtin, native" - "mcicda.drv" = "builtin, native" - "mciseq.drv" = "builtin, native" - "mciwave.drv" = "builtin, native" - "mciavi.drv" = "native, builtin" - "mcianim.drv" = "native, builtin" - "msacm.drv" = "builtin, native" - "msacm" = "builtin, native" - "msacm32" = "builtin, native" - "midimap.drv" = "builtin, native" - ; you can specify programs too - "notepad.exe" = "native, builtin" - ; default for all other DLLs - "*" = "native, builtin" +[DllOverrides] +"rpcrt4" = "builtin, native" +"oleaut32" = "builtin, native" +"ole32" = "builtin, native" +"commdlg" = "builtin, native" +"comdlg32" = "builtin, native" +"ver" = "builtin, native" +"version" = "builtin, native" +"shell" = "builtin, native" +"shell32" = "builtin, native" +"shfolder" = "builtin, native" +"shlwapi" = "builtin, native" +"shdocvw" = "builtin, native" +"lzexpand" = "builtin, native" +"lz32" = "builtin, native" +"comctl32" = "builtin, native" +"commctrl" = "builtin, native" +"advapi32" = "builtin, native" +"crtdll" = "builtin, native" +"mpr" = "builtin, native" +"winspool.drv" = "builtin, native" +"ddraw" = "builtin, native" +"dinput" = "builtin, native" +"dsound" = "builtin, native" +"opengl32" = "builtin, native" +"msvcrt" = "native, builtin" +"msvideo" = "builtin, native" +"msvfw32" = "builtin, native" +"mcicda.drv" = "builtin, native" +"mciseq.drv" = "builtin, native" +"mciwave.drv" = "builtin, native" +"mciavi.drv" = "native, builtin" +"mcianim.drv" = "native, builtin" +"msacm.drv" = "builtin, native" +"msacm" = "builtin, native" +"msacm32" = "builtin, native" +"midimap.drv" = "builtin, native" +; you can specify programs too +"notepad.exe" = "native, builtin" +; default for all other DLLs +"*" = "native, builtin" @@ -632,8 +614,6 @@ "Resolution" = "96" - - Since the way X handles fonts is different from the way Windows does, wine uses a special mechanism to deal with them. It must scale them using the number defined in the @@ -656,11 +636,7 @@ The Alias setting allows you to map an X font to a font used in wine. This is good for apps that need a special font you don't have, but a good replacement exists. The syntax is like so: - - "AliasX" = "[Fake windows name],[Real X name]"<,optional "masking" section> - - - + "AliasX" = "[Fake windows name],[Real X name]"<,optional "masking" section> Pretty straightforward. Replace "AliasX" with "Alias0", then "Alias1" and so on. The fake windows name is the name that the font will be under a windows app in wine. The @@ -673,19 +649,10 @@ Here is an example of an alias without masking. The font will show up in windows apps as "Google". - - - "Alias0" = "Foo,--google-" - - - + "Alias0" = "Foo,--google-" Here is an example with masking enabled. The font will show up as "Foo" in windows apps. - - "Alias1" = "Foo,--google-,subst" - - - + "Alias1" = "Foo,--google-,subst" For more information check out the Fonts chapter. @@ -702,8 +669,6 @@ The [serialports] section tells wine what serial ports it is allowed to use. "ComX" = "/dev/ttySY" - - Replace X with the number of the COM port in Windows (1-8) and Y with the number of it in X (Usually the number @@ -713,8 +678,6 @@ not always necessary to define any COM ports (An optional setting). Here is an example: "Com1" = "/dev/ttyS0" - - Use as many of these as you like in the section to define all of the COM ports you need. @@ -722,8 +685,6 @@ The [parallelports] section sets up any parallel ports that will be allowed access under wine. "LptX" = "/dev/lpY" - - Sounds familiar? Syntax is just like the COM port setting. Replace X with a value from 1-4 as it is in Windows and Y with a value from @@ -733,8 +694,6 @@ the other section, LptX can equal any device (Maybe /dev/printer). Here is an example: "Lpt1" = "/dev/lp0" - - The [spooler] section will inform wine where to spool print jobs. Use this if you want to try printing. Wine docs claim that spooling is "rather primitive" at this @@ -743,13 +702,9 @@ for example) to a file or a command. Here is an example, mapping LPT1 to the file out.ps: "LPT1:" = "out.ps" - - The following command maps printing jobs to LPT1 to the command lpr. Notice the |: "LPT1:" = "|lpr" - - The [ports] section is usually useful only for people who need direct port access for programs requiring dongles or scanners. If you don't need it, don't use @@ -1004,9 +959,7 @@ configuration on Linux, then make sure to add the unhide mount option to the CD-ROM file system entry in /etc/fstab, e.g.: - -/dev/cdrom /cdrom iso9660 ro,noauto,users,unhide 0 0 - + /dev/cdrom /cdrom iso9660 ro,noauto,users,unhide 0 0 Several Windows program setup CD-ROMs or other CD-ROMs chose to do such braindamaged things as marking very important setup helper files on the CD-ROM as hidden. @@ -1296,11 +1249,7 @@ And here is a setup for Drive A, a generic floppy drive: access!! - -"Path" = "c:\\windows;c:\\windows\\system;c:\\blanco" - - - + "Path" = "c:\\windows;c:\\windows\\system;c:\\blanco" Behaves like the PATH setting on UNIX boxes. When wine is run like wine sol.exe, if sol.exe @@ -1313,9 +1262,7 @@ And here is a setup for Drive A, a generic floppy drive: "c:\\windows;c:\\windows\\system"). - -"ShowDirSymlinks" = "1" - + "ShowDirSymlinks" = "1" Wine doesn't pass directory symlinks to Windows programs by default, as doing so may crash some programs that do recursive lookups of whole subdirectory trees @@ -1626,9 +1573,9 @@ And here is a setup for Drive A, a generic floppy drive: from a ~/.wine/config file does this: - [Drive C] - "Path" = "/c" - "Type" = "hd" +[Drive C] +"Path" = "/c" +"Type" = "hd" Although VFAT filesystems are preferable to FAT filesystems @@ -1646,13 +1593,13 @@ And here is a setup for Drive A, a generic floppy drive: either case, by default, the permissions will probably be configured so that they look like: - + ~>cd /c /c>ls -l -rwxr-xr-x 1 root root 91 Oct 10 17:58 autoexec.bat -rwxr-xr-x 1 root root 245 Oct 10 17:58 config.sys drwxr-xr-x 41 root root 16384 Dec 30 1998 windows - + where all the files are owned by "root", are in the "root" group and are only writable by "root" @@ -1714,20 +1661,20 @@ And here is a setup for Drive A, a generic floppy drive: results in the files on the FAT filesystem having permissions similar to files created by root. For example: - + ~>whoami root ~>touch root_file ~>ls -l root_file -rw-r--r-- 1 root root 0 Dec 10 00:20 root_file - + which matches the owner, group and permissions of files seen on the FAT filesystem except for the missing 'x's. The permissions on the FAT filesystem can be changed by changing root's umask (unset permissions bits). For example: - + ~>umount /c ~>umask 022 @@ -1738,7 +1685,7 @@ And here is a setup for Drive A, a generic floppy drive: -rwx---r-- 1 root root 91 Oct 10 17:58 autoexec.bat -rwx---r-- 1 root root 245 Oct 10 17:58 config.sys drwx---r-- 41 root root 16384 Dec 30 1998 windows - + Mounting the FAT filesystem with a umask of 000 gives all users complete control over @@ -1749,7 +1696,7 @@ And here is a setup for Drive A, a generic floppy drive: and umask. They can each be specified when the filesystem is manually mounted. For example: - + ~>umount /c ~>mount -o uid=500 -o gid=500 -o umask=002 /c ~>cd /c @@ -1757,17 +1704,17 @@ And here is a setup for Drive A, a generic floppy drive: -rwxrwxr-x 1 sle sle 91 Oct 10 17:58 autoexec.bat -rwxrwxr-x 1 sle sle 245 Oct 10 17:58 config.sys drwxrwxr-x 41 sle sle 16384 Dec 30 1998 windows - + which gives "sle" complete control over /c. The options listed above can be made permanent by adding them to the /etc/fstab file: - + ~>grep /c /etc/fstab /dev/hda1 /c vfat uid=500,gid=500,umask=002,exec,dev,suid,rw 1 1 - + Note that the umask of 002 is common in the user private group file permission scheme. On FAT file @@ -1795,7 +1742,7 @@ And here is a setup for Drive A, a generic floppy drive: lack of root access. On this system a shadow directory might be set up in the following manner: - + ~>cd / />mkdir c_shadow />cd c_shadow @@ -1803,8 +1750,8 @@ And here is a setup for Drive A, a generic floppy drive: /c_shadow>rm windows AnApp /c_shadow>cp -R /c_/{windows,AnApp} . /c_shadow>chmod -R 777 windows AnApp -/c_shadow>perl -p -i -e 's|/c$|/c_shadow|g' ~/.wine/config - + /c_shadow>perl -p -i -e 's|/c$|/c_shadow|g' ~/.wine/config + The above gives everyone complete read and write access to the windows and @@ -1922,31 +1869,31 @@ And here is a setup for Drive A, a generic floppy drive: read from the device on both CD-ROM and floppy; serial numbers on floppy only: - - [Drive A] - "Path" = "/mnt/floppy" - "Type" = "floppy" - "Device" = "/dev/fd0" - "Filesystem" = "msdos" + +[Drive A] +"Path" = "/mnt/floppy" +"Type" = "floppy" +"Device" = "/dev/fd0" +"Filesystem" = "msdos" - [Drive R] - "Path" = "/mnt/cdrom" - "Type" = "cdrom" - "Device" = "/dev/hda1" - "Filesystem" = "win95" - +[Drive R] +"Path" = "/mnt/cdrom" +"Type" = "cdrom" +"Device" = "/dev/hda1" +"Filesystem" = "win95" + Here's an example of overriding the CD-ROM label: - - [Drive J] - "Path" = "/mnt/cdrom" - "Type" = "cdrom" - "Label" = "X234GCDSE" - ; note that the device isn't really needed here as we have a fixed label - "Device" = "/dev/cdrom" - "Filesystem" = "msdos" - + +[Drive J] +"Path" = "/mnt/cdrom" +"Type" = "cdrom" +"Label" = "X234GCDSE" +; note that the device isn't really needed here as we have a fixed label +"Device" = "/dev/cdrom" +"Filesystem" = "msdos" + diff --git a/documentation/getting.sgml b/documentation/getting.sgml index a9a57f66fa7..122b5bc7fa4 100644 --- a/documentation/getting.sgml +++ b/documentation/getting.sgml @@ -265,11 +265,10 @@ Red Hat Linux - Red Hat users can use - rpmfind.net to track down available Wine RPM binaries. - This - page contains a list of all rpmfind packages that start with - the letter "W", including a few Wine packages. + Red Hat users can use the + + sourceforge.net Wine page to get the RPM most suitable for + their system. @@ -301,12 +300,12 @@ If you want to install Wine from the FreeBSD CD-ROM, run in a terminal: - -$ su - -# mount /cdrom -# cd /cdrom/packages/All -# pkg_add wine_.X.X.X.tgz - + + $ su - + # mount /cdrom + # cd /cdrom/packages/All + # pkg_add wine_.X.X.X.tgz + @@ -407,22 +406,8 @@ - - ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/ - - - - - - - ftp://ftp.fu-berlin.de/unix/linux/mirrors/sunsite.unc.edu/ALPHA/wine/development/ - - - - - - - ftp://orcus.progsoc.uts.edu.au/pub/Wine/development/ + + http://prdownloads.sourceforge.net/wine/ @@ -443,9 +428,9 @@ switch to the directory containing the file you just downloaded. Then extract the source in a terminal with (e.g.): - -$ tar xvzf wine-20030115.tar.gz - + + $ tar xvzf wine-20030115.tar.gz + Just in case you happen to get a Wine archive that uses @@ -484,9 +469,9 @@ To check whether this is the case, please run in a terminal: - - $ cvs - + + $ cvs + If this was successful, then you should have gotten a nice CVS "Usage" help output. Otherwise (e.g. an error "cvs: command @@ -503,9 +488,9 @@ First, you should do a - - $ touch ~/.cvspass - + + $ touch ~/.cvspass + to create or update the file .cvspass in your home directory, since CVS needs this file (for password @@ -527,9 +512,9 @@ checkout -P Create the file with an editor of your choice, either by running - - $ <editor> ~/.cvsrc - + + $ <editor> ~/.cvsrc + , where <editor> is the editor you want to use (e.g. joe, ae, vi), @@ -548,9 +533,9 @@ checkout -P server and checkout (download) the Wine source code. First, let's do the server login: - - $ cvs -d :pserver:cvs@cvs.winehq.com:/home/wine login - + + $ cvs -d :pserver:cvs@cvs.winehq.com:/home/wine login + If cvs successfully connects to the CVS server, then you will get a "CVS password:" prompt. @@ -568,9 +553,9 @@ checkout -P might be your user's home directory. To download the Wine tree into the subdirectory wine/, run: - - $ cvs -d :pserver:cvs@cvs.winehq.com:/home/wine checkout wine - + + $ cvs -d :pserver:cvs@cvs.winehq.com:/home/wine checkout wine + Downloading the CVS tree might take a while (some minutes to few hours), depending on your connection speed. @@ -579,24 +564,24 @@ checkout -P wine/ directory is in, by running pwd (Print Working Directory): - - $ pwd - + + $ pwd + Later, you will be able to change to this directory by running: - - $ cd <some_dir> - + + $ cd <some_dir> + , where <some_dir> is the directory that pwd gave you. By running - - $ cd wine - + + $ cd wine + , you can now change to the directory of the Wine CVS tree you just downloaded. Since you now have a fully working Wine @@ -621,10 +606,10 @@ checkout -P To proceed with updating Wine, simply cd to the Wine CVS tree directory, then run: - - $ make distclean - $ cvs -d :pserver:cvs@cvs.winehq.com:/home/wine update - + + $ make distclean + $ cvs -d :pserver:cvs@cvs.winehq.com:/home/wine update + The make distclean part is optional, but it's a good idea to remove old build and compile configuration @@ -645,16 +630,16 @@ checkout -P mailing list, and received a patch file to fix the bug. You can apply the patch with the patch command, which takes a streamed patch from stdin: - -$ cd wine -$ patch -p0 <../patch_to_apply.diff - + + $ cd wine + $ patch -p0 <../patch_to_apply.diff + To remove the patch, use the -R option: - -$ patch -p0 -R <../patch_to_apply.diff - + + $ patch -p0 -R <../patch_to_apply.diff + If you want to do a test run to see if the patch will apply @@ -662,10 +647,9 @@ checkout -P newer version of the tree), you can use the --dry-run parameter to run the patch without writing to any files: - -$ patch -p0 --dry-run <../patch_to_apply.d -iff - + + $ patch -p0 --dry-run <../patch_to_apply.diff + patch is pretty smart about extracting diff --git a/documentation/installing.sgml b/documentation/installing.sgml index cace3fd526f..043aa59ec1e 100644 --- a/documentation/installing.sgml +++ b/documentation/installing.sgml @@ -48,12 +48,12 @@ .deb package file to. Once there, type these commands, adapting the package file name as required: - -$ su - -Password: -# cd /home/user -# dpkg -i wine_0.0.20030115-1.deb - + + $ su - + Password: + # cd /home/user + # dpkg -i wine_0.0.20030115-1.deb + (Type the root password at the "Password:" prompt) @@ -69,17 +69,17 @@ Password: Uninstalling an installed Wine Debian package can be done by running: - -# dpkg -l|grep wine - + + # dpkg -l|grep wine + The second column of the output (if any) of this command will indicate the installed packages dealing with "wine". The corresponding packages can be uninstalled by running: - -# dpkg -r <package_name> - + + # dpkg -r <package_name> + where <package_name> is the name of the Wine-related package which you want to uninstall. @@ -93,9 +93,9 @@ Password: Once there, type this one command as root, adapting the package file name as required: - -# rpm -ivh wine-20020605-2.i386.rpm - + + # rpm -ivh wine-20020605-2.i386.rpm + You may also want to install the wine-devel package. @@ -104,16 +104,16 @@ Password: Uninstalling an installed Wine RPM package can be done by running: - -# rpm -qa|grep -i wine - + + # rpm -qa|grep -i wine + This command will indicate the installed packages dealing with "wine". The corresponding packages can be uninstalled by running: - -# rpm -e <package_name> - + + # rpm -e <package_name> + where <package_name> is the name of the Wine-related package which you want to uninstall. @@ -128,9 +128,9 @@ Password: If you are in the directory of the Wine version that you just compiled (e.g. by having run make depend && make), then you may now install this Wine version by running as root: - -# make install - + + # make install + This will copy the Wine binary files to their final destination in your system. You can then proceed to the root: - -# make uninstall - + + # make uninstall + diff --git a/documentation/introduction.sgml b/documentation/introduction.sgml index db1531c4198..9d9c2475a0f 100644 --- a/documentation/introduction.sgml +++ b/documentation/introduction.sgml @@ -520,7 +520,7 @@ - A computer ;-) + A computer ;-) Wine: only PCs >= i386 are supported at the moment. Winelib: selected other platforms are supported, but can be tricky. diff --git a/documentation/registry.sgml b/documentation/registry.sgml index ec9e5171069..25b4b5f09a8 100644 --- a/documentation/registry.sgml +++ b/documentation/registry.sgml @@ -36,10 +36,10 @@ workarounds for certain programs etc.). In the main Wine source code directory in a terminal, run: - -$ cd programs/regedit -$ ./regedit ../../winedefault.reg - + + $ cd programs/regedit + $ ./regedit ../../winedefault.reg + @@ -232,19 +232,19 @@ files (which we assume will reside in /usr/local/etc here), with: - -cd ~/.wine -cp system.reg /usr/local/etc/wine.systemreg -cp wine.userreg /usr/local/etc/wine.userreg - + + cd ~/.wine + cp system.reg /usr/local/etc/wine.systemreg + cp wine.userreg /usr/local/etc/wine.userreg + and perhaps even symlink these back to the administrator's account, to make it easier to install apps system-wide later: - -ln -sf /usr/local/etc/wine.systemreg system.reg -ln -sf /usr/local/etc/wine.userreg wine.userreg - + + ln -sf /usr/local/etc/wine.systemreg system.reg + ln -sf /usr/local/etc/wine.userreg wine.userreg + Note that the tools/wineinstall script already does all of this for you, if you install Wine source as root.