Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

isql.1: Add information about handling passwords containing semicolons #126

Merged
merged 2 commits into from
May 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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