From 1862ab1259270b5a83e955528dccc4b63c652648 Mon Sep 17 00:00:00 2001
From: dkf <donal.k.fellows@manchester.ac.uk>
Date: Mon, 18 Jul 2011 15:24:59 +0000
Subject: More small documentation improvements.
---
doc/binary.n | 4 ++--
doc/clock.n | 8 ++++----
doc/file.n | 6 +++---
doc/http.n | 4 ++--
doc/interp.n | 4 ++--
doc/lsearch.n | 2 +-
doc/lsort.n | 4 ++--
doc/mathop.n | 2 +-
doc/packagens.n | 10 +++++-----
doc/pkgMkIndex.n | 4 ++--
doc/socket.n | 4 ++--
doc/tcltest.n | 4 ++--
doc/unset.n | 6 +++---
tools/tcltk-man2html-utils.tcl | 19 ++++++++++++++++---
tools/tcltk-man2html.tcl | 14 +++++++++++++-
15 files changed, 60 insertions(+), 35 deletions(-)
diff --git a/doc/binary.n b/doc/binary.n
index 53d8b5a..8133829 100644
--- a/doc/binary.n
+++ b/doc/binary.n
@@ -13,9 +13,9 @@
binary \- Insert and extract fields from binary strings
.SH SYNOPSIS
.VS 8.6
-\fBbinary decode \fIformat\fR ?\fI-option value ...\fR? \fIdata\fR
+\fBbinary decode \fIformat\fR ?\fI\-option value ...\fR? \fIdata\fR
.br
-\fBbinary encode \fIformat\fR ?\fI-option value ...\fR? \fIdata\fR
+\fBbinary encode \fIformat\fR ?\fI\-option value ...\fR? \fIdata\fR
.br
.VE 8.6
\fBbinary format \fIformatString \fR?\fIarg arg ...\fR?
diff --git a/doc/clock.n b/doc/clock.n
index 56a139e..8708029 100644
--- a/doc/clock.n
+++ b/doc/clock.n
@@ -42,12 +42,12 @@ is system-dependent but should be the highest resolution clock available
on the system such as a CPU cycle counter. See \fBHIGH RESOLUTION TIMERS\fR for a full description.
.RS
.PP
-If the \fI\-option\fR argument is \fI\-milliseconds\fR, then the command
+If the \fI\-option\fR argument is \fB\-milliseconds\fR, then the command
is synonymous with \fBclock milliseconds\fR (see below). This
usage is obsolete, and \fBclock milliseconds\fR is to be
considered the preferred way of obtaining a count of milliseconds.
.PP
-If the \fI\-option\fR argument is \fI\-microseconds\fR, then the command
+If the \fI\-option\fR argument is \fB\-microseconds\fR, then the command
is synonymous with \fBclock microseconds\fR (see below). This
usage is obsolete, and \fBclock microseconds\fR is to be
considered the preferred way of obtaining a count of microseconds.
@@ -116,7 +116,7 @@ On \fBclock format\fR, the default format is
%a %b %d %H:%M:%S %z %Y
.CE
.PP
-On \fBclock scan\fR, the lack of a \fI\-format\fR option indicates that a
+On \fBclock scan\fR, the lack of a \fB\-format\fR option indicates that a
.QW "free format scan"
is requested; see \fBFREE FORM SCAN\fR for a description of what happens.
.RE
@@ -904,7 +904,7 @@ or
Note that only these three formats are accepted.
The command does \fInot\fR accept the full range of point-in-time
specifications specified in ISO8601. Other formats can be recognized by
-giving an explicit \fI\-format\fR option to the \fBclock scan\fR command.
+giving an explicit \fB\-format\fR option to the \fBclock scan\fR command.
.TP
\fIrelative time\fR
A specification relative to the current time. The format is \fBnumber
diff --git a/doc/file.n b/doc/file.n
index 9205d3b..eef4647 100644
--- a/doc/file.n
+++ b/doc/file.n
@@ -104,7 +104,7 @@ within a single filesystem, \fIfile copy\fR will copy soft links (i.e.
the links themselves are copied, not the things they point to). Trying
to overwrite a non-empty directory, overwrite a directory with a file,
or overwrite a file with a directory will all result in errors even if
-\fI\-force\fR was specified. Arguments are processed in the order
+\fB\-force\fR was specified. Arguments are processed in the order
specified, halting at the first error, if any. A \fB\-\|\-\fR marks
the end of switches; the argument following the \fB\-\|\-\fR will be
treated as a \fIsource\fR even if it starts with a \fB\-\fR.
@@ -227,9 +227,9 @@ If the user wishes to make a link of a specific type only, (and signal an
error if for some reason that is not possible), then the optional
\fI\-linktype\fR argument should be given. Accepted values for
\fI\-linktype\fR are
-.QW \-symbolic
+.QW \fB\-symbolic\fR
and
-.QW \-hard .
+.QW \fB\-hard\fR .
.PP
On Unix, symbolic links can be made to relative paths, and those paths
must be relative to the actual \fIlinkName\fR's location (not to the
diff --git a/doc/http.n b/doc/http.n
index b05588e..631a141 100644
--- a/doc/http.n
+++ b/doc/http.n
@@ -16,9 +16,9 @@ http \- Client-side implementation of the HTTP/1.1 protocol
\fBpackage require http ?2.7?\fR
.\" See Also -useragent option documentation in body!
.sp
-\fB::http::config ?\fI-option value\fR ...?
+\fB::http::config ?\fI\-option value\fR ...?
.sp
-\fB::http::geturl \fIurl\fR ?\fI-option value\fR ...?
+\fB::http::geturl \fIurl\fR ?\fI\-option value\fR ...?
.sp
\fB::http::formatQuery\fR \fIkey value\fR ?\fIkey value\fR ...?
.sp
diff --git a/doc/interp.n b/doc/interp.n
index 02421e1..b261779 100644
--- a/doc/interp.n
+++ b/doc/interp.n
@@ -194,11 +194,11 @@ given name already exists in this master.
The initial recursion limit of the slave interpreter is set to the
current recursion limit of its parent interpreter.
.TP
-\fBinterp\fR \fBdebug \fIpath\fR ?\fI\-frame\fR ?\fIbool\fR??
+\fBinterp\fR \fBdebug \fIpath\fR ?\fB\-frame\fR ?\fIbool\fR??
.
Controls whether frame-level stack information is captured in the
slave interpreter identified by \fIpath\fR. If no arguments are
-given, option and current setting are returned. If \fI\-frame\fR
+given, option and current setting are returned. If \fB\-frame\fR
is given, the debug setting is set to the given boolean if provided
and the current setting is returned.
This only effects the output of \fBinfo frame\fR, in that exact
diff --git a/doc/lsearch.n b/doc/lsearch.n
index a049b53..7835352 100644
--- a/doc/lsearch.n
+++ b/doc/lsearch.n
@@ -161,7 +161,7 @@ If this option is given, the index result from this command (or every
index result when \fB\-all\fR is also specified) will be a complete
path (suitable for use with \fBlindex\fR or \fBlset\fR) within the
overall list to the term found. This option has no effect unless the
-\fI\-index\fR is also specified, and is just a convenience short-cut.
+\fB\-index\fR is also specified, and is just a convenience short-cut.
.SH EXAMPLES
.PP
Basic searching:
diff --git a/doc/lsort.n b/doc/lsort.n
index 8e85f5a..312048e 100644
--- a/doc/lsort.n
+++ b/doc/lsort.n
@@ -79,7 +79,7 @@ the values themselves.
\fB\-index\0\fIindexList\fR
.
If this option is specified, each of the elements of \fIlist\fR must
-itself be a proper Tcl sublist (unless \fB-stride\fR is used).
+itself be a proper Tcl sublist (unless \fB\-stride\fR is used).
Instead of sorting based on whole sublists, \fBlsort\fR will extract
the \fIindexList\fR'th element from each sublist (as if the overall
element and the \fIindexList\fR were passed to \fBlindex\fR) and sort
@@ -161,7 +161,7 @@ effect if combined with the \fB\-dictionary\fR, \fB\-integer\fR, or
If this option is specified, then only the last set of duplicate
elements found in the list will be retained. Note that duplicates are
determined relative to the comparison used in the sort. Thus if
-\fI\-index 0\fR is used, \fB{1 a}\fR and \fB{1 b}\fR would be
+\fB\-index 0\fR is used, \fB{1 a}\fR and \fB{1 b}\fR would be
considered duplicates and only the second element, \fB{1 b}\fR, would
be retained.
.SH "NOTES"
diff --git a/doc/mathop.n b/doc/mathop.n
index 282b636..e359276 100644
--- a/doc/mathop.n
+++ b/doc/mathop.n
@@ -133,7 +133,7 @@ holds true:
.RS
.PP
.CS
-(\fIx \fB/ \fIy\fR) \fB* \fIy \fB== \fIx \fB-\fR (\fIx \fB% \fIy\fR)
+(\fIx \fB/ \fIy\fR) \fB* \fIy \fB== \fIx \fB\-\fR (\fIx \fB% \fIy\fR)
.CE
.RE
.TP
diff --git a/doc/packagens.n b/doc/packagens.n
index 1220b20..30617a3 100644
--- a/doc/packagens.n
+++ b/doc/packagens.n
@@ -9,7 +9,7 @@
.SH NAME
pkg::create \- Construct an appropriate 'package ifneeded' command for a given package specification
.SH SYNOPSIS
-\fB::pkg::create \fI\-name packageName\fR \fI\-version packageVersion\fR ?\fI\-load filespec\fR? ... ?\fI\-source filespec\fR? ...
+\fB::pkg::create\fR \fB\-name \fIpackageName \fB\-version \fIpackageVersion\fR ?\fB\-load \fIfilespec\fR? ... ?\fB\-source \fIfilespec\fR? ...
.BE
.SH DESCRIPTION
@@ -22,13 +22,13 @@ command for a given package specification. It can be used to construct a
.SH OPTIONS
The parameters supported are:
.TP
-\fB\-name\fR\0\fIpackageName\fR
+\fB\-name \fIpackageName\fR
This parameter specifies the name of the package. It is required.
.TP
-\fB\-version\fR\0\fIpackageVersion\fR
+\fB\-version \fIpackageVersion\fR
This parameter specifies the version of the package. It is required.
.TP
-\fB\-load\fR\0\fIfilespec\fR
+\fB\-load \fIfilespec\fR
This parameter specifies a binary library that must be loaded with the
\fBload\fR command. \fIfilespec\fR is a list with two elements. The
first element is the name of the file to load. The second, optional
@@ -37,7 +37,7 @@ list of procedures is empty or omitted, \fB::pkg::create\fR will
set up the library for direct loading (see \fBpkg_mkIndex\fR). Any
number of \fB\-load\fR parameters may be specified.
.TP
-\fB\-source\fR\0\fIfilespec\fR
+\fB\-source \fIfilespec\fR
This parameter is similar to the \fB\-load\fR parameter, except that it
specifies a Tcl library that must be loaded with the
\fBsource\fR command. Any number of \fB\-source\fR parameters may be
diff --git a/doc/pkgMkIndex.n b/doc/pkgMkIndex.n
index 07370ef..2753208 100644
--- a/doc/pkgMkIndex.n
+++ b/doc/pkgMkIndex.n
@@ -153,7 +153,7 @@ commands for each version of each available package; these commands
invoke \fBpackage provide\fR commands to announce the
availability of the package, and they setup auto-loader
information to load the files of the package.
-If the \fI\-lazy\fR flag was provided when the \fBpkgIndex.tcl\fR
+If the \fB\-lazy\fR flag was provided when the \fBpkgIndex.tcl\fR
was generated,
a given file of a given version of a given package is not
actually loaded until the first time one of its commands
@@ -168,7 +168,7 @@ commands or those which require special initialization, might select
that their package files be loaded immediately upon \fBpackage require\fR
instead of delaying the actual loading to the first use of one of the
package's command. This is the default mode when generating the package
-index. It can be overridden by specifying the \fI\-lazy\fR argument.
+index. It can be overridden by specifying the \fB\-lazy\fR argument.
.SH "COMPLEX CASES"
Most complex cases of dependencies among scripts
and binary files, and packages being split among scripts and
diff --git a/doc/socket.n b/doc/socket.n
index 9c9366d..e2c4759 100644
--- a/doc/socket.n
+++ b/doc/socket.n
@@ -169,8 +169,8 @@ identical to the address, the first element of the list.
For server sockets this option returns a list of a multiple of three
elements each group of which have the same meaning as described
above. The list contains more than one group when the server socket
-was created without \fB-myaddr\fR or with the argument to
-\fB-myaddr\fR being a domain name that resolves multiple IP addresses
+was created without \fB\-myaddr\fR or with the argument to
+\fB\-myaddr\fR being a domain name that resolves multiple IP addresses
that are local to the invoking host.
.TP
diff --git a/doc/tcltest.n b/doc/tcltest.n
index 5977013..731bed7 100644
--- a/doc/tcltest.n
+++ b/doc/tcltest.n
@@ -32,7 +32,7 @@ tcltest \- Test harness support code and utilities
\fBtcltest::configure\fR
\fBtcltest::configure \fI\-option\fR
-\fBtcltest::configure \fI\-option value\fR ?\fI-option value ...\fR?
+\fBtcltest::configure \fI\-option value\fR ?\fI\-option value ...\fR?
\fBtcltest::customMatch \fImode command\fR
\fBtcltest::testConstraint \fIconstraint\fR ?\fIvalue\fR?
\fBtcltest::outputChannel \fR?\fIchannelID\fR?
@@ -90,7 +90,7 @@ of how to use the commands of \fBtcltest\fR to produce test suites
for your Tcl-enabled code.
.SH COMMANDS
.TP
-\fBtest\fR \fIname description\fR ?\fI-option value ...\fR?
+\fBtest\fR \fIname description\fR ?\fI\-option value ...\fR?
.
Defines and possibly runs a test with the name \fIname\fR and
description \fIdescription\fR. The name and description of a test
diff --git a/doc/unset.n b/doc/unset.n
index b86407a..64b334d 100644
--- a/doc/unset.n
+++ b/doc/unset.n
@@ -13,7 +13,7 @@
.SH NAME
unset \- Delete variables
.SH SYNOPSIS
-\fBunset \fR?\fI\-nocomplain\fR? ?\fI\-\-\fR? ?\fIname name name ...\fR?
+\fBunset \fR?\fB\-nocomplain\fR? ?\fB\-\-\fR? ?\fIname name name ...\fR?
.BE
.SH DESCRIPTION
.PP
@@ -25,9 +25,9 @@ element is removed without affecting the rest of the array.
If a \fIname\fR consists of an array name with no parenthesized
index, then the entire array is deleted.
The \fBunset\fR command returns an empty string as result.
-If \fI\-nocomplain\fR is specified as the first argument, any possible
+If \fB\-nocomplain\fR is specified as the first argument, any possible
errors are suppressed. The option may not be abbreviated, in order to
-disambiguate it from possible variable names. The option \fI\-\-\fR
+disambiguate it from possible variable names. The option \fB\-\-\fR
indicates the end of the options, and should be used if you wish to
remove a variable with the same name as any of the options.
If an error occurs during variable deletion, any variables after the named one
diff --git a/tools/tcltk-man2html-utils.tcl b/tools/tcltk-man2html-utils.tcl
index 16e9a93..a7270a1 100644
--- a/tools/tcltk-man2html-utils.tcl
+++ b/tools/tcltk-man2html-utils.tcl
@@ -623,7 +623,7 @@ proc cross-reference {ref} {
global ensemble_commands exclude_refs_map exclude_when_followed_by_map
set manname $manual(name)
set mantail $manual(tail)
- if {[string match "Tcl_*" $ref] || [string match "Tk_*" $ref]} {
+ if {[string match "Tcl_*" $ref] || [string match "Tk_*" $ref] || [string match "Ttk_*" $ref]} {
set lref $ref
##
## apply a link remapping if available
@@ -758,6 +758,7 @@ proc insert-cross-references {text} {
bold {<B>} end-bold {</B>}
tcl {Tcl_}
tk {Tk_}
+ ttk {Ttk_}
Tcl1 {Tcl manual entry}
Tcl2 {Tcl overview manual entry}
url {http://}
@@ -795,7 +796,7 @@ proc insert-cross-references {text} {
if {$offset(end-quote) < 0} {
return [reference-error "Missing end quote" $text]
}
- if {$invert([lindex $offsets 1]) in {tcl tk}} {
+ if {$invert([lindex $offsets 1]) in {tcl tk ttk}} {
set offsets [lreplace $offsets 1 1]
}
switch -exact -- $invert([lindex $offsets 1]) {
@@ -824,7 +825,7 @@ proc insert-cross-references {text} {
if {$offset(end-bold) < 0} {
return [append result $text]
}
- if {$invert([lindex $offsets 1]) in {tcl tk}} {
+ if {$invert([lindex $offsets 1]) in {tcl tk ttk}} {
set offsets [lreplace $offsets 1 1]
}
switch -exact -- $invert([lindex $offsets 1]) {
@@ -864,6 +865,18 @@ proc insert-cross-references {text} {
append result [cross-reference $body]
continue
}
+ ttk {
+ append result [string range $text 0 [expr {$offset(ttk)-1}]]
+ if {![regexp -indices -start $offset(ttk) {Ttk_\w+} $text range]} {
+ return [reference-error "Ttk regexp failed" $text]
+ }
+ set body [string range $text {*}$range]
+ set text [string range $text[set text ""] \
+ [expr {[lindex $range 1]+1}] end]
+ set tail $text
+ append result [cross-reference $body]
+ continue
+ }
tcl {
append result [string range $text 0 [expr {$offset(tcl)-1}]]
if {![regexp -indices -start $offset(tcl) {Tcl_\w+} $text range]} {
diff --git a/tools/tcltk-man2html.tcl b/tools/tcltk-man2html.tcl
index 33d9ff9..cd8b0e5 100755
--- a/tools/tcltk-man2html.tcl
+++ b/tools/tcltk-man2html.tcl
@@ -836,22 +836,31 @@ array set exclude_refs_map {
next.n {unknown}
zlib.n {binary close filename text}
canvas.n {bitmap text}
+ console.n {eval}
checkbutton.n {image}
clipboard.n {string}
+ entry.n {string}
+ event.n {return}
+ font.n {menu}
+ getOpenFile.n {file open text}
+ grab.n {global}
interp.n {time}
menu.n {checkbutton radiobutton}
+ messageBox.n {error info}
options.n {bitmap image set}
radiobutton.n {image}
safe.n {join split}
+ scale.n {label variable}
scrollbar.n {set}
selection.n {string}
tcltest.n {error}
tkvars.n {tk}
+ tkwait.n {variable}
tm.n {exec}
ttk_checkbutton.n {variable}
ttk_combobox.n {selection}
ttk_entry.n {focus variable}
- ttk_intro.n {focus}
+ ttk_intro.n {focus text}
ttk_label.n {font text}
ttk_labelframe.n {text}
ttk_menubutton.n {flush}
@@ -880,6 +889,9 @@ array set exclude_when_followed_by_map {
ttk_image.n {
image imageSpec
}
+ fontchooser.n {
+ tk fontchooser
+ }
}
try {
--
cgit v0.12