summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorBruce Momjian <bruce@momjian.us>1999-12-05 20:02:49 +0000
committerBruce Momjian <bruce@momjian.us>1999-12-05 20:02:49 +0000
commited62104ea90be4dbfb50e2e408342e0372a38467 (patch)
treef093d7c4a93cdb085622ffd5f7be82f974107e4d /doc/src
parent9eb69977fe53b70a76d743278d0a2393a495c231 (diff)
I cleaned those out as well (the echo -n "bug" was in there ;) and moved
them into the scripts dir. I also added a --list option to show already installed languages. This whole moving and renaming totally confused CVS and my checked out copy got completely fried last night. When you apply the source patch, please make sure that all the directories src/bin/{create|destroy}* as well as vacuumdb, cleardbdir are gone and that all the scripts (7) are in scripts/. Meanwhile I am still puzzled about what happened with the docs patch. Because I don't know what you got now, the second attachment contains the files ref/allfiles.sgml ref/commands.sgml ref/createlang.sgml ref/droplang.sgml doc/src/sgml/Makefile Peter Eisentraut Sernanders väg 10:115
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/allfiles.sgml8
-rw-r--r--doc/src/sgml/ref/commands.sgml4
-rw-r--r--doc/src/sgml/ref/createlang.sgml213
3 files changed, 221 insertions, 4 deletions
diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml
index 000966dcd94..dc04300f2a2 100644
--- a/doc/src/sgml/ref/allfiles.sgml
+++ b/doc/src/sgml/ref/allfiles.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/allfiles.sgml,v 1.13 1999/12/04 04:53:15 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/allfiles.sgml,v 1.14 1999/12/05 20:02:42 momjian Exp $
Postgres documentation
Complete list of usable sgml source files in this directory.
-->
@@ -100,9 +100,11 @@ Complete list of usable sgml source files in this directory.
<!-- these are in the "utilities" reference chapter -->
<!entity createdb system "createdb.sgml">
+<!entity createlang system "createlang.sgml">
<!entity createuser system "createuser.sgml">
-<!entity dropdb system "dropdb.sgml">
-<!entity dropuser system "dropuser.sgml">
+<!entity dropdb system "dropdb.sgml">
+<!entity droplang system "droplang.sgml">
+<!entity dropuser system "dropuser.sgml">
<!entity ecpgRef system "ecpg-ref.sgml">
<!entity initdb system "initdb.sgml">
<!entity initlocation system "initlocation.sgml">
diff --git a/doc/src/sgml/ref/commands.sgml b/doc/src/sgml/ref/commands.sgml
index 37da8bef8e5..a8f32017393 100644
--- a/doc/src/sgml/ref/commands.sgml
+++ b/doc/src/sgml/ref/commands.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/commands.sgml,v 1.20 1999/12/04 04:53:15 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/commands.sgml,v 1.21 1999/12/05 20:02:42 momjian Exp $
Postgres documentation
-->
@@ -107,8 +107,10 @@ functions supported by <productname>Postgres</productname>.
</abstract>
&createdb;
+ &createlang;
&createuser;
&dropdb;
+ &droplang;
&dropuser;
&ecpgRef;
&pgAccess;
diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml
index e69de29bb2d..309a80266df 100644
--- a/doc/src/sgml/ref/createlang.sgml
+++ b/doc/src/sgml/ref/createlang.sgml
@@ -0,0 +1,213 @@
+<!--
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.3 1999/12/05 20:02:42 momjian 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>PostgreSQL</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>
+
+ <varlistentry>
+ <term>-e, --echo</term>
+ <listitem>
+ <para>
+ Echo the commands that <application>createlang</application> generates
+ and sends to the backend.
+ </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>
+ <para>
+ No output is generated if <application>createlang</application> succeeds.
+ </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>PostgreSQL</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:
+-->