Backslash love (Issue #1268)

Author: cjbj

INSTALL.md

@@ -868,14 +868,16 @@ Client libraries are, see [Initializing Node-oracledb][17]:
     ```javascript
     const oracledb = require('oracledb');
     try {
-      oracledb.initOracleClient({libDir: 'C:\oracle\instantclient_19_6'});
+      oracledb.initOracleClient({libDir: 'C:\\oracle\\instantclient_19_6'});
     } catch (err) {
       console.error('Whoops!');
       console.error(err);
       process.exit(1);
     }
     ```
 
+  If you use backslashes in the `libDir` string, you will need to double them.
+
 - Alternatively, copy the Oracle Instant Client libraries to the
   `node_modules/oracledb/build/Release` directory where the `oracledb*.node`
   binary is.
@@ -913,17 +915,19 @@ documentation.
 
 If you use optional Oracle configuration files such as `tnsnames.ora`,
 `sqlnet.ora` or `oraaccess.xml` with Instant Client, then put the files in an
-accessible directory, for example in `C:\oracle\your_config_dir`.  Then use
-[`oracledb.initOracleClient()`][64] in your application:
+accessible directory.  For example if they are in `C:\oracle\your_config_dir`
+then use [`oracledb.initOracleClient()`][64] in your application:
 
 ```javascript
 const oracledb = require('oracledb');
-oracledb.initOracleClient({configDir: 'C:\oracle\your_config_dir'});
+oracledb.initOracleClient({configDir: 'C:\\oracle\\your_config_dir'});
 ```
 
+If you use backslashes in the `configDir` string, you will need to double them.
+
 Or you can set the environment variable `TNS_ADMIN` to that directory name.
 
-Another alternative is to put the files in the `network/admin` subdirectory of
+Another alternative is to put the files in the `network\admin` subdirectory of
 Instant Client, for example in `C:\oracle\instantclient_19_6\network\admin`.
 This is the default Oracle configuration directory for executables linked with
 this Instant Client.
@@ -1025,8 +1029,9 @@ Optional Oracle client configuration files such as [`tnsnames.ora`][15],
 `$ORACLE_HOME\network\admin`.
 
 Alternatively, if you use Oracle client configuration files, they can be put in
-another, accessible directory.  Then use `oracledb.initOracleClient({configDir:
-'C:\oracle\your_config_dir'});` in your application or set the environment
+another, accessible directory.  For example in `C:\oracle\your_config_dir`.
+Then use `oracledb.initOracleClient({configDir:
+'C:\\oracle\\your_config_dir'});` in your application or set the environment
 variable `TNS_ADMIN` to that directory name.
 
 ##### 3.4.2.5 Run an example program

doc/api.md

@@ -2709,10 +2709,10 @@ The options parameter and option attributes are optional.  If an attribute is se
 
 Attribute           | Description
 ------------------- |-----------------------------
-`configDir`         | This specifies the directory in which the [Optional Oracle Net Configuration](#tnsadmin) and [Optional Oracle Client Configuration](#oraaccess) files reside.  It is equivalent to setting the Oracle environment variable `TNS_ADMIN` to this value.  Any value in that environment variable prior to the call to `oracledb.initOracleClient()` is ignored.  If this attribute is not set, Oracle's default configuration file [search heuristics](#tnsadmin) are used.
+`configDir`         | This specifies the directory in which the [Optional Oracle Net Configuration](#tnsadmin) and [Optional Oracle Client Configuration](#oraaccess) files reside.  It is equivalent to setting the Oracle environment variable `TNS_ADMIN` to this value.  Any value in that environment variable prior to the call to `oracledb.initOracleClient()` is ignored. On Windows, remember to double each blackslash used as a directory separator.  If `configDir` is not set, Oracle's default configuration file [search heuristics](#tnsadmin) are used.
 `driverName`        | This specifies the driver name value shown in database views, such as `V$SESSION_CONNECT_INFO`.  It can be used by applications to identify themselves for tracing and monitoring purposes.  The convention is to separate the product name from the product version by a colon and single space characters.  If this attribute is not specified, the value "node-oracledb : *version*" is used. See [Other Node-oracledb Initialization](#otherinit).
 `errorUrl`          | This specifies the URL that is included in the node-oracledb exception message if the Oracle Client libraries cannot be loaded.  This allows applications that use node-oracledb to refer users to application-specific installation instructions.  If this attribute is not specified, then the [node-oracledb installation instructions][2] URL is used.  See [Other Node-oracledb Initialization](#otherinit).
-`libDir`            | This specifies the directory containing the Oracle Client libraries.  If `libDir` is not specified, the default library search mechanism is used.  If your client libraries are in a full Oracle Client or Oracle Database installation, such as Oracle Database "XE" Express Edition, then you must have previously set environment variables like `ORACLE_HOME` before calling `initOracleClient()`.  See [Locating the Oracle Client Libraries](#oracleclientloading).
+`libDir`            | This specifies the directory containing the Oracle Client libraries.  If `libDir` is not specified, the default library search mechanism is used.  If your client libraries are in a full Oracle Client or Oracle Database installation, such as Oracle Database "XE" Express Edition, then you must have previously set environment variables like `ORACLE_HOME` before calling `initOracleClient()`.  On Windows, remember to double each blackslash used as a directory separator. See [Locating the Oracle Client Libraries](#oracleclientloading).
 
 
 On Linux, ensure a `libclntsh.so` file exists.  On macOS ensure a
@@ -7750,14 +7750,16 @@ use:
 ```javascript
 const oracledb = require('oracledb');
 try {
-  oracledb.initOracleClient({libDir: 'C:\oracle\instantclient_19_6'});
+  oracledb.initOracleClient({libDir: 'C:\\oracle\\instantclient_19_6'});
 } catch (err) {
   console.error('Whoops!');
   console.error(err);
   process.exit(1);
 }
 ```
 
+If you use backslashes in the `libDir` string, you will need to double them.
+
 The `initOracleClient()` function should only be called once.
 
 If you set `libDir` on Linux and related platforms, you must still have
@@ -7795,6 +7797,8 @@ const oracledb = require('oracledb');
 oracledb.initOracleClient({configDir: '/etc/my-oracle-config'});
 ```
 
+(If you use backslashes in the `configDir` string, you will need to double them.)
+
 This is equivalent to setting the environment variable [`TNS_ADMIN`][8] to
 `/etc/my-oracle-config`.