aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/psql-ref.sgml103
-rw-r--r--doc/src/sgml/release-9.1.sgml2
2 files changed, 59 insertions, 46 deletions
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index 6385c78d1d6..54fc3ee24ec 100644
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -1440,25 +1440,21 @@ testdb=>
<literal>\r</> to cancel.
</para>
- <tip>
<para>
- <application>psql</application> checks the environment
- variables <envar>PSQL_EDITOR</envar>, <envar>EDITOR</envar>, and
- <envar>VISUAL</envar> (in that order) for an editor to use. If
- all of them are unset, <filename>vi</filename> is used on Unix
- systems, <filename>notepad.exe</filename> on Windows systems.
+ If a line number is specified, <application>psql</application> will
+ position the cursor on the specified line of the file or query buffer.
+ Note that if a single all-digits argument is given,
+ <application>psql</application> assumes it is a line number,
+ not a file name.
</para>
- </tip>
+ <tip>
<para>
- If a line number is specified, <application>psql</application> will
- position the cursor on the specified line of the file or query buffer.
- This feature requires the <varname>EDITOR_LINENUMBER_SWITCH</varname>
- variable to be set, so that <application>psql</application> knows how
- to specify the line number to the editor. Note that if a single
- all-digits argument is given, <application>psql</application> assumes
- it is a line number not a file name.
+ See under <xref linkend="app-psql-environment"
+ endterm="app-psql-environment-title"> for how to configure and
+ customize your editor.
</para>
+ </tip>
</listitem>
</varlistentry>
@@ -1514,13 +1510,18 @@ Tue Oct 26 21:40:57 CEST 1999
<para>
If a line number is specified, <application>psql</application> will
- position the cursor on the specified line of the function body
- (note that the function body typically does not begin on the
- first line of the file).
- This feature requires the <varname>EDITOR_LINENUMBER_SWITCH</varname>
- variable to be set, so that <application>psql</application> knows how
- to specify the line number to the editor.
+ position the cursor on the specified line of the function body.
+ (Note that the function body typically does not begin on the first
+ line of the file.)
+ </para>
+
+ <tip>
+ <para>
+ See under <xref linkend="app-psql-environment"
+ endterm="app-psql-environment-title"> for how to configure and
+ customize your editor.
</para>
+ </tip>
</listitem>
</varlistentry>
@@ -2599,27 +2600,6 @@ bar
</varlistentry>
<varlistentry>
- <term><varname>EDITOR_LINENUMBER_SWITCH</varname></term>
- <listitem>
- <para>
- When <command>\edit</command> or <command>\ef</command> is used with a
- line number argument, this variable specifies the command-line switch
- used to pass the line number to the user's editor. For editors such
- as <productname>emacs</> or <productname>vi</>, you can simply set
- this variable to a plus sign. Include a trailing space in the value
- of the variable if there needs to be space between the switch name and
- the line number.
- Examples:
-
-<programlisting>
-\set EDITOR_LINENUMBER_SWITCH +
-\set EDITOR_LINENUMBER_SWITCH '--line '
-</programlisting>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><varname>ENCODING</varname></term>
<listitem>
<para>
@@ -3167,8 +3147,8 @@ $endif
</refsect1>
- <refsect1>
- <title>Environment</title>
+ <refsect1 id="app-psql-environment">
+ <title id="app-psql-environment-title">Environment</title>
<variablelist>
@@ -3218,8 +3198,41 @@ $endif
<listitem>
<para>
- Editor used by the <command>\e</command> command. The variables
- are examined in the order listed; the first that is set is used.
+ Editor used by the <command>\e</command> and
+ <command>\ef</command> commands. The variables are examined in
+ the order listed; the first that is set is used.
+ </para>
+
+ <para>
+ The built-in default editors are <filename>vi</filename> on Unix
+ systems and <filename>notepad.exe</filename> on Windows systems.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>PSQL_EDITOR_LINENUMBER_ARG</envar></term>
+
+ <listitem>
+ <para>
+ When <command>\e</command> or <command>\ef</command> is used
+ with a line number argument, this variable specifies the
+ command-line argument used to pass the starting line number to
+ the user's editor. For editors such as <productname>Emacs</> or
+ <productname>vi</>, this is a plus sign. Include a trailing
+ space in the value of the variable if there needs to be space
+ between the option name and the line number. Examples:
+<programlisting>
+PSQL_EDITOR_LINENUMBER_ARG='+'
+PSQL_EDITOR_LINENUMBER_ARG='--line '
+</programlisting>
+ </para>
+
+ <para>
+ The default is <literal>+</literal> on Unix systems
+ (corresponding to the default editor <filename>vi</filename>,
+ and useful for many other common editors); but there is no
+ default on Windows systems.
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/release-9.1.sgml b/doc/src/sgml/release-9.1.sgml
index a4f8e2459fc..6c812cb6c47 100644
--- a/doc/src/sgml/release-9.1.sgml
+++ b/doc/src/sgml/release-9.1.sgml
@@ -1994,7 +1994,7 @@
<para>
This is passed to the editor according to the
- <envar>EDITOR_LINENUMBER_SWITCH</> psql variable.
+ <envar>PSQL_EDITOR_LINENUMBER_ARG</> environment variable.
</para>
</listitem>