1 Fix some smaller issue in the manpage brought up by lintian.
2 Mostly hyphen-as-minus and two spelling issue.
3 Index: mysqltcl/doc/mysqltcl.n
4 ===================================================================
5 --- mysqltcl.orig/doc/mysqltcl.n
6 +++ mysqltcl/doc/mysqltcl.n
7 @@ -358,17 +358,17 @@ The port number for the TCP/IP connectio
8 The socket or named pipe for the connection.
10 \fB-encoding\fR \fIencodingname\fR
11 -The option works similar to -encoding option in fconfigure. It support also
12 -special encoding name binary. By option -binary no converting will be done be reading or writing to/from MySQL.
13 +The option works similar to \-encoding option in fconfigure. It support also
14 +special encoding name binary. By option \-binary no converting will be done be reading or writing to/from MySQL.
15 If option is not set the system encoding (see utf-8) is used.
16 Please test all input and outputs with another program to check that all
17 is the way you expect it. If option binary is not used the system procedures
18 Tcl_ExternalToUtfDString (writing) and Tcl_ExternalToUtf (reading) will be used
19 by option binary the function Tcl_GetByteArrayFromObj and Tcl_NewByteArrayObj are used.
20 -If you want to manipulate binary date use -encoding binary. By handling textes set your
21 +If you want to manipulate binary date use \-encoding binary. By handling textes set your
22 special encoding that you want to use in your database. Consider what another system access the
23 database and what encoding they expect. It can useful
24 -to use -encoding utf-8. That is standard encoding in some linux distributions and newer systems.
25 +to use \-encoding utf-8. That is standard encoding in some linux distributions and newer systems.
27 \fB-compress\fR \fIboolean\fR
28 Use compression protocol. Default is false
29 @@ -404,23 +404,23 @@ Switch to SSL after handshake. Default i
31 \fB-sslkey\fR \fIstring\fR
32 is the pathname to the key file.
34 +Used if \-ssl is true
36 \fB-sslcert\fR \fIstring\fR
37 is the pathname to the certificate file.
39 +Used if \-ssl is true
41 \fB-sslca\fR \fIstring\fR
42 is the pathname to the certificate authority file.
44 +Used if \-ssl is true
46 \fB-sslcapath\fR \fIstring\fR
47 is the pathname to a directory that contains trusted SSL CA certificates in pem format.
49 +Used if \-ssl is true
51 \fB-sslcipher\fR \fIstring\fR
52 is a list of allowable ciphers to use for SSL encryption.
54 +Used if \-ssl is true
56 \fB-reconnect\fR \fIboolean\fR
58 @@ -466,9 +466,9 @@ is useful for scanning with a single \fI
62 -% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" -list
63 +% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" \-list
64 {1 Joe} {2 Phil} {3 John}
65 -% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" -flatlist
66 +% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" \-flatlist
70 @@ -482,7 +482,7 @@ Note that both list syntaxes are faster
73 If \fIsql-statement\fR is a valid MySQL statement, but not a SELECT
74 -statement, the command returns -1 after executing the statement, or an empty
75 +statement, the command returns \-1 after executing the statement, or an empty
76 string if \fI-list\fR or \fI-flatlist\fR is specified.
77 There is no pending result in this case.
79 @@ -513,7 +513,7 @@ In case of multiple statement ::mysql::e
80 \fB::mysql::query\fR \fIhandle\fR \fIsql-select-statement\fR
81 Send \fIsql-select-statement\fR to the server.
83 -\fImysql::query\fR allow to send multiple nested queries on one handle (without need to build
84 +\fImysql::query\fR allow one to send multiple nested queries on one handle (without need to build
85 new handle or caching results).
86 mysql::query return a query handle that can be used as handle in commands as (mysql::fetch,
87 ::mysql::map, mysql::seek, mysql::col, mysql::result).
88 @@ -566,7 +566,7 @@ The first variable in the binding list i
90 The variables are created in the current context (if they do not
92 -A variable name begining with a hyphen is not bound; it serves as a
93 +A variable name beginning with a hyphen is not bound; it serves as a
94 placeholder in the binding list.
95 If there are more columns than variables the extra columns are
97 @@ -614,9 +614,9 @@ from server.
98 There is also no client cache.
99 This command can be faster as using of ::mysql::sel and by
100 very big resultset will not overload client machine.
101 -The scipt should process the result immadiatly because
102 +The scipt should process the result immediately because
103 it can block table (or tables) for another clients.
104 -If performance matter please test all alternatives separatly.
105 +If performance matter please test all alternatives separately.
106 You must consider two aspects: memory consumption and performance.
108 \fB::mysql::seek\fR \fIhandle\fR \fIrow-index\fR
109 @@ -628,8 +628,8 @@ Row index 0 is the position just before
110 row index 1 is the position just before the second row, and so
112 You may specify a negative row index.
113 -Row index -1 is the position just before the last row;
114 -row index -2 is the position just before the second last row,
115 +Row index \-1 is the position just before the last row;
116 +row index \-2 is the position just before the second last row,
118 An out-of-bounds row index will cause ::mysql::seek to set the new current
119 position either just before the first row (if the index is too negative),
120 @@ -716,7 +716,7 @@ name lname area phone
121 % ::mysql::col $db friends {name type length}
122 {fname char 12} {lname char 20} {area char 5} {phone char 12}
123 % ::mysql::sel $db {select * from friends}
124 -% ::mysql::col $db -current name type length
125 +% ::mysql::col $db \-current name type length
126 {fname lname area phone} {char char char char} {12 20 5 12}]
129 @@ -895,7 +895,7 @@ Rollback the current transaction.
131 \fB::mysql::nextresult\fR \fIhandle\fR
132 If more query results exist, mysql::nextresult() reads the next query results and returns the status back to application.
133 -returns -1 if no result or number of rows in the result set.
134 +returns \-1 if no result or number of rows in the result set.
136 \fB::mysql::moreresult\fR \fIhandle\fR
137 Returns true if more results exist from the currently executed query, and the application must call mysql::result to fetch the results.
138 @@ -930,7 +930,7 @@ if {[mysql::isnull $row]} {
139 create new null object. It can be used to simulate returned row contents.
141 \fB::mysql::setserveroption\fR \fIhandle\fR \fIoption\fR
142 -there are only 2 options now: -multi_statment_on and -multi_statment_off
143 +there are only 2 options now: \-multi_statment_on and \-multi_statment_off
145 \fB::mysql::shutdown\fR \fIhandle\fR
146 Asks the database server to shut down. The connected user must have SHUTDOWN privileges.
147 @@ -954,7 +954,7 @@ All conflicts also generate a Tcl error.
148 All MySQL server conflicts set mysqlstatus(code) to the numeric
149 code of the MySQL error.
151 -Any other conflict sets mysqlstatus(code) to -1.
152 +Any other conflict sets mysqlstatus(code) to \-1.
155 The last failing mysqltcl command.
156 @@ -973,7 +973,7 @@ You may set it to another value.
158 .SH "Backward compatibility"
159 Up from version 3.0 all mysql commands are declared in ::mysql namespace.
160 -All names for example mysqlconnect are also aviable but deprecated.
161 +All names for example mysqlconnect are also available but deprecated.
162 All old commands have the name pattern mysql{name} and the most of them are now mysql::{name}.
163 The exception is mysqlnext, which was renamed to mysql::fetch.
164 .SH "BUGS & POSSIBLE MISFEATURES"