Attachment "pat.tcllib.docs" to
ticket [567428ffff]
added by
lvirden
2002-06-11 22:45:06.
--- modules/cmdline/cmdline.man.orig Tue Jun 11 11:20:33 2002
+++ modules/cmdline/cmdline.man Tue Jun 11 11:20:59 2002
@@ -16,3 +16,3 @@
this command will process the first argument and return info on how to
-procede. The command returns 1 if an option was found, 0 if no more
+proceed. The command returns 1 if an option was found, 0 if no more
options were found, and -1 if an error occurred.
--- modules/comm/comm.man.orig Tue Jun 11 11:21:49 2002
+++ modules/comm/comm.man Tue Jun 11 11:23:36 2002
@@ -105,3 +105,3 @@
More than one [cmd comm] channel (or [emph listener]) can be created
-in each Tcl interpeter. This allows flexibility to create full and
+in each Tcl interpreter. This allows flexibility to create full and
restricted channels. For instance, [strong hook] scripts are specific
@@ -218,3 +218,3 @@
By default, each channel is restricted to accepting connections from
-the local system. This can be overriden by using the
+the local system. This can be overridden by using the
@@ -381,3 +381,3 @@
This hook is invoked after collecting a complete script from a remote
-but [strong before] evalutating it. This allows complete control over
+but [strong before] evaluating it. This allows complete control over
the processing of incoming commands. [arg cmd] contains either
@@ -420,3 +420,3 @@
[enum]
-short circuting a command
+short circuiting a command
[nl]
@@ -487,3 +487,3 @@
This hook is invoked after collecting a complete reply script from a
-remote but [strong before] evalutating it. This allows complete
+remote but [strong before] evaluating it. This allows complete
control over the processing of replies to sent commands. The reply
@@ -675,3 +675,3 @@
This has been fixed by removing the extra level of indirection into
-the internal procedure [strong commSend ]. Also added propogation of
+the internal procedure [strong commSend ]. Also added propagation of
the [arg errorCode] variable. This means that these commands return
--- modules/counter/counter.man.orig Tue Jun 11 11:35:49 2002
+++ modules/counter/counter.man Tue Jun 11 11:35:52 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin counter n 2.0]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Counters and Histograms}]
--- modules/doctools/dtformat.man.orig Tue Jun 11 11:24:01 2002
+++ modules/doctools/dtformat.man Tue Jun 11 11:25:50 2002
@@ -69,3 +69,3 @@
is used in a loose sense here, i.e application of the commands to a
-sequence of words is entierely possible, if they are properly quoted.
+sequence of words is entirely possible, if they are properly quoted.
@@ -89,3 +89,3 @@
list of their type. In other words, [cmd bullet] is allowed in
-bulleted lists but nowhere else, [cmd enum] in enumerated lists and
+bulletted lists but nowhere else, [cmd enum] in enumerated lists and
[cmd lst_item] and [cmd call] are for definition lists. These two
@@ -107,3 +107,3 @@
syntax to the table of contents (synopsis) if supported by the output
-format. Unlike [cmd call], this command doens't add any text to the
+format. Unlike [cmd call], this command doesn't add any text to the
output as a direct result of the command. Thus, it can be used
@@ -111,4 +111,4 @@
used near the top of the document, in cases where it is not desireable
-to use [cmd call] elsehere in the document, or where additional usage
-information is desired (eg: to document a "package require" command).
+to use [cmd call] elsewhere in the document, or where additional usage
+information is desired (e.g.: to document a "package require" command).
@@ -325,3 +325,3 @@
-Starts a new item in a bulleted list.
+Starts a new item in a bulletted list.
--- modules/doctools/mpexpand.man.orig Tue Jun 11 11:31:11 2002
+++ modules/doctools/mpexpand.man Tue Jun 11 11:31:27 2002
@@ -21,3 +21,3 @@
-If the option [arg -module] is present its value overides the internal
+If the option [arg -module] is present its value overrides the internal
definition of the module name.
--- modules/fileutil/fileutil.man.orig Tue Jun 11 11:36:15 2002
+++ modules/fileutil/fileutil.man Tue Jun 11 11:36:18 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin fileutil n 1.4]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {file utilities}]
--- modules/ftp/ftp.man.orig Tue Jun 11 11:27:47 2002
+++ modules/ftp/ftp.man Tue Jun 11 11:28:52 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin ftp n 2.3.1]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {ftp client}]
@@ -171,3 +171,3 @@
completed and any additional arguments specific to the operation. If
-an error occured during the execution of the operation the callback is
+an error occurred during the execution of the operation the callback is
given the keyword [strong error].
@@ -191,3 +191,3 @@
happens the server will write the result response for the transfer to
-it and close the conenction afterward.
+it and close the connection afterward.
@@ -282,3 +282,3 @@
[arg file] on the ftp server as a system dependent integer value in
-seconds or an empty string if an error occured. Use the built-in
+seconds or an empty string if an error occurred. Use the built-in
command [cmd clock] to convert the retrieves value into other formats.
@@ -307,3 +307,3 @@
unspecified, the server will use the name of the local file as the
-name of the remote file. The command returns 1 to indicate a sucessful
+name of the remote file. The command returns 1 to indicate a successful
transfer and 0 in the case of a failure.
@@ -339,3 +339,3 @@
name of the remote file as the name of the local file. The command
-returns 1 to indicate a sucessful transfer and 0 in the case of a
+returns 1 to indicate a successful transfer and 0 in the case of a
failure. The command will throw an error if the directory the file
@@ -390,3 +390,3 @@
created directory will have the specified path name. The command
-returns 1 to indicate a sucessful creation of the directory and 0 in
+returns 1 to indicate a successful creation of the directory and 0 in
the case of a failure.
@@ -397,3 +397,3 @@
remote directory has to be empty or the command will fail. The command
-returns 1 to indicate a sucessful removal of the directory and 0 in
+returns 1 to indicate a successful removal of the directory and 0 in
the case of a failure.
@@ -410,3 +410,3 @@
-In constrast to the other commands in this package this command will
+In contrast to the other commands in this package this command will
not parse the response it got from the ftp server but return it
--- modules/ftpd/ftpd.man.orig Tue Jun 11 11:36:32 2002
+++ modules/ftpd/ftpd.man Tue Jun 11 11:36:34 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin ftpd n 1.1.2]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Tcl FTP Server Package}]
--- modules/html/html.man.orig Tue Jun 11 11:36:40 2002
+++ modules/html/html.man Tue Jun 11 11:36:43 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin html n 1.2.1]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {HTML Generation}]
--- modules/irc/irc.man.orig Tue Jun 11 11:30:31 2002
+++ modules/irc/irc.man Tue Jun 11 11:30:51 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin irc n 0.2]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Low Level Tcl IRC Interface}]
@@ -116,3 +116,3 @@
-Returns the action perfomed, such as KICK, PRIVMSG, MODE, etc...
+Returns the action performed, such as KICK, PRIVMSG, MODE, etc...
Normally not useful, as callbacks are bound to a particular event.
--- modules/javascript/javascript.man.orig Tue Jun 11 11:37:00 2002
+++ modules/javascript/javascript.man Tue Jun 11 11:37:02 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin javascript n 1.0]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {HTML and Java Script Generation}]
--- modules/log/log.man.orig Tue Jun 11 11:37:13 2002
+++ modules/log/log.man Tue Jun 11 11:37:15 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin log n 1.0.1]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Logging facility}]
--- modules/math/combinatorics.man.orig Tue Jun 11 11:37:31 2002
+++ modules/math/combinatorics.man Tue Jun 11 11:37:35 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin combinatorics n 4.2]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Tcl Math Library}]
--- modules/math/math.man.orig Tue Jun 11 11:38:37 2002
+++ modules/math/math.man Tue Jun 11 11:40:59 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin math n 4.2]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Tcl Math Library}]
@@ -70,4 +70,4 @@
-Return the mean, standard deviation, and coefficient of variation as
-percent as a list.
+Return the mean, standard deviation, and coefficient of variation (as
+percent) as a list.
--- modules/mime/mime.man.orig Tue Jun 11 11:41:08 2002
+++ modules/mime/mime.man Tue Jun 11 11:41:11 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin mime n 1.3.2]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Mime}]
--- modules/mime/smtp.man.orig Tue Jun 11 11:41:19 2002
+++ modules/mime/smtp.man Tue Jun 11 11:41:22 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin smtp n 1.3.2]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {smtp client}]
--- modules/ncgi/ncgi.man.orig Tue Jun 11 11:41:31 2002
+++ modules/ncgi/ncgi.man Tue Jun 11 11:41:34 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin ncgi n 1.2.1]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {CGI Support}]
--- modules/nntp/nntp.man.orig Tue Jun 11 11:31:44 2002
+++ modules/nntp/nntp.man Tue Jun 11 11:31:58 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin nntp n 1.5.1]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Tcl NNTP Client Library}]
@@ -126,3 +126,3 @@
is returned in a similar form to the list of groups returned by the
-[cmd {BnntpName list}] command. Each element of the list has the form:
+[cmd {[strong nntpName ] list}] command. Each element of the list has the form:
.sp
--- modules/pop3/pop3.man.orig Tue Jun 11 11:42:03 2002
+++ modules/pop3/pop3.man Tue Jun 11 11:42:05 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin pop3 n 1.5.1]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Tcl POP3 Client Library}]
--- modules/profiler/profiler.man.orig Tue Jun 11 11:42:16 2002
+++ modules/profiler/profiler.man Tue Jun 11 11:42:18 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin profiler n 0.2]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Tcl Profiler}]
--- modules/report/report.man.orig Tue Jun 11 11:42:26 2002
+++ modules/report/report.man Tue Jun 11 11:42:29 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin report n 0.3]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Matrix reports}]
--- modules/smtpd/smtpd.man.orig Tue Jun 11 11:33:35 2002
+++ modules/smtpd/smtpd.man Tue Jun 11 11:34:02 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin smtpd n 1.0]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Tcl SMTP Server Package}]
@@ -79,6 +79,6 @@
It should be noted that stopping the server does not disconnect any
-currently active sessions as these are operating over an independant
+currently active sessions as these are operating over an independent
channel. Only explicitly tracking and closing these sessions, or
exiting the server process will close down all the running
-sessions. This is similar to the ususal unix daemon practice where the
+sessions. This is similar to the usual unix daemon practice where the
server performs a [syscmd fork](2) and the client session continues on
--- modules/stooop/stooop.man.orig Tue Jun 11 11:34:19 2002
+++ modules/stooop/stooop.man Tue Jun 11 11:34:32 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin stooop n 4.2]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Simple Tcl Only Object Oriented Programming}]
@@ -197,3 +197,3 @@
first. Each output line contains the class name, object identifier and
-the procedure within which the creation occured. The optional pattern
+the procedure within which the creation occurred. The optional pattern
argument (as in the Tcl [cmd {string match}] command) can be used to
--- modules/struct/graph.man.orig Tue Jun 11 11:29:07 2002
+++ modules/struct/graph.man Tue Jun 11 11:30:15 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*-}]
[manpage_begin graph n 1.2.1]
+[comment {-*- tcl -*-}]
[moddesc {Tcl Data Structures}]
@@ -363,5 +363,4 @@
each node, with the mode of the call ([strong enter] or
-
[strong leave]) and values [arg graphName] and the name of the current
-node appended. For a pre-order walk all nodes are Bentered, for a
+node appended. For a pre-order walk, all nodes are [strong enter]ed, for a
post-order all nodes are left. In a both-order walk the first visit of
--- modules/struct/pool.man.orig Tue Jun 11 11:32:26 2002
+++ modules/struct/pool.man Tue Jun 11 11:33:16 2002
@@ -1,4 +1,4 @@
+[manpage_begin pool n 1.2.1]
[comment {-*- tcl -*-}]
[comment {Author: Erik Leunissen <[email protected]>}]
-[manpage_begin pool n 1.2.1]
[moddesc {Tcl Data Structures}]
@@ -53,3 +53,3 @@
[bullet]
-the seats in a cinema, theatre, train etc.. for which visitors/travellers can make a reservation;
+the seats in a cinema, theatre, train etc.. for which visitors/travelers can make a reservation;
[bullet]
@@ -324,3 +324,3 @@
items, they need to be managed separately. In the latter case the
-items should be labelled with more neutral names such as: car1, car2,
+items should be labeled with more neutral names such as: car1, car2,
car3 , etc ... and a separate database or array should hold the brand
@@ -376,3 +376,3 @@
[example {
- # Suppose mr. Wiggly has a preference for the Trabant:
+ # Suppose Mr. Wiggly has a preference for the Trabant:
if { [CarPool request car -allocID "Mr. Wiggly" -prefer Trabant] } {
--- modules/textutil/expander.man.orig Tue Jun 11 11:26:29 2002
+++ modules/textutil/expander.man Tue Jun 11 11:27:08 2002
@@ -1,3 +1,3 @@
-[comment {-*- tcl -*- doctools manpage}]
[manpage_begin expander n 1.0.1]
+[comment {-*- tcl -*- doctools manpage}]
[moddesc {Text expansion and template processing}]
@@ -77,3 +77,3 @@
described below. The rest of the section is taken by a description of
-the methods for the exapnder objects created by this command.
+the methods for the expander objects created by this command.
@@ -245,3 +245,3 @@
-Returns the current command for processing polain text, which defaults
+Returns the current command for processing plain text, which defaults
to the empty string, meaning [emph identity]. If specified,
--- modules/textutil/textutil.man.orig Tue Jun 11 11:35:06 2002
+++ modules/textutil/textutil.man Tue Jun 11 11:35:16 2002
@@ -144,3 +144,3 @@
-[arg num] spaces this comand works more like an editor. [arg num]
+[arg num] spaces this command works more like an editor. [arg num]
defaults to 8.
