winemenubuilder: Escape XML special characters in menus.
[wine/hramrach.git] / tools / wineprefixcreate.man.in
blobdaaedebc2c9410afae60256148569cacab2a729c
1 .\" -*- nroff -*-
2 .TH WINEPREFIXCREATE 1 "August 2006" "@PACKAGE_STRING@" "Windows on Unix"
3 .SH NAME
4 wineprefixcreate \- create or update the Wine configuration
5 .SH SYNOPSIS
6 .BI wineprefixcreate\  [options]
7 .SH DESCRIPTION
8 .B wineprefixcreate
9 creates or updates a Wine configuration directory.  When running Wine,
10 the base name of the configuration directory is specified in the
11 WINEPREFIX variable, hence the name of this tool.
12 .PP
13 .B wineprefixcreate
14 is launched automatically by
15 .B wine(1)
16 if you don't have an existing configuration. However, it can sometimes
17 be useful to run it explicitly to create a different directory, or
18 update an existing one.
19 .SH OPTIONS
20 .TP
21 .BI \--prefix\  directory
22 Create the specified directory (or update it if it exists already). If
23 this option is not specified,
24 .B wineprefixcreate
25 defaults to the
26 .I WINEPREFIX
27 environment variable, or to
28 .I $HOME/.wine
29 if not set.
30 .TP
31 .B \-h, \--help
32 Display a usage message.
33 .TP
34 .B \-q, \--quiet
35 Don't display any status messages.
36 .TP
37 .B \-w, \--wait
38 Wait for
39 .B wineserver
40 to save everything before returning. This is necessary for instance if
41 you are planning to rename the directory once created; otherwise a
42 running server could still try to access the directory under its old
43 name.
44 .SH ENVIRONMENT VARIABLES
45 .TP
46 .I WINEPREFIX
47 If set, the content of this variable is taken as the name of the directory where
48 .B wineprefixcreate
49 stores its data (the default is \fI$HOME/.wine\fR). All
50 .B wine
51 processes using the same prefix share certain things like registry,
52 shared memory and kernel objects.  By setting
53 .I WINEPREFIX
54 to different values for different Wine processes, it is possible to
55 run a number of truly independent Wine sessions.
56 .SH FILES
57 .TP
58 .B ~/.wine
59 Default location for the
60 .B wine
61 configuration data.
62 .SH AUTHORS
63 Many people have contributed to the development of Wine. Please check
64 the file Changelog in the Wine distribution for the complete details.
65 .SH BUGS
66 If you find a bug, please submit a bug report at
67 .UR http://bugs.winehq.org
68 .B http://bugs.winehq.org.
69 .UE
70 .SH AVAILABILITY
71 .B wineprefixcreate
72 is part of the Wine distribution, which is available through WineHQ,
73 the Wine development headquarters, at
74 .UR http://www.winehq.org/
75 .B http://www.winehq.org/.
76 .UE
77 .br
78 It is distributed under the terms of the GNU Lesser General Public
79 License.
80 .SH "SEE ALSO"
81 .BR wine (1),
82 .BR wineserver (1).