New upstream release - adds a -reconnect option.
[sven/mysqltcl.git] / debian / patches / man-hyphen-and-spelling
1 Fix some smaller issue in the manpage brought up by lintian.
2 Mostly hyphen-as-minus and two spelling issue.
3 --- a/doc/mysqltcl.n
4 +++ b/doc/mysqltcl.n
5 @@ -358,17 +358,17 @@ The port number for the TCP/IP connectio
6  The socket or named pipe for the connection.
7  .TP
8  \fB-encoding\fR \fIencodingname\fR
9 -The option works similar to -encoding option in fconfigure. It support also
10 -special encoding name binary. By option -binary no converting will be done be reading or writing to/from MySQL.
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  If option is not set the system encoding (see utf-8) is used.
14  Please test all input and outputs with another program to check that all
15  is the way you expect it. If option binary is not used the system procedures
16  Tcl_ExternalToUtfDString (writing) and Tcl_ExternalToUtf (reading) will be used
17  by option binary the function Tcl_GetByteArrayFromObj and Tcl_NewByteArrayObj are used.
18 -If you want to manipulate binary date use -encoding binary. By handling textes set your
19 +If you want to manipulate binary date use \-encoding binary. By handling textes set your
20  special encoding that you want to use in your database. Consider what another system access the
21  database and what encoding they expect. It can useful
22 -to use -encoding utf-8. That is standard encoding in some linux distributions and newer systems.
23 +to use \-encoding utf-8. That is standard encoding in some linux distributions and newer systems.
24  .TP
25  \fB-compress\fR \fIboolean\fR
26  Use compression protocol. Default is false
27 @@ -404,23 +404,23 @@ Switch to SSL after handshake. Default i
28  .TP
29  \fB-sslkey\fR \fIstring\fR
30  is the pathname to the key file.
31 -Used if -ssl is true
32 +Used if \-ssl is true
33  .TP
34  \fB-sslcert\fR \fIstring\fR
35  is the pathname to the certificate file.
36 -Used if -ssl is true
37 +Used if \-ssl is true
38  .TP
39  \fB-sslca\fR \fIstring\fR
40  is the pathname to the certificate authority file.
41 -Used if -ssl is true
42 +Used if \-ssl is true
43  .TP
44  \fB-sslcapath\fR \fIstring\fR
45  is the pathname to a directory that contains trusted SSL CA certificates in pem format.
46 -Used if -ssl is true
47 +Used if \-ssl is true
48  .TP
49  \fB-sslcipher\fR \fIstring\fR
50  is a list of allowable ciphers to use for SSL encryption.
51 -Used if -ssl is true
52 +Used if \-ssl is true
53  .TP
54  \fB-reconnect\fR \fIboolean\fR
55  default is false.
56 @@ -466,9 +466,9 @@ is useful for scanning with a single \fI
57  Example:
58  .nf
59  
60 -% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" -list
61 +% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" \-list
62  {1 Joe} {2 Phil} {3 John}
63 -% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" -flatlist
64 +% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" \-flatlist
65  {1 Joe 2 Phil 3 John}
66  
67  .fi
68 @@ -482,7 +482,7 @@ Note that both list syntaxes are faster
69  
70  .fi
71  If \fIsql-statement\fR is a valid MySQL statement, but not a SELECT
72 -statement, the command returns -1 after executing the statement, or an empty
73 +statement, the command returns \-1 after executing the statement, or an empty
74  string if \fI-list\fR or \fI-flatlist\fR is specified.
75  There is no pending result in this case.
76  .sp
77 @@ -566,7 +566,7 @@ The first variable in the binding list i
78  the row, and so on.
79  The variables are created in the current context (if they do not
80  already exist).
81 -A variable name begining with a hyphen is not bound; it serves as a
82 +A variable name beginning with a hyphen is not bound; it serves as a
83  placeholder in the binding list.
84  If there are more columns than variables the extra columns are
85  ignored.
86 @@ -616,7 +616,7 @@ This command can be faster as using of :
87  very big resultset will not overload client machine.
88  The scipt should process the result immadiatly because
89  it can block table (or tables) for another clients.
90 -If performance matter please test all alternatives separatly.
91 +If performance matter please test all alternatives separately.
92  You must consider two aspects: memory consumption and performance.
93  .TP
94  \fB::mysql::seek\fR \fIhandle\fR \fIrow-index\fR
95 @@ -628,8 +628,8 @@ Row index 0 is the position just before
96  row index 1 is the position just before the second row, and so
97  on.
98  You may specify a negative row index.
99 -Row index -1 is the position just before the last row;
100 -row index -2 is the position just before the second last row,
101 +Row index \-1 is the position just before the last row;
102 +row index \-2 is the position just before the second last row,
103  and so on.
104  An out-of-bounds row index will cause ::mysql::seek to set the new current
105  position either just before the first row (if the index is too negative),
106 @@ -716,7 +716,7 @@ name lname area phone
107  % ::mysql::col $db friends {name type length}
108  {fname char 12} {lname char 20} {area char 5} {phone char 12}
109  % ::mysql::sel $db {select * from friends}
110 -% ::mysql::col $db -current name type length
111 +% ::mysql::col $db \-current name type length
112  {fname lname area phone} {char char char char} {12 20 5 12}]
113  
114  .fi
115 @@ -895,7 +895,7 @@ Rollback the current transaction.
116  .TP
117  \fB::mysql::nextresult\fR \fIhandle\fR
118  If more query results exist, mysql::nextresult() reads the next query results and returns the status back to application.
119 -returns -1 if no result or number of rows in the result set.
120 +returns \-1 if no result or number of rows in the result set.
121  .TP
122  \fB::mysql::moreresult\fR \fIhandle\fR
123  Returns true if more results exist from the currently executed query, and the application must call mysql::result to fetch the results.
124 @@ -930,7 +930,7 @@ if {[mysql::isnull $row]} {
125  create new null object. It can be used to simulate returned row contents.
126  .TP
127  \fB::mysql::setserveroption\fR \fIhandle\fR \fIoption\fR
128 -there are only 2 options now: -multi_statment_on and -multi_statment_off
129 +there are only 2 options now: \-multi_statment_on and \-multi_statment_off
130  .TP
131  \fB::mysql::shutdown\fR \fIhandle\fR
132  Asks the database server to shut down. The connected user must have SHUTDOWN privileges.
133 @@ -954,7 +954,7 @@ All conflicts also generate a Tcl error.
134  All MySQL server conflicts set mysqlstatus(code) to the numeric
135  code of the MySQL error.
136  .sp
137 -Any other conflict sets mysqlstatus(code) to -1.
138 +Any other conflict sets mysqlstatus(code) to \-1.
139  .TP
140  command
141  The last failing mysqltcl command.