diff options
Diffstat (limited to 'doc/src/sgml/ref/dropuser.sgml')
| -rw-r--r-- | doc/src/sgml/ref/dropuser.sgml | 227 |
1 files changed, 227 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml new file mode 100644 index 00000000000..981a8003143 --- /dev/null +++ b/doc/src/sgml/ref/dropuser.sgml @@ -0,0 +1,227 @@ +<!-- +$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.1 1999/12/04 04:53:15 momjian Exp $ +Postgres documentation +--> + +<refentry id="APP-DROPUSER"> + <refmeta> + <refentrytitle id="APP-DROPUSER-TITLE"> + <application>dropuser</application> + </refentrytitle> + <refmiscinfo>Application</refmiscinfo> + </refmeta> + <refnamediv> + <refname> + <application>dropuser</application> + </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> + + <refsect2 id="R2-APP-DROPUSER-1"> + <refsect2info> + <date>1999-11-07</date> + </refsect2info> + <title> + Inputs + </title> + <para> + + <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>-e, --echo</term> + <listitem> + <para> + Echo the queries that <application>createdb</application> generates + and sends to the backend. + </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>Postgres</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" endterm="APP-PSQL-title">. If you + need the <application>psql</application> options <literal>-U</literal> and + <literal>-W</literal> as well, you can uncomment the + respective lines in the source. They are disabled by default because of the potential + conceptual confusion between existing and new users. + </para> + </refsect2> + + <refsect2 id="R2-APP-DROPUSER-2"> + <refsect2info> + <date>1999-11-07</date> + </refsect2info> + <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" endterm="APP-PSQL-title"> for possibilities. + </para> + </refsect2> + </refsynopsisdiv> + + <refsect1 id="R1-APP-DROPUSER-1"> + <refsect1info> + <date>1999-11-07</date> + </refsect1info> + <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> class 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" endterm="APP-PSQL-title">. 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"> + <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> + + <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> +QUERY: DROP USER "joe" +DROP USER + </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: +--> |