pgpool2.git / summary / log / commit / refs

commit    f2c3d99eb443f5ac85f125acf1305d272d69fef7
Author:   pengbo <pengbo@sraoss.co.jp>
Date:     Thu Sep 29 07:58:49 2016 +0000

    add SGML docs of pg_md5


 doc/src/sgml/ref/allfiles.sgml |  1 +
 doc/src/sgml/ref/pg_md5.sgml   | 79 ++++++++++++++++++++++++++++++++++++++++++
 doc/src/sgml/reference.sgml    |  1 +
 3 files changed, 81 insertions(+)

diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml
index 262ad22f2..eb11f07f0 100644
--- a/doc/src/sgml/ref/allfiles.sgml
+++ b/doc/src/sgml/ref/allfiles.sgml
@@ -16,5 +16,6 @@ Complete list of usable sgml source files in this directory.
 <!ENTITY pcpPromoteNode      SYSTEM "pcp_promote_node.sgml">
 <!ENTITY pcpStopPgpool       SYSTEM "pcp_stop_pgpool.sgml">
 <!ENTITY pcpRecoveryNode     SYSTEM "pcp_recovery_node.sgml">
+<!ENTITY pgMd5               SYSTEM "pg_md5.sgml">
 <!ENTITY pgpoolSetup         SYSTEM "pgpool_setup.sgml">
 <!ENTITY watchdoglSetup      SYSTEM "watchdog_setup.sgml">
diff --git a/doc/src/sgml/ref/pg_md5.sgml b/doc/src/sgml/ref/pg_md5.sgml
new file mode 100644
index 000000000..d89154291
--- /dev/null
+++ b/doc/src/sgml/ref/pg_md5.sgml
@@ -0,0 +1,79 @@
+<!--
+doc/src/sgml/ref/pg_md5.sgml
+Pgpool-II documentation
+-->
+
+<refentry id="PG-MD5">
+ <indexterm zone="pg-md5">
+  <primary>pg_md5</primary>
+ </indexterm>
+
+ <refmeta>
+  <refentrytitle>pg_md5</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo>Other Commands</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+  <refname>pg_md5</refname>
+  <refpurpose>
+	produces encrypted password in md5</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>pg_md5</command>
+   <arg rep="repeat"><replaceable>option</replaceable></arg>
+  </cmdsynopsis>
+  <cmdsynopsis>
+   <command>pg_md5</command>
+   <arg><replaceable>password</replaceable></arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="R1-PG-MD5-1">
+  <title>Description</title>
+  <para>
+  <command>pg_md5</command>
+  	produces encrypted password in md5.
+  </para>
+ </refsect1>
+
+ <refsect1>
+  <title>Options</title>
+   <para>
+    <variablelist>
+
+     <varlistentry>
+      <term><option>-p</option></term>
+      <term><option>--prompt</option></term>
+      <listitem>
+       <para>
+	 Prompt password using standard input.
+       </para>
+      </listitem>
+     </varlistentry>
+
+    </variablelist>
+   </para>
+ </refsect1>
+
+ <refsect1>
+  <title>Example</title>
+   <para>
+	Here is an example output:
+    <programlisting>
+pg_md5 -p
+password: [your password]
+    </programlisting>
+  </para>
+  <para>
+  or
+  </para>
+    <programlisting>
+./pg_md5 foo
+acbd18db4cc2f85cedef654fccc4a4d8
+    </programlisting>
+ </refsect1>
+
+</refentry>
diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml
index 491292d9a..474f75fe1 100644
--- a/doc/src/sgml/reference.sgml
+++ b/doc/src/sgml/reference.sgml
@@ -99,6 +99,7 @@
 
    </partintro>
 
+   &pgMd5;
    &pgpoolSetup;
    &watchdoglSetup;
 


[parent: 72a4cbf4421e]