Blame - server/wineserver.man.in - wine

blob: ae0e19f9ed571cf371303967b3678cb999657523 [file] [log] [blame]

Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	1	.\" -- nroff --
Alexandre Julliard	12a7499	2005-10-06 16:10:01 +0000	[diff] [blame]	2	.TH WINESERVER 1 "October 2005" "@PACKAGE_STRING@" "Windows on Unix"
Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	3	.SH NAME
				4	wineserver \- the Wine server
				5	.SH SYNOPSIS
				6	.BI wineserver\ [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(1)\fR, 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
Vitaliy Margolen	67daa7f	2008-05-21 17:58:58 -0600	[diff] [blame]	19	.BI \-d [n] ,\ --debug [=n]
Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	20	Set the debug level to
				21	.I 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(1)\fR will automatically set the debug level when
				27	starting \fBwineserver\fR if the +server option is set in the
				28	WINEDEBUG variable.
				29	.TP
Vitaliy Margolen	67daa7f	2008-05-21 17:58:58 -0600	[diff] [blame]	30	.B \-f, --foreground
Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	31	Make the server remain in the foreground for easier debugging, for
				32	instance when running it under a debugger.
				33	.TP
Vitaliy Margolen	67daa7f	2008-05-21 17:58:58 -0600	[diff] [blame]	34	.B \-h, --help
Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	35	Display a help message.
				36	.TP
Vitaliy Margolen	67daa7f	2008-05-21 17:58:58 -0600	[diff] [blame]	37	.BI \-k [n] ,\ --kill [=n]
Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	38	Kill the currently running
				39	.B wineserver,
				40	optionally by sending signal \fIn\fR. If no signal is specified, sends
				41	a SIGINT first and then a SIGKILL. The instance of \fBwineserver\fR
				42	that is killed is selected based on the WINEPREFIX environment
				43	variable.
				44	.TP
Vitaliy Margolen	67daa7f	2008-05-21 17:58:58 -0600	[diff] [blame]	45	.BI \-p [n] ,\ --persistent [=n]
Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	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
Vitaliy Margolen	67daa7f	2008-05-21 17:58:58 -0600	[diff] [blame]	53	.B \-v, --version
Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	54	Display version information and exit.
				55	.TP
Vitaliy Margolen	67daa7f	2008-05-21 17:58:58 -0600	[diff] [blame]	56	.B \-w, --wait
Alexandre Julliard	79b387d	2005-09-27 10:56:47 +0000	[diff] [blame]	57	Wait until the currently running
				58	.B wineserver
				59	terminates.
				60	.SH ENVIRONMENT VARIABLES
				61	.TP
				62	.I 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	.I 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	.I 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	.I @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	.B wine.
				89	.TP
				90	.BI /tmp/.wine- uid
				91	The directory containing the server Unix socket and the lock
				92	file. These files are created in a subdirectory generated from the
				93	WINEPREFIX 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. Please check the file Changelog in the Wine
				99	distribution for the complete details.
				100	.SH BUGS
				101	If you find a bug, please submit a bug report at
				102	.UR http://bugs.winehq.org
				103	.B http://bugs.winehq.org.
				104	.UE
				105	.SH AVAILABILITY
				106	.B wineserver
				107	is part of the Wine distribution, which is available through WineHQ,
				108	the Wine development headquarters, at
				109	.UR http://www.winehq.org/
				110	.B http://www.winehq.org/.
				111	.UE
				112	.SH "SEE ALSO"
				113	.BR wine (1).