summaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/createdb.sgml
diff options
context:
space:
mode:
authorThomas G. Lockhart <lockhart@fourpalms.org>1999-07-06 17:16:42 +0000
committerThomas G. Lockhart <lockhart@fourpalms.org>1999-07-06 17:16:42 +0000
commita4ac2f458e8cb76177254f4bd7bbd885991379af (patch)
tree278de40d122f67db3a6694319b0d3b6880eba752 /doc/src/sgml/ref/createdb.sgml
parent192a66e3dad33ff8aa446c4c053f0b01498549f5 (diff)
downloadpostgresql-a4ac2f458e8cb76177254f4bd7bbd885991379af.tar.gz
Fix markup for docbook2man man page generation.
No big deal; fixed lots of other markup at the same time. Bigest change: make sure there is no whitespace in front of <term> contents. This will probably help the other output types too.
Diffstat (limited to 'doc/src/sgml/ref/createdb.sgml')
-rw-r--r--doc/src/sgml/ref/createdb.sgml534
1 files changed, 271 insertions, 263 deletions
diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml
index 54e27a5e67..f9c8e21101 100644
--- a/doc/src/sgml/ref/createdb.sgml
+++ b/doc/src/sgml/ref/createdb.sgml
@@ -1,266 +1,274 @@
-<REFENTRY ID="APP-CREATEDB">
- <REFMETA>
- <REFENTRYTITLE>
- <application>createdb</application>
- </REFENTRYTITLE>
- <REFMISCINFO>Application</REFMISCINFO>
- </REFMETA>
- <REFNAMEDIV>
- <REFNAME>
- <application>createdb</application>
- </REFNAME>
- <REFPURPOSE>
- Create a new <productname>Postgres</productname> database
- </REFPURPOSE>
- </refnamediv>
- <REFSYNOPSISDIV>
- <REFSYNOPSISDIVINFO>
- <DATE>1998-10-02</DATE>
- </REFSYNOPSISDIVINFO>
- <SYNOPSIS>
- createdb [ <replaceable class="parameter">dbname</replaceable> ]
- createdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ]
- [ -D <replaceable class="parameter">datadir</replaceable> ]
- [ -u ] [ <replaceable class="parameter">dbname</replaceable> ]
- </SYNOPSIS>
-
- <REFSECT2 ID="R2-APP-CREATEDB-1">
- <REFSECT2INFO>
- <DATE>1998-10-02</DATE>
- </REFSECT2INFO>
- <TITLE>
- Inputs
- </TITLE>
- <PARA>
-
- <variablelist>
- <varlistentry>
- <term>
- -h <replaceable class="parameter">host</replaceable>
- </term>
- <listitem>
- <para>
- Specifies the hostname of the machine on which the
- <application>postmaster</application>
- is running. Defaults to using a local Unix domain socket
- rather than an IP connection..
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- -p <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. The port number defaults to 5432,
- or the value of the <envar>PGPORT</envar>
- environment variable (if set).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- -u
- </term>
- <listitem>
- <para>
- Use password authentication.
- Prompts for
- <replaceable class="parameter">username</replaceable>
- and <replaceable class="parameter">password</replaceable>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- -D <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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- <replaceable class="parameter">dbname</replaceable>
- </term>
- <listitem>
- <para>
- Specifies the name of the database to be created. The name must be
- unique among all <productname>Postgres</productname> databases in this installation.
- <replaceable class="parameter">dbname</replaceable>
- defaults to the value of the
- <envar>USER</envar>
- environment variable.
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </para>
- </refsect2>
+<refentry id="APP-CREATEDB">
+ <refmeta>
+ <refentrytitle>
+ <application>createdb</application>
+ </refentrytitle>
+ <refmiscinfo>Application</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <application>createdb</application>
+ </refname>
+ <refpurpose>
+ Create a new <productname>Postgres</productname> database
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <refsynopsisdivinfo>
+ <date>1998-10-02</date>
+ </refsynopsisdivinfo>
+ <synopsis>
+createdb [ <replaceable class="parameter">dbname</replaceable> ]
+createdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ]
+ [ -D <replaceable class="parameter">datadir</replaceable> ] [ -u ] [ <replaceable class="parameter">dbname</replaceable> ]
+ </synopsis>
- <REFSECT2 ID="R2-APP-CREATEDB-2">
- <REFSECT2INFO>
- <DATE>1998-10-02</DATE>
- </REFSECT2INFO>
- <TITLE>
- Outputs
- </TITLE>
- <PARA>
- <application>createdb</application> will create files in the
- <filename><envar>PGDATA</envar>/<replaceable class="parameter">dbname</replaceable>/</filename>
- data area for the new database.
-
- <variablelist>
- <varlistentry>
- <term>
- Connection to database 'template1' failed.
- connectDB() failed: Is the postmaster running and accepting connections
- at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
- createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
- </term>
- <listitem>
- <para>
- <application>createdb</application> could not attach to the
- <application>postmaster</application>
- process on the specified host and port. If you see this message,
- ensure that the <application>postmaster</application>
- is running on the proper host and that you have specified the proper
- port. If your site uses an authentication system, ensure that you
- have obtained the required authentication credentials.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- Connection to database 'template1' failed.
- FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
- createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
- </term>
- <listitem>
- <para>
- You do not have a valid entry in the relation <literal>pg_shadow</literal>
- and and will not be allowed to access <productname>Postgres</productname>.
- Contact your <productname>Postgres</productname> administrator.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- ERROR: user '<replaceable class="parameter">username</replaceable>' is not allowed to create/destroy databases
- createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
- </term>
- <listitem>
- <para>
- You do not have permission to create new databases.
- Contact your <productname>Postgres</productname> site administrator.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- ERROR: createdb: database '<replaceable class="parameter">dbname</replaceable>' already exists.
- createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
- </term>
- <listitem>
- <para>
- The database already exists.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
- </term>
- <listitem>
- <para>
- An internal error occurred in <application>psql</application>
- or in the backend server. Ensure that your site administrator has
- properly installed <productname>Postgres</productname>and initialized the site with
- <application>initdb</application>.
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </para>
- <note>
- <para>
- <application>createdb</application> internally runs
- CREATE DATABASE from <application>psql</application>
- while connected to the <literal>template1</literal> database.
- </para>
- </note>
- </refsect2>
- </refsynopsisdiv>
-
- <REFSECT1 ID="R1-APP-CREATEDB-1">
- <REFSECT1INFO>
- <DATE>1998-10-02</DATE>
- </REFSECT1INFO>
- <TITLE>
- Description
- </TITLE>
- <PARA>
- <application>createdb</application> creates a new
- <productname>Postgres</productname> database.
- The person who executes this command becomes
- the database administrator, or <acronym>DBA</acronym>,
- for this database and is the only
- person, other than the <productname>Postgres</productname> super-user,
- who can destroy it.
- </para>
+ <refsect2 id="R2-APP-CREATEDB-1">
+ <refsect2info>
+ <date>1998-10-02</date>
+ </refsect2info>
+ <title>
+ Inputs
+ </title>
+ <para>
+
+ <variablelist>
+ <varlistentry>
+ <term>-h <replaceable class="parameter">host</replaceable></term>
+ <listitem>
+ <para>
+ Specifies the hostname of the machine on which the
+ <application>postmaster</application>
+ is running. Defaults to using a local Unix domain socket
+ rather than an IP connection.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-p <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. The port number defaults to 5432,
+ or the value of the <envar>PGPORT</envar>
+ environment variable (if set).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-u</term>
+ <listitem>
+ <para>
+ Use password authentication.
+ Prompts for
+ <replaceable class="parameter">username</replaceable>
+ and <replaceable class="parameter">password</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-D <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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><replaceable class="parameter">dbname</replaceable></term>
+ <listitem>
+ <para>
+ Specifies the name of the database to be created. The name must be
+ unique among all <productname>Postgres</productname> databases in this installation.
+ <replaceable class="parameter">dbname</replaceable>
+ defaults to the value of the
+ <envar>USER</envar>
+ environment variable.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+ </refsect2>
+
+ <refsect2 id="R2-APP-CREATEDB-2">
+ <refsect2info>
+ <date>1998-10-02</date>
+ </refsect2info>
+ <title>
+ Outputs
+ </title>
+ <para>
+ <application>createdb</application> will create files in the
+ <filename><envar>PGDATA</envar>/<replaceable class="parameter">dbname</replaceable>/</filename>
+ data area for the new database.
+
+ <variablelist>
+ <varlistentry>
+ <term><computeroutput>
+Connection to database 'template1' failed.
+connectDB() failed: Is the postmaster running and accepting connections at 'UNIX Socket' on port '<replaceable class="parameter">port</replaceable>'?
+createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
+ </computeroutput></term>
+ <listitem>
+ <para>
+ <application>createdb</application> could not attach to the
+ <application>postmaster</application>
+ process on the specified host and port. If you see this message,
+ ensure that the <application>postmaster</application>
+ is running on the proper host and that you have specified the proper
+ port. If your site uses an authentication system, ensure that you
+ have obtained the required authentication credentials.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>
+Connection to database 'template1' failed.
+FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
+createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
+ </computeroutput></term>
+ <listitem>
+ <para>
+ You do not have a valid entry in the relation <literal>pg_shadow</literal>
+ and and will not be allowed to access <productname>Postgres</productname>.
+ Contact your <productname>Postgres</productname> administrator.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>
+ERROR: user '<replaceable class="parameter">username</replaceable>' is not allowed to create/destroy databases
+createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
+ </computeroutput></term>
+ <listitem>
+ <para>
+ You do not have permission to create new databases.
+ Contact your <productname>Postgres</productname> site administrator.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>
+ERROR: createdb: database '<replaceable class="parameter">dbname</replaceable>' already exists.
+createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
+ </computeroutput></term>
+ <listitem>
+ <para>
+ The database already exists.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>
+createdb: database creation failed on <replaceable class="parameter">dbname</replaceable>.
+ </computeroutput></term>
+ <listitem>
+ <para>
+ An internal error occurred in <application>psql</application>
+ or in the backend server. Ensure that your site administrator has
+ properly installed <productname>Postgres</productname>and initialized the site with
+ <application>initdb</application>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+ <note>
<para>
- <application>createdb</application> is a shell script that invokes
- <application>psql</application>.
- Hence, a <application>postmaster</application>
- process must be running on the database server host before
- <application>createdb</application>
- is executed. The
- <envar>PGOPTION</envar>
- and
- <envar>PGREALM</envar>
- environment variables will be passed on to
- <application>psql</application>
- and processed as described in <xref linkend="app-psql" endterm="psql-ref">.
+ <application>createdb</application> internally runs
+ <command>CREATE DATABASE</command> from <application>psql</application>
+ while connected to the <literal>template1</literal> database.
</para>
- </refsect1>
-
- <REFSECT1 ID="R1-APP-CREATEDB-2">
- <REFSECT1INFO>
- <DATE>1998-10-02</DATE>
- </REFSECT1INFO>
- <TITLE>
- Usage
- </TITLE>
- <PARA>
- To create the database <literal>demo</literal>
- using the postmaster on the local host, port 5432:
-
- <programlisting>
- createdb demo
- </programlisting>
-
- To create the database <literal>demo</literal>
- using the postmaster on host eden, port 5000:
-
- <programlisting>
- createdb -p 5000 -h eden demo
- </programlisting>
- </para>
- </refsect1>
-</REFENTRY>
+ </note>
+ </refsect2>
+ </refsynopsisdiv>
+
+ <refsect1 id="R1-APP-CREATEDB-1">
+ <refsect1info>
+ <date>1998-10-02</date>
+ </refsect1info>
+ <title>
+ Description
+ </title>
+ <para>
+ <application>createdb</application> creates a new
+ <productname>Postgres</productname> database.
+ The person who executes this command becomes
+ the database administrator, or <acronym>DBA</acronym>,
+ for this database and is the only
+ person, other than the <productname>Postgres</productname> super-user,
+ who can destroy it.
+ </para>
+ <para>
+ <application>createdb</application> is a shell script that invokes
+ <application>psql</application>.
+ Hence, a <application>postmaster</application>
+ process must be running on the database server host before
+ <application>createdb</application>
+ is executed. The
+ <envar>PGOPTION</envar>
+ and
+ <envar>PGREALM</envar>
+ environment variables will be passed on to
+ <application>psql</application>
+ and processed as described in <xref endterm="psql-ref"
+ linkend="app-psql">.
+ </para>
+ </refsect1>
+
+ <refsect1 id="R1-APP-CREATEDB-2">
+ <refsect1info>
+ <date>1998-10-02</date>
+ </refsect1info>
+ <title>
+ Usage
+ </title>
+ <para>
+ To create the database <literal>demo</literal>
+ using the postmaster on the local host, port 5432:
+
+ <programlisting>
+$ createdb demo
+ </programlisting>
+ </para>
+
+ <para>
+ To create the database <literal>demo</literal>
+ using the postmaster on host eden, port 5000:
+
+ <programlisting>
+$ createdb -p 5000 -h eden demo
+ </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:
+-->