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