(G-GT-00271): Unify G-IU+200FD.

[chise/xemacs-chise.git-] / man / lispref / postgresql.texi

diff --git a/man/lispref/postgresql.texi b/man/lispref/postgresql.texi
index 982cc95..5053498 100644 (file)
--- a/man/lispref/postgresql.texi
+++ b/man/lispref/postgresql.texi
@@ -23,19 +23,22 @@ relational database access from Emacs Lisp code.
 @comment  node-name,  next,  previous,  up
 @section Building XEmacs with PostgreSQL support
 
 @comment  node-name,  next,  previous,  up
 @section Building XEmacs with PostgreSQL support
 

-XEmacs PostgreSQL support requires linking to the PostgreSQL libpq.so
+XEmacs PostgreSQL support requires linking to the PostgreSQL libpq

 library.  Describing how to build and install PostgreSQL is beyond the
 library.  Describing how to build and install PostgreSQL is beyond the

-scope of this document, see the PostgreSQL manual for details.
+scope of this document.  See the PostgreSQL manual for details.

 
 If you have installed XEmacs from one of the binary kits on
 (@url{ftp://ftp.xemacs.org/}), or are using an XEmacs binary from a CD
 
 If you have installed XEmacs from one of the binary kits on
 (@url{ftp://ftp.xemacs.org/}), or are using an XEmacs binary from a CD

-ROM, you should have XEmacs PostgreSQL support by default.  If you are
-building XEmacs from source on a Linux system with PostgreSQL installed
-into the default location, it should be autodetected when you run
-configure.  If you have installed PostgreSQL into its non-Linux default
-location, @file{/usr/local/pgsql}, you must specify
+ROM, you may have XEmacs PostgreSQL support by default.  @code{M-x
+describe-installation} will tell you if you do.
+
+If you are building XEmacs from source, you need to install PostgreSQL
+first.  On some systems, PostgreSQL will come pre-installed in /usr.  In
+this case, it should be autodetected when you run configure.  If
+PostgreSQL is installed into its default location,
+@file{/usr/local/pgsql}, you must specify

 @code{--site-prefixes=/usr/local/pgsql} when you run configure.  If
 @code{--site-prefixes=/usr/local/pgsql} when you run configure.  If

-you installed PostgreSQL into another location, use that instead of
+PostgreSQL is installed into another location, use that instead of

 @file{/usr/local/pgsql} when specifying @code{--site-prefixes}.
 
 As of XEmacs 21.2, PostgreSQL versions 6.5.3 and 7.0 are supported.
 @file{/usr/local/pgsql} when specifying @code{--site-prefixes}.
 
 As of XEmacs 21.2, PostgreSQL versions 6.5.3 and 7.0 are supported.

@@ -46,9 +49,9 @@ V6.5.  In particular, asynchronous queries are supported.
 @comment  node-name,  next,  previous,  up
 @section XEmacs PostgreSQL libpq API
 
 @comment  node-name,  next,  previous,  up
 @section XEmacs PostgreSQL libpq API
 

-XEmacs PostgreSQL API is intended to be a policy-free, low-level binding
-to libpq.  The intent is to provide all the basic functionality and then
-let high level Lisp code decide its own policies.
+The XEmacs PostgreSQL API is intended to be a policy-free, low-level
+binding to libpq.  The intent is to provide all the basic functionality
+and then let high level Lisp code decide its own policies.

 
 This documentation assumes that the reader has knowledge of SQL, but
 requires no prior knowledge of libpq.
 
 This documentation assumes that the reader has knowledge of SQL, but
 requires no prior knowledge of libpq.

@@ -101,27 +104,27 @@ backend database server during the establishment of a database
 connection and when the @code{pq-setenv} call is made.
 
 @defvar pg:host
 connection and when the @code{pq-setenv} call is made.
 
 @defvar pg:host

-Initialized from the @var{PGHOST} environment variable.  The default
+Initialized from the @code{PGHOST} environment variable.  The default

 host to connect to.
 @end defvar
 
 @defvar pg:user
 host to connect to.
 @end defvar
 
 @defvar pg:user

-Initialized from the @var{PGUSER} environment variable.  The default
+Initialized from the @code{PGUSER} environment variable.  The default

 database user name.
 @end defvar
 
 @defvar pg:options
 database user name.
 @end defvar
 
 @defvar pg:options

-Initialized from the @var{PGOPTIONS} environment variable.  Default
+Initialized from the @code{PGOPTIONS} environment variable.  Default

 additional server options.
 @end defvar
 
 @defvar pg:port
 additional server options.
 @end defvar
 
 @defvar pg:port

-Initialized from the @var{PGPORT} environment variable.  The default TCP
-port to connect to.
+Initialized from the @code{PGPORT} environment variable.  The default
+TCP port to connect to.

 @end defvar
 
 @defvar pg:tty
 @end defvar
 
 @defvar pg:tty

-Initialized from the @var{PGTTY} environment variable.  The default
+Initialized from the @code{PGTTY} environment variable.  The default

 debugging TTY.
 
 Compatibility note:  Debugging TTYs are turned off in the XEmacs Lisp
 debugging TTY.
 
 Compatibility note:  Debugging TTYs are turned off in the XEmacs Lisp

@@ -129,17 +132,17 @@ binding.
 @end defvar
 
 @defvar pg:database
 @end defvar
 
 @defvar pg:database

-Initialized from the @var{PGDATABASE} environment variable.  The default
-database to connect to.
+Initialized from the @code{PGDATABASE} environment variable.  The
+default database to connect to.

 @end defvar
 
 @defvar pg:realm
 @end defvar
 
 @defvar pg:realm

-Initialized from the @var{PGREALM} environment variable.  The default
+Initialized from the @code{PGREALM} environment variable.  The default

 Kerberos realm.
 @end defvar
 
 @defvar pg:client-encoding
 Kerberos realm.
 @end defvar
 
 @defvar pg:client-encoding

-Initialized from the @var{PGCLIENTENCODING} environment variable.  The
+Initialized from the @code{PGCLIENTENCODING} environment variable.  The

 default client encoding.
 
 Compatibility note:  This variable is not present in non-Mule XEmacsen.
 default client encoding.
 
 Compatibility note:  This variable is not present in non-Mule XEmacsen.

@@ -150,35 +153,35 @@ In the current implementation, client encoding is equivalent to the
 
 @c unused
 @defvar pg:authtype
 
 @c unused
 @defvar pg:authtype

-Initialized from the @var{PGAUTHTYPE} environment variable.  The default
-authentication scheme used.
+Initialized from the @code{PGAUTHTYPE} environment variable.  The
+default authentication scheme used.

 
 Compatibility note:  This variable is unused in versions of libpq after
 6.5.  It is not implemented at all in the XEmacs Lisp binding.
 @end defvar
 
 @defvar pg:geqo
 
 Compatibility note:  This variable is unused in versions of libpq after
 6.5.  It is not implemented at all in the XEmacs Lisp binding.
 @end defvar
 
 @defvar pg:geqo

-Initialized from the @var{PGGEQO} environment variable.  Genetic
+Initialized from the @code{PGGEQO} environment variable.  Genetic

 optimizer options.
 @end defvar
 
 @defvar pg:cost-index
 optimizer options.
 @end defvar
 
 @defvar pg:cost-index

-Initialized from the @var{PGCOSTINDEX} environment variable.  Cost index
-options.
+Initialized from the @code{PGCOSTINDEX} environment variable.  Cost
+index options.

 @end defvar
 
 @defvar pg:cost-heap
 @end defvar
 
 @defvar pg:cost-heap

-Initialized from the @var{PGCOSTHEAP} environment variable.  Cost heap
+Initialized from the @code{PGCOSTHEAP} environment variable.  Cost heap

 options.
 @end defvar
 
 @defvar pg:tz
 options.
 @end defvar
 
 @defvar pg:tz

-Initialized from the @var{PGTZ} environment variable.  Default
+Initialized from the @code{PGTZ} environment variable.  Default

 timezone.
 @end defvar
 
 @defvar pg:date-style
 timezone.
 @end defvar
 
 @defvar pg:date-style

-Initialized from the @var{PGDATESTYLE} environment variable.  Default
+Initialized from the @code{PGDATESTYLE} environment variable.  Default

 date style in returned date objects.
 @end defvar
 
 date style in returned date objects.
 @end defvar
 

@@ -335,7 +338,7 @@ Copy In data transfer is in progress.
 An unexpected response was received from the backend.
 @item pgres::nonfatal-error
 Undocumented.  This value is returned when the libpq function
 An unexpected response was received from the backend.
 @item pgres::nonfatal-error
 Undocumented.  This value is returned when the libpq function

-@code{PQresultStatus} is called with a @var{NULL} pointer.
+@code{PQresultStatus} is called with a @code{NULL} pointer.

 @item pgres::fatal-error
 Undocumented.  An error has occurred in processing the query and the
 operation was not completed.
 @item pgres::fatal-error
 Undocumented.  An error has occurred in processing the query and the
 operation was not completed.

@@ -507,7 +510,7 @@ Return the length of a specific value.
 @end defun
 
 @defun pq-get-is-null result tup-num field-num
 @end defun
 
 @defun pq-get-is-null result tup-num field-num

-Return t if the specific value is the SQL @var{NULL}.
+Return t if the specific value is the SQL @code{NULL}.

 @var{result} is a PGresult object.
 @var{tup-num} selects which tuple to fetch from.
 @var{field-num} selects which field to fetch from.
 @var{result} is a PGresult object.
 @var{tup-num} selects which tuple to fetch from.
 @var{field-num} selects which field to fetch from.

@@ -518,8 +521,8 @@ Return a summary string from the query.
 @var{result} is a PGresult object.
 @example
 @comment This example was written on day 3 of the 2000 Haru Basho.
 @var{result} is a PGresult object.
 @example
 @comment This example was written on day 3 of the 2000 Haru Basho.

-(pq-exec P "INSERT INTO xemacs_test
-            VALUES (6, 'Wakanohana', 'Yokozuna');")
+(setq R (pq-exec P "INSERT INTO xemacs_test
+                   VALUES (6, 'Wakanohana', 'Yokozuna');"))

      @result{} #<PGresult PGRES_COMMAND_OK[1] - INSERT 542086 1>
 (pq-cmd-status R)
      @result{} "INSERT 542086 1"
      @result{} #<PGresult PGRES_COMMAND_OK[1] - INSERT 542086 1>
 (pq-cmd-status R)
      @result{} "INSERT 542086 1"

@@ -645,24 +648,24 @@ example idiom is:
 The following options are available in the options string:
 @table @code
 @item authtype
 The following options are available in the options string:
 @table @code
 @item authtype

-Authentication type.  Same as @var{PGAUTHTYPE}.  This is no longer used.
+Authentication type.  Same as @code{PGAUTHTYPE}.  This is no longer used.

 @item user
 @item user

-Database user name.  Same as @var{PGUSER}.
+Database user name.  Same as @code{PGUSER}.

 @item password
 Database password.
 @item dbname
 @item password
 Database password.
 @item dbname

-Database name.  Same as @var{PGDATABASE}
+Database name.  Same as @code{PGDATABASE}

 @item host
 @item host

-Symbolic hostname.  Same as @var{PGHOST}.
+Symbolic hostname.  Same as @code{PGHOST}.

 @item hostaddr
 Host address as four octets (eg. like 192.168.1.1).
 @item port
 @item hostaddr
 Host address as four octets (eg. like 192.168.1.1).
 @item port

-TCP port to connect to.  Same as @var{PGPORT}.
+TCP port to connect to.  Same as @code{PGPORT}.

 @item tty
 @item tty

-Debugging TTY.  Same as @var{PGTTY}.  This value is suppressed in the
+Debugging TTY.  Same as @code{PGTTY}.  This value is suppressed in the

 XEmacs Lisp API.
 @item options
 XEmacs Lisp API.
 @item options

-Extra backend database options.  Same as @var{PGOPTIONS}.
+Extra backend database options.  Same as @code{PGOPTIONS}.

 @end table
 A database connection object is returned regardless of whether a
 connection was established or not.
 @end table
 A database connection object is returned regardless of whether a
 connection was established or not.

@@ -778,7 +781,7 @@ Returns: t if successfully submitted
 Retrieve an asynchronous result from a query.
 @var{conn} A database connection object.
 
 Retrieve an asynchronous result from a query.
 @var{conn} A database connection object.
 

-NIL is returned when no more query work remains.
+@code{nil} is returned when no more query work remains.

 @end defun
 
 @defun pq-set-nonblocking conn arg
 @end defun
 
 @defun pq-set-nonblocking conn arg

@@ -806,7 +809,7 @@ Compatibility note: this function is only available with libpq-7.0.
 @end defun
 
 @defun PQsetenvPoll conn
 @end defun
 
 @defun PQsetenvPoll conn

-Check an asynchronous enviroment variables transfer for completion.
+Check an asynchronous environment variables transfer for completion.

 @var{conn} A database connection object.
 
 Compatibility note: this function is only available with libpq-7.0.
 @var{conn} A database connection object.
 
 Compatibility note: this function is only available with libpq-7.0.

@@ -894,7 +897,8 @@ does not exist in a non-Mule XEmacs.
 @end defun
 
 @defun pq-env-2-encoding
 @end defun
 
 @defun pq-env-2-encoding

-Return the integer code representing the coding system in @var{PGCLIENTENCODING}.
+Return the integer code representing the coding system in
+@code{PGCLIENTENCODING}.

 
 @example
 (pq-env-2-encoding)
 
 @example
 (pq-env-2-encoding)