]> granicus.if.org Git - postgresql/blobdiff - doc/src/sgml/ref/reset.sgml
Change "parameter" to "varname" in the alter role and alter user
[postgresql] / doc / src / sgml / ref / reset.sgml
index 85194663eb2e7baec5d3fc4ce4b7daad01e7d123..f8729d3fdaebd52c7091c40f5b383be139d96786 100644 (file)
@@ -1,6 +1,6 @@
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.11 2001/06/07 04:50:56 momjian Exp $
-Postgres documentation
+$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">
@@ -8,82 +8,87 @@ Postgres documentation
   <refentrytitle id="SQL-RESET-TITLE">RESET</refentrytitle>
   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  </refmeta>
+
  <refnamediv>
   <refname>RESET</refname>
-  <refpurpose>Restores run-time parameters to default values</refpurpose>
+  <refpurpose>restore the value of a run-time parameter to the default value</refpurpose>
  </refnamediv>
+
+ <indexterm zone="sql-reset">
+  <primary>RESET</primary>
+ </indexterm>
+
  <refsynopsisdiv>
-  <synopsis>
-RESET <replaceable class="PARAMETER">variable</replaceable>
-  </synopsis>
-  <synopsis>
+<synopsis>
+RESET <replaceable class="PARAMETER">varname</replaceable>
 RESET ALL
-  </synopsis>
-
-  <refsect2 id="R2-SQL-RESET-1">
-   <title>Inputs</title>
-   <para>              
-    <variablelist>
-     <varlistentry>
-      <term><replaceable class="PARAMETER">variable</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>ALL</term>
-      <listitem>
-       <para>
-        Resets all run-time parameters to default values.
-       </para>
-      </listitem>
-     </varlistentry>
-    </variablelist>
-   </para>
-  </refsect2>
-
+</synopsis>
  </refsynopsisdiv>
   
  <refsect1>
   <title>Description</title>
+
   <para>
    <command>RESET</command> restores run-time parameters to their
-   default values. Refer to
-   <xref linkend="sql-set" endterm="sql-set-title">
-   for details. <command>RESET</command> is an alternate form for
+   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>
 
-   <synopsis>
-SET <replaceable class="parameter">variable</replaceable> TO DEFAULT
-   </synopsis>
+  <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>
- </refsect1>
 
- <refsect1>
-  <title>Diagnostics</title>
   <para>
-   See under the <xref linkend="sql-set"
-   endterm="sql-set-title"> 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>
+
  </refsect1>
 
  <refsect1>
-  <title>Examples</title>
-  <para>
-   Set DateStyle to its default value:
+  <title>Parameters</title>
 
-<screen>
-RESET DateStyle;
-</screen>
-  </para>
+  <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>
 
-  <para>
-   Set Geqo to its default value:
+   <varlistentry>
+    <term><literal>ALL</literal></term>
+    <listitem>
+     <para>
+      Resets all settable run-time parameters to default values.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
 
-<screen>   
-RESET GEQO;
+ <refsect1>
+  <title>Examples</title>
+
+  <para>
+   Set the <varname>geqo</> configuration variable to its default value:
+<screen>
+RESET geqo;
 </screen>
   </para>
  </refsect1>
@@ -92,7 +97,7 @@ RESET GEQO;
   <title>Compatibility</title>
 
   <para>
-   <command>RESET</command> is a <productname>Postgres</productname> extension.
+   <command>RESET</command> is a <productname>PostgreSQL</productname> extension.
   </para>
  </refsect1>
 </refentry>