<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.10 2000/03/27 17:14:42 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.11 2000/11/11 23:01:38 petere Exp $
Postgres documentation
-->
<refentry id="APP-CREATEDB" xreflabel="createdb">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-CREATEDB-TITLE">
- <application>createdb</application>
- </refentrytitle>
+ <refentrytitle id="APP-CREATEDB-TITLE"><application>createdb</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>createdb</application>
- </refname>
- <refpurpose>
- Create a new <productname>Postgres</productname> database
- </refpurpose>
+ <refname>createdb</refname>
+ <refpurpose>Create a new <productname>Postgres</productname> database</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>1999-11-07</date>
- </refsynopsisdivinfo>
- <synopsis>
-createdb [ <replaceable class="parameter">options</replaceable> ] <replaceable class="parameter">dbname</replaceable> [ <replaceable class="parameter">description</replaceable> ]
- </synopsis>
+ <cmdsynopsis>
+ <command>createdb</command>
+ <arg rep="repeat"><replaceable>options</replaceable></arg>
+ <arg choice="plain"><replaceable>dbname</replaceable></arg>
+ <arg><replaceable>description</replaceable></arg>
+ </cmdsynopsis>
<refsect2 id="R2-APP-CREATEDB-1">
- <refsect2info>
- <date>1999-11-07</date>
- </refsect2info>
<title>
Inputs
</title>
<term>-D, --location <replaceable class="parameter">datadir</replaceable></term>
<listitem>
<para>
- Specifies the alternate database location for this database installation.
- This is the location of the installation system tables, not the location
- of this specific database, which may be different.
+ Specifies the alternative database location. See also <xref
+ linkend="app-initlocation" endterm="app-initlocation-title">.
</para>
</listitem>
</varlistentry>
</refsect2>
<refsect2 id="R2-APP-CREATEDB-2">
- <refsect2info>
- <date>1999-11-07</date>
- </refsect2info>
<title>
Outputs
</title>
</refsynopsisdiv>
<refsect1 id="R1-APP-CREATEDB-1">
- <refsect1info>
- <date>1999-11-07</date>
- </refsect1info>
<title>
Description
</title>
</refsect1>
<refsect1 id="R1-APP-CREATEDB-2">
- <refsect1info>
- <date>1999-11-07</date>
- </refsect1info>
- <title>
- Usage
- </title>
- <para>
- To create the database <literal>demo</literal>
- using the default database server:
+ <title>Usage</title>
- <programlisting>
-$ <userinput>createdb demo</userinput>
-CREATE DATABASE
- </programlisting>
-
- The response is the same as you would have gotten from running the
- <command>CREATE DATABASE</command> <acronym>SQL</acronym> command.
- </para>
-
- <para>
- To create the database <literal>demo</literal>
- using the postmaster on host eden, port 5000, using the <literal>LATIN1</literal>
- encoding scheme with a look at the underlying query:
+ <informalexample>
+ <para>
+ To create the database <literal>demo</literal> using the default
+ database server:
+<screen>
+<prompt>$ </prompt><userinput>createdb demo</userinput>
+<computeroutput>CREATE DATABASE</computeroutput>
+</screen>
+ The response is the same as you would have gotten from running the
+ <command>CREATE DATABASE</command> <acronym>SQL</acronym> command.
+ </para>
+ </informalexample>
- <programlisting>
-$ <userinput>createdb -p 5000 -h eden -E LATIN1 -e demo</userinput>
-CREATE DATABASE "demo" WITH ENCODING = 'LATIN1'
-CREATE DATABASE
- </programlisting>
- </para>
+ <informalexample>
+ <para>
+ To create the database <literal>demo</literal> using the
+ postmaster on host eden, port 5000, using the
+ <literal>LATIN1</literal> encoding scheme with a look at the
+ underlying query:
+<screen>
+<prompt>$ </prompt><userinput>createdb -p 5000 -h eden -E LATIN1 -e demo</userinput>
+<computeroutput>CREATE DATABASE "demo" WITH ENCODING = 'LATIN1'</computeroutput>
+<computeroutput>CREATE DATABASE</computeroutput>
+</screen>
+ </para>
+ </informalexample>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.9 2000/11/04 21:09:41 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.10 2000/11/11 23:01:38 petere Exp $
Postgres documentation
-->
<refentry id="APP-CREATELANG">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-CREATELANG-TITLE">
- <application>createlang</application>
- </refentrytitle>
+ <refentrytitle id="APP-CREATELANG-TITLE"><application>createlang</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<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>
+ <refname id="createlang">createlang</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 [ <replaceable class="parameter">dbname</replaceable> ]
- </synopsis>
+ <cmdsynopsis>
+ <command>createlang</command>
+ <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
+ <arg><replaceable>langname</replaceable></arg>
+ <arg choice="plain"><replaceable>dbname</replaceable></arg>
+ <sbr>
+ <command>createlang</command>
+ <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
+ <group choice="plain"><arg>--list</arg><arg>-l</arg></group>
+ <arg choice="plain"><replaceable>dbname</replaceable></arg>
+ </cmdsynopsis>
<refsect2 id="R2-APP-CREATELANG-1">
<title>
</refsect2>
<refsect2 id="R2-APP-CREATELANG-2">
- <refsect2info>
- <date>1998-10-04</date>
- </refsect2info>
<title>
Outputs
</title>
</refsynopsisdiv>
<refsect1 id="R1-APP-CREATELANG-1">
- <refsect1info>
- <date>1999-12-05</date>
- </refsect1info>
<title>
Description
</title>
</refsect1>
<refsect1 id="R1-APP-CREATELANG-3">
- <title>
- Usage
- </title>
- <para>
- To install <literal>pltcl</literal>:
-<programlisting>
-$ createlang pltcl dbname
-</programlisting>
- </para>
+ <title>Usage</title>
+
+ <informalexample>
+ <para>
+ To install <literal>pltcl</literal> into the database
+ <literal>template1</literal>:
+<screen>
+<prompt>$ </prompt><userinput>createlang pltcl template1</userinput>
+</screen>
+ </para>
+ </informalexample>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.9 2000/03/27 17:14:42 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.10 2000/11/11 23:01:40 petere Exp $
Postgres documentation
-->
<refentry id="APP-CREATEUSER">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-CREATEUSER-TITLE">
- <application>createuser</application>
- </refentrytitle>
+ <refentrytitle id="APP-CREATEUSER-TITLE"><application>createuser</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>createuser</application>
- </refname>
- <refpurpose>
- Create a new <productname>Postgres</productname> user
- </refpurpose>
+ <refname>createuser</refname>
+ <refpurpose>Create a new <productname>Postgres</productname> user</refpurpose>
</refnamediv>
- <refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>1999-11-07</date>
- </refsynopsisdivinfo>
- <synopsis>
-createuser [ <replaceable class="parameter">options</replaceable> ] [ <replaceable class="parameter">username</replaceable> ]
- </synopsis>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>createuser</command>
+ <arg rep="repeat"><replaceable>options</replaceable></arg>
+ <arg><replaceable>username</replaceable></arg>
+ </cmdsynopsis>
<refsect2 id="R2-APP-CREATEUSER-1">
- <refsect2info>
- <date>1999-11-07</date>
- </refsect2info>
<title>
Inputs
</title>
</refsect2>
<refsect2 id="R2-APP-CREATEUSER-2">
- <refsect2info>
- <date>1999-11-07</date>
- </refsect2info>
<title>
Outputs
</title>
</refsynopsisdiv>
<refsect1 id="R1-APP-CREATEUSER-1">
- <refsect1info>
- <date>1998-11-07</date>
- </refsect1info>
<title>
Description
</title>
<refsect1 id="R1-APP-CREATEUSER-2">
- <refsect1info>
- <date>1999-11-07</date>
- </refsect1info>
- <title>
- Usage
- </title>
- <para>
- To create a user <literal>joe</literal>
- on the default database server:
+ <title>Usage</title>
- <programlisting>
-$ <userinput>createuser joe</userinput>
-Is the new user allowed to create databases? (y/n) <userinput>n</userinput>
-Shall the new user be allowed to create more new users? (y/n) <userinput>n</userinput>
-CREATE USER
- </programlisting>
- </para>
-
- <para>
- To create the same user <literal>joe</literal>
- using the postmaster on host eden, port 5000, avoiding
- the prompts and taking a look at the underlying query:
+ <informalexample>
+ <para>
+ To create a user <literal>joe</literal> on the default database
+ server:
+<screen>
+<prompt>$ </prompt><userinput>createuser joe</userinput>
+<computeroutput>Is the new user allowed to create databases? (y/n) </computeroutput><userinput>n</userinput>
+<computeroutput>Shall the new user be allowed to create more new users? (y/n) </computeroutput><userinput>n</userinput>
+<computeroutput>CREATE USER</computeroutput>
+</screen>
+ </para>
+ </informalexample>
- <programlisting>
-$ <userinput>createuser -p 5000 -h eden -D -A -e joe</userinput>
-CREATE USER "joe" NOCREATEDB NOCREATEUSER
-CREATE USER
- </programlisting>
- </para>
+ <informalexample>
+ <para>
+ To create the same user <literal>joe</literal> using the
+ postmaster on host eden, port 5000, avoiding the prompts and
+ taking a look at the underlying query:
+<screen>
+<prompt>$ </prompt><userinput>createuser -p 5000 -h eden -D -A -e joe</userinput>
+<computeroutput>CREATE USER "joe" NOCREATEDB NOCREATEUSER</computeroutput>
+<computeroutput>CREATE USER</computeroutput>
+</screen>
+ </para>
+ </informalexample>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_database.sgml,v 1.10 2000/10/05 19:48:18 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_database.sgml,v 1.11 2000/11/11 23:01:43 petere Exp $
Postgres documentation
-->
-<refentry id="SQL-DROPDATABASE" xreflabel="drop_database">
+<refentry id="SQL-DROPDATABASE">
<refmeta>
<refentrytitle id="SQL-DROPDATABASE-TITLE">
DROP DATABASE
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.3 2000/03/27 17:14:43 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.4 2000/11/11 23:01:45 petere Exp $
Postgres documentation
-->
<refentry id="APP-DROPDB">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-DROPDB-TITLE">
- <application>dropdb</application>
- </refentrytitle>
+ <refentrytitle id="APP-DROPDB-TITLE"><application>dropdb</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>dropdb</application>
- </refname>
- <refpurpose>
- Remove an existing <productname>Postgres</productname> database
- </refpurpose>
+ <refname>dropdb</refname>
+ <refpurpose>Remove an existing <productname>Postgres</productname> database</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>1999-11-07</date>
- </refsynopsisdivinfo>
- <synopsis>
-dropdb [ <replaceable class="parameter">options</replaceable> ] <replaceable class="parameter">dbname</replaceable>
- </synopsis>
+ <cmdsynopsis>
+ <command>dropdb</command>
+ <arg rep="repeat"><replaceable>options</replaceable></arg>
+ <arg choice="plain"><replaceable>dbname</replaceable></arg>
+ </cmdsynopsis>
<refsect2 id="R2-APP-DROPDB-1">
- <refsect2info>
- <date>1999-11-07</date>
- </refsect2info>
<title>
Inputs
</title>
<refsect2 id="R2-APP-DROPDB-2">
- <refsect2info>
- <date>1998-10-02</date>
- </refsect2info>
<title>
Outputs
</title>
<refsect1 id="R1-APP-DROPDB-1">
- <refsect1info>
- <date>1998-10-02</date>
- </refsect1info>
<title>
Description
</title>
</refsect1>
<refsect1 id="R1-APP-DROPDB-2">
- <refsect1info>
- <date>1999-11-07</date>
- </refsect1info>
- <title>
- Usage
- </title>
- <para>
- To destroy the database <literal>demo</literal>
- on the default database server:
- <programlisting>
-$ <userinput>dropdb demo</userinput>
-DROP DATABASE
- </programlisting>
- </para>
- <para>
- To destroy the database <literal>demo</literal>
- using the postmaster on host eden, port 5000, with verification
- and a peek at the underlying query:
- <programlisting>
-$ <userinput>dropdb -p 5000 -h eden -i -e demo</userinput>
-Database "demo" will be permanently deleted.
-Are you sure? (y/n) <userinput>y</userinput>
-DROP DATABASE "demo"
-DROP DATABASE
- </programlisting>
- </para>
+ <title>Usage</title>
+
+ <informalexample>
+ <para>
+ To destroy the database <literal>demo</literal> on the default
+ database server:
+<screen>
+<prompt>$ </prompt><userinput>dropdb demo</userinput>
+<computeroutput>DROP DATABASE</computeroutput>
+</screen>
+ </para>
+ </informalexample>
+
+ <informalexample>
+ <para>
+ To destroy the database <literal>demo</literal> using the
+ postmaster on host eden, port 5000, with verification and a peek
+ at the underlying query:
+<screen>
+<prompt>$ </prompt><userinput>dropdb -p 5000 -h eden -i -e demo</userinput>
+<computeroutput>Database "demo" will be permanently deleted.
+Are you sure? (y/n) </computeroutput><userinput>y</userinput>
+<computeroutput>DROP DATABASE "demo"
+DROP DATABASE</computeroutput>
+</screen>
+ </para>
+ </informalexample>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.3 2000/03/27 17:14:43 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.4 2000/11/11 23:01:45 petere Exp $
Postgres documentation
-->
<refentry id="APP-DROPLANG">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-DROPLANG-TITLE">
- <application>droplang</application>
- </refentrytitle>
+ <refentrytitle id="APP-DROPLANG-TITLE"><application>droplang</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname id="droplang">
- <application>droplang</application>
- </refname>
- <refpurpose>
- Remove a programming language from a <productname>Postgres</productname> database
- </refpurpose>
+ <refname id="droplang">droplang</refname>
+ <refpurpose>Remove a programming language from a <productname>Postgres</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>
+ <cmdsynopsis>
+ <command>droplang</command>
+ <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
+ <arg><replaceable>langname</replaceable></arg>
+ <arg choice="plain"><replaceable>dbname</replaceable></arg>
+ <sbr>
+ <command>droplang</command>
+ <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
+ <group choice="plain"><arg>--list</arg><arg>-l</arg></group>
+ <arg choice="plain"><replaceable>dbname</replaceable></arg>
+ </cmdsynopsis>
<refsect2 id="R2-APP-DROPLANG-1">
<title>
</refsect2>
<refsect2 id="R2-APP-DROPLANG-2">
- <refsect2info>
- <date>1999-12-05</date>
- </refsect2info>
<title>
Outputs
</title>
</refsynopsisdiv>
<refsect1 id="R1-APP-DROPLANG-1">
- <refsect1info>
- <date>1999-12-05</date>
- </refsect1info>
<title>
Description
</title>
</refsect1>
<refsect1 id="R1-APP-DROPLANG-3">
- <title>
- Usage
- </title>
- <para>
- To remove <literal>pltcl</literal>:
-<programlisting>
-$ droplang pltcl
-</programlisting>
- </para>
+ <title>Usage</title>
+
+ <informalexample>
+ <para>
+ To remove <literal>pltcl</literal>:
+<screen>
+<prompt>$ </prompt><userinput>droplang pltcl</userinput>
+</screen>
+ </para>
+ </informalexample>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.4 2000/03/27 17:14:43 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.5 2000/11/11 23:01:45 petere Exp $
Postgres documentation
-->
<refentry id="APP-DROPUSER">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-DROPUSER-TITLE">
- <application>dropuser</application>
- </refentrytitle>
+ <refentrytitle id="APP-DROPUSER-TITLE"><application>dropuser</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>dropuser</application>
- </refname>
- <refpurpose>
- Drops (removes) a <productname>Postgres</productname> user
- </refpurpose>
+ <refname>dropuser</refname>
+ <refpurpose>Drops (removes) a <productname>Postgres</productname> user</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>1999-11-07</date>
- </refsynopsisdivinfo>
- <synopsis>
-dropuser [ <replaceable class="parameter">options</replaceable> ] [ <replaceable class="parameter">username</replaceable> ]
- </synopsis>
+ <cmdsynopsis>
+ <command>dropuser</command>
+ <arg rep="repeat"><replaceable>options</replaceable></arg>
+ <arg><replaceable>username</replaceable></arg>
+ </cmdsynopsis>
<refsect2 id="R2-APP-DROPUSER-1">
- <refsect2info>
- <date>1999-11-07</date>
- </refsect2info>
<title>
Inputs
</title>
</refsect2>
<refsect2 id="R2-APP-DROPUSER-2">
- <refsect2info>
- <date>1999-11-07</date>
- </refsect2info>
<title>
Outputs
</title>
</refsynopsisdiv>
<refsect1 id="R1-APP-DROPUSER-1">
- <refsect1info>
- <date>1999-11-07</date>
- </refsect1info>
<title>
Description
</title>
</refsect1>
<refsect1 id="R1-APP-DROPUSER-2">
- <refsect1info>
- <date>1999-11-07</date>
- </refsect1info>
- <title>
- Usage
- </title>
- <para>
- To remove user <literal>joe</literal>
- from the default database server:
- <programlisting>
-$ <userinput>dropuser joe</userinput>
-DROP USER
- </programlisting>
- </para>
+ <title>Usage</title>
- <para>
- To remove user <literal>joe</literal>
- using the postmaster on host eden, port 5000, with verification
- and a peek at the underlying query:
- <programlisting>
-$ <userinput>dropuser -p 5000 -h eden -i -e joe</userinput>
-User "joe" and any owned databases will be permanently deleted.
-Are you sure? (y/n) <userinput>y</userinput>
-DROP USER "joe"
-DROP USER
- </programlisting>
- </para>
+ <informalexample>
+ <para>
+ To remove user <literal>joe</literal> from the default database
+ server:
+<screen>
+<prompt>$ </prompt><userinput>dropuser joe</userinput>
+<computeroutput>DROP USER</computeroutput>
+</screen>
+ </para>
+ </informalexample>
+
+ <informalexample>
+ <para>
+ To remove user <literal>joe</literal> using the postmaster on host
+ eden, port 5000, with verification and a peek at the underlying
+ query:
+<screen>
+<prompt>$ </prompt><userinput>dropuser -p 5000 -h eden -i -e joe</userinput>
+<computeroutput>User "joe" and any owned databases will be permanently deleted.
+Are you sure? (y/n) </computeroutput><userinput>y</userinput>
+<computeroutput>DROP USER "joe"
+DROP USER</computeroutput>
+</screen>
+ </para>
+ </informalexample>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.12 2000/10/05 19:48:18 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.13 2000/11/11 23:01:45 petere Exp $
Postgres documentation
-->
<refentry id="APP-INITDB">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-INITDB-TITLE">
- <application>initdb</application>
- </refentrytitle>
+ <refentrytitle id="APP-INITDB-TITLE"><application>initdb</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>initdb</application>
- </refname>
- <refpurpose>
- Create a new <productname>Postgres</productname> database installation
- </refpurpose>
+ <refname>initdb</refname>
+ <refpurpose>Create a new <productname>Postgres</productname> database cluster</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>1999-12-17</date>
- </refsynopsisdivinfo>
- <synopsis>
-initdb [ --pgdata|-D <replaceable class="parameter">dbdir</replaceable> ]
- [ --sysid|-i <replaceable class="parameter">sysid</replaceable> ]
- [ --pwprompt|-W ]
- [ --encoding|-E <replaceable class="parameter">encoding</replaceable> ]
- [ --pglib|-L <replaceable class="parameter">libdir</replaceable> ]
- [ --noclean | -n ] [ --debug | -d ] [ --template | -t ]
- </synopsis>
-
- <refsect2 id="R2-APP-INITDB-1">
- <refsect2info>
- <date>1999-11-17</date>
- </refsect2info>
- <title>
- Inputs
- </title>
- <para>
+ <cmdsynopsis>
+ <command>initdb</command>
+ <group choice="plain">
+ <arg>--pgdata </arg>
+ <arg>-D </arg>
+ <replaceable>dbdir</replaceable>
+ </group>
+ <group>
+ <arg>--sysid </arg>
+ <arg>-i </arg>
+ <replaceable>sysid</replaceable>
+ </group>
+ <group><arg>--pwprompt</arg><arg>-W</arg></group>
+ <group>
+ <arg>--encoding </arg>
+ <arg>-E </arg>
+ <replaceable>encoding</replaceable>
+ </group>
+ <arg>-L <replaceable>directory</replaceable></arg>
+ <group><arg>--noclean</arg><arg>-n</arg></group>
+ <group><arg>--debug</arg><arg>-d</arg></group>
+ <group><arg>--template</arg><arg>-t</arg></group>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="R1-APP-INITDB-1">
+ <title>
+ Description
+ </title>
+ <para>
+ <application>initdb</application> creates a new
+ <productname>Postgres</productname> database cluster or system. A
+ database cluster is a collection of databases that are managed by a
+ single postmaster.
+ </para>
+ <para>
+ Creating a database system consists of creating the directories in which
+ the database data will live, generating the shared catalog tables
+ (tables that don't belong to any particular database), and
+ creating the <literal>template1</literal>
+ database. When you create a new database, everything in the
+ <literal>template1</literal> database is copied.
+ It contains catalog tables filled in for things like the
+ built-in types.
+ </para>
+
+ <para>
+ You must not execute <application>initdb</application> as root. This is
+ because you cannot run the database server as root either, but the
+ server needs to have access to the files <application>initdb</application>
+ creates. Furthermore, during the initialization phase, when there are no
+ users and no access controls installed, <productname>Postgres</productname>
+ will only connect with
+ the name of the current Unix user, so you must log in under the account
+ that will own the server process.
+ </para>
+
+ <para>
+ Although <application>initdb</application> will attempt to create the respective
+ data directory, chances are that it won't have the permission to do so. Thus
+ it is a good idea to create the data directory before running <application>initdb</application>
+ <emphasis>and</emphasis> to hand over the ownership of it to the database superuser.
+ </para>
+
+ <refsect2>
+ <title>Options</title>
+ <para>
<variablelist>
<varlistentry>
<term>--pgdata=<replaceable class="parameter">dbdir</replaceable></term>
<term>-D <replaceable class="parameter">dbdir</replaceable></term>
- <term><envar>PGDATA</envar></term>
<listitem>
<para>
This option specifies where in the file system the database should be
Selects the system id of the database superuser. This defaults to
the effective user id of the user running initdb. It is really
not important what the superuser's sysid is, but one might choose
- to start the numbering at some number like 0 or 1.
+ to start the numbering at some number like 1.
</para>
</listitem>
</varlistentry>
<variablelist>
<varlistentry>
- <term>--pglib=<replaceable class="parameter">libdir</replaceable></term>
- <term>-l <replaceable class="parameter">libdir</replaceable></term>
+ <term>-L <replaceable class="parameter">directory</replaceable></term>
<listitem>
<para>
- initdb needs a few input files to initialize the database. This option
- tells where to find them. You normally don't have to worry about this
- since initdb knows about the most common installation layouts and will
- find the files itself. You will be told if you need to specify their
- location explicitly. If that happens, one of the files is called
- <filename>global1.bki.source</filename> and is traditionally installed
- along with the others in the library directory (e.g.,
- <filename>/usr/local/pgsql/lib</filename>).
+ Specifies where initdb should find its input files to
+ initialize the database system. This is normally not
+ necessary. You will be told if you need to specify their
+ location explicitly.
</para>
</listitem>
</varlistentry>
</para>
</refsect2>
+ </refsect1>
- <refsect2 id="R2-APP-INITDB-2">
- <refsect2info>
- <date>1999-12-17</date>
- </refsect2info>
- <title>
- Outputs
- </title>
- <para>
- <application>initdb</application> will create files in the specified
- data area which are the system tables and framework for a complete
- installation.
- </para>
- </refsect2>
- </refsynopsisdiv>
-
- <refsect1 id="R1-APP-INITDB-1">
- <refsect1info>
- <date>1999-12-17</date>
- </refsect1info>
- <title>
- Description
- </title>
- <para>
- <application>initdb</application> creates a new
- <productname>Postgres</productname> database system.
- A database system is a
- collection of databases that are all administered by the same Unix user
- and managed by a single postmaster.
- </para>
- <para>
- Creating a database system consists of creating the directories in which
- the database data will live, generating the shared catalog tables
- (tables that don't belong to any particular database), and
- creating the <literal>template1</literal>
- database. When you create a new database, everything in the
- <literal>template1</literal> database is copied.
- It contains catalog tables filled in for things like the
- built-in types.
- </para>
-
- <para>
- You must not execute <application>initdb</application> as root. This is
- because you cannot run the database server as root either, but the
- server needs to have access to the files <application>initdb</application>
- creates. Furthermore, during the initialization phase, when there are no
- users and no access controls installed, <productname>Postgres</productname>
- will only connect with
- the name of the current Unix user, so you must log in under the account
- that will own the server process.
- </para>
+ <refsect1>
+ <title>See also</title>
- <para>
- Although <application>initdb</application> will attempt to create the respective
- data directory, chances are that it won't have the permission to do so. Thus
- it is a good idea to create the data directory before running <application>initdb</application>
- <emphasis>and</emphasis> to hand over the ownership of it to the database superuser.
- </para>
+ <simpara>
+ <citetitle>PostgreSQL Administrator's Guide</citetitle>
+ </simpara>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.10 2000/10/05 19:48:18 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.11 2000/11/11 23:01:45 petere Exp $
Postgres documentation
-->
<refentry id="APP-INITLOCATION">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-INITLOCATION-TITLE">
- <application>initlocation</application>
- </refentrytitle>
+ <refentrytitle id="APP-INITLOCATION-TITLE"><application>initlocation</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>initlocation</application>
- </refname>
- <refpurpose>
- Create a secondary <productname>Postgres</productname> database storage area
- </refpurpose>
+ <refname>initlocation</refname>
+ <refpurpose>Create a secondary <productname>Postgres</productname> database storage area</refpurpose>
</refnamediv>
- <refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>2000-01-17</date>
- </refsynopsisdivinfo>
- <synopsis>
-initlocation <replaceable class="parameter">directory</replaceable>
- </synopsis>
-
- <refsect2 id="R2-APP-INITLOCATION-1">
- <refsect2info>
- <date>1998-10-02</date>
- </refsect2info>
- <title>
- Inputs
- </title>
- <para>
- <variablelist>
- <varlistentry>
- <term><replaceable class="parameter">directory</replaceable></term>
- <listitem>
- <para>
- Where in your Unix filesystem do you want alternate databases to go?
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </para>
- </refsect2>
-
- <refsect2 id="R2-APP-INITLOCATION-2">
- <refsect2info>
- <date>1998-09-26</date>
- </refsect2info>
- <title>
- Outputs
- </title>
- <para>
- <application>initlocation</application> will create directories in
- the specified place.
- </para>
- </refsect2>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>initlocation</command>
+ <arg choice="plain"><replaceable>directory</replaceable></arg>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="R1-APP-INITLOCATION-1">
- <refsect1info>
- <date>1998-09-26</date>
- </refsect1info>
- <title>
- Description
- </title>
+ <title>Description</title>
<para>
<application>initlocation</application>
creates a new <productname>Postgres</productname> secondary database storage area.
</refsect1>
<refsect1 id="R1-APP-INITLOCATION-2">
- <refsect1info>
- <date>1998-09-26</date>
- </refsect1info>
- <title>
- Usage
- </title>
- <para>
- To create a database in an alternate location, using an environment variable:
-<programlisting>
-$ export PGDATA2=/opt/postgres/data
-</programlisting>
-Start and stop postmaster so it sees the $PGDATA2 environment variable.
-The system must be configured so the postmaster sees $PGDATA2 every time it
-starts.
-<programlisting>
-$ initlocation PGDATA2
-$ createdb -D 'PGDATA2' 'testdb'
-</programlisting>
- </para>
+ <title>Usage</title>
- <para>
- Alternatively, if you allow absolute paths you could write:
-<programlisting>
-$ initlocation /opt/postgres/data
-$ createdb -D '/opt/postgres/data/testdb' testdb
-</programlisting>
- </para>
+ <informalexample>
+ <para>
+ To create a database in an alternate location, using an
+ environment variable:
+<screen>
+<prompt>$ </prompt><userinput>export PGDATA2=/opt/postgres/data</userinput>
+</screen>
+ Stop and start postmaster so it sees the <envar>PGDATA2</envar>
+ environment variable. The system must be configured so the
+ postmaster sees <envar>PGDATA2</envar> every time it starts. Finally:
+<screen>
+<prompt>$</prompt> <userinput>initlocation PGDATA2</userinput>
+<prompt>$</prompt> <userinput>createdb -D PGDATA2 testdb</userinput>
+</screen>
+ </para>
+ </informalexample>
+
+ <informalexample>
+ <para>
+ Alternatively, if you allow absolute paths you could write:
+<screen>
+<prompt>$</prompt> <userinput>initlocation /opt/postgres/data</userinput>
+<prompt>$</prompt> <userinput>createdb -D /opt/postgres/data/testdb testdb</userinput>
+</screen>
+ </para>
+ </informalexample>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/ipcclean.sgml,v 1.2 2000/10/05 19:48:18 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/ipcclean.sgml,v 1.3 2000/11/11 23:01:45 petere Exp $
Postgres documentation
-->
<refentry id="APP-IPCCLEAN">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-IPCCLEAN-TITLE">
- <application>ipcclean</application>
- </refentrytitle>
+ <refentrytitle id="APP-IPCCLEAN-TITLE"><application>ipcclean</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>ipcclean</application>
- </refname>
- <refpurpose>
- Clean up shared memory and semaphores from aborted backends
- </refpurpose>
+ <refname>ipcclean</refname>
+ <refpurpose>Clean up shared memory and semaphores from aborted backends</refpurpose>
</refnamediv>
- <refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>1999-07-20</date>
- </refsynopsisdivinfo>
- <synopsis>
-ipcclean
- </synopsis>
-
- <refsect2 id="R2-APP-IPCCLEAN-1">
- <refsect2info>
- <date>1999-07-20</date>
- </refsect2info>
- <title>
- Inputs
- </title>
- <para>
- None.
- </para>
- </refsect2>
- <refsect2 id="R2-APP-IPCCLEAN-2">
- <refsect2info>
- <date>1999-07-30</date>
- </refsect2info>
- <title>
- Outputs
- </title>
- <para>
- None.
- </para>
- </refsect2>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ipcclean</command>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="R1-APP-IPCCLEAN-1">
- <refsect1info>
- <date>1999-07-20</date>
- </refsect1info>
- <title>
- Description
- </title>
+ <title>Description</title>
<para>
<application>ipcclean</application>
cleans up shared memory and semaphore space from aborted backends by
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.3 2000/10/20 13:44:39 thomas Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.4 2000/11/11 23:01:45 petere Exp $ -->
<refentry id="app-pgconfig">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="app-pgconfig-title">pg_config</>
- <refmiscinfo>Application</>
+ <refentrytitle id="app-pgconfig-title">pg_config</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
- <refname>pg_config</>
- <refpurpose>Provides information about the installed version of <productname>PostgreSQL</></>
+ <refname>pg_config</refname>
+ <refpurpose>Provides information about the installed version of <productname>PostgreSQL</></refpurpose>
</refnamediv>
<refsynopsisdiv>
-<synopsis>
-pg_config --bindir | --includedir | --libdir | --configure | --version
-</synopsis>
+ <cmdsynopsis>
+ <command>pg_config</command>
+ <group choice="req" rep="repeat">
+ <arg>--bindir</arg>
+ <arg>--includedir</arg>
+ <arg>--libdir</arg>
+ <arg>--configure</arg>
+ <arg>--version</arg>
+ </group>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.9 2000/05/02 20:02:03 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.10 2000/11/11 23:01:45 petere Exp $
Postgres documentation
-->
<refentry id="APP-VACUUMDB">
+ <docinfo>
+ <date>2000-11-11</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="APP-VACUUMDB-TITLE">
- <application>vacuumdb</application>
- </refentrytitle>
+ <refentrytitle id="APP-VACUUMDB-TITLE"><application>vacuumdb</application></refentrytitle>
+ <manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname id="vacuumdb">
- <application>vacuumdb</application>
- </refname>
- <refpurpose>
- Clean and analyze a <productname>Postgres</productname> database
- </refpurpose>
+ <refname id="vacuumdb">vacuumdb</refname>
+ <refpurpose>Clean and analyze a <productname>Postgres</productname> database</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>1999-12-04</date>
- </refsynopsisdivinfo>
- <synopsis>
-vacuumdb [ <replaceable class="parameter">options</replaceable> ] [ --analyze | -z ]
- [ --alldb | -a ] [ --verbose | -v ]
- [ --table '<replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column</replaceable> [,...] ) ]' ] [ [-d] <replaceable class="parameter">dbname</replaceable> ]
- </synopsis>
+ <cmdsynopsis>
+ <command>vacuumdb</command>
+ <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
+ <arg><arg>-d</arg> <replaceable>dbname</replaceable></arg>
+ <group><arg>--analyze</arg><arg>-z</arg></group>
+ <group><arg>--verbose</arg><arg>-v</arg></group>
+ <sbr>
+ <arg>--table '<replaceable>table</replaceable>
+ <arg>( <replaceable class="parameter">column</replaceable> [,...] )</arg>'
+ </arg>
+ <sbr>
+ <command>vacuumdb</command>
+ <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
+ <group><arg>--all</arg><arg>-a</arg></group>
+ <group><arg>--analyze</arg><arg>-z</arg></group>
+ <group><arg>--verbose</arg><arg>-v</arg></group>
+ </cmdsynopsis>
<refsect2 id="R2-APP-VACUUMDB-1">
- <refsect2info>
- <date>1999-12-04</date>
- </refsect2info>
<title>
Inputs
</title>
</refsect2>
<refsect2 id="R2-APP-VACUUMDB-2">
- <refsect2info>
- <date>1999-12-04</date>
- </refsect2info>
<title>
Outputs
</title>
</refsynopsisdiv>
<refsect1 id="R1-APP-VACUUMDB-1">
- <refsect1info>
- <date>1999-12-04</date>
- </refsect1info>
<title>
Description
</title>
</refsect1>
<refsect1 id="R1-APP-VACUUMDB-3">
- <refsect1info>
- <date>1998-10-04</date>
- </refsect1info>
- <title>
- Usage
- </title>
+ <title>Usage</title>
- <para>
- To clean the database <literal>test</literal>:
-<programlisting>
-$ vacuumdb test
-</programlisting>
- </para>
+ <informalexample>
+ <para>
+ To clean the database <literal>test</literal>:
+<screen>
+<prompt>$ </prompt><userinput>vacuumdb test</userinput>
+</screen>
+ </para>
+ </informalexample>
- <para>
- To analyze a database named <literal>bigdb</literal> for the optimizer:
-<programlisting>
-$ vacuumdb --analyze bigdb
-</programlisting>
- </para>
+ <informalexample>
+ <para>
+ To analyze for the optimzer a database named
+ <literal>bigdb</literal>:
+<screen>
+<prompt>$ </prompt><userinput>vacuumdb --analyze bigdb</userinput>
+</screen>
+ </para>
+ </informalexample>
- <para>
- To analyze a single column <literal>bar</literal> in table <literal>foo</literal>
- in a database named <literal>xyzzy</literal> for the optimizer:
-<programlisting>
-$ vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy
-</programlisting>
- </para>
+ <informalexample>
+ <para>
+ To analyze a single column <literal>bar</literal> in table
+ <literal>foo</literal> in a database named
+ <literal>xyzzy</literal> for the optimizer:
+<screen>
+<prompt>$ </prompt><userinput>vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy</userinput>
+</screen>
+ </para>
+ </informalexample>
</refsect1>
</refentry>
projects / postgresql / commitdiff