postgres/doc/src/sgml/install-win32.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/install-win32.sgml,v 1.14 2003/09/30 01:26:29 tgl Exp $
-->

<chapter id="install-win32">
 <title>Installation on <productname>Windows</productname></title>

 <indexterm>
  <primary>installation</primary>
  <secondary>on Windows</secondary>
 </indexterm>

 <para>
  Although <productname>PostgreSQL</productname> is written for
  Unix-like operating systems, the C client library
  (<application>libpq</application>) and the interactive terminal
  (<application>psql</application>) can be compiled natively under
  Windows.  The makefiles included in the source distribution are
  written for <productname>Microsoft Visual C++</productname> and will
  probably not work with other systems.  It should be possible to
  compile the libraries manually in other cases.
 </para>

 <tip>
  <para>
   If you are using Windows 98 or newer you can build and use all of
   <productname>PostgreSQL</productname> <quote>the Unix way</quote>
   if you install the <productname>Cygwin</productname> toolkit first.
   In that case see <xref linkend="installation">.
  </para>
 </tip>

 <para>
  To build everything that you can on
  <productname>Windows</productname>, change into the
  <filename>src</filename> directory and type the command
<screen>
<userinput>nmake /f win32.mak</userinput>
</screen>
  This assumes that you have <productname>Visual C++</productname> in
  your path.
 </para>

 <para>
  The following files will be built:

  <variablelist>
   <varlistentry>
    <term><filename>interfaces\libpq\Release\libpq.dll</filename></term>
    <listitem>
     <para>
      The dynamically linkable frontend library
     </para>
    </listitem>
   </varlistentry>
  
   <varlistentry>
    <term><filename>interfaces\libpq\Release\libpqdll.lib</filename></term>
    <listitem>
     <para>
      Import library to link your programs to <filename>libpq.dll</filename>
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><filename>interfaces\libpq\Release\libpq.lib</filename></term>
    <listitem>
     <para>
      Static library version of the frontend library
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><filename>bin\psql\Release\psql.exe</filename></term>
    <listitem>
     <para>
      The <productname>PostgreSQL</productname> interactive terminal
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>

 <para>
  The only file that really needs to be installed is the
  <filename>libpq.dll</filename> library.  This file should in most
  cases be placed in the <filename>WINNT\SYSTEM32</filename> directory
  (or in <filename>WINDOWS\SYSTEM</filename> on a Windows 95/98/ME
  system).  If this file is installed using a setup program, it should
  be installed with version checking using the
  <symbol>VERSIONINFO</symbol> resource included in the file, to
  ensure that a newer version of the library is not overwritten.
 </para>

 <para>
  If you plan to do development using <application>libpq</application> on this machine, you will
  have to add the <filename>src\include</filename> and
  <filename>src\interfaces\libpq</filename> subdirectories of the
  source tree to the include path in your compilers settings.
 </para>

 <para>
  To use the library, you must add the
  <filename>libpqdll.lib</filename> file to your project.  (In Visual
  C++, just right-click on the project and choose to add it.)
 </para>

 <para>
  <application>psql</application> is compiled as a <quote>console
  application</>. As 
  the Win32 console windows use a different encoding than the rest of the
  system, you must take special care when using 8-bit characters (eg. German
  umlauts) at the <application>psql</application> prompt. When
  <application>psql</application> detects a problematic console codepage, it
  will warn you at startup. To change the console codepage, two things are
  neccessary:

   <itemizedlist>
    <listitem>
     <para>
      Set the codepage with <userinput>cmd.exe /c chcp 1252</userinput>
      (1252 is the German value, replace it with your value). If you are using
      cygwin, you can put this command in <filename>/etc/profile</filename>.
     </para>
    </listitem>

    <listitem>
     <para>
      Set the console font to <quote>Lucida Console</>, because the raster font
      does not work with the ANSI codepage.
     </para>
    </listitem>
   </itemizedlist>
 </para>

</chapter>

<!-- Keep this comment at the end of the file
Local variables:
mode:sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:("/usr/lib/sgml/catalog")
sgml-local-ecat-files:nil
End:
-->