granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/createlang.sgml

   1 <!--
   2 $Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.9 2000/11/04 21:09:41 momjian Exp $
   3 Postgres documentation
   4 -->
   5
   6 <refentry id="APP-CREATELANG">
   7  <refmeta>
   8   <refentrytitle id="APP-CREATELANG-TITLE">
   9    <application>createlang</application>
  10   </refentrytitle>
  11   <refmiscinfo>Application</refmiscinfo>
  12  </refmeta>
  13  <refnamediv>
  14   <refname id="createlang">
  15    <application>createlang</application>
  16   </refname>
  17   <refpurpose>
  18    Add a new programming language to a <productname>Postgres</productname> database
  19   </refpurpose>
  20  </refnamediv>
  21  <refsynopsisdiv>
  22   <refsynopsisdivinfo>
  23    <date>1999-12-05</date>
  24   </refsynopsisdivinfo>
  25   <synopsis>
  26 createlang [ <replaceable class="parameter">connection options</replaceable> ] [ <replaceable class="parameter">langname</replaceable> [ <replaceable class="parameter">dbname</replaceable> ] ]
  27 createlang [ <replaceable class="parameter">connection options</replaceable> ] --list|-l [ <replaceable class="parameter">dbname</replaceable> ]
  28   </synopsis>
  29
  30   <refsect2 id="R2-APP-CREATELANG-1">
  31    <title>
  32     Inputs
  33    </title>
  34    <para>
  35     <application>createlang</application> accepts the following command line arguments:
  36
  37     <variablelist>
  38      <varlistentry>
  39       <term><replaceable class="parameter">langname</replaceable></term>
  40       <listitem>
  41        <para>
  42         Specifies the name of the backend programming language to be defined.
  43         <application>createlang</application> will prompt for
  44         <replaceable class="parameter">langname</replaceable>
  45         if it is not specified on the command line.
  46        </para>
  47       </listitem>
  48      </varlistentry>
  49
  50      <varlistentry>
  51       <term>-d, --dbname <replaceable class="parameter">dbname</replaceable></term>
  52       <listitem>
  53        <para>
  54         Specifies which database the language should be added.
  55        </para>
  56       </listitem>
  57      </varlistentry>
  58
  59      <varlistentry>
  60       <term>-l, --list</term>
  61       <listitem>
  62        <para>
  63         Shows a list of already installed languages in the target database
  64         (which must be specified).
  65        </para>
  66       </listitem>
  67      </varlistentry>
  68
  69     </variablelist>
  70    </para>
  71
  72    <para>
  73     <application>createlang</application> also accepts
  74     the following command line arguments for connection parameters:
  75
  76     <variablelist>
  77      <varlistentry>
  78       <term>-h, --host <replaceable class="parameter">host</replaceable></term>
  79       <listitem>
  80        <para>
  81         Specifies the hostname of the machine on which the
  82         <application>postmaster</application>
  83         is running.
  84        </para>
  85       </listitem>
  86      </varlistentry>
  87
  88      <varlistentry>
  89       <term>-p, --port <replaceable class="parameter">port</replaceable></term>
  90       <listitem>
  91        <para>
  92         Specifies the Internet TCP/IP port or local Unix domain socket file
  93         extension on which the <application>postmaster</application>
  94         is listening for connections.
  95        </para>
  96       </listitem>
  97      </varlistentry>
  98
  99      <varlistentry>
 100       <term>-U, --username <replaceable class="parameter">username</replaceable></term>
 101       <listitem>
 102        <para>
 103         Username to connect as.
 104        </para>
 105       </listitem>
 106      </varlistentry>
 107
 108      <varlistentry>
 109       <term>-W, --password</term>
 110       <listitem>
 111        <para>
 112         Force password prompt.
 113        </para>
 114       </listitem>
 115      </varlistentry>
 116
 117     </variablelist>
 118    </para>
 119   </refsect2>
 120
 121   <refsect2 id="R2-APP-CREATELANG-2">
 122    <refsect2info>
 123     <date>1998-10-04</date>
 124    </refsect2info>
 125    <title>
 126     Outputs
 127    </title>
 128    <para>
 129     Most error messages are self-explanatory. If not, run
 130     <application>createlang</application> with the <option>--echo</option>
 131     option and see under the respective <acronym>SQL</acronym> command
 132     for details. Check also under <xref linkend="APP-PSQL" endterm="APP-PSQL-title">
 133     for more possibilities.
 134    </para>
 135   </refsect2>
 136  </refsynopsisdiv>
 137
 138  <refsect1 id="R1-APP-CREATELANG-1">
 139   <refsect1info>
 140    <date>1999-12-05</date>
 141   </refsect1info>
 142   <title>
 143    Description
 144   </title>
 145
 146   <para>
 147    <application>createlang</application> is a utility for adding a new
 148    programming language to a <productname>Postgres</productname> database.
 149    <application>createlang</application> currently accepts several
 150    languages, <literal>plpgsql, pltcl, pltclu,</literal> and <literal>
 151    plperl</literal>.
 152   </para>
 153   <para>
 154    Although backend programming languages can be added directly using
 155    several <acronym>SQL</acronym> commands, it is recommended to use
 156    <application>createlang</application> because it performs a number
 157    of checks and is much easier to use. See
 158    <xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
 159    for more.
 160   </para>
 161  </refsect1>
 162
 163  <refsect1 id="R1-APP-CREATELANG-2">
 164   <title>
 165    Notes
 166   </title>
 167   <para>
 168    Use <xref linkend="app-droplang" endterm="app-droplang-title">
 169    to remove a language.
 170   </para>
 171  </refsect1>
 172
 173  <refsect1 id="R1-APP-CREATELANG-3">
 174   <title>
 175    Usage
 176   </title>
 177   <para>
 178    To install <literal>pltcl</literal>:
 179 <programlisting>
 180 $ createlang pltcl dbname
 181 </programlisting>
 182   </para>
 183  </refsect1>
 184 </refentry>
 185
 186 <!-- Keep this comment at the end of the file
 187 Local variables:
 188 mode: sgml
 189 sgml-omittag:nil
 190 sgml-shorttag:t
 191 sgml-minimize-attributes:nil
 192 sgml-always-quote-attributes:t
 193 sgml-indent-step:1
 194 sgml-indent-data:t
 195 sgml-parent-document:nil
 196 sgml-default-dtd-file:"../reference.ced"
 197 sgml-exposed-tags:nil
 198 sgml-local-catalogs:"/usr/lib/sgml/catalog"
 199 sgml-local-ecat-files:nil
 200 End:
 201 -->