From 32881d222bd536bdbf64ad2faf3deb6bb1f34aca Mon Sep 17 00:00:00 2001 From: das Date: Fri, 12 Nov 2004 09:01:22 +0000 Subject: * doc/CrtChannel.3: * doc/Interp.3: * doc/Limit.3: * doc/binary.n: * doc/dict.n: * doc/tm.n: * doc/upvar.n: fixed *roff errors uncovered by running 'make html'. * tools/tcltk-man2html.tcl: added faked support for bullet point lists, i.e. *nroff ".IP \(bu" syntax. --- ChangeLog | 13 +++++++++++++ doc/CrtChannel.3 | 4 ++-- doc/Interp.3 | 6 +++--- doc/Limit.3 | 4 ++-- doc/binary.n | 4 ++-- doc/dict.n | 6 +++--- doc/tm.n | 10 +++++----- doc/upvar.n | 18 +++++++++--------- tools/tcltk-man2html.tcl | 3 +++ 9 files changed, 42 insertions(+), 26 deletions(-) diff --git a/ChangeLog b/ChangeLog index 24bce63..173f6ab 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2004-11-12 Daniel Steffen + + * doc/CrtChannel.3: + * doc/Interp.3: + * doc/Limit.3: + * doc/binary.n: + * doc/dict.n: + * doc/tm.n: + * doc/upvar.n: fixed *roff errors uncovered by running 'make html'. + + * tools/tcltk-man2html.tcl: added faked support for bullet point + lists, i.e. *nroff ".IP \(bu" syntax. + 2004-11-11 Daniel Steffen * tests/fCmd.test: diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index 8fce08c..779b755 100644 --- a/doc/CrtChannel.3 +++ b/doc/CrtChannel.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtChannel.3,v 1.23 2004/11/02 09:23:38 dkf Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.24 2004/11/12 09:01:25 das Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -35,7 +35,7 @@ int Tcl_ThreadId \fBTcl_GetChannelThread\fR(\fIchannel\fR) .VE 8.4 -.SP +.sp int \fBTcl_GetChannelMode\fR(\fIchannel\fR) .sp diff --git a/doc/Interp.3 b/doc/Interp.3 index 14ac854..a67c9f1 100644 --- a/doc/Interp.3 +++ b/doc/Interp.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Interp.3,v 1.6 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: Interp.3,v 1.7 2004/11/12 09:01:25 das Exp $ '\" .so man.macros .TH Tcl_Interp 3 7.5 Tcl "Tcl Library Procedures" @@ -34,8 +34,8 @@ on the interpreter. Interpreter structures contain many fields that are used by Tcl, but only three that may be accessed by clients: \fIresult\fR, \fIfreeProc\fR, and \fIerrorLine\fR. .PP -\fBNote that access to the \fIresult\fP and \fIfreeProc\fP fields is -deprecated.\fR Use \fBTcl_SetResult\fR and \fBTcl_GetResult\fR instead. +\fBNote that access to the \fIresult\fB and \fIfreeProc\fB fields is\fR +\fBdeprecated.\fR Use \fBTcl_SetResult\fR and \fBTcl_GetResult\fR instead. .PP The \fIresult\fR and \fIfreeProc\fR fields are used to return results or error messages from commands. diff --git a/doc/Limit.3 b/doc/Limit.3 index 389c406..002b422 100644 --- a/doc/Limit.3 +++ b/doc/Limit.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Limit.3,v 1.6 2004/10/07 16:05:14 dkf Exp $ +'\" RCS: @(#) $Id: Limit.3,v 1.7 2004/11/12 09:01:25 das Exp $ '\" .so man.macros .TH Tcl_LimitCheck 3 8.5 Tcl "Tcl Library Procedures" @@ -148,7 +148,7 @@ call \fBTcl_LimitTypeSet\fR, and to disable a limit call The level of a command limit may be set using \fBTcl_LimitSetCommands\fR, and retrieved using \fBTcl_LimitGetCommands\fR. Similarly for a time limit with -\fRTcl_LimitSetTime\fR and \fBTcl_LimitGetTime\fR respectively, but +\fBTcl_LimitSetTime\fR and \fBTcl_LimitGetTime\fR respectively, but with that API the time limit is copied from and to the Tcl_Time structure that the \fItimeLimitPtr\fR argument points to. .PP diff --git a/doc/binary.n b/doc/binary.n index ca75b6a..a4f7008 100644 --- a/doc/binary.n +++ b/doc/binary.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: binary.n,v 1.22 2004/10/27 14:24:37 dkf Exp $ +'\" RCS: @(#) $Id: binary.n,v 1.23 2004/11/12 09:01:25 das Exp $ '\" .so man.macros .TH binary n 8.0 Tcl "Tcl Built-In Commands" @@ -82,7 +82,7 @@ formatted. For example, .CE will return a string equivalent to \fBalpha\\000\\000bravoc\fR and .CS -\fBbinary format a* [encoding convertto utf-8 \\u20ac] +\fBbinary format a* [encoding convertto utf-8 \\u20ac]\fR .CE will return a string equivalent to \fB\\342\\202\\254\fR (which is the UTF-8 byte sequence for a Euro-currency character). diff --git a/doc/dict.n b/doc/dict.n index 98cb491..f0d4ea9 100644 --- a/doc/dict.n +++ b/doc/dict.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: dict.n,v 1.10 2004/10/31 15:38:35 dkf Exp $ +'\" RCS: @(#) $Id: dict.n,v 1.11 2004/11/12 09:01:25 das Exp $ '\" .so man.macros .TH dict n 8.5 Tcl "Tcl Built-In Commands" @@ -268,8 +268,8 @@ foreach c {abcdefghijklmnopqrstuvwxyz} { # English locales can luckily share the "C" locale \fBdict set\fR capital en [\fBdict get\fR $capital C] -\fBdict set\fR capital en_US [\fRdict get\fR $capital C] -\fBdict set\fR capital en_GB [\fRdict get\fR $capital C] +\fBdict set\fR capital en_US [\fBdict get\fR $capital C] +\fBdict set\fR capital en_GB [\fBdict get\fR $capital C] # ... and so on for other supported languages ... diff --git a/doc/tm.n b/doc/tm.n index d8a35cc..aa33fc4 100644 --- a/doc/tm.n +++ b/doc/tm.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tm.n,v 1.4 2004/10/22 22:33:48 dkf Exp $ +'\" RCS: @(#) $Id: tm.n,v 1.5 2004/11/12 09:01:25 das Exp $ '\" .so man.macros .TH tm n 8.5 Tcl "Tcl Built-In Commands" @@ -25,7 +25,7 @@ tm \- Facilities for locating and loading of Tcl Modules This document describes the facilities for locating and loading Tcl Modules. The following commands are supported: .TP -\fB::tcl::tm::path\fR \fBadd\fR \fIpath\fR...\fR +\fB::tcl::tm::path\fR \fBadd\fR \fIpath\fR... The paths are added at the head to the list of module paths, in order of appearance. This means that the last argument ends up as the new head of the list. @@ -46,15 +46,15 @@ reverse order of addition. In other words, the paths added last are looked at first. .RE .TP -\fB::tcl::tm::path\fR \fBremove\fR \fIpath\fR...\fR +\fB::tcl::tm::path\fR \fBremove\fR \fIpath\fR... Removes the paths from the list of module paths. The command silently ignores all paths which are not on the list. .TP -\fB::tcl::tm::path\fR \fBlist\fR\fR +\fB::tcl::tm::path\fR \fBlist\fR Returns a list containing all registered module paths, in the order that they are searched for modules. .TP -\fB::tcl::tm::roots\fR \fIpath\fR...\fR +\fB::tcl::tm::roots\fR \fIpath\fR... Similar to \fBpath add\fR, and layered on top of it. This command takes a list of paths, extends each with "\fBtcl\fIX\fB/site-tcl\fR", and "\fBtcl\fIX\fB/\fIX\fB.\fIy\fR", for major version \fIX\fR of the diff --git a/doc/upvar.n b/doc/upvar.n index 8cc28a6..145adf9 100644 --- a/doc/upvar.n +++ b/doc/upvar.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: upvar.n,v 1.8 2004/10/27 14:43:54 dkf Exp $ +'\" RCS: @(#) $Id: upvar.n,v 1.9 2004/11/12 09:01:25 das Exp $ '\" .so man.macros .TH upvar n "" Tcl "Tcl Built-In Commands" @@ -46,12 +46,12 @@ procedure calling and also makes it easier to build new control constructs as Tcl procedures. For example, consider the following procedure: .CS -\fBproc add2 name { +proc \fBadd2\fR name { \fBupvar\fR $name x set x [expr $x+2] -}\fR +} .CE -\fBAdd2\fR is invoked with an argument giving the name of a variable, +\fBadd2\fR is invoked with an argument giving the name of a variable, and it adds two to the value of that variable. Although \fBadd2\fR could have been implemented using \fBuplevel\fR instead of \fBupvar\fR, \fBupvar\fR makes it simpler for \fBadd2\fR @@ -84,17 +84,17 @@ the trace procedure will be passed the name of \fImyVar\fR, rather than the name of \fIotherVar\fR. Thus, the output of the following code will be \fBlocalVar\fR rather than \fBoriginalVar\fR: .CS -\fBproc traceproc { name index op } { +proc \fBtraceproc\fR { name index op } { puts $name } -proc setByUpvar { name value } { +proc \fBsetByUpvar\fR { name value } { \fBupvar\fR $name localVar set localVar $value } set originalVar 1 -trace variable originalVar w traceproc -setByUpvar originalVar 2 -}\fR +trace variable originalVar w \fBtraceproc\fR +\fBsetByUpvar\fR originalVar 2 +} .CE .PP If \fIotherVar\fR refers to an element of an array, then variable diff --git a/tools/tcltk-man2html.tcl b/tools/tcltk-man2html.tcl index 7190b1d..b9c8280 100755 --- a/tools/tcltk-man2html.tcl +++ b/tools/tcltk-man2html.tcl @@ -230,6 +230,7 @@ proc process-text {text} { {\(+-} {±} \ {\fP} {\fR} \ {\.} . \ + {\(bu} {•} \ ] $text] regsub -all {\\o'o\^'} $text {\ô} text; # o-circumflex in re_syntax.n regsub -all {\\-\\\|\\-} $text -- text; # two hyphens @@ -558,6 +559,8 @@ proc output-IP-list {context code rest} { if {[string equal $manual(section) "ARGUMENTS"] || \ [regexp {^\[\d+\]$} $rest]} { man-puts "$para
$rest
" + } elseif {[string equal {•} $rest]} { + man-puts "$para
$rest " } else { man-puts "$para
[long-toc $rest]
" } -- cgit v0.12