Alexandre Julliard : tools: Added a man page for wineprefixcreate.

[Alexandre Julliard]

Module: wine
Branch: master
Commit: 6bcbc126edcc255e9ab3c4ca41e9dfc2fb441548
URL:    http://source.winehq.org/git/?p=wine.git;a=commit;h=6bcbc126edcc255e9ab3c4ca...

Author: Alexandre Julliard <julliard(a)winehq.org>
Date:   Wed Aug 23 15:59:05 2006 +0200

tools: Added a man page for wineprefixcreate.

---

 tools/.gitignore              |    1 +
 tools/Makefile.in             |    8 +++-
 tools/wineprefixcreate.man.in |   82 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 88 insertions(+), 3 deletions(-)
 create mode 100644 tools/wineprefixcreate.man.in

diff --git a/tools/.gitignore b/tools/.gitignore
index dd1392f..767f5bd 100644
--- a/tools/.gitignore
+++ b/tools/.gitignore
@@ -7,3 +7,4 @@
 /sfnt2fnt
 /winemaker.man
 /wineprefixcreate
+/wineprefixcreate.man
diff --git a/tools/Makefile.in b/tools/Makefile.in
index e205e4f..982a02c 100644
--- a/tools/Makefile.in
+++ b/tools/Makefile.in
@@ -19,7 +19,8 @@ PROGRAMS = \
 	wineprefixcreate
 
 MANPAGES = \
-	winemaker.man
+	winemaker.man \
+	wineprefixcreate.man
 
 C_SRCS = \
 	bin2res.c \
@@ -79,10 +80,11 @@ wineprefixcreate: wineprefixcreate.in re
 	sed -e "s,@bintodlldir\@,`$(RELPATH) $(bindir) $(dlldir)`,g" -e "s,@bintodatadir\@,`$(RELPATH) $(bindir) $(datadir)/wine`,g" $(SRCDIR)/wineprefixcreate.in >$@ || ($(RM) $@ && false)
 	chmod +x wineprefixcreate
 
-install install-lib:: wineprefixcreate $(DESTDIR)$(bindir) $(DESTDIR)$(datadir)/wine $(DESTDIR)$(datadir)/applications
+install install-lib:: wineprefixcreate $(INSTALLDIRS)
 	$(INSTALL_SCRIPT) wineprefixcreate $(DESTDIR)$(bindir)/wineprefixcreate
 	$(INSTALL_DATA) $(SRCDIR)/wine.inf $(DESTDIR)$(datadir)/wine/wine.inf
 	$(INSTALL_DATA) $(SRCDIR)/wine.desktop $(DESTDIR)$(datadir)/applications/wine.desktop
+	$(INSTALL_DATA) wineprefixcreate.man $(DESTDIR)$(mandir)/man$(prog_manext)/wineprefixcreate.$(prog_manext)
 	-$(UPDATE_DESKTOP_DATABASE)
 
 install install-dev:: $(INSTALLSUBDIRS:%=%/__install__) $(DESTDIR)$(bindir) $(DESTDIR)$(mandir)/man$(prog_manext)
@@ -90,7 +92,7 @@ install install-dev:: $(INSTALLSUBDIRS:%
 	$(INSTALL_DATA) winemaker.man $(DESTDIR)$(mandir)/man$(prog_manext)/winemaker.$(prog_manext)
 
 uninstall::
-	$(RM) $(DESTDIR)$(bindir)/winemaker $(DESTDIR)$(bindir)/wineprefixcreate $(DESTDIR)$(mandir)/man$(prog_manext)/winemaker.$(prog_manext) $(DESTDIR)$(datadir)/wine/wine.inf $(DESTDIR)$(datadir)/applications/wine.desktop
+	$(RM) $(DESTDIR)$(bindir)/winemaker $(DESTDIR)$(bindir)/wineprefixcreate $(DESTDIR)$(mandir)/man$(prog_manext)/winemaker.$(prog_manext) $(DESTDIR)$(mandir)/man$(prog_manext)/wineprefixcreate.$(prog_manext) $(DESTDIR)$(datadir)/wine/wine.inf $(DESTDIR)$(datadir)/applications/wine.desktop
 	-$(UPDATE_DESKTOP_DATABASE)
 
 ### Dependencies:
diff --git a/tools/wineprefixcreate.man.in b/tools/wineprefixcreate.man.in
new file mode 100644
index 0000000..daaedeb
--- /dev/null
+++ b/tools/wineprefixcreate.man.in
@@ -0,0 +1,82 @@
+.\" -*- nroff -*-
+.TH WINEPREFIXCREATE 1 "August 2006" "@PACKAGE_STRING@" "Windows on Unix"
+.SH NAME
+wineprefixcreate \- create or update the Wine configuration
+.SH SYNOPSIS
+.BI wineprefixcreate\  [options]
+.SH DESCRIPTION
+.B wineprefixcreate
+creates or updates a Wine configuration directory.  When running Wine,
+the base name of the configuration directory is specified in the
+WINEPREFIX variable, hence the name of this tool.
+.PP
+.B wineprefixcreate
+is launched automatically by
+.B wine(1)
+if you don't have an existing configuration. However, it can sometimes
+be useful to run it explicitly to create a different directory, or
+update an existing one.
+.SH OPTIONS
+.TP
+.BI \--prefix\  directory
+Create the specified directory (or update it if it exists already). If
+this option is not specified,
+.B wineprefixcreate
+defaults to the
+.I WINEPREFIX
+environment variable, or to
+.I $HOME/.wine
+if not set.
+.TP
+.B \-h, \--help
+Display a usage message.
+.TP
+.B \-q, \--quiet
+Don't display any status messages.
+.TP
+.B \-w, \--wait
+Wait for
+.B wineserver
+to save everything before returning. This is necessary for instance if
+you are planning to rename the directory once created; otherwise a
+running server could still try to access the directory under its old
+name.
+.SH ENVIRONMENT VARIABLES
+.TP
+.I WINEPREFIX
+If set, the content of this variable is taken as the name of the directory where
+.B wineprefixcreate
+stores its data (the default is \fI$HOME/.wine\fR). All
+.B wine
+processes using the same prefix share certain things like registry,
+shared memory and kernel objects.  By setting
+.I WINEPREFIX
+to different values for different Wine processes, it is possible to
+run a number of truly independent Wine sessions.
+.SH FILES
+.TP
+.B ~/.wine
+Default location for the
+.B wine
+configuration data.
+.SH AUTHORS
+Many people have contributed to the development of Wine. Please check
+the file Changelog in the Wine distribution for the complete details.
+.SH BUGS
+If you find a bug, please submit a bug report at
+.UR http://bugs.winehq.org
+.B http://bugs.winehq.org.
+.UE
+.SH AVAILABILITY
+.B wineprefixcreate
+is part of the Wine distribution, which is available through WineHQ,
+the Wine development headquarters, at
+.UR http://www.winehq.org/
+.B http://www.winehq.org/.
+.UE
+.br
+It is distributed under the terms of the GNU Lesser General Public
+License.
+.SH "SEE ALSO"
+.BR wine (1),
+.BR wineserver (1).