documentation/README.documentation

   1
   2                         Wine Documentation README
   3
   4
   5 Wine Man Page
   6
   7   The man page for the wine emulator is in this directory. It is installed
   8 by 'make install'.
   9
  10 Wine Reference Manual
  11
  12   Texinfo source for preliminary comprehensive documentation is in
  13 this directory.  Use 'make info' in this directory to generate the GNU
  14 info version, 'make dvi' to generate the DVI version (hit 'r' to
  15 ignore errors), or 'make all' for both. It is not installed by
  16 default.
  17
  18 Wine API documentation
  19
  20   Do a 'make manpages' in the Wine toplevel directory to generate the
  21 API manpages from the Wine source, or 'make man' in any source
  22 subdirectory to generate manpages from only that directory. Only
  23 functions mentioned in Wine spec files will be documented; the
  24 specific .spec files checked are set by the MANSPECS variable in
  25 Make.rules. The manpages will be generated into
  26 [documentation/man3w]. For HTML formatted manpages, do 'make
  27 htmlpages' from the toplevel, or 'make html' from any
  28 subdirectory. HTML formatted pages are generated into
  29 [documentation/html]. You will need c2man as modified for Wine,
  30 available as source or binary from ftp://ftp.winehq.com/pub/wine/.
  31 The man pages are not installed by 'make install'.
  32
  33 Other READMEs
  34
  35   Other informational files are in this directory as well as scattered
  36 through the source tree.
  37
  38 Other resources:
  39
  40   Usenet: news:comp.emulators.ms-windows.wine
  41   WWW:    http://www.winehq.com/
  42
  43
  44 Writing Wine API Documentation
  45
  46 To improve the documentation of the Wine API, just add comments to the
  47 existing source. For example,
  48
  49 /******************************************************************
  50  *         CopyMetaFile32A   (GDI32.23)
  51  *
  52  *  Copies the metafile corresponding to hSrcMetaFile to either
  53  *  a disk file, if a filename is given, or to a new memory based
  54  *  metafile, if lpFileName is NULL.
  55  *
  56  * RETURNS
  57  *
  58  *  Handle to metafile copy on success, NULL on failure.
  59  *
  60  * BUGS
  61  *
  62  *  Copying to disk returns NULL even if successful.
  63  */
  64 HMETAFILE32 WINAPI CopyMetaFile32A(
  65                    HMETAFILE32 hSrcMetaFile, /* handle of metafile to copy */
  66                    LPCSTR lpFilename /* filename if copying to a file */
  67 ) { ... }
  68
  69 becomes, after processing with c2man and nroff -man,
  70
  71 CopyMetaFileA(3w)                               CopyMetaFileA(3w)
  72
  73
  74 NAME
  75        CopyMetaFileA - CopyMetaFile32A   (GDI32.23)
  76
  77 SYNOPSIS
  78        HMETAFILE32 CopyMetaFileA
  79        (
  80             HMETAFILE32 hSrcMetaFile,
  81             LPCSTR lpFilename
  82        );
  83
  84 PARAMETERS
  85        HMETAFILE32 hSrcMetaFile
  86               Handle of metafile to copy.
  87
  88        LPCSTR lpFilename
  89               Filename if copying to a file.
  90
  91 DESCRIPTION
  92        Copies  the  metafile  corresponding  to  hSrcMetaFile  to
  93        either a disk file, if a filename is given, or  to  a  new
  94        memory based metafile, if lpFileName is NULL.
  95
  96 RETURNS
  97        Handle to metafile copy on success, NULL on failure.
  98
  99 BUGS
 100        Copying to disk returns NULL even if successful.
 101
 102 SEE ALSO
 103        GetMetaFileA(3w),   GetMetaFileW(3w),   CopyMetaFileW(3w),
 104        PlayMetaFile(3w),  SetMetaFileBitsEx(3w),  GetMetaFileBit-
 105        sEx(3w)