<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.5 2000/03/27 17:14:42 thomas Exp $
Postgres documentation
-->

<refentry id="APP-CREATELANG">
 <refmeta>
  <refentrytitle id="APP-CREATELANG-TITLE">
   <application>createlang</application>
  </refentrytitle>
  <refmiscinfo>Application</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname id="createlang">
   <application>createlang</application>
  </refname>
  <refpurpose>
   Add a new programming language to a <productname>Postgres</productname> database
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1999-12-05</date>
  </refsynopsisdivinfo>
  <synopsis>
createlang [ <replaceable class="parameter">connection options</replaceable> ] [ <replaceable class="parameter">langname</replaceable> [ <replaceable class="parameter">dbname</replaceable> ] ]
createlang [ <replaceable class="parameter">connection options</replaceable> ] --list|-l
  </synopsis>

  <refsect2 id="R2-APP-CREATELANG-1">
   <title>
    Inputs
   </title>
   <para>
    <application>createlang</application> accepts the following command line arguments:
    
    <variablelist>
     <varlistentry>
      <term><replaceable class="parameter">langname</replaceable></term>
      <listitem>
       <para>
	Specifies the name of the backend programming language to be defined.
	<application>createlang</application> will prompt for
	<replaceable class="parameter">langname</replaceable>
	if it is not specified on the command line.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>[-d, --dbname] <replaceable class="parameter">dbname</replaceable></term>
      <listitem>
       <para>
	Specifies to which database the language should be added.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-l, --list</term>
      <listitem>
       <para>
        Shows a list of already installed languages in the target database
        (which must be specified).
       </para>
      </listitem>
     </varlistentry>

    </variablelist>
   </para>

   <para>
    <application>createlang</application> also accepts 
    the following command line arguments for connection parameters:
    
    <variablelist>
     <varlistentry>
      <term>-h, --host <replaceable class="parameter">host</replaceable></term>
      <listitem>
       <para>
	Specifies the hostname of the machine on which the 
	<application>postmaster</application>
	is running.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-p, --port <replaceable class="parameter">port</replaceable></term>
      <listitem>
       <para>
	Specifies the Internet TCP/IP port or local Unix domain socket file 
	extension on which the <application>postmaster</application>
	is listening for connections.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-U, --username <replaceable class="parameter">username</replaceable></term>
      <listitem>
       <para>
        Username to connect as.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-W, --password</term>
      <listitem>
       <para>
        Force password prompt.
       </para>
      </listitem>
     </varlistentry>

    </variablelist>
   </para>
  </refsect2>

  <refsect2 id="R2-APP-CREATELANG-2">
   <refsect2info>
    <date>1998-10-04</date>
   </refsect2info>
   <title>
    Outputs
   </title>
   <para>
    Most error messages are self-explanatory. If not, run
    <application>createlang</application> with the <option>--echo</option>
    option and see under the respective <acronym>SQL</acronym> command
    for details. Check also under <xref linkend="APP-PSQL" endterm="APP-PSQL-title">
    for more possibilities.
   </para>
  </refsect2>
 </refsynopsisdiv>
 
 <refsect1 id="R1-APP-CREATELANG-1">
  <refsect1info>
   <date>1999-12-05</date>
  </refsect1info>
  <title>
   Description
  </title>

  <para>
   <application>createlang</application> is a utility for adding a new 
   programming language to a <productname>Postgres</productname> database.
   <application>createlang</application> currently accepts two
   languages, <literal>plsql</literal> and <literal>pltcl</literal>.
  </para>
  <para>
   Although backend programming languages can be added directly using
   several <acronym>SQL</acronym> commands, it is recommended to use
   <application>createlang</application> because it performs a number
   of checks and is much easier to use. See
   <xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
   for more.
  </para>
 </refsect1>

 <refsect1 id="R1-APP-CREATELANG-2">
  <title>
   Notes
  </title>
  <para>
   Use <xref linkend="app-droplang" endterm="app-droplang-title">
   to remove a language.
  </para>
 </refsect1>
 
 <refsect1 id="R1-APP-CREATELANG-3">
  <title>
   Usage
  </title>
  <para>
   To install <literal>pltcl</literal>:
<programlisting>
$ createlang pltcl
</programlisting>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
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:
-->
