Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 07f6373

Browse files
author
Liudmila Mantrova
committed
DOC: documented sql man handling by pg-wrapper
1 parent a82585b commit 07f6373

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

doc/src/sgml/ref/pg-wrapper.sgml

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,13 @@
3737
<para>
3838
<application>pg-wrapper</application> is a shell script provided in
3939
the <productname>&productname;</productname> distribution to manage
40-
<productname>&productname;</productname> symbolic links on Linux systems.
40+
<productname>&productname;</productname> symbolic links and
41+
<acronym>SQL</acronym> man pages on Linux systems.
4142
This script is provided as part of the <filename>postgrespro-std-&majorversion;-client</filename>
4243
package. Once this package is installed, you can find <application>pg-wrapper</application>
4344
in the <filename><replaceable>install-dir</replaceable>/bin</filename>
4445
directory, where <replaceable>install-dir</replaceable> is
45-
<filename>/opt/pgpro/std-&majorversion;</filename> by default.
46+
<filename>/opt/pgpro/std-&majorversion;</filename>.
4647
</para>
4748
<para>
4849
<application>pg-wrapper</application> must be run as root.
@@ -60,16 +61,23 @@
6061

6162
<varlistentry>
6263
<term><option>links</option> {<option>update</option> | <option>remove</option>}</term>
63-
<listitem><para>Manage <productname>&productname;</productname> symbolic links:
64+
<listitem><para>Manage <productname>&productname;</productname>
65+
symbolic links and <acronym>SQL</acronym> man pages:
6466
<itemizedlist spacing="compact">
6567
<listitem>
6668
<para>
67-
<literal>update</literal> &mdash; create or replace symbolic links.
69+
<literal>update</literal> &mdash; create or replace
70+
symbolic links for server and client programs provided with
71+
<productname>&productname;</productname>, as well as make
72+
the provided <acronym>SQL</acronym> man pages available in
73+
man page configuration files.
6874
</para>
6975
</listitem>
7076
<listitem>
7177
<para>
72-
<literal>remove</literal> &mdash; remove symbolic links.
78+
<literal>remove</literal> &mdash; remove symbolic links
79+
and <acronym>SQL</acronym> man page support for the current
80+
<productname>&productname;</productname> version.
7381
</para>
7482
</listitem>
7583
</itemizedlist>
@@ -92,11 +100,20 @@
92100
<para>
93101
If you are installing individual <productname>&productname;</productname>
94102
packages, you can run this script manually to create symbolic links
95-
to the provided client and server programs.
103+
to the provided client and server programs, as well as add
104+
<acronym>SQL</acronym> man pages to the man page configuration file.
105+
</para>
106+
<para>
107+
If <acronym>SQL</acronym> man pages are already installed
108+
from a different product, the previous installation will keep
109+
its priority. For the new <acronym>SQL</acronym> documentation
110+
to be displayed first, you have to modify the system configuration,
111+
for example, change the <envar>MANPATH</envar> value.
112+
</para>
96113
<important>
97114
<para>
98115
If you have been using the same programs provided with
99-
other products, running this command may result in a conflict.
116+
other products, running <application>pg-wrapper</application> may result in a conflict.
100117
In this case, you can either continue using the already
101118
available program version, or adjust the settings manually.
102119
</para>
@@ -106,7 +123,6 @@
106123
make these programs available just for a particular user or user session.
107124
</para>
108125
</important>
109-
</para>
110126

111127
<para>
112128
For details on binary installation specifics on Linux,

0 commit comments

Comments
 (0)