Skip to content

Commit

Permalink
Merge pull request #126 from hughmcmaster/docs
Browse files Browse the repository at this point in the history
isql.1: Add information about handling passwords containing semicolons
  • Loading branch information
lurcher authored May 4, 2023
2 parents b97cbe1 + c95a408 commit 458833b
Showing 1 changed file with 23 additions and 7 deletions.
30 changes: 23 additions & 7 deletions man/isql.1
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ The tools provide several useful features, including an option to generate
output wrapped in an HTML table.

\fBiusql\fR is the same as \fBisql\fR but includes built-in Unicode support.
Some data sources only work with \fBiusql\fR. A important difference between the
two tools, is \fBisql\fR connects using SQLConnect and \fBiusql\fR SQLDriverConnect.
Some data sources only work with \fBiusql\fR. An important difference between the
two tools is that \fBisql\fR connects using SQLConnect and \fBiusql\fR connects
using SQLDriverConnect.

.SH ARGUMENTS

Expand All @@ -44,13 +45,18 @@ Password required to access the database for the specified \fBUSER\fR.
This parameter overrides any \fBPASSWORD\fR specified in the data source
configuration files.

When using \fBiusql\fR, passwords containing semicolons should be escaped with
braces (curly brackets) and terminated with a semicolon. Refer to the Examples
section below for syntax.

.IP \fB"ConnectionString"\fR
Connection string starting with DSN=, DRIVER= or FILEDSN= that is passed unchanged to
SQLDriverConnect. This option allows the use of more complex syntax in
the connection string than would be available just using DSN,UID and PWD.
A connection string starting with DSN=, DRIVER= or FILEDSN= will be passed
unchanged to SQLDriverConnect. This option allows for the use of more complex
syntax in a connection string than would otherwise be possible by just using
DSN, UID and PWD.

It also (and this was the main reason for its inclusion) allows passwords
containing semicolons without having to add complex escape syntax to the
It also (and this was the main reason for its inclusion) allows passwords
to contain semicolons without having to add complex escape syntax to the
existing code.

.SH OPTIONS
Expand Down Expand Up @@ -158,6 +164,16 @@ A string DSN may be provided in its entirety, with no file DSN reference at all:
$ iusql ";Driver=PostgreSQL Unicode;UID=MyID;PASSWORD=secret" \-v
.fi

.IP "A password containing a semicolon (\fBiusql\fR):"

.nf
$ iusql WebDB MyID '{My;PWD};'
.fi

.nf
$ iusql 'DSN=WebDB;UID=MyID;PWD={My;PWD};'
.fi

.SH TROUBLESHOOTING

.IP "Cryptic error messages"
Expand Down

0 comments on commit 458833b

Please sign in to comment.