Sweden-Number/documentation
Alexandre Julliard c0d52e0688 Initial revision 1998-10-04 18:02:24 +00:00
..
status Release 980927 1998-09-27 18:28:36 +00:00
.cvsignore Initial revision 1998-10-04 18:02:24 +00:00
Makefile.in Release 980927 1998-09-27 18:28:36 +00:00
README.documentation Release 980726 1998-07-26 14:27:39 +00:00
aspi Release 980614 1998-06-14 15:24:15 +00:00
cdrom-labels Release 980927 1998-09-27 18:28:36 +00:00
common_controls Release 980927 1998-09-27 18:28:36 +00:00
console Release 980315 1998-03-15 20:29:56 +00:00
debug-msgs Release 980614 1998-06-14 15:24:15 +00:00
debugging Release 980927 1998-09-27 18:28:36 +00:00
filehandles Release 980913 1998-09-13 16:32:00 +00:00
fonts Release 970824 1997-08-24 16:00:30 +00:00
how-to-port Release 971221 1997-12-21 19:17:50 +00:00
internal-dll Release 980822 1998-08-22 19:03:56 +00:00
internals Release 980215 1998-02-15 19:40:49 +00:00
languages Release 980215 1998-02-15 19:40:49 +00:00
printing Release 980628 1998-06-28 18:40:26 +00:00
programs Release 980517 1998-05-17 17:13:43 +00:00
shell32 Release 980913 1998-09-13 16:32:00 +00:00
ttfserver Release 980601 1998-06-01 10:44:35 +00:00
win95look Release 980927 1998-09-27 18:28:36 +00:00
wine.man Release 980712 1998-07-12 19:29:36 +00:00
wine.texinfo Release 980614 1998-06-14 15:24:15 +00:00
wine_os2 Release 970616 1997-06-16 17:43:53 +00:00
winsock Release 970525 1997-05-25 13:58:18 +00:00

README.documentation

			Wine Documentation README


Wine Man Page

  The man page for the wine emulator is in this directory. It is installed 
by 'make install'.

Wine Reference Manual

  Texinfo source for preliminary comprehensive documentation is in
this directory.  Use 'make info' in this directory to generate the GNU
info version, 'make dvi' to generate the DVI version (hit 'r' to
ignore errors), or 'make all' for both. It is not installed by
default.

Wine API documentation

  Do a 'make manpages' in the Wine toplevel directory to generate the
API manpages from the Wine source, or 'make man' in any source
subdirectory to generate manpages from only that directory. Only
functions mentioned in Wine spec files will be documented; the
specific .spec files checked are set by the MANSPECS variable in
Make.rules. The manpages will be generated into
[documentation/man3w]. For HTML formatted manpages, do 'make
htmlpages' from the toplevel, or 'make html' from any
subdirectory. HTML formatted pages are generated into
[documentation/html]. You will need c2man as modified for Wine,
available as source or binary from ftp://ftp.winehq.com/pub/wine/.
The man pages are not installed by 'make install'.

Other READMEs

  Other informational files are in this directory as well as scattered
through the source tree.

Other resources:

  Usenet: news:comp.emulators.ms-windows.wine
  WWW:    http://www.winehq.com/


Writing Wine API Documentation

To improve the documentation of the Wine API, just add comments to the
existing source. For example,

/******************************************************************
 *         CopyMetaFile32A   (GDI32.23)
 *
 *  Copies the metafile corresponding to hSrcMetaFile to either
 *  a disk file, if a filename is given, or to a new memory based
 *  metafile, if lpFileName is NULL.
 *
 * RETURNS
 *
 *  Handle to metafile copy on success, NULL on failure.
 *
 * BUGS
 *
 *  Copying to disk returns NULL even if successful.
 */
HMETAFILE32 WINAPI CopyMetaFile32A(
		   HMETAFILE32 hSrcMetaFile, /* handle of metafile to copy */
		   LPCSTR lpFilename /* filename if copying to a file */
) { ... }

becomes, after processing with c2man and nroff -man,

CopyMetaFileA(3w)                               CopyMetaFileA(3w)


NAME
       CopyMetaFileA - CopyMetaFile32A   (GDI32.23)

SYNOPSIS
       HMETAFILE32 CopyMetaFileA
       (
            HMETAFILE32 hSrcMetaFile,
            LPCSTR lpFilename
       );

PARAMETERS
       HMETAFILE32 hSrcMetaFile
              Handle of metafile to copy.

       LPCSTR lpFilename
              Filename if copying to a file.

DESCRIPTION
       Copies  the  metafile  corresponding  to  hSrcMetaFile  to
       either a disk file, if a filename is given, or  to  a  new
       memory based metafile, if lpFileName is NULL.

RETURNS
       Handle to metafile copy on success, NULL on failure.

BUGS
       Copying to disk returns NULL even if successful.

SEE ALSO
       GetMetaFileA(3w),   GetMetaFileW(3w),   CopyMetaFileW(3w),
       PlayMetaFile(3w),  SetMetaFileBitsEx(3w),  GetMetaFileBit-
       sEx(3w)