blob: c0b696ef642cf98d5254f5549c6dfa7beb64616d [file] [log] [blame]
Alexandre Julliard79b387d2005-09-27 10:56:47 +00001.\" -*- nroff -*-
Alexandre Julliard12a74992005-10-06 16:10:01 +00002.TH WINESERVER 1 "October 2005" "@PACKAGE_STRING@" "Windows on Unix"
Alexandre Julliard79b387d2005-09-27 10:56:47 +00003.SH NAME
4wineserver \- the Wine server
5.SH SYNOPSIS
6.BI wineserver\ [options]
7.SH DESCRIPTION
8.B wineserver
9is a daemon process that provides to Wine roughly the same services
10that the Windows kernel provides on Windows.
11.PP
12.B wineserver
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020013is normally launched automatically when starting \fBwine\fR(1), so you
Alexandre Julliard79b387d2005-09-27 10:56:47 +000014shouldn't have to worry about it. In some cases however, it can be
15useful to start \fBwineserver\fR explicitly with different options, as
16explained below.
17.SH OPTIONS
18.TP
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020019\fB\-d\fI[n]\fR, \fB--debug\fI[=n]
Alexandre Julliard79b387d2005-09-27 10:56:47 +000020Set the debug level to
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020021.IR n .
Alexandre Julliard79b387d2005-09-27 10:56:47 +0000220 means no debugging information, 1 is the normal level, and 2 is for
23extra verbose debugging. If
24.I n
25is not specified, the default is 1. The debug output will be sent to
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020026stderr. \fBwine\fR(1) will automatically set the debug level when
Alexandre Julliard79b387d2005-09-27 10:56:47 +000027starting \fBwineserver\fR if the +server option is set in the
28WINEDEBUG variable.
29.TP
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020030.BR \-f ", " --foreground
Alexandre Julliard79b387d2005-09-27 10:56:47 +000031Make the server remain in the foreground for easier debugging, for
32instance when running it under a debugger.
33.TP
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020034.BR \-h ", " --help
Alexandre Julliard79b387d2005-09-27 10:56:47 +000035Display a help message.
36.TP
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020037\fB\-k\fI[n]\fR, \fB--kill\fI[=n]
Alexandre Julliard79b387d2005-09-27 10:56:47 +000038Kill the currently running
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020039.BR wineserver ,
Alexandre Julliard79b387d2005-09-27 10:56:47 +000040optionally by sending signal \fIn\fR. If no signal is specified, sends
41a SIGINT first and then a SIGKILL. The instance of \fBwineserver\fR
42that is killed is selected based on the WINEPREFIX environment
43variable.
44.TP
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020045\fB\-p\fI[n]\fR, \fB--persistent\fI[=n]
Alexandre Julliard79b387d2005-09-27 10:56:47 +000046Specify the \fBwineserver\fR persistence delay, i.e. the amount of
47time that the server will keep running when all client processes have
48terminated. This avoids the cost of shutting down and starting again
49when programs are launched in quick succession. The timeout \fIn\fR is
50in seconds, the default value is 3 seconds. If \fIn\fR is not
51specified, the server stays around forever.
52.TP
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020053.BR \-v ", " --version
Alexandre Julliard79b387d2005-09-27 10:56:47 +000054Display version information and exit.
55.TP
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020056.BR \-w ", " --wait
Alexandre Julliard79b387d2005-09-27 10:56:47 +000057Wait until the currently running
58.B wineserver
59terminates.
60.SH ENVIRONMENT VARIABLES
61.TP
62.I WINEPREFIX
63If set, the content of this variable is taken as the name of the directory where
64.B wineserver
65stores its data (the default is \fI$HOME/.wine\fR). All
66.B wine
67processes using the same
68.B wineserver
69(i.e.: same user) share certain things like registry, shared memory
70and kernel objects.
71By setting
72.I WINEPREFIX
73to different values for different Wine processes, it is possible to
74run a number of truly independent Wine sessions.
75.TP
76.I WINESERVER
77Specifies the path and name of the
78.B wineserver
79binary that will be launched automatically by \fBwine\fR. If not set,
80\fBwine\fR will try to load
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020081.IR @bindir@/wineserver ,
Alexandre Julliard79b387d2005-09-27 10:56:47 +000082and 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
87Directory containing user specific data managed by
Frédéric Delanoydb7928c2010-04-09 01:29:57 +020088.BR wine .
Alexandre Julliard79b387d2005-09-27 10:56:47 +000089.TP
90.BI /tmp/.wine- uid
91The directory containing the server Unix socket and the lock
92file. These files are created in a subdirectory generated from the
93WINEPREFIX directory device and inode numbers.
94.SH AUTHORS
95The original author of
96.B wineserver
97is Alexandre Julliard. Many other people have contributed new features
98and bug fixes. Please check the file Changelog in the Wine
99distribution for the complete details.
100.SH BUGS
101If you find a bug, please submit a bug report at
102.UR http://bugs.winehq.org
Frédéric Delanoydb7928c2010-04-09 01:29:57 +0200103.BR http://bugs.winehq.org .
Alexandre Julliard79b387d2005-09-27 10:56:47 +0000104.UE
105.SH AVAILABILITY
106.B wineserver
107is part of the Wine distribution, which is available through WineHQ,
108the Wine development headquarters, at
109.UR http://www.winehq.org/
Frédéric Delanoydb7928c2010-04-09 01:29:57 +0200110.BR http://www.winehq.org/ .
Alexandre Julliard79b387d2005-09-27 10:56:47 +0000111.UE
112.SH "SEE ALSO"
113.BR wine (1).