summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorBruce Momjian <bruce@momjian.us>1999-12-05 20:04:42 +0000
committerBruce Momjian <bruce@momjian.us>1999-12-05 20:04:42 +0000
commit66f8da0756e06f64a05d80226c5ac683778ccc07 (patch)
treea94fee1c3a567cccf0797cb7e59460727592a1ff /doc/src
parented62104ea90be4dbfb50e2e408342e0372a38467 (diff)
Update
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/Makefile197
-rw-r--r--doc/src/sgml/ref/droplang.sgml215
2 files changed, 412 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/Makefile b/doc/src/sgml/ref/Makefile
new file mode 100644
index 00000000000..d384c195d23
--- /dev/null
+++ b/doc/src/sgml/ref/Makefile
@@ -0,0 +1,197 @@
+#----------------------------------------------------------------------------
+#
+# Makefile
+# Postgres documentation makefile
+# Thomas Lockhart
+#
+# Copyright (c) 1994, Regents of the University of California
+#
+#
+# IDENTIFICATION
+# $Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/Makefile,v 1.1 1999/12/05 20:04:39 momjian Exp $
+#
+#----------------------------------------------------------------------------
+
+PGDOCS= ../..
+SRCDIR= ../../../src
+
+# This is where the default stylesheets appear on my linux system.
+# Probably no need to change this; rather, put definitions
+# for HSTYLE and PSTYLE and/or for HDSL and PDSL
+# in Makefile.custom in your code src directory.
+#HSTYLE=/usr/lib/sgml/stylesheets/nwalsh-modular/html
+#PSTYLE=/usr/lib/sgml/stylesheets/nwalsh-modular/print
+# This is where the production stylesheets appear on postgresql.org
+
+HSTYLE= /home/users/t/thomas/db118.d/docbook/html
+PSTYLE= /home/users/t/thomas/db118.d/docbook/print
+
+HDSL=$(HSTYLE)/docbook.dsl
+PDSL=$(PSTYLE)/docbook.dsl
+
+# Options for DocBook style sheets
+
+DBOPTS= -D ref -D ../graphics
+#DBOPTS+= -V %no-split-output% -V %no-make-index%
+# use-id-as-filename picks up the "Id=" fields to use as file names.
+# If this is omitted then file names are generic "c01.htm"
+# as in v6.3 documentation. Yuck.
+DBOPTS+= -V %use-id-as-filename%
+
+# docbook2man generates man pages from docbook refentry source code.
+# This is where the (patched) docbook2man perl scripts reside on hub.org.
+
+D2MDIR= /home/users/t/thomas/d2x/docbook2man
+D2MSCRIPT= $(D2MDIR)/docbook2man-spec.pl
+
+TAR= tar
+
+# Pick up Makefile.global from the source area
+# This is the only resource from the code source area and is optional.
+# Actually, we want this to get Makefile.custom - thomas 1998-03-01
+
+ifneq ($(wildcard $(SRCDIR)/Makefile.global),)
+ include $(SRCDIR)/Makefile.global
+endif
+
+# Hmm, made this optional but jade _really_ doesn't like them missing
+# - thomas 1998-03-01
+ifneq ($(HDSL), )
+HTMLOPTS= -d $(HDSL)
+endif
+ifneq ($(PDSL), )
+PRINTOPTS= -d $(PDSL)
+endif
+
+vpath %.sgml ./ref
+
+MANSOURCES= $(wildcard ref/*.sgml)
+
+APPLICATIONS= createdb.sgml createuser.sgml \
+ createlang.sgml \
+ dropdb.sgml dropuser.sgml \
+ droplang.sgml \
+ initdb.sgml initlocation.sgml \
+ ipcclean.sgml \
+ pg_dump.sgml \
+ pg_dumpall.sgml \
+ pg_upgrade.sgml \
+ pgaccess-ref.sgml \
+ pgadmin-ref.sgml \
+ pgtclsh.sgml \
+ pgtksh.sgml \
+ postgres-ref.sgml \
+ postmaster.sgml \
+ psql-ref.sgml \
+ vacuumdb.sgml
+
+COMMANDS= abort.sgml alter_table.sgml alter_user.sgml \
+ begin.sgml \
+ close.sgml cluster.sgml commit.sgml copy.sgml \
+ create_aggregate.sgml create_database.sgml create_function.sgml create_index.sgml \
+ create_language.sgml create_operator.sgml create_rule.sgml create_sequence.sgml \
+ create_table.sgml create_table_as.sgml create_trigger.sgml create_type.sgml \
+ create_user.sgml create_view.sgml \
+ declare.sgml delete.sgml \
+ drop_aggregate.sgml drop_database.sgml drop_function.sgml drop_index.sgml \
+ drop_language.sgml drop_operator.sgml drop_rule.sgml drop_sequence.sgml \
+ drop_table.sgml drop_trigger.sgml drop_type.sgml drop_user.sgml drop_view.sgml \
+ explain.sgml fetch.sgml grant.sgml \
+ insert.sgml listen.sgml load.sgml lock.sgml move.sgml \
+ notify.sgml \
+ reset.sgml revoke.sgml rollback.sgml \
+ select.sgml select_into.sgml set.sgml show.sgml \
+ unlisten.sgml update.sgml vacuum.sgml
+
+FUNCTIONS= current_date.sgml current_time.sgml current_timestamp.sgml current_user.sgml
+
+#APPSOURCES= $(addprefix ref/, $(APPLICATIONS))
+#SQLSOURCES= $(addprefix ref/, $(COMMANDS))
+APPSOURCES= $(APPLICATIONS)
+SQLSOURCES= $(COMMANDS)
+XAPPTARGETS= $(APPLICATIONS:.sgml=.1)
+APPTARGETS= $(XAPPTARGETS:-ref.1=.1)
+XSQLTARGETS= $(COMMANDS:.sgml=.l)
+SQLTARGETS= $(XSQLTARGETS:-ref.l=.l)
+
+.PRECIOUS: postgres.tex postgres.dvi
+.PHONY: install all clean distclean
+
+install::
+
+all::
+
+man:
+ $(MAKE) man1 manl
+ ($(RM) -r *.1 *.l man1 manl)
+ $(MAKE) man1 manl
+
+manpage.refs:
+ $(MAKE) man
+
+man1: $(APPTARGETS) manpage.refs
+ $(RM) -rf man1
+ if [ ! -d man1 ]; then mkdir man1; fi
+ cp *.1 man1/
+
+manl: $(SQLTARGETS) manpage.refs
+ $(RM) -rf manl/*
+ if [ ! -d manl ]; then mkdir manl; fi
+ cp *.l manl/
+
+clean::
+ (rm -rf HTML.manifest *.html *.htm *.1 *.l man1 manl manpage*)
+
+distclean::
+ $(MAKE) clean
+
+#
+# Generic production rules
+#
+
+%.1: %-ref.sgml
+ nsgmls $(NSGMLS_FLAGS) refentry.sgml $< \
+ | sgmlspl $(D2MSCRIPT) --lowercase --blockformat --section 1
+
+%.1: %.sgml
+ nsgmls $(NSGMLS_FLAGS) refentry.sgml $< \
+ | sgmlspl $(D2MSCRIPT) --lowercase --blockformat --section 1
+
+%.l: %.sgml
+ nsgmls $(NSGMLS_FLAGS) refentry.sgml $< \
+ | sgmlspl $(D2MSCRIPT) --lowercase --blockformat --section l
+
+# HTML
+# Include some softlinks to the generic default file names
+
+%.html: %.sgml #$(HDSL)
+ (rm -rf *.htm)
+ jade $(DBOPTS) $(HTMLOPTS) -t sgml $<
+ (ln -sf $*.htm index.html)
+ (ln -sf $*.htm $*.html)
+
+# RTF to allow minor editing for hardcopy
+# This is used for v6.3 docs
+
+%.rtf: %.sgml #$(PDSL)
+ jade $(DBOPTS) $(PRINTOPTS) -t rtf $<
+
+# TeX and DVI
+
+%.tex: %.sgml #$(PDSL)
+ jade $(DBOPTS) $(PRINTOPTS) -t tex $<
+
+%.dvi: %.tex
+ jadetex $<
+ jadetex $<
+
+# Postscript from TeX
+
+%.ps: %.dvi
+ dvips -o $@ $<
+
+# Graphics
+
+%.gif:
+ cp -p ../graphics/$@ .
+
diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml
new file mode 100644
index 00000000000..e367ed254c7
--- /dev/null
+++ b/doc/src/sgml/ref/droplang.sgml
@@ -0,0 +1,215 @@
+<!--
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.1 1999/12/05 20:04:39 momjian Exp $
+Postgres documentation
+-->
+
+<refentry id="APP-DROPLANG">
+ <refmeta>
+ <refentrytitle id="APP-DROPLANG-TITLE">
+ <application>droplang</application>
+ </refentrytitle>
+ <refmiscinfo>Application</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname id="droplang">
+ <application>droplang</application>
+ </refname>
+ <refpurpose>
+ Remove a programming language from a <productname>PostgreSQL</productname> database
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <refsynopsisdivinfo>
+ <date>1999-12-05</date>
+ </refsynopsisdivinfo>
+ <synopsis>
+droplang [ <replaceable class="parameter">connection options</replaceable> ] [ <replaceable class="parameter">langname</replaceable> [ <replaceable class="parameter">dbname</replaceable> ] ]
+droplang [ <replaceable class="parameter">connection options</replaceable> ] --list|-l
+ </synopsis>
+
+ <refsect2 id="R2-APP-DROPLANG-1">
+ <title>
+ Inputs
+ </title>
+ <para>
+ <application>droplang</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 removed.
+ <application>droplang</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 from which database the language should be removed.
+ </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>droplang</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>droplang</application> generates
+ and sends to the backend.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+ </refsect2>
+
+ <refsect2 id="R2-APP-DROPLANG-2">
+ <refsect2info>
+ <date>1999-12-05</date>
+ </refsect2info>
+ <title>
+ Outputs
+ </title>
+ <para>
+ Most error messages are self-explanatory. If not, run
+ <application>droplang</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>droplang</application> succeeds.
+ </para>
+ </refsect2>
+ </refsynopsisdiv>
+
+ <refsect1 id="R1-APP-DROPLANG-1">
+ <refsect1info>
+ <date>1999-12-05</date>
+ </refsect1info>
+ <title>
+ Description
+ </title>
+
+ <para>
+ <application>droplang</application> is a utility for removing an
+ existing programming language from a
+ <productname>PostgreSQL</productname> database.
+ <application>droplang</application> currently accepts two
+ languages, <literal>plsql</literal> and <literal>pltcl</literal>.
+ </para>
+ <para>
+ Although backend programming languages can be removed directly using
+ several <acronym>SQL</acronym> commands, it is recommended to use
+ <application>droplang</application> because it performs a number
+ of checks and is much easier to use. See
+ <xref linkend="sql-droplanguage" endterm="sql-droplanguage-title">
+ for more.
+ </para>
+ </refsect1>
+
+ <refsect1 id="R1-APP-DROPLANG-2">
+ <title>
+ Notes
+ </title>
+
+ <para>
+ Use <xref linkend="app-createlang" endterm="app-createlang-title">
+ to add a language.
+ </para>
+ </refsect1>
+
+ <refsect1 id="R1-APP-DROPLANG-3">
+ <title>
+ Usage
+ </title>
+ <para>
+ To remove <literal>pltcl</literal>:
+<programlisting>
+$ droplang 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:
+-->