Change "parameter" to "varname" in the alter role and alter user

[postgresql] / doc / src / sgml / ref / reset.sgml

diff --git a/doc/src/sgml/ref/reset.sgml b/doc/src/sgml/ref/reset.sgml
index a778a11658ca172beb2e9e1c6e862d0ad535569e..f8729d3fdaebd52c7091c40f5b383be139d96786 100644 (file)
--- a/doc/src/sgml/ref/reset.sgml
+++ b/doc/src/sgml/ref/reset.sgml
@@ -1,142 +1,104 @@
+<!--
+$PostgreSQL: pgsql/doc/src/sgml/ref/reset.sgml,v 1.29 2006/04/25 14:47:29 momjian Exp $
+PostgreSQL documentation
+-->
+
 <refentry id="SQL-RESET">
  <refmeta>
-  <refentrytitle>
-   RESET
-  </refentrytitle>
+  <refentrytitle id="SQL-RESET-TITLE">RESET</refentrytitle>
   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  </refmeta>
+
  <refnamediv>
-  <refname>
-   RESET
-  </refname>
-  <refpurpose>
-   Restores run-time parameters for session to default values
-  </refpurpose>
+  <refname>RESET</refname>
+  <refpurpose>restore the value of a run-time parameter to the default value</refpurpose>
  </refnamediv>
+
+ <indexterm zone="sql-reset">
+  <primary>RESET</primary>
+ </indexterm>
+
  <refsynopsisdiv>
-  <refsynopsisdivinfo>
-   <date>1998-09-24</date>
-  </refsynopsisdivinfo>
-  <synopsis>
-RESET <replaceable class="PARAMETER">variable</replaceable>
-  </synopsis>
-
-  <refsect2 id="R2-SQL-RESET-1">
-   <refsect2info>
-    <date>1998-09-24</date>
-   </refsect2info>
-   <title>
-    Inputs
-   </title>
-   <para>              
-    <variablelist>
-     <varlistentry>
-      <term>
-       <replaceable class="PARAMETER">variable</replaceable>
-      </term>
-      <listitem>
-       <para>
-       Refer to the SET statement for more information on available
-       variables.
-       </para>
-      </listitem>
-     </varlistentry>
-    </variablelist>
-   </para>
-  </refsect2>
-
-  <refsect2 id="R2-SQL-RESET-2">
-   <refsect2info>
-    <date>1998-09-24</date>
-   </refsect2info>
-   <title>
-    Outputs
-   </title>
-   <para>
-
-    <variablelist>
-     <varlistentry>
-      <term>
-       RESET VARIABLE
-      </term>
-      <listitem>
-       <para>
-       Message returned if 
-       <replaceable class="PARAMETER">variable</replaceable> is successfully reset
-       to its default value..
-       </para>
-      </listitem>
-     </varlistentry>
-    </variablelist>
-   </para>
-  </refsect2>
+<synopsis>
+RESET <replaceable class="PARAMETER">varname</replaceable>
+RESET ALL
+</synopsis>
  </refsynopsisdiv>
   
- <refsect1 id="R1-SQL-RESET-1">
-  <refsect1info>
-   <date>1998-09-24</date>
-  </refsect1info>
-  <title>
-   Description
-  </title>
+ <refsect1>
+  <title>Description</title>
+
+  <para>
+   <command>RESET</command> restores run-time parameters to their
+   default values.  <command>RESET</command> is an alternative
+   spelling for
+<synopsis>
+SET <replaceable class="parameter">varname</replaceable> TO DEFAULT
+</synopsis>
+   Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
+   details.
+  </para>
+
+  <para>
+   The default value is defined as the value that the parameter would
+   have had, had no <command>SET</> ever been issued for it in the
+   current session.  The actual source of this value might be a
+   compiled-in default, the configuration file, command-line options,
+   or per-database or per-user default settings.  See <xref
+   linkend="runtime-config"> for details.
+  </para>
+
   <para>
-   <command>RESET</command> restores variables to the
-   default values.
-   Refer to the <command>SET</command> command for details on
-   allowed values and defaults.
-   <command>RESET</command> is an alternate form for
-   <command>SET <replaceable class="parameter">variable</replaceable> = DEFAULT</command>
+   See the <command>SET</> reference page for details on the
+   transaction behavior of <command>RESET</>.  <command>RESET
+   CONNECTION</command> can be used to reset all aspects of
+   a session, not just parameter values.
   </para>
 
-  <refsect2 id="R2-SQL-RESET-3">
-   <refsect2info>
-    <date>1998-09-24</date>
-   </refsect2info>
-   <title>
-    Notes
-   </title>
-   <para>
-    The RESET statement is a <productname>Postgres</productname>
-    language extension.
-   </para>
-   <para>
-    Refer to SET/SHOW statements to set/show variable values.
-   </para>
-  </refsect2>
  </refsect1>
-  
- <refsect1 id="R1-SQL-RESET-2">
-  <title>
-   Usage
-  </title>
+
+ <refsect1>
+  <title>Parameters</title>
+
+  <variablelist>
+   <varlistentry>
+    <term><replaceable class="PARAMETER">varname</replaceable></term>
+    <listitem>
+     <para>
+      The name of a run-time parameter. See <xref linkend="sql-set"
+      endterm="sql-set-title"> for a list.
+     </para>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term><literal>ALL</literal></term>
+    <listitem>
+     <para>
+      Resets all settable run-time parameters to default values.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1>
+  <title>Examples</title>
+
   <para>
-   <programlisting>
--- reset DateStyle to its default;
-RESET DateStyle;
-   </programlisting>
-   <programlisting>   
--- reset Geqo to its default;
-RESET GEQO;
-   </programlisting>
+   Set the <varname>geqo</> configuration variable to its default value:
+<screen>
+RESET geqo;
+</screen>
   </para>
  </refsect1>
 
- <refsect1 id="R1-SQL-RESET-3">
-  <title>
-   Compatibility
-  </title>
-
-  <refsect2 id="R2-SQL-RESET-4">
-   <refsect2info>
-    <date>1998-09-24</date>
-   </refsect2info>
-   <title>
-    SQL92
-   </title>
-   <para>
-    There is no <command>RESET</command> in <acronym>SQL92</acronym>.
-   </para>
-  </refsect2>
+ <refsect1>
+  <title>Compatibility</title>
+
+  <para>
+   <command>RESET</command> is a <productname>PostgreSQL</productname> extension.
+  </para>
  </refsect1>
 </refentry>