diff --git a/README.md b/README.md index c8ebdbc8..95945601 100644 --- a/README.md +++ b/README.md @@ -241,6 +241,92 @@ sudo urpmi.update -a sudo urpmi wine-compholio ``` +Using wine-compholio +==================== + +Since we don't want to duplicate a lot of information here, we recommend to take a +look at the [official Wine FAQ](http://wiki.winehq.org/FAQ) for general information +about how to use Wine. The following part will mainly concentrate on the differences +between wine and wine-compholio. + + +Running wine-compholio +---------------------- + +**Using multiple Wine versions:*** Unless you specify a special `WINEPREFIX` environment +variable, wine-compholio will use the same wineprefix `~/.wine` (in your home directory) +like regular wine. This allows you to use your already installed programs directly, +without much effort or reinstalling them. Often you have both regular wine and wine-compholio +installed at the same time, which is *absolutely no problem* - by typing in either `wine` +(=regular wine) or `/opt/wine-compholio/bin/wine` you can decide, which wine version you +want to run. You can switch between versions as often as you like - just make sure that all +Windows programs have terminated before starting them with a different version. + +To run wine-compholio always type `/opt/wine-compholio/bin/wine`, for example: +```bash +cd ~/.wine/drive_c// +/opt/wine-compholio/bin/wine game.exe +``` + +You also have to add `/opt/wine-compholio/bin/` when running other wine related programs, +here are some additional example: +```bash +# Initialize the wine prefix +/opt/wine-compholio/bin/wineboot + +# Open the wine configuration +/opt/wine-compholio/bin/winecfg + +# Run winepath to convert paths +/opt/wine-compholio/bin/winepath --unix 'c:\Windows' + +# Kill the running wineserver instance +/opt/wine-compholio/bin/wineserver -k + +... +``` + +If you're an experienced user, and always want to use wine-compholio, you can also add +`/opt/wine-compholio/bin` to your bash profile. We will not go into detail here, because +such a setup has the big disadvantage, that it hides which version you're using - which +is very important for getting support or reporting bugs. + + +Submitting bugs +--------------- + +**Warning: Do not submit bug reports at bugs.winehq.org when using this version!** + +If you encounter any issues, the first thing you should do is to try it with regular wine. +We're only a very small developer team, and although we would like to do that, we probably +cannot really solve all your Wine bugs. When it turns out that the official Wine version also +doesn't work, you can file a bugreport at the official [Wine bugtracker](http://bugs.winehq.org/). +Feel free to mention that you also tested with wine-compholio, but all bugreport related +information (logs, crashdumps, ...) should concentrate only on upstream wine. + +If it turns out, that it works with upstream wine, but not with wine-compholio, then it +might be a regression caused by our patches. We would like you to report this issue to us, +so we can fix it in future versions. You can also report issues, when testing with upstream +Wine is impossible or it crashes with a different error (for example much earlier). + +When submitting a application related bug here on github, please make sure to include at least +the following information. Generally its always a good idea to provide as much information as +possible, since this will significantly increase chances to provide support and to fix it. + +1. **Which application triggers the bug** + * Application name + * Version number (if available) + * Download URL (if available) +2. **WINEPREFIX settings** + * *Recommended:* Test it in a new wine prefix, and report if this works + * Did you install any overrides? (for examples by using `winetricks`) + * Did you change any settings by running `winecfg`? +3. **Information about your wine-compholio version** + * *Recommended:* Test with regular wine, and report if this works + * Version number (`/opt/wine-compholio/bin/wine --version`) + * Patches in your build (`/opt/wine-compholio/bin/wine --patches`) + * Installed optional libraries (`/opt/wine-compholio/bin/wine --check-libs`) + Compiling wine-compholio ======================== diff --git a/debian/tools/README.md.in b/debian/tools/README.md.in index f3f73e05..97fac7d7 100644 --- a/debian/tools/README.md.in +++ b/debian/tools/README.md.in @@ -215,6 +215,92 @@ sudo urpmi.update -a sudo urpmi wine-compholio ``` +Using wine-compholio +==================== + +Since we don't want to duplicate a lot of information here, we recommend to take a +look at the [official Wine FAQ](http://wiki.winehq.org/FAQ) for general information +about how to use Wine. The following part will mainly concentrate on the differences +between wine and wine-compholio. + + +Running wine-compholio +---------------------- + +**Using multiple Wine versions:*** Unless you specify a special `WINEPREFIX` environment +variable, wine-compholio will use the same wineprefix `~/.wine` (in your home directory) +like regular wine. This allows you to use your already installed programs directly, +without much effort or reinstalling them. Often you have both regular wine and wine-compholio +installed at the same time, which is *absolutely no problem* - by typing in either `wine` +(=regular wine) or `/opt/wine-compholio/bin/wine` you can decide, which wine version you +want to run. You can switch between versions as often as you like - just make sure that all +Windows programs have terminated before starting them with a different version. + +To run wine-compholio always type `/opt/wine-compholio/bin/wine`, for example: +```bash +cd ~/.wine/drive_c// +/opt/wine-compholio/bin/wine game.exe +``` + +You also have to add `/opt/wine-compholio/bin/` when running other wine related programs, +here are some additional example: +```bash +# Initialize the wine prefix +/opt/wine-compholio/bin/wineboot + +# Open the wine configuration +/opt/wine-compholio/bin/winecfg + +# Run winepath to convert paths +/opt/wine-compholio/bin/winepath --unix 'c:\Windows' + +# Kill the running wineserver instance +/opt/wine-compholio/bin/wineserver -k + +... +``` + +If you're an experienced user, and always want to use wine-compholio, you can also add +`/opt/wine-compholio/bin` to your bash profile. We will not go into detail here, because +such a setup has the big disadvantage, that it hides which version you're using - which +is very important for getting support or reporting bugs. + + +Submitting bugs +--------------- + +**Warning: Do not submit bug reports at bugs.winehq.org when using this version!** + +If you encounter any issues, the first thing you should do is to try it with regular wine. +We're only a very small developer team, and although we would like to do that, we probably +cannot really solve all your Wine bugs. When it turns out that the official Wine version also +doesn't work, you can file a bugreport at the official [Wine bugtracker](http://bugs.winehq.org/). +Feel free to mention that you also tested with wine-compholio, but all bugreport related +information (logs, crashdumps, ...) should concentrate only on upstream wine. + +If it turns out, that it works with upstream wine, but not with wine-compholio, then it +might be a regression caused by our patches. We would like you to report this issue to us, +so we can fix it in future versions. You can also report issues, when testing with upstream +Wine is impossible or it crashes with a different error (for example much earlier). + +When submitting a application related bug here on github, please make sure to include at least +the following information. Generally its always a good idea to provide as much information as +possible, since this will significantly increase chances to provide support and to fix it. + +1. **Which application triggers the bug** + * Application name + * Version number (if available) + * Download URL (if available) +2. **WINEPREFIX settings** + * *Recommended:* Test it in a new wine prefix, and report if this works + * Did you install any overrides? (for examples by using `winetricks`) + * Did you change any settings by running `winecfg`? +3. **Information about your wine-compholio version** + * *Recommended:* Test with regular wine, and report if this works + * Version number (`/opt/wine-compholio/bin/wine --version`) + * Patches in your build (`/opt/wine-compholio/bin/wine --patches`) + * Installed optional libraries (`/opt/wine-compholio/bin/wine --check-libs`) + Compiling wine-compholio ========================