<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.14 2001/11/28 20:49:10 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>
  <manvolnum>1</manvolnum>
  <refmiscinfo>Application</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>dropuser</refname>
  <refpurpose>remove a <productname>PostgreSQL</productname> user account</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>dropuser</command>
   <arg rep="repeat"><replaceable>options</replaceable></arg>
   <arg><replaceable>username</replaceable></arg>
  </cmdsynopsis>

  <refsect2 id="R2-APP-DROPUSER-1">
   <title>
    Inputs
   </title>
   <para>

    <variablelist>
     <varlistentry>
      <term>-h, --host <replaceable class="parameter">host</replaceable></term>
      <listitem>
       <para>
	Specifies the host name of the machine on which the 
	server
	is running.  If host begins with a slash, it is used 
	as the directory for the Unix domain socket.
       </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 server
	is listening for connections.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-e, --echo</term>
      <listitem>
       <para>
        Echo the queries that <application>createdb</application> generates
	and sends to the server.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-q, --quiet</term>
      <listitem>
       <para>
        Do not display a response.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-i, --interactive</term>
      <listitem>
       <para>
        Prompt for confirmation before actually removing the user.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><replaceable class="parameter">username</replaceable></term>
      <listitem>
       <para>
	Specifies the name of the <productname>PostgreSQL</productname> user to be removed. 
	This name must exist in the <productname>PostgreSQL</productname> installation.
	You will be prompted for a name if none is specified on the command line.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
    </para>

    <para>
    The options <literal>-h</literal>, <literal>-p</literal>, and <literal>-e</literal>,
    are passed on literally to <xref linkend="APP-PSQL">. The
    <application>psql</application> options <literal>-U</literal> and <literal>-W</literal>
    are available as well, but they can be confusing in this context.
   </para>
  </refsect2>

  <refsect2 id="R2-APP-DROPUSER-2">
   <title>
    Outputs
   </title>

   <para>
    <variablelist>
     <varlistentry>
      <term><computeroutput>DROP USER</computeroutput></term>
      <listitem>
       <para>
        All is well.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>dropuser: deletion of user "<replaceable class="parameter">username</replaceable>" failed</computeroutput></term>
      <listitem>
       <para>
        Something went wrong. The user was not removed.
       </para>
      </listitem>
     </varlistentry>

    </variablelist>

    If there is an error condition, the backend error message will be displayed.
    See <xref linkend="SQL-DROPUSER" endterm="SQL-DROPUSER-title">
    and <xref linkend="APP-PSQL"> for possibilities.
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-APP-DROPUSER-1">
  <title>
   Description
  </title>
  <para>
   <application>dropuser</application> removes an existing
   <productname>PostgreSQL</productname> user
   <emphasis>and</emphasis> the databases which that user owned.
   Only users with <literal>usesuper</literal> set in
   the <literal>pg_shadow</literal> table can destroy 
   <productname>PostgreSQL</productname> users.
  </para>

  <para>
   <application>dropuser</application> is a shell script wrapper around the
   <acronym>SQL</acronym> command
   <xref linkend="SQL-DROPUSER" endterm="SQL-DROPUSER-title"> via
   the <productname>PostgreSQL</productname> interactive terminal
   <xref linkend="APP-PSQL">. Thus, there is nothing
   special about removing users via this or other methods. This means
   that the <application>psql</application> must be found by the script and that
   a database server is running at the targeted host. Also, any default
   settings and environment variables available to <application>psql</application>
   and the <application>libpq</application> front-end library do apply.
  </para>

 </refsect1>

 <refsect1 id="R1-APP-DROPUSER-2">
  <title>Usage</title>

  <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>

<!-- 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:
-->
