Skip to content

Commit 808a2d6

Browse files
committed
Some improvements to documentation
1 parent 52d4368 commit 808a2d6

File tree

1 file changed

+16
-30
lines changed

1 file changed

+16
-30
lines changed

README.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,28 @@ export LC_ALL=en_US.utf-8
3939
The charset-part of LC_ALL is ignored.
4040

4141
## Usage
42-
Currently, utPLSQL-cli knows the following commands:
42+
Currently, utPLSQL-cli supports the following commands:
4343
- run
4444
- info
4545
- reporters
4646

47+
#### \<ConnectionURL>
48+
49+
This is used in all commands as first parameter (though it's optional for `info`).
50+
51+
Accepted formats:
52+
53+
- `<user>/<password>@//<host>[:<port>]/<service>`
54+
- `<user>/<password>@<host>:<port>:<SID>`
55+
- `<user>/<password>@<TNSName>`
56+
57+
To connect using TNS, you need to have the ORACLE_HOME environment variable set.
58+
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
59+
The file tnsnames.ora must contain valid TNS entries.
60+
4761
### run
4862
`utplsql run <ConnectionURL> [<options>]`
4963

50-
```
51-
<ConnectionURL> - accepted formats:
52-
<user>/<password>@//<host>[:<port>]/<service>
53-
<user>/<password>@<host>:<port>:<SID>
54-
<user>/<password>@<TNSName>
55-
To connect using TNS, you need to have the ORACLE_HOME environment variable set.
56-
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
57-
The file tnsnames.ora must contain valid TNS entries.
58-
```
5964

6065
#### Options
6166
```
@@ -133,15 +138,6 @@ Invokes all unit test suites from schema "hr". Results are displayed to screen u
133138
### info
134139
`utplsql info [<ConnectionURL>]`
135140

136-
```
137-
<ConnectionURL> - accepted formats:
138-
<user>/<password>@//<host>[:<port>]/<service>
139-
<user>/<password>@<host>:<port>:<SID>
140-
<user>/<password>@<TNSName>
141-
To connect using TNS, you need to have the ORACLE_HOME environment variable set.
142-
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
143-
The file tnsnames.ora must contain valid TNS entries.
144-
```
145141

146142
#### Examples
147143

@@ -160,17 +156,7 @@ utPLSQL 3.1.2.1913
160156
```
161157

162158
### reporters
163-
`utplsql info <ConnectionURL>`
164-
165-
```
166-
<ConnectionURL> - accepted formats:
167-
<user>/<password>@//<host>[:<port>]/<service>
168-
<user>/<password>@<host>:<port>:<SID>
169-
<user>/<password>@<TNSName>
170-
To connect using TNS, you need to have the ORACLE_HOME environment variable set.
171-
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
172-
The file tnsnames.ora must contain valid TNS entries.
173-
```
159+
`utplsql reporters <ConnectionURL>`
174160

175161
#### Examples
176162
```

0 commit comments

Comments
 (0)