kernel32/tests: A couple of spelling fixes in ok() messages.
[wine.git] / server / wineserver.man.in
blob82136a38e765488f9a8318881e21638a862cf31d
1 .TH WINESERVER 1 "October 2005" "@PACKAGE_STRING@" "Windows on Unix"
2 .SH NAME
3 wineserver \- the Wine server
4 .SH SYNOPSIS
5 .B wineserver
6 .RI [ options ]
7 .SH DESCRIPTION
8 .B wineserver
9 is a daemon process that provides to Wine roughly the same services
10 that the Windows kernel provides on Windows.
11 .PP
12 .B wineserver
13 is normally launched automatically when starting \fBwine\fR(1), so you
14 shouldn't have to worry about it. In some cases however, it can be
15 useful to start \fBwineserver\fR explicitly with different options, as
16 explained below.
17 .SH OPTIONS
18 .TP
19 \fB\-d\fR[\fIn\fR], \fB--debug\fR[\fB=\fIn\fR]
20 Set the debug level to
21 .IR n .
22 0 means no debugging information, 1 is the normal level, and 2 is for
23 extra verbose debugging. If
24 .I n
25 is not specified, the default is 1. The debug output will be sent to
26 stderr. \fBwine\fR(1) will automatically enable normal level debugging
27 when starting \fBwineserver\fR if the +server option is set in the
28 \fBWINEDEBUG\fR variable.
29 .TP
30 .BR \-f ", " --foreground
31 Make the server remain in the foreground for easier debugging, for
32 instance when running it under a debugger.
33 .TP
34 .BR \-h ", " --help
35 Display a help message.
36 .TP
37 \fB\-k\fR[\fIn\fR], \fB--kill\fR[\fB=\fIn\fR]
38 Kill the currently running
39 .BR wineserver ,
40 optionally by sending signal \fIn\fR. If no signal is specified, sends
41 a \fBSIGINT\fR first and then a \fBSIGKILL\fR.  The instance of \fBwineserver\fR
42 that is killed is selected based on the \fBWINEPREFIX\fR environment
43 variable.
44 .TP
45 \fB\-p\fR[\fIn\fR], \fB--persistent\fR[\fB=\fIn\fR]
46 Specify the \fBwineserver\fR persistence delay, i.e. the amount of
47 time that the server will keep running when all client processes have
48 terminated. This avoids the cost of shutting down and starting again
49 when programs are launched in quick succession. The timeout \fIn\fR is
50 in seconds, the default value is 3 seconds. If \fIn\fR is not
51 specified, the server stays around forever.
52 .TP
53 .BR \-v ", " --version
54 Display version information and exit.
55 .TP
56 .BR \-w ", " --wait
57 Wait until the currently running
58 .B wineserver
59 terminates.
60 .SH ENVIRONMENT
61 .TP
62 .B WINEPREFIX
63 If set, the content of this variable is taken as the name of the directory where
64 .B wineserver
65 stores its data (the default is \fI$HOME/.wine\fR). All
66 .B wine
67 processes using the same
68 .B wineserver
69 (i.e.: same user) share certain things like registry, shared memory
70 and kernel objects.
71 By setting
72 .B WINEPREFIX
73 to different values for different Wine processes, it is possible to
74 run a number of truly independent Wine sessions.
75 .TP
76 .B WINESERVER
77 Specifies the path and name of the
78 .B wineserver
79 binary that will be launched automatically by \fBwine\fR. If not set,
80 \fBwine\fR will try to load
81 .IR @bindir@/wineserver ,
82 and if this doesn't exist it will then look for a file named
83 \fIwineserver\fR in the path and in a few other likely locations.
84 .SH FILES
85 .TP
86 .B ~/.wine
87 Directory containing user specific data managed by
88 .BR wine .
89 .TP
90 .BI /tmp/.wine- uid
91 Directory containing the server Unix socket and the lock
92 file. These files are created in a subdirectory generated from the
93 \fBWINEPREFIX\fR directory device and inode numbers.
94 .SH AUTHORS
95 The original author of
96 .B wineserver
97 is Alexandre Julliard. Many other people have contributed new features
98 and bug fixes. For a complete list, see the git commit logs.
99 .SH BUGS
100 Bugs can be reported on the
101 .UR http://bugs.winehq.org
102 .B Wine bug tracker
103 .UE .
104 .SH AVAILABILITY
105 .B wineserver
106 is part of the Wine distribution, which is available through WineHQ,
108 .UR http://www.winehq.org/
109 .B Wine development headquarters
110 .UE .
111 .SH "SEE ALSO"
112 .BR wine (1),
114 .UR http://www.winehq.org/help
115 .B Wine documentation and support
116 .UE .