Difference between revisions of "Winetricks"

From WineHQ Wiki
Jump to: navigation, search
(Initial import; needs work on markup)
 
(Options: Update help text.)
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
'''Translations of this page:'''
+
'''Translations of this page:''' not yet ported. Translators, please see Discussion page.  
[http://upload.wikimedia.org/wikipedia/en/thumb/b/ba/Flag_of_Germany.svg/22px-Flag_of_Germany.svg.png][:winetricks de: Deutsch]
+
[http://upload.wikimedia.org/wikipedia/en/thumb/1/12/Flag_of_Poland.svg/22px-Flag_of_Poland.svg.png][:winetricks PL: Polish]
+
[http://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Flag_of_Romania.svg/22px-Flag_of_Romania.svg.png][:winetricks ro: Romanian]
+
[http://upload.wikimedia.org/wikipedia/en/thumb/9/9a/Flag_of_Spain.svg/22px-Flag_of_Spain.svg.png][:winetricks es: Español]
+
[http://upload.wikimedia.org/wikipedia/en/thumb/f/f3/Flag_of_Russia.svg/22px-Flag_of_Russia.svg.png][:winetricks ru: Russian]
+
[http://upload.wikimedia.org/wikipedia/en/thumb/9/9e/Flag_of_Japan.svg/22px-Flag_of_Japan.svg.png] [:winetricks ja: Japanese]
+
[http://upload.wikimedia.org/wikipedia/commons/thumb/f/fa/Flag_of_the_People's_Republic_of_China.svg/22px-Flag_of_the_People's_Republic_of_China.svg.png][:winetricks cn: 简体中文]
+
 
----
 
----
== winetricks ==
+
== What is winetricks? ==
'''winetricks''' is a helper script to download and install various redistributable runtime libraries needed to run some programs in Wine. These may include replacements for components of Wine using closed source libraries.
+
'''Winetricks''' is a helper script to download and install various redistributable runtime libraries needed to run some programs in Wine. These may include replacements for components of Wine using closed source libraries.
  
/!\ '''Note:''' Although using winetricks may be ''very'' useful for getting some programs working in Wine, doing so may limit your ability to get support though WineHQ.  In particular, reporting bugs may not be possible if you've replaced parts of Wine with it.  See [#winetricks_and_bugs Reporting bugs after you have used Winetricks] below.
+
'''Note:''' Although using winetricks may be ''very'' useful for getting some programs working in Wine, doing so may limit your ability to get support though WineHQ.  In particular, reporting bugs may not be possible if you've replaced parts of Wine with it.  See [[#winetricks_and_bugs|Reporting bugs after you have used Winetricks]] below.
  
/!\ '''Note:''' Some of the packages listed below may not work well with older versions of Wine.  As always we recommend you use the [http://www.winehq.org/site/download latest version of Wine].
+
'''Note:''' Some of the packages listed below may not work well with older versions of Wine.  As always we recommend you use the [https://www.winehq.org/download latest version of Wine].
  
 
== Getting winetricks ==
 
== Getting winetricks ==
The script is maintained by AustinEnglish at http://winetricks.org.  The latest release is available at https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks.  Right-click on that link and use 'Save As' to save a fresh copy. Or you can get it from the commandline with the command:
+
The script is maintained by Austin English at http://winetricks.org.  The latest release is available at https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks.  Right-click on that link and use 'Save As' to save a fresh copy. Or you can get it from the commandline with the command:
  
{{{
+
wget  https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks
wget  https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks
+
chmod +x winetricks  
chmod +x winetricks }}}
+
  
(!) Also, some winetricks "packages" require a few external tools to be installed, namely: cabextract, unzip, p7zip, wget (or curl), and zenity (or kdialog).  Linux users can usually get these via their distribution's package management system.
+
Also, some winetricks "packages" require a few external tools to be installed, namely: cabextract, unzip, p7zip, wget (or curl), and zenity (or kdialog).  Linux users can usually get these via their distribution's package management system.
 
+
== New Gui ==
+
 
+
winetricks 20110311 was a major release.  Changes:
+
* the menu has been broken up into sections (it was getting too big)
+
* dependency checking is better
+
* verbs can now be in external files for testing
+
* it includes a bunch of games and apps ported in from wisotool (a separate project that has since been merged into winetricks)
+
* apps are installed in their own wineprefix by default, making them easier to uninstall reliably, and preventing workarounds for one app from breaking other apps
+
  
 
== Using winetricks ==
 
== Using winetricks ==
Once you've obtained winetricks you can run it simply by typing '''sh winetricks''' at the console. You can also use '''./winetricks''' if you '''chmod +x winetricks''' first.  If run without parameters, winetricks displays a GUI with a list of available packages.  If you know the names of the package(s) you wish to install, you can append them to the winetricks command and it will immediately start the installation process.  For example,
+
Once you've obtained winetricks you can run it simply by typing <tt>sh winetricks</tt> at the console. You can also use <tt>./winetricks</tt> if you <tt>chmod +x winetricks</tt> first.  If run without parameters, winetricks displays a GUI with a list of available packages.  If you know the names of the package(s) you wish to install, you can append them to the winetricks command and it will immediately start the installation process.  For example,
  
{{{
+
sh winetricks corefonts vcrun6  
sh winetricks corefonts vcrun6 }}}
+
 
will install both the corefonts and vcrun6 packages.
 
will install both the corefonts and vcrun6 packages.
  
 
== Options ==
 
== Options ==
Here is its help text as of 2012/09/12:
+
Version 20170614 help text:
  
{{{
+
Usage: /usr/bin/winetricks [options] [command|verb|path-to-verb] ...
Usage: /usr/bin/winetricks [options] [command|verb|path-to-verb] ...
+
Executes given verbs.  Each verb installs an application or changes a setting.
Executes given verbs.  Each verb installs an application or changes a setting.
+
 +
Options:
 +
    --force          Don't check whether packages were already installed
 +
    --gui            Show gui diagnostics even when driven by commandline
 +
    --isolate        Install each app or game in its own bottle (WINEPREFIX)
 +
    --self-update    Update this application to the last version
 +
    --update-rollback Rollback the last self update
 +
-k, --keep_isos      Cache isos (allows later installation without disc)
 +
    --no-clean        Don't delete temp directories (useful during debugging)
 +
-q, --unattended      Don't ask any questions, just install automatically
 +
-r, --ddrescue        Retry hard when caching scratched discs
 +
    --showbroken      Even show verbs that are currently broken in wine
 +
-t  --torify          Run downloads under torify, if available
 +
    --verify          Run (automated) GUI tests for verbs, if available
 +
-v, --verbose        Echo all commands as they are executed
 +
-h, --help            Display this message and exit
 +
-V, --version        Display version and exit
 +
 +
Commands:
 +
list                  list categories
 +
list-all              list all categories and their verbs
 +
apps list            list verbs in category 'applications'
 +
benchmarks list      list verbs in category 'benchmarks'
 +
dlls list            list verbs in category 'dlls'
 +
games list            list verbs in category 'games'
 +
settings list        list verbs in category 'settings'
 +
list-cached          list cached-and-ready-to-install verbs
 +
list-download        list verbs which download automatically
 +
list-manual-download  list verbs which download with some help from the user
 +
list-installed        list already-installed verbs
 +
prefix=foobar        select WINEPREFIX=/home/$USER/.local/share/wineprefixes/foobar
  
Options:
+
'''Tip:''' As with all Wine commands, winetricks knows about the `WINEPREFIX` environment variable.  This is useful for using winetricks with different Wine prefix locations.  For example,
    --force          Don't check whether packages were already installed
+
    --gui            Show gui diagnostics even when driven by commandline
+
-k, --keep_isos      Cache isos (allows later installation without disc)
+
    --no-clean        Don't delete temp directories (useful during debugging)
+
    --no-isolate      Don't install each app or game in its own bottle
+
-q, --unattended      Don't ask any questions, just install automatically
+
-r, --ddrescue        Retry hard when caching scratched discs
+
    --showbroken      Even show verbs that are currently broken in wine
+
-v, --verbose        Echo all commands as they are executed
+
-h, --help            Display this message and exit
+
-V, --version        Display version and exit
+
  
Commands:
+
  env WINEPREFIX=~/.winetest sh winetricks mfc40  
list                  list categories
+
list-all              list all categories and their verbs
+
apps list            list verbs in category 'applications'
+
benchmarks list      list verbs in category 'benchmarks'
+
dlls list            list verbs in category 'dlls'
+
games list            list verbs in category 'games'
+
settings list        list verbs in category 'settings'
+
list-cached          list cached-and-ready-to-install verbs
+
list-download        list verbs which download automatically
+
list-manual-download list verbs which download with some help from the user
+
list-installed        list already-installed verbs
+
prefix=foobar        select WINEPREFIX=/home/USER/.local/share/wineprefixes/foobar
+
}}}
+
(!) '''Tip:''' As with all Wine commands, winetricks knows about the `WINEPREFIX` environment variable.  This is useful for using winetricks with different Wine prefix locations.  For example,
+
 
+
{{{
+
env WINEPREFIX=~/.winetest sh winetricks mfc40 }}}
+
 
installs the mfc40 package in the `~/.winetest` prefix.
 
installs the mfc40 package in the `~/.winetest` prefix.
  
(!) '''Tip: '''Users with more than one version of Wine on their system (for example, an installed package and an uninstalled Wine built from git) can specify which version winetricks should use. For example,
+
'''Tip: '''Users with more than one version of Wine on their system (for example, an installed package and an uninstalled Wine built from git) can specify which version winetricks should use. For example,
  
{{{
+
env WINE=~/wine-git/wine sh winetricks mfc40  
env WINE=~/wine-git/wine sh winetricks mfc40 }}}
+
 
installs the mfc40 package using the Wine in the ~/wine-git directory.
 
installs the mfc40 package using the Wine in the ~/wine-git directory.
  
[[Anchor(winetricks_and_bugs)]]
+
<div id=winetricks_and_bugs></div>
  
 
== Reporting bugs after you have used Winetricks ==
 
== Reporting bugs after you have used Winetricks ==
{X} Please do not report bugs if you have used winetricks to install native (ie non Wine) files, as we cannot support Microsoft dlls.
+
Please do not report bugs if you have used winetricks to install native (ie non Wine) files, as we cannot support Microsoft dlls.
  
{OK} Using winetricks to install gecko, mono, and fakeie6 options is acceptable for bug reports - just be sure to mention that's what you've done.
+
Using winetricks to install gecko, mono, and fakeie6 options is acceptable for bug reports - just be sure to mention that's what you've done.
  
 
Additionally if you found it necessary to use winetricks for an application please mention it when submitting to the AppDB, mailing lists, and other Wine resources.
 
Additionally if you found it necessary to use winetricks for an application please mention it when submitting to the AppDB, mailing lists, and other Wine resources.
Line 102: Line 85:
  
 
Winetricks does not provide a way to uninstall individual apps or DLLs inside a Wine prefix. This is for several reasons, but mainly because the preferred way to uninstall anything in Wine is to simply install into a fresh Wine prefix. (Yes, it would be nice to have uninstallers for everything, but I don't need it myself. Patches welcome.)
 
Winetricks does not provide a way to uninstall individual apps or DLLs inside a Wine prefix. This is for several reasons, but mainly because the preferred way to uninstall anything in Wine is to simply install into a fresh Wine prefix. (Yes, it would be nice to have uninstallers for everything, but I don't need it myself. Patches welcome.)
 
  
 
== Installing winetricks ==
 
== Installing winetricks ==
It's not necessary to install winetricks to use it. You may choose to install winetricks in a global location so you can just type '''winetricks''' on the command line. Some Linux distributions include winetricks in their Wine packages, so you don't have to download it separately. (You might still want to if their version is old.)
+
It's not necessary to install winetricks to use it. You may choose to install winetricks in a global location so you can just type <tt>winetricks</tt> on the command line. Some Linux distributions include winetricks in their Wine packages, so you don't have to download it separately. (You might still want to if their version is old.)
 
+
See also http://code.google.com/p/winetricks/wiki/Installing
+
  
 
If you've downloaded your own copy of winetricks, you can install it manually like this:
 
If you've downloaded your own copy of winetricks, you can install it manually like this:
  
{{{
+
chmod +x winetricks
chmod +x winetricks
+
sudo cp winetricks /usr/local/bin
sudo cp winetricks /usr/local/bin }}}
+
  
 
== See Also ==
 
== See Also ==
* http://www.cabextract.org.uk/ -- cabextract is a tool for extracting MS cabinet files under Unix environments.
+
* http://www.cabextract.org.uk/ -- cabextract is a tool for extracting MS cabinet files under Unix environments.
* http://mike.kronenberg.org/index.php?s=trix (Darwine now comes bundled with trix, a gui that invokes winetricks)
+
* http://mike.kronenberg.org/index.php?s=trix (Darwine now comes bundled with trix, a gui that invokes winetricks)

Latest revision as of 12:50, 22 August 2017

Translations of this page: not yet ported. Translators, please see Discussion page.


What is winetricks?

Winetricks is a helper script to download and install various redistributable runtime libraries needed to run some programs in Wine. These may include replacements for components of Wine using closed source libraries.

Note: Although using winetricks may be very useful for getting some programs working in Wine, doing so may limit your ability to get support though WineHQ. In particular, reporting bugs may not be possible if you've replaced parts of Wine with it. See Reporting bugs after you have used Winetricks below.

Note: Some of the packages listed below may not work well with older versions of Wine. As always we recommend you use the latest version of Wine.

Getting winetricks

The script is maintained by Austin English at http://winetricks.org. The latest release is available at https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks. Right-click on that link and use 'Save As' to save a fresh copy. Or you can get it from the commandline with the command:

wget  https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks
chmod +x winetricks 

Also, some winetricks "packages" require a few external tools to be installed, namely: cabextract, unzip, p7zip, wget (or curl), and zenity (or kdialog). Linux users can usually get these via their distribution's package management system.

Using winetricks

Once you've obtained winetricks you can run it simply by typing sh winetricks at the console. You can also use ./winetricks if you chmod +x winetricks first. If run without parameters, winetricks displays a GUI with a list of available packages. If you know the names of the package(s) you wish to install, you can append them to the winetricks command and it will immediately start the installation process. For example,

sh winetricks corefonts vcrun6 

will install both the corefonts and vcrun6 packages.

Options

Version 20170614 help text:

Usage: /usr/bin/winetricks [options] [command|verb|path-to-verb] ...
Executes given verbs.  Each verb installs an application or changes a setting.

Options:
    --force           Don't check whether packages were already installed
    --gui             Show gui diagnostics even when driven by commandline
    --isolate         Install each app or game in its own bottle (WINEPREFIX)
    --self-update     Update this application to the last version
    --update-rollback Rollback the last self update
-k, --keep_isos       Cache isos (allows later installation without disc)
    --no-clean        Don't delete temp directories (useful during debugging)
-q, --unattended      Don't ask any questions, just install automatically
-r, --ddrescue        Retry hard when caching scratched discs
    --showbroken      Even show verbs that are currently broken in wine
-t  --torify          Run downloads under torify, if available
    --verify          Run (automated) GUI tests for verbs, if available
-v, --verbose         Echo all commands as they are executed
-h, --help            Display this message and exit
-V, --version         Display version and exit

Commands:
list                  list categories
list-all              list all categories and their verbs
apps list             list verbs in category 'applications'
benchmarks list       list verbs in category 'benchmarks'
dlls list             list verbs in category 'dlls'
games list            list verbs in category 'games'
settings list         list verbs in category 'settings'
list-cached           list cached-and-ready-to-install verbs
list-download         list verbs which download automatically
list-manual-download  list verbs which download with some help from the user
list-installed        list already-installed verbs
prefix=foobar         select WINEPREFIX=/home/$USER/.local/share/wineprefixes/foobar

Tip: As with all Wine commands, winetricks knows about the `WINEPREFIX` environment variable. This is useful for using winetricks with different Wine prefix locations. For example,

env WINEPREFIX=~/.winetest sh winetricks mfc40 

installs the mfc40 package in the `~/.winetest` prefix.

Tip: Users with more than one version of Wine on their system (for example, an installed package and an uninstalled Wine built from git) can specify which version winetricks should use. For example,

env WINE=~/wine-git/wine sh winetricks mfc40 

installs the mfc40 package using the Wine in the ~/wine-git directory.

Reporting bugs after you have used Winetricks

Please do not report bugs if you have used winetricks to install native (ie non Wine) files, as we cannot support Microsoft dlls.

Using winetricks to install gecko, mono, and fakeie6 options is acceptable for bug reports - just be sure to mention that's what you've done.

Additionally if you found it necessary to use winetricks for an application please mention it when submitting to the AppDB, mailing lists, and other Wine resources.

Reporting bugs *in* Winetricks

Winetricks has a bug tracking system at http://winetricks.org, please use it. If you don't want to get an account there to file a bug, posting on the wine user forum may also eventually get noticed.

How to remove things installed by Winetricks

It's easy to install an entire wineprefix, so by default, winetricks installs each app into its own Wine prefix, and offers an easy way to remove wineprefixes and the menu items they created.

Winetricks does not provide a way to uninstall individual apps or DLLs inside a Wine prefix. This is for several reasons, but mainly because the preferred way to uninstall anything in Wine is to simply install into a fresh Wine prefix. (Yes, it would be nice to have uninstallers for everything, but I don't need it myself. Patches welcome.)

Installing winetricks

It's not necessary to install winetricks to use it. You may choose to install winetricks in a global location so you can just type winetricks on the command line. Some Linux distributions include winetricks in their Wine packages, so you don't have to download it separately. (You might still want to if their version is old.)

If you've downloaded your own copy of winetricks, you can install it manually like this:

chmod +x winetricks
sudo cp winetricks /usr/local/bin

See Also