diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2009-07-24 09:27:17 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2009-07-24 09:27:17 (GMT) |
commit | 2e48744c8edfe050bbe2ac99b4fac911eb2aa1fa (patch) | |
tree | 9ecaf22d3444daca639ecf2323ccd3da427ba18e /doc | |
parent | 8569a517d4490cb136c99a73fb036eef3d05bd25 (diff) | |
download | tcl-2e48744c8edfe050bbe2ac99b4fac911eb2aa1fa.zip tcl-2e48744c8edfe050bbe2ac99b4fac911eb2aa1fa.tar.gz tcl-2e48744c8edfe050bbe2ac99b4fac911eb2aa1fa.tar.bz2 |
Removed mention of auto_mkindex_old from indexed locations; we really
don't want people finding out about it and using it if they're not
already doing so...
Diffstat (limited to 'doc')
-rw-r--r-- | doc/library.n | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/library.n b/doc/library.n index 572c0eb..7fcd574 100644 --- a/doc/library.n +++ b/doc/library.n @@ -5,19 +5,18 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: library.n,v 1.25 2008/11/26 19:19:16 kennykb Exp $ +'\" RCS: @(#) $Id: library.n,v 1.26 2009/07/24 09:27:17 dkf Exp $ .so man.macros .TH library n "8.0" Tcl "Tcl Built-In Commands" .BS .SH NAME -auto_execok, auto_import, auto_load, auto_mkindex, auto_mkindex_old, auto_qualify, auto_reset, tcl_findLibrary, parray, tcl_endOfWord, tcl_startOfNextWord, tcl_startOfPreviousWord, tcl_wordBreakAfter, tcl_wordBreakBefore \- standard library of Tcl procedures +auto_execok, auto_import, auto_load, auto_mkindex, auto_qualify, auto_reset, tcl_findLibrary, parray, tcl_endOfWord, tcl_startOfNextWord, tcl_startOfPreviousWord, tcl_wordBreakAfter, tcl_wordBreakBefore \- standard library of Tcl procedures .SH SYNOPSIS .nf \fBauto_execok \fIcmd\fR \fBauto_import \fIpattern\fR \fBauto_load \fIcmd\fR \fBauto_mkindex \fIdir pattern pattern ...\fR -\fBauto_mkindex_old \fIdir pattern pattern ...\fR \fBauto_qualify \fIcommand namespace\fR \fBauto_reset\fR \fBtcl_findLibrary \fIbasename version patch initScript enVarName varName\fR @@ -132,18 +131,21 @@ auto_mkindex_parser package to register other commands that can contribute to the auto_load index. You will have to read through auto.tcl to see how this works. .PP -\fBAuto_mkindex_old\fR parses the Tcl scripts in a relatively -unsophisticated way: if any line contains the word \fBproc\fR +\fBAuto_mkindex_old\fR +(which has the same syntax as \fBauto_mkindex\fR) +parses the Tcl scripts in a relatively +unsophisticated way: if any line contains the word +.QW \fBproc\fR as its first characters then it is assumed to be a procedure definition and the next word of the line is taken as the procedure's name. -Procedure definitions that do not appear in this way (e.g. they +Procedure definitions that do not appear in this way (e.g.\ they have spaces before the \fBproc\fR) will not be indexed. If your script contains .QW dangerous code, such as global initialization code or procedure names with special characters like \fB$\fR, -\fB*\fR, \fB[\fR or \fB]\fR, you are safer using auto_mkindex_old. +\fB*\fR, \fB[\fR or \fB]\fR, you are safer using \fBauto_mkindex_old\fR. .RE .TP \fBauto_reset\fR |