0000: 27 5c 22 0a 27 5c 22 20 47 65 6e 65 72 61 74 65 '\".'\" Generate
0010: 64 20 66 72 6f 6d 20 66 69 6c 65 20 27 2f 6e 65 d from file '/ne
0020: 74 2f 6e 61 73 2f 64 61 74 61 2f 61 6e 64 72 65 t/nas/data/andre
0030: 61 73 6b 2f 44 65 76 2f 54 63 6c 6c 69 62 2f 74 ask/Dev/Tcllib/t
0040: 63 6c 6c 69 62 2f 65 6d 62 65 64 64 65 64 2f 6d cllib/embedded/m
0050: 61 6e 2f 66 69 6c 65 73 2f 6d 6f 64 75 6c 65 73 an/files/modules
0060: 2f 64 6f 63 74 6f 6f 6c 73 32 69 64 78 2f 65 78 /doctools2idx/ex
0070: 70 6f 72 74 5f 64 6f 63 69 64 78 2e 6e 27 20 62 port_docidx.n' b
0080: 79 20 74 63 6c 6c 69 62 2f 64 6f 63 74 6f 6f 6c y tcllib/doctool
0090: 73 20 77 69 74 68 20 66 6f 72 6d 61 74 20 27 6e s with format 'n
00a0: 72 6f 66 66 27 0a 27 5c 22 20 43 6f 70 79 72 69 roff'.'\" Copyri
00b0: 67 68 74 20 28 63 29 20 32 30 30 39 20 41 6e 64 ght (c) 2009 And
00c0: 72 65 61 73 20 4b 75 70 72 69 65 73 20 3c 61 6e reas Kupries <an
00d0: 64 72 65 61 73 5f 6b 75 70 72 69 65 73 40 75 73 dreas_kupries@us
00e0: 65 72 73 2e 73 6f 75 72 63 65 66 6f 72 67 65 2e ers.sourceforge.
00f0: 6e 65 74 3e 0a 27 5c 22 0a 27 5c 22 20 54 68 65 net>.'\".'\" The
0100: 20 64 65 66 69 6e 69 74 69 6f 6e 73 20 62 65 6c definitions bel
0110: 6f 77 20 61 72 65 20 66 6f 72 20 73 75 70 70 6c ow are for suppl
0120: 65 6d 65 6e 74 61 6c 20 6d 61 63 72 6f 73 20 75 emental macros u
0130: 73 65 64 20 69 6e 20 54 63 6c 2f 54 6b 0a 27 5c sed in Tcl/Tk.'\
0140: 22 20 6d 61 6e 75 61 6c 20 65 6e 74 72 69 65 73 " manual entries
0150: 2e 0a 27 5c 22 0a 27 5c 22 20 2e 41 50 20 74 79 ..'\".'\" .AP ty
0160: 70 65 20 6e 61 6d 65 20 69 6e 2f 6f 75 74 20 3f pe name in/out ?
0170: 69 6e 64 65 6e 74 3f 0a 27 5c 22 09 53 74 61 72 indent?.'\".Star
0180: 74 20 70 61 72 61 67 72 61 70 68 20 64 65 73 63 t paragraph desc
0190: 72 69 62 69 6e 67 20 61 6e 20 61 72 67 75 6d 65 ribing an argume
01a0: 6e 74 20 74 6f 20 61 20 6c 69 62 72 61 72 79 20 nt to a library
01b0: 70 72 6f 63 65 64 75 72 65 2e 0a 27 5c 22 09 74 procedure..'\".t
01c0: 79 70 65 20 69 73 20 74 79 70 65 20 6f 66 20 61 ype is type of a
01d0: 72 67 75 6d 65 6e 74 20 28 69 6e 74 2c 20 65 74 rgument (int, et
01e0: 63 2e 29 2c 20 69 6e 2f 6f 75 74 20 69 73 20 65 c.), in/out is e
01f0: 69 74 68 65 72 20 22 69 6e 22 2c 20 22 6f 75 74 ither "in", "out
0200: 22 2c 0a 27 5c 22 09 6f 72 20 22 69 6e 2f 6f 75 ",.'\".or "in/ou
0210: 74 22 20 74 6f 20 64 65 73 63 72 69 62 65 20 77 t" to describe w
0220: 68 65 74 68 65 72 20 70 72 6f 63 65 64 75 72 65 hether procedure
0230: 20 72 65 61 64 73 20 6f 72 20 6d 6f 64 69 66 69 reads or modifi
0240: 65 73 20 61 72 67 2c 0a 27 5c 22 09 61 6e 64 20 es arg,.'\".and
0250: 69 6e 64 65 6e 74 20 69 73 20 65 71 75 69 76 61 indent is equiva
0260: 6c 65 6e 74 20 74 6f 20 73 65 63 6f 6e 64 20 61 lent to second a
0270: 72 67 20 6f 66 20 2e 49 50 20 28 73 68 6f 75 6c rg of .IP (shoul
0280: 64 6e 27 74 20 65 76 65 72 20 62 65 0a 27 5c 22 dn't ever be.'\"
0290: 09 6e 65 65 64 65 64 3b 20 20 75 73 65 20 2e 41 .needed; use .A
02a0: 53 20 62 65 6c 6f 77 20 69 6e 73 74 65 61 64 29 S below instead)
02b0: 0a 27 5c 22 0a 27 5c 22 20 2e 41 53 20 3f 74 79 .'\".'\" .AS ?ty
02c0: 70 65 3f 20 3f 6e 61 6d 65 3f 0a 27 5c 22 09 47 pe? ?name?.'\".G
02d0: 69 76 65 20 6d 61 78 69 6d 75 6d 20 73 69 7a 65 ive maximum size
02e0: 73 20 6f 66 20 61 72 67 75 6d 65 6e 74 73 20 66 s of arguments f
02f0: 6f 72 20 73 65 74 74 69 6e 67 20 74 61 62 20 73 or setting tab s
0300: 74 6f 70 73 2e 20 20 54 79 70 65 20 61 6e 64 0a tops. Type and.
0310: 27 5c 22 09 6e 61 6d 65 20 61 72 65 20 65 78 61 '\".name are exa
0320: 6d 70 6c 65 73 20 6f 66 20 6c 61 72 67 65 73 74 mples of largest
0330: 20 70 6f 73 73 69 62 6c 65 20 61 72 67 75 6d 65 possible argume
0340: 6e 74 73 20 74 68 61 74 20 77 69 6c 6c 20 62 65 nts that will be
0350: 20 70 61 73 73 65 64 0a 27 5c 22 09 74 6f 20 2e passed.'\".to .
0360: 41 50 20 6c 61 74 65 72 2e 20 20 49 66 20 61 72 AP later. If ar
0370: 67 73 20 61 72 65 20 6f 6d 69 74 74 65 64 2c 20 gs are omitted,
0380: 64 65 66 61 75 6c 74 20 74 61 62 20 73 74 6f 70 default tab stop
0390: 73 20 61 72 65 20 75 73 65 64 2e 0a 27 5c 22 0a s are used..'\".
03a0: 27 5c 22 20 2e 42 53 0a 27 5c 22 09 53 74 61 72 '\" .BS.'\".Star
03b0: 74 20 62 6f 78 20 65 6e 63 6c 6f 73 75 72 65 2e t box enclosure.
03c0: 20 20 46 72 6f 6d 20 68 65 72 65 20 75 6e 74 69 From here unti
03d0: 6c 20 6e 65 78 74 20 2e 42 45 2c 20 65 76 65 72 l next .BE, ever
03e0: 79 74 68 69 6e 67 20 77 69 6c 6c 20 62 65 0a 27 ything will be.'
03f0: 5c 22 09 65 6e 63 6c 6f 73 65 64 20 69 6e 20 6f \".enclosed in o
0400: 6e 65 20 6c 61 72 67 65 20 62 6f 78 2e 0a 27 5c ne large box..'\
0410: 22 0a 27 5c 22 20 2e 42 45 0a 27 5c 22 09 45 6e ".'\" .BE.'\".En
0420: 64 20 6f 66 20 62 6f 78 20 65 6e 63 6c 6f 73 75 d of box enclosu
0430: 72 65 2e 0a 27 5c 22 0a 27 5c 22 20 2e 43 53 0a re..'\".'\" .CS.
0440: 27 5c 22 09 42 65 67 69 6e 20 63 6f 64 65 20 65 '\".Begin code e
0450: 78 63 65 72 70 74 2e 0a 27 5c 22 0a 27 5c 22 20 xcerpt..'\".'\"
0460: 2e 43 45 0a 27 5c 22 09 45 6e 64 20 63 6f 64 65 .CE.'\".End code
0470: 20 65 78 63 65 72 70 74 2e 0a 27 5c 22 0a 27 5c excerpt..'\".'\
0480: 22 20 2e 56 53 20 3f 76 65 72 73 69 6f 6e 3f 20 " .VS ?version?
0490: 3f 62 72 3f 0a 27 5c 22 09 42 65 67 69 6e 20 76 ?br?.'\".Begin v
04a0: 65 72 74 69 63 61 6c 20 73 69 64 65 62 61 72 2c ertical sidebar,
04b0: 20 66 6f 72 20 75 73 65 20 69 6e 20 6d 61 72 6b for use in mark
04c0: 69 6e 67 20 6e 65 77 6c 79 2d 63 68 61 6e 67 65 ing newly-change
04d0: 64 20 70 61 72 74 73 0a 27 5c 22 09 6f 66 20 6d d parts.'\".of m
04e0: 61 6e 20 70 61 67 65 73 2e 20 20 54 68 65 20 66 an pages. The f
04f0: 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 69 73 irst argument is
0500: 20 69 67 6e 6f 72 65 64 20 61 6e 64 20 75 73 65 ignored and use
0510: 64 20 66 6f 72 20 72 65 63 6f 72 64 69 6e 67 0a d for recording.
0520: 27 5c 22 09 74 68 65 20 76 65 72 73 69 6f 6e 20 '\".the version
0530: 77 68 65 6e 20 74 68 65 20 2e 56 53 20 77 61 73 when the .VS was
0540: 20 61 64 64 65 64 2c 20 73 6f 20 74 68 61 74 20 added, so that
0550: 74 68 65 20 73 69 64 65 62 61 72 73 20 63 61 6e the sidebars can
0560: 20 62 65 0a 27 5c 22 09 66 6f 75 6e 64 20 61 6e be.'\".found an
0570: 64 20 72 65 6d 6f 76 65 64 20 77 68 65 6e 20 74 d removed when t
0580: 68 65 79 20 72 65 61 63 68 20 61 20 63 65 72 74 hey reach a cert
0590: 61 69 6e 20 61 67 65 2e 20 20 49 66 20 61 6e 6f ain age. If ano
05a0: 74 68 65 72 20 61 72 67 75 6d 65 6e 74 0a 27 5c ther argument.'\
05b0: 22 09 69 73 20 70 72 65 73 65 6e 74 2c 20 74 68 ".is present, th
05c0: 65 6e 20 61 20 6c 69 6e 65 20 62 72 65 61 6b 20 en a line break
05d0: 69 73 20 66 6f 72 63 65 64 20 62 65 66 6f 72 65 is forced before
05e0: 20 73 74 61 72 74 69 6e 67 20 74 68 65 20 73 69 starting the si
05f0: 64 65 62 61 72 2e 0a 27 5c 22 0a 27 5c 22 20 2e debar..'\".'\" .
0600: 56 45 0a 27 5c 22 09 45 6e 64 20 6f 66 20 76 65 VE.'\".End of ve
0610: 72 74 69 63 61 6c 20 73 69 64 65 62 61 72 2e 0a rtical sidebar..
0620: 27 5c 22 0a 27 5c 22 20 2e 44 53 0a 27 5c 22 09 '\".'\" .DS.'\".
0630: 42 65 67 69 6e 20 61 6e 20 69 6e 64 65 6e 74 65 Begin an indente
0640: 64 20 75 6e 66 69 6c 6c 65 64 20 64 69 73 70 6c d unfilled displ
0650: 61 79 2e 0a 27 5c 22 0a 27 5c 22 20 2e 44 45 0a ay..'\".'\" .DE.
0660: 27 5c 22 09 45 6e 64 20 6f 66 20 69 6e 64 65 6e '\".End of inden
0670: 74 65 64 20 75 6e 66 69 6c 6c 65 64 20 64 69 73 ted unfilled dis
0680: 70 6c 61 79 2e 0a 27 5c 22 0a 27 5c 22 20 2e 53 play..'\".'\" .S
0690: 4f 0a 27 5c 22 09 53 74 61 72 74 20 6f 66 20 6c O.'\".Start of l
06a0: 69 73 74 20 6f 66 20 73 74 61 6e 64 61 72 64 20 ist of standard
06b0: 6f 70 74 69 6f 6e 73 20 66 6f 72 20 61 20 54 6b options for a Tk
06c0: 20 77 69 64 67 65 74 2e 20 20 54 68 65 0a 27 5c widget. The.'\
06d0: 22 09 6f 70 74 69 6f 6e 73 20 66 6f 6c 6c 6f 77 ".options follow
06e0: 20 6f 6e 20 73 75 63 63 65 73 73 69 76 65 20 6c on successive l
06f0: 69 6e 65 73 2c 20 69 6e 20 66 6f 75 72 20 63 6f ines, in four co
0700: 6c 75 6d 6e 73 20 73 65 70 61 72 61 74 65 64 0a lumns separated.
0710: 27 5c 22 09 62 79 20 74 61 62 73 2e 0a 27 5c 22 '\".by tabs..'\"
0720: 0a 27 5c 22 20 2e 53 45 0a 27 5c 22 09 45 6e 64 .'\" .SE.'\".End
0730: 20 6f 66 20 6c 69 73 74 20 6f 66 20 73 74 61 6e of list of stan
0740: 64 61 72 64 20 6f 70 74 69 6f 6e 73 20 66 6f 72 dard options for
0750: 20 61 20 54 6b 20 77 69 64 67 65 74 2e 0a 27 5c a Tk widget..'\
0760: 22 0a 27 5c 22 20 2e 4f 50 20 63 6d 64 4e 61 6d ".'\" .OP cmdNam
0770: 65 20 64 62 4e 61 6d 65 20 64 62 43 6c 61 73 73 e dbName dbClass
0780: 0a 27 5c 22 09 53 74 61 72 74 20 6f 66 20 64 65 .'\".Start of de
0790: 73 63 72 69 70 74 69 6f 6e 20 6f 66 20 61 20 73 scription of a s
07a0: 70 65 63 69 66 69 63 20 6f 70 74 69 6f 6e 2e 20 pecific option.
07b0: 20 63 6d 64 4e 61 6d 65 20 67 69 76 65 73 20 74 cmdName gives t
07c0: 68 65 0a 27 5c 22 09 6f 70 74 69 6f 6e 27 73 20 he.'\".option's
07d0: 6e 61 6d 65 20 61 73 20 73 70 65 63 69 66 69 65 name as specifie
07e0: 64 20 69 6e 20 74 68 65 20 63 6c 61 73 73 20 63 d in the class c
07f0: 6f 6d 6d 61 6e 64 2c 20 64 62 4e 61 6d 65 20 67 ommand, dbName g
0800: 69 76 65 73 0a 27 5c 22 09 74 68 65 20 6f 70 74 ives.'\".the opt
0810: 69 6f 6e 27 73 20 6e 61 6d 65 20 69 6e 20 74 68 ion's name in th
0820: 65 20 6f 70 74 69 6f 6e 20 64 61 74 61 62 61 73 e option databas
0830: 65 2c 20 61 6e 64 20 64 62 43 6c 61 73 73 20 67 e, and dbClass g
0840: 69 76 65 73 0a 27 5c 22 09 74 68 65 20 6f 70 74 ives.'\".the opt
0850: 69 6f 6e 27 73 20 63 6c 61 73 73 20 69 6e 20 74 ion's class in t
0860: 68 65 20 6f 70 74 69 6f 6e 20 64 61 74 61 62 61 he option databa
0870: 73 65 2e 0a 27 5c 22 0a 27 5c 22 20 2e 55 4c 20 se..'\".'\" .UL
0880: 61 72 67 31 20 61 72 67 32 0a 27 5c 22 09 50 72 arg1 arg2.'\".Pr
0890: 69 6e 74 20 61 72 67 31 20 75 6e 64 65 72 6c 69 int arg1 underli
08a0: 6e 65 64 2c 20 74 68 65 6e 20 70 72 69 6e 74 20 ned, then print
08b0: 61 72 67 32 20 6e 6f 72 6d 61 6c 6c 79 2e 0a 27 arg2 normally..'
08c0: 5c 22 0a 27 5c 22 20 52 43 53 3a 20 40 28 23 29 \".'\" RCS: @(#)
08d0: 20 24 49 64 3a 20 6d 61 6e 2e 6d 61 63 72 6f 73 $Id: man.macros
08e0: 2c 76 20 31 2e 31 20 32 30 30 39 2f 30 31 2f 33 ,v 1.1 2009/01/3
08f0: 30 20 30 34 3a 35 36 3a 34 37 20 61 6e 64 72 65 0 04:56:47 andre
0900: 61 73 5f 6b 75 70 72 69 65 73 20 45 78 70 20 24 as_kupries Exp $
0910: 0a 27 5c 22 0a 27 5c 22 09 23 20 53 65 74 20 75 .'\".'\".# Set u
0920: 70 20 74 72 61 70 73 20 61 6e 64 20 6f 74 68 65 p traps and othe
0930: 72 20 6d 69 73 63 65 6c 6c 61 6e 65 6f 75 73 20 r miscellaneous
0940: 73 74 75 66 66 20 66 6f 72 20 54 63 6c 2f 54 6b stuff for Tcl/Tk
0950: 20 6d 61 6e 20 70 61 67 65 73 2e 0a 2e 69 66 20 man pages...if
0960: 74 20 2e 77 68 20 2d 31 2e 33 69 20 5e 42 0a 2e t .wh -1.3i ^B..
0970: 6e 72 20 5e 6c 20 5c 6e 28 2e 6c 0a 2e 61 64 20 nr ^l \n(.l..ad
0980: 62 0a 27 5c 22 09 23 20 53 74 61 72 74 20 61 6e b.'\".# Start an
0990: 20 61 72 67 75 6d 65 6e 74 20 64 65 73 63 72 69 argument descri
09a0: 70 74 69 6f 6e 0a 2e 64 65 20 41 50 0a 2e 69 65 ption..de AP..ie
09b0: 20 21 22 5c 5c 24 34 22 22 20 2e 54 50 20 5c 5c !"\\$4"" .TP \\
09c0: 24 34 0a 2e 65 6c 20 5c 7b 5c 0a 2e 20 20 20 69 $4..el \{\.. i
09d0: 65 20 21 22 5c 5c 24 32 22 22 20 2e 54 50 20 5c e !"\\$2"" .TP \
09e0: 5c 6e 28 29 43 75 0a 2e 20 20 20 65 6c 20 20 20 \n()Cu.. el
09f0: 20 20 20 20 20 20 20 2e 54 50 20 31 35 0a 2e 5c .TP 15..\
0a00: 7d 0a 2e 74 61 20 5c 5c 6e 28 29 41 75 20 5c 5c }..ta \\n()Au \\
0a10: 6e 28 29 42 75 0a 2e 69 65 20 21 22 5c 5c 24 33 n()Bu..ie !"\\$3
0a20: 22 22 20 5c 7b 5c 0a 5c 26 5c 5c 24 31 09 5c 5c "" \{\.\&\\$1.\\
0a30: 66 49 5c 5c 24 32 5c 5c 66 50 09 28 5c 5c 24 33 fI\\$2\\fP.(\\$3
0a40: 29 0a 2e 5c 22 2e 62 0a 2e 5c 7d 0a 2e 65 6c 20 )..\".b..\}..el
0a50: 5c 7b 5c 0a 2e 62 72 0a 2e 69 65 20 21 22 5c 5c \{\..br..ie !"\\
0a60: 24 32 22 22 20 5c 7b 5c 0a 5c 26 5c 5c 24 31 09 $2"" \{\.\&\\$1.
0a70: 5c 5c 66 49 5c 5c 24 32 5c 5c 66 50 0a 2e 5c 7d \\fI\\$2\\fP..\}
0a80: 0a 2e 65 6c 20 5c 7b 5c 0a 5c 26 5c 5c 66 49 5c ..el \{\.\&\\fI\
0a90: 5c 24 31 5c 5c 66 50 0a 2e 5c 7d 0a 2e 5c 7d 0a \$1\\fP..\}..\}.
0aa0: 2e 2e 0a 27 5c 22 09 23 20 64 65 66 69 6e 65 20 ...'\".# define
0ab0: 74 61 62 62 69 6e 67 20 76 61 6c 75 65 73 20 66 tabbing values f
0ac0: 6f 72 20 2e 41 50 0a 2e 64 65 20 41 53 0a 2e 6e or .AP..de AS..n
0ad0: 72 20 29 41 20 31 30 6e 0a 2e 69 66 20 21 22 5c r )A 10n..if !"\
0ae0: 5c 24 31 22 22 20 2e 6e 72 20 29 41 20 5c 5c 77 \$1"" .nr )A \\w
0af0: 27 5c 5c 24 31 27 75 2b 33 6e 0a 2e 6e 72 20 29 '\\$1'u+3n..nr )
0b00: 42 20 5c 5c 6e 28 29 41 75 2b 31 35 6e 0a 2e 5c B \\n()Au+15n..\
0b10: 22 0a 2e 69 66 20 21 22 5c 5c 24 32 22 22 20 2e "..if !"\\$2"" .
0b20: 6e 72 20 29 42 20 5c 5c 77 27 5c 5c 24 32 27 75 nr )B \\w'\\$2'u
0b30: 2b 5c 5c 6e 28 29 41 75 2b 33 6e 0a 2e 6e 72 20 +\\n()Au+3n..nr
0b40: 29 43 20 5c 5c 6e 28 29 42 75 2b 5c 5c 77 27 28 )C \\n()Bu+\\w'(
0b50: 69 6e 2f 6f 75 74 29 27 75 2b 32 6e 0a 2e 2e 0a in/out)'u+2n....
0b60: 2e 41 53 20 54 63 6c 5f 49 6e 74 65 72 70 20 54 .AS Tcl_Interp T
0b70: 63 6c 5f 43 72 65 61 74 65 49 6e 74 65 72 70 20 cl_CreateInterp
0b80: 69 6e 2f 6f 75 74 0a 27 5c 22 09 23 20 42 53 20 in/out.'\".# BS
0b90: 2d 20 73 74 61 72 74 20 62 6f 78 65 64 20 74 65 - start boxed te
0ba0: 78 74 0a 27 5c 22 09 23 20 5e 79 20 3d 20 73 74 xt.'\".# ^y = st
0bb0: 61 72 74 69 6e 67 20 79 20 6c 6f 63 61 74 69 6f arting y locatio
0bc0: 6e 0a 27 5c 22 09 23 20 5e 62 20 3d 20 31 0a 2e n.'\".# ^b = 1..
0bd0: 64 65 20 42 53 0a 2e 62 72 0a 2e 6d 6b 20 5e 79 de BS..br..mk ^y
0be0: 0a 2e 6e 72 20 5e 62 20 31 75 0a 2e 69 66 20 6e ..nr ^b 1u..if n
0bf0: 20 2e 6e 66 0a 2e 69 66 20 6e 20 2e 74 69 20 30 .nf..if n .ti 0
0c00: 0a 2e 69 66 20 6e 20 5c 6c 27 5c 5c 6e 28 2e 6c ..if n \l'\\n(.l
0c10: 75 5c 28 75 6c 27 0a 2e 69 66 20 6e 20 2e 66 69 u\(ul'..if n .fi
0c20: 0a 2e 2e 0a 27 5c 22 09 23 20 42 45 20 2d 20 65 ....'\".# BE - e
0c30: 6e 64 20 62 6f 78 65 64 20 74 65 78 74 20 28 64 nd boxed text (d
0c40: 72 61 77 20 62 6f 78 20 6e 6f 77 29 0a 2e 64 65 raw box now)..de
0c50: 20 42 45 0a 2e 6e 66 0a 2e 74 69 20 30 0a 2e 6d BE..nf..ti 0..m
0c60: 6b 20 5e 74 0a 2e 69 65 20 6e 20 5c 6c 27 5c 5c k ^t..ie n \l'\\
0c70: 6e 28 5e 6c 75 5c 28 75 6c 27 0a 2e 65 6c 20 5c n(^lu\(ul'..el \
0c80: 7b 5c 0a 2e 5c 22 09 44 72 61 77 20 66 6f 75 72 {\..\".Draw four
0c90: 2d 73 69 64 65 64 20 62 6f 78 20 6e 6f 72 6d 61 -sided box norma
0ca0: 6c 6c 79 2c 20 62 75 74 20 64 6f 6e 27 74 20 64 lly, but don't d
0cb0: 72 61 77 20 74 6f 70 20 6f 66 0a 2e 5c 22 09 62 raw top of..\".b
0cc0: 6f 78 20 69 66 20 74 68 65 20 62 6f 78 20 73 74 ox if the box st
0cd0: 61 72 74 65 64 20 6f 6e 20 61 6e 20 65 61 72 6c arted on an earl
0ce0: 69 65 72 20 70 61 67 65 2e 0a 2e 69 65 20 21 5c ier page...ie !\
0cf0: 5c 6e 28 5e 62 2d 31 20 5c 7b 5c 0a 5c 68 27 2d \n(^b-1 \{\.\h'-
0d00: 31 2e 35 6e 27 5c 4c 27 7c 5c 5c 6e 28 5e 79 75 1.5n'\L'|\\n(^yu
0d10: 2d 31 76 27 5c 6c 27 5c 5c 6e 28 5e 6c 75 2b 33 -1v'\l'\\n(^lu+3
0d20: 6e 5c 28 75 6c 27 5c 4c 27 5c 5c 6e 28 5e 74 75 n\(ul'\L'\\n(^tu
0d30: 2b 31 76 2d 5c 5c 6e 28 5e 79 75 27 5c 6c 27 7c +1v-\\n(^yu'\l'|
0d40: 30 75 2d 31 2e 35 6e 5c 28 75 6c 27 0a 2e 5c 7d 0u-1.5n\(ul'..\}
0d50: 0a 2e 65 6c 20 5c 7d 5c 0a 5c 68 27 2d 31 2e 35 ..el \}\.\h'-1.5
0d60: 6e 27 5c 4c 27 7c 5c 5c 6e 28 5e 79 75 2d 31 76 n'\L'|\\n(^yu-1v
0d70: 27 5c 68 27 5c 5c 6e 28 5e 6c 75 2b 33 6e 27 5c '\h'\\n(^lu+3n'\
0d80: 4c 27 5c 5c 6e 28 5e 74 75 2b 31 76 2d 5c 5c 6e L'\\n(^tu+1v-\\n
0d90: 28 5e 79 75 27 5c 6c 27 7c 30 75 2d 31 2e 35 6e (^yu'\l'|0u-1.5n
0da0: 5c 28 75 6c 27 0a 2e 5c 7d 0a 2e 5c 7d 0a 2e 66 \(ul'..\}..\}..f
0db0: 69 0a 2e 62 72 0a 2e 6e 72 20 5e 62 20 30 0a 2e i..br..nr ^b 0..
0dc0: 2e 0a 27 5c 22 09 23 20 56 53 20 2d 20 73 74 61 ..'\".# VS - sta
0dd0: 72 74 20 76 65 72 74 69 63 61 6c 20 73 69 64 65 rt vertical side
0de0: 62 61 72 0a 27 5c 22 09 23 20 5e 59 20 3d 20 73 bar.'\".# ^Y = s
0df0: 74 61 72 74 69 6e 67 20 79 20 6c 6f 63 61 74 69 tarting y locati
0e00: 6f 6e 0a 27 5c 22 09 23 20 5e 76 20 3d 20 31 20 on.'\".# ^v = 1
0e10: 28 66 6f 72 20 74 72 6f 66 66 3b 20 20 66 6f 72 (for troff; for
0e20: 20 6e 72 6f 66 66 20 74 68 69 73 20 64 6f 65 73 nroff this does
0e30: 6e 27 74 20 6d 61 74 74 65 72 29 0a 2e 64 65 20 n't matter)..de
0e40: 56 53 0a 2e 69 66 20 21 22 5c 5c 24 32 22 22 20 VS..if !"\\$2""
0e50: 2e 62 72 0a 2e 6d 6b 20 5e 59 0a 2e 69 65 20 6e .br..mk ^Y..ie n
0e60: 20 27 6d 63 20 5c 73 31 32 5c 28 62 72 5c 73 30 'mc \s12\(br\s0
0e70: 0a 2e 65 6c 20 2e 6e 72 20 5e 76 20 31 75 0a 2e ..el .nr ^v 1u..
0e80: 2e 0a 27 5c 22 09 23 20 56 45 20 2d 20 65 6e 64 ..'\".# VE - end
0e90: 20 6f 66 20 76 65 72 74 69 63 61 6c 20 73 69 64 of vertical sid
0ea0: 65 62 61 72 0a 2e 64 65 20 56 45 0a 2e 69 65 20 ebar..de VE..ie
0eb0: 6e 20 27 6d 63 0a 2e 65 6c 20 5c 7b 5c 0a 2e 65 n 'mc..el \{\..e
0ec0: 76 20 32 0a 2e 6e 66 0a 2e 74 69 20 30 0a 2e 6d v 2..nf..ti 0..m
0ed0: 6b 20 5e 74 0a 5c 68 27 7c 5c 5c 6e 28 5e 6c 75 k ^t.\h'|\\n(^lu
0ee0: 2b 33 6e 27 5c 4c 27 7c 5c 5c 6e 28 5e 59 75 2d +3n'\L'|\\n(^Yu-
0ef0: 31 76 5c 28 62 76 27 5c 76 27 5c 5c 6e 28 5e 74 1v\(bv'\v'\\n(^t
0f00: 75 2b 31 76 2d 5c 5c 6e 28 5e 59 75 27 5c 68 27 u+1v-\\n(^Yu'\h'
0f10: 2d 7c 5c 5c 6e 28 5e 6c 75 2b 33 6e 27 0a 2e 73 -|\\n(^lu+3n'..s
0f20: 70 20 2d 31 0a 2e 66 69 0a 2e 65 76 0a 2e 5c 7d p -1..fi..ev..\}
0f30: 0a 2e 6e 72 20 5e 76 20 30 0a 2e 2e 0a 27 5c 22 ..nr ^v 0....'\"
0f40: 09 23 20 53 70 65 63 69 61 6c 20 6d 61 63 72 6f .# Special macro
0f50: 20 74 6f 20 68 61 6e 64 6c 65 20 70 61 67 65 20 to handle page
0f60: 62 6f 74 74 6f 6d 3a 20 20 66 69 6e 69 73 68 20 bottom: finish
0f70: 6f 66 66 20 63 75 72 72 65 6e 74 0a 27 5c 22 09 off current.'\".
0f80: 23 20 62 6f 78 2f 73 69 64 65 62 61 72 20 69 66 # box/sidebar if
0f90: 20 69 6e 20 62 6f 78 2f 73 69 64 65 62 61 72 20 in box/sidebar
0fa0: 6d 6f 64 65 2c 20 74 68 65 6e 20 69 6e 76 6f 6b mode, then invok
0fb0: 65 64 20 73 74 61 6e 64 61 72 64 0a 27 5c 22 09 ed standard.'\".
0fc0: 23 20 70 61 67 65 20 62 6f 74 74 6f 6d 20 6d 61 # page bottom ma
0fd0: 63 72 6f 2e 0a 2e 64 65 20 5e 42 0a 2e 65 76 20 cro...de ^B..ev
0fe0: 32 0a 27 74 69 20 30 0a 27 6e 66 0a 2e 6d 6b 20 2.'ti 0.'nf..mk
0ff0: 5e 74 0a 2e 69 66 20 5c 5c 6e 28 5e 62 20 5c 7b ^t..if \\n(^b \{
1000: 5c 0a 2e 5c 22 09 44 72 61 77 20 74 68 72 65 65 \..\".Draw three
1010: 2d 73 69 64 65 64 20 62 6f 78 20 69 66 20 74 68 -sided box if th
1020: 69 73 20 69 73 20 74 68 65 20 62 6f 78 27 73 20 is is the box's
1030: 66 69 72 73 74 20 70 61 67 65 2c 0a 2e 5c 22 09 first page,..\".
1040: 64 72 61 77 20 74 77 6f 20 73 69 64 65 73 20 62 draw two sides b
1050: 75 74 20 6e 6f 20 74 6f 70 20 6f 74 68 65 72 77 ut no top otherw
1060: 69 73 65 2e 0a 2e 69 65 20 21 5c 5c 6e 28 5e 62 ise...ie !\\n(^b
1070: 2d 31 20 5c 68 27 2d 31 2e 35 6e 27 5c 4c 27 7c -1 \h'-1.5n'\L'|
1080: 5c 5c 6e 28 5e 79 75 2d 31 76 27 5c 6c 27 5c 5c \\n(^yu-1v'\l'\\
1090: 6e 28 5e 6c 75 2b 33 6e 5c 28 75 6c 27 5c 4c 27 n(^lu+3n\(ul'\L'
10a0: 5c 5c 6e 28 5e 74 75 2b 31 76 2d 5c 5c 6e 28 5e \\n(^tu+1v-\\n(^
10b0: 79 75 27 5c 68 27 7c 30 75 27 5c 63 0a 2e 65 6c yu'\h'|0u'\c..el
10c0: 20 5c 68 27 2d 31 2e 35 6e 27 5c 4c 27 7c 5c 5c \h'-1.5n'\L'|\\
10d0: 6e 28 5e 79 75 2d 31 76 27 5c 68 27 5c 5c 6e 28 n(^yu-1v'\h'\\n(
10e0: 5e 6c 75 2b 33 6e 27 5c 4c 27 5c 5c 6e 28 5e 74 ^lu+3n'\L'\\n(^t
10f0: 75 2b 31 76 2d 5c 5c 6e 28 5e 79 75 27 5c 68 27 u+1v-\\n(^yu'\h'
1100: 7c 30 75 27 5c 63 0a 2e 5c 7d 0a 2e 69 66 20 5c |0u'\c..\}..if \
1110: 5c 6e 28 5e 76 20 5c 7b 5c 0a 2e 6e 72 20 5e 78 \n(^v \{\..nr ^x
1120: 20 5c 5c 6e 28 5e 74 75 2b 31 76 2d 5c 5c 6e 28 \\n(^tu+1v-\\n(
1130: 5e 59 75 0a 5c 6b 78 5c 68 27 2d 5c 5c 6e 78 75 ^Yu.\kx\h'-\\nxu
1140: 27 5c 68 27 7c 5c 5c 6e 28 5e 6c 75 2b 33 6e 27 '\h'|\\n(^lu+3n'
1150: 5c 6b 79 5c 4c 27 2d 5c 5c 6e 28 5e 78 75 27 5c \ky\L'-\\n(^xu'\
1160: 76 27 5c 5c 6e 28 5e 78 75 27 5c 68 27 7c 30 75 v'\\n(^xu'\h'|0u
1170: 27 5c 63 0a 2e 5c 7d 0a 2e 62 70 0a 27 66 69 0a '\c..\}..bp.'fi.
1180: 2e 65 76 0a 2e 69 66 20 5c 5c 6e 28 5e 62 20 5c .ev..if \\n(^b \
1190: 7b 5c 0a 2e 6d 6b 20 5e 79 0a 2e 6e 72 20 5e 62 {\..mk ^y..nr ^b
11a0: 20 32 0a 2e 5c 7d 0a 2e 69 66 20 5c 5c 6e 28 5e 2..\}..if \\n(^
11b0: 76 20 5c 7b 5c 0a 2e 6d 6b 20 5e 59 0a 2e 5c 7d v \{\..mk ^Y..\}
11c0: 0a 2e 2e 0a 27 5c 22 09 23 20 44 53 20 2d 20 62 ....'\".# DS - b
11d0: 65 67 69 6e 20 64 69 73 70 6c 61 79 0a 2e 64 65 egin display..de
11e0: 20 44 53 0a 2e 52 53 0a 2e 6e 66 0a 2e 73 70 0a DS..RS..nf..sp.
11f0: 2e 2e 0a 27 5c 22 09 23 20 44 45 20 2d 20 65 6e ...'\".# DE - en
1200: 64 20 64 69 73 70 6c 61 79 0a 2e 64 65 20 44 45 d display..de DE
1210: 0a 2e 66 69 0a 2e 52 45 0a 2e 73 70 0a 2e 2e 0a ..fi..RE..sp....
1220: 27 5c 22 09 23 20 53 4f 20 2d 20 73 74 61 72 74 '\".# SO - start
1230: 20 6f 66 20 6c 69 73 74 20 6f 66 20 73 74 61 6e of list of stan
1240: 64 61 72 64 20 6f 70 74 69 6f 6e 73 0a 2e 64 65 dard options..de
1250: 20 53 4f 0a 2e 53 48 20 22 53 54 41 4e 44 41 52 SO..SH "STANDAR
1260: 44 20 4f 50 54 49 4f 4e 53 22 0a 2e 4c 50 0a 2e D OPTIONS"..LP..
1270: 6e 66 0a 2e 74 61 20 34 63 20 38 63 20 31 32 63 nf..ta 4c 8c 12c
1280: 0a 2e 66 74 20 42 0a 2e 2e 0a 27 5c 22 09 23 20 ..ft B....'\".#
1290: 53 45 20 2d 20 65 6e 64 20 6f 66 20 6c 69 73 74 SE - end of list
12a0: 20 6f 66 20 73 74 61 6e 64 61 72 64 20 6f 70 74 of standard opt
12b0: 69 6f 6e 73 0a 2e 64 65 20 53 45 0a 2e 66 69 0a ions..de SE..fi.
12c0: 2e 66 74 20 52 0a 2e 4c 50 0a 53 65 65 20 74 68 .ft R..LP.See th
12d0: 65 20 5c 5c 66 42 6f 70 74 69 6f 6e 73 5c 5c 66 e \\fBoptions\\f
12e0: 52 20 6d 61 6e 75 61 6c 20 65 6e 74 72 79 20 66 R manual entry f
12f0: 6f 72 20 64 65 74 61 69 6c 73 20 6f 6e 20 74 68 or details on th
1300: 65 20 73 74 61 6e 64 61 72 64 20 6f 70 74 69 6f e standard optio
1310: 6e 73 2e 0a 2e 2e 0a 27 5c 22 09 23 20 4f 50 20 ns.....'\".# OP
1320: 2d 20 73 74 61 72 74 20 6f 66 20 66 75 6c 6c 20 - start of full
1330: 64 65 73 63 72 69 70 74 69 6f 6e 20 66 6f 72 20 description for
1340: 61 20 73 69 6e 67 6c 65 20 6f 70 74 69 6f 6e 0a a single option.
1350: 2e 64 65 20 4f 50 0a 2e 4c 50 0a 2e 6e 66 0a 2e .de OP..LP..nf..
1360: 74 61 20 34 63 0a 43 6f 6d 6d 61 6e 64 2d 4c 69 ta 4c.Command-Li
1370: 6e 65 20 4e 61 6d 65 3a 09 5c 5c 66 42 5c 5c 24 ne Name:.\\fB\\$
1380: 31 5c 5c 66 52 0a 44 61 74 61 62 61 73 65 20 4e 1\\fR.Database N
1390: 61 6d 65 3a 09 5c 5c 66 42 5c 5c 24 32 5c 5c 66 ame:.\\fB\\$2\\f
13a0: 52 0a 44 61 74 61 62 61 73 65 20 43 6c 61 73 73 R.Database Class
13b0: 3a 09 5c 5c 66 42 5c 5c 24 33 5c 5c 66 52 0a 2e :.\\fB\\$3\\fR..
13c0: 66 69 0a 2e 49 50 0a 2e 2e 0a 27 5c 22 09 23 20 fi..IP....'\".#
13d0: 43 53 20 2d 20 62 65 67 69 6e 20 63 6f 64 65 20 CS - begin code
13e0: 65 78 63 65 72 70 74 0a 2e 64 65 20 43 53 0a 2e excerpt..de CS..
13f0: 52 53 0a 2e 6e 66 0a 2e 74 61 20 2e 32 35 69 20 RS..nf..ta .25i
1400: 2e 35 69 20 2e 37 35 69 20 31 69 0a 2e 2e 0a 27 .5i .75i 1i....'
1410: 5c 22 09 23 20 43 45 20 2d 20 65 6e 64 20 63 6f \".# CE - end co
1420: 64 65 20 65 78 63 65 72 70 74 0a 2e 64 65 20 43 de excerpt..de C
1430: 45 0a 2e 66 69 0a 2e 52 45 0a 2e 2e 0a 2e 64 65 E..fi..RE.....de
1440: 20 55 4c 0a 5c 5c 24 31 5c 6c 27 7c 30 5c 28 75 UL.\\$1\l'|0\(u
1450: 6c 27 5c 5c 24 32 0a 2e 2e 0a 2e 54 48 20 22 64 l'\\$2.....TH "d
1460: 6f 63 74 6f 6f 6c 73 3a 3a 69 64 78 3a 3a 65 78 octools::idx::ex
1470: 70 6f 72 74 3a 3a 64 6f 63 69 64 78 22 20 6e 20 port::docidx" n
1480: 30 2e 31 20 74 63 6c 6c 69 62 20 22 44 6f 63 75 0.1 tcllib "Docu
1490: 6d 65 6e 74 61 74 69 6f 6e 20 74 6f 6f 6c 73 22 mentation tools"
14a0: 0a 2e 42 53 0a 2e 53 48 20 4e 41 4d 45 0a 64 6f ..BS..SH NAME.do
14b0: 63 74 6f 6f 6c 73 3a 3a 69 64 78 3a 3a 65 78 70 ctools::idx::exp
14c0: 6f 72 74 3a 3a 64 6f 63 69 64 78 20 5c 2d 20 64 ort::docidx \- d
14d0: 6f 63 69 64 78 20 65 78 70 6f 72 74 20 70 6c 75 ocidx export plu
14e0: 67 69 6e 0a 2e 53 48 20 53 59 4e 4f 50 53 49 53 gin..SH SYNOPSIS
14f0: 0a 70 61 63 6b 61 67 65 20 72 65 71 75 69 72 65 .package require
1500: 20 5c 66 42 54 63 6c 20 20 38 2e 34 5c 66 52 0a \fBTcl 8.4\fR.
1510: 2e 73 70 0a 70 61 63 6b 61 67 65 20 72 65 71 75 .sp.package requ
1520: 69 72 65 20 5c 66 42 64 6f 63 74 6f 6f 6c 73 3a ire \fBdoctools:
1530: 3a 69 64 78 3a 3a 65 78 70 6f 72 74 3a 3a 64 6f :idx::export::do
1540: 63 69 64 78 20 20 3f 30 2e 31 3f 5c 66 52 0a 2e cidx ?0.1?\fR..
1550: 73 70 0a 5c 66 42 65 78 70 6f 72 74 5c 66 52 20 sp.\fBexport\fR
1560: 5c 66 49 73 65 72 69 61 6c 5c 66 52 20 5c 66 49 \fIserial\fR \fI
1570: 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 5c 66 52 configuration\fR
1580: 0a 2e 73 70 0a 2e 42 45 0a 2e 53 48 20 44 45 53 ..sp..BE..SH DES
1590: 43 52 49 50 54 49 4f 4e 0a 54 68 69 73 20 70 61 CRIPTION.This pa
15a0: 63 6b 61 67 65 20 69 6d 70 6c 65 6d 65 6e 74 73 ckage implements
15b0: 20 74 68 65 20 64 6f 63 74 6f 6f 6c 73 20 6b 65 the doctools ke
15c0: 79 77 6f 72 64 20 69 6e 64 65 78 20 65 78 70 6f yword index expo
15d0: 72 74 20 70 6c 75 67 69 6e 20 66 6f 72 0a 74 68 rt plugin for.th
15e0: 65 20 67 65 6e 65 72 61 74 69 6f 6e 20 6f 66 20 e generation of
15f0: 64 6f 63 69 64 78 20 6d 61 72 6b 75 70 2e 0a 2e docidx markup...
1600: 50 50 0a 54 68 69 73 20 69 73 20 61 6e 20 69 6e PP.This is an in
1610: 74 65 72 6e 61 6c 20 70 61 63 6b 61 67 65 20 6f ternal package o
1620: 66 20 64 6f 63 74 6f 6f 6c 73 2c 20 66 6f 72 20 f doctools, for
1630: 75 73 65 20 62 79 20 74 68 65 20 68 69 67 68 65 use by the highe
1640: 72 20 6c 65 76 65 6c 0a 6d 61 6e 61 67 65 6d 65 r level.manageme
1650: 6e 74 20 70 61 63 6b 61 67 65 73 20 68 61 6e 64 nt packages hand
1660: 6c 69 6e 67 20 6b 65 79 77 6f 72 64 20 69 6e 64 ling keyword ind
1670: 69 63 65 73 2c 20 65 73 70 65 63 69 61 6c 6c 79 ices, especially
1680: 20 5c 66 42 64 6f 63 74 6f 6f 6c 73 3a 3a 69 64 \fBdoctools::id
1690: 78 3a 3a 65 78 70 6f 72 74 5c 66 52 2c 20 74 68 x::export\fR, th
16a0: 65 20 65 78 70 6f 72 74 20 6d 61 6e 61 67 65 72 e export manager
16b0: 2e 0a 2e 50 50 0a 55 73 69 6e 67 20 69 74 20 66 ...PP.Using it f
16c0: 72 6f 6d 20 61 20 72 65 67 75 6c 61 72 20 69 6e rom a regular in
16d0: 74 65 72 70 72 65 74 65 72 20 69 73 20 70 6f 73 terpreter is pos
16e0: 73 69 62 6c 65 2c 20 68 6f 77 65 76 65 72 20 6f sible, however o
16f0: 6e 6c 79 20 77 69 74 68 0a 63 6f 6e 74 6f 72 74 nly with.contort
1700: 69 6f 6e 73 2c 20 61 6e 64 20 69 73 20 6e 6f 74 ions, and is not
1710: 20 72 65 63 6f 6d 6d 65 6e 64 65 64 2e 0a 54 68 recommended..Th
1720: 65 20 70 72 6f 70 65 72 20 77 61 79 20 74 6f 20 e proper way to
1730: 75 73 65 20 74 68 69 73 20 66 75 6e 63 74 69 6f use this functio
1740: 6e 61 6c 69 74 79 20 69 73 20 74 68 72 6f 75 67 nality is throug
1750: 68 20 74 68 65 20 70 61 63 6b 61 67 65 0a 5c 66 h the package.\f
1760: 42 64 6f 63 74 6f 6f 6c 73 3a 3a 69 64 78 3a 3a Bdoctools::idx::
1770: 65 78 70 6f 72 74 5c 66 52 20 61 6e 64 20 74 68 export\fR and th
1780: 65 20 65 78 70 6f 72 74 20 6d 61 6e 61 67 65 72 e export manager
1790: 20 6f 62 6a 65 63 74 73 20 69 74 0a 70 72 6f 76 objects it.prov
17a0: 69 64 65 73 2e 0a 2e 53 48 20 41 50 49 0a 54 68 ides...SH API.Th
17b0: 65 20 41 50 49 20 70 72 6f 76 69 64 65 64 20 62 e API provided b
17c0: 79 20 74 68 69 73 20 70 61 63 6b 61 67 65 20 73 y this package s
17d0: 61 74 69 73 66 69 65 73 20 74 68 65 20 73 70 65 atisfies the spe
17e0: 63 69 66 69 63 61 74 69 6f 6e 20 6f 66 20 74 68 cification of th
17f0: 65 0a 64 6f 63 69 64 78 20 65 78 70 6f 72 74 20 e.docidx export
1800: 70 6c 75 67 69 6e 20 41 50 49 20 76 65 72 73 69 plugin API versi
1810: 6f 6e 20 32 2e 0a 2e 54 50 0a 5c 66 42 65 78 70 on 2...TP.\fBexp
1820: 6f 72 74 5c 66 52 20 5c 66 49 73 65 72 69 61 6c ort\fR \fIserial
1830: 5c 66 52 20 5c 66 49 63 6f 6e 66 69 67 75 72 61 \fR \fIconfigura
1840: 74 69 6f 6e 5c 66 52 0a 54 68 69 73 20 63 6f 6d tion\fR.This com
1850: 6d 61 6e 64 20 74 61 6b 65 73 20 74 68 65 20 63 mand takes the c
1860: 61 6e 6f 6e 69 63 61 6c 20 73 65 72 69 61 6c 69 anonical seriali
1870: 7a 61 74 69 6f 6e 20 6f 66 20 61 20 6b 65 79 77 zation of a keyw
1880: 6f 72 64 20 69 6e 64 65 78 2c 20 61 73 0a 73 70 ord index, as.sp
1890: 65 63 69 66 69 65 64 20 69 6e 20 73 65 63 74 69 ecified in secti
18a0: 6f 6e 20 5c 66 42 4b 65 79 77 6f 72 64 20 69 6e on \fBKeyword in
18b0: 64 65 78 20 73 65 72 69 61 6c 69 7a 61 74 69 6f dex serializatio
18c0: 6e 20 66 6f 72 6d 61 74 5c 66 52 2c 0a 61 6e 64 n format\fR,.and
18d0: 20 63 6f 6e 74 61 69 6e 65 64 20 69 6e 20 5c 66 contained in \f
18e0: 49 73 65 72 69 61 6c 5c 66 52 2c 20 74 68 65 20 Iserial\fR, the
18f0: 5c 66 49 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e \fIconfiguration
1900: 5c 66 52 2c 20 61 20 64 69 63 74 69 6f 6e 61 72 \fR, a dictionar
1910: 79 2c 0a 61 6e 64 20 67 65 6e 65 72 61 74 65 73 y,.and generates
1920: 20 64 6f 63 69 64 78 20 6d 61 72 6b 75 70 20 65 docidx markup e
1930: 6e 63 6f 64 69 6e 67 20 74 68 65 20 69 6e 64 65 ncoding the inde
1940: 78 2e 0a 54 68 65 20 63 72 65 61 74 65 64 20 73 x..The created s
1950: 74 72 69 6e 67 20 69 73 20 74 68 65 6e 20 72 65 tring is then re
1960: 74 75 72 6e 65 64 20 61 73 20 74 68 65 20 72 65 turned as the re
1970: 73 75 6c 74 20 6f 66 20 74 68 65 20 63 6f 6d 6d sult of the comm
1980: 61 6e 64 2e 0a 2e 50 50 0a 2e 53 48 20 22 5b 44 and...PP..SH "[D
1990: 4f 43 49 44 58 5d 20 4e 4f 54 41 54 49 4f 4e 20 OCIDX] NOTATION
19a0: 4f 46 20 4b 45 59 57 4f 52 44 20 49 4e 44 49 43 OF KEYWORD INDIC
19b0: 45 53 22 0a 54 68 65 20 64 6f 63 69 64 78 20 66 ES".The docidx f
19c0: 6f 72 6d 61 74 20 66 6f 72 20 6b 65 79 77 6f 72 ormat for keywor
19d0: 64 20 69 6e 64 69 63 65 73 2c 20 61 6c 73 6f 20 d indices, also
19e0: 63 61 6c 6c 65 64 20 74 68 65 0a 5c 66 49 64 6f called the.\fIdo
19f0: 63 69 64 78 20 6d 61 72 6b 75 70 20 6c 61 6e 67 cidx markup lang
1a00: 75 61 67 65 5c 66 52 2c 20 69 73 20 74 6f 6f 20 uage\fR, is too
1a10: 6c 61 72 67 65 20 74 6f 20 62 65 20 63 6f 76 65 large to be cove
1a20: 72 65 64 20 69 6e 20 73 69 6e 67 6c 65 0a 73 65 red in single.se
1a30: 63 74 69 6f 6e 2e 0a 54 68 65 20 69 6e 74 65 72 ction..The inter
1a40: 65 73 74 65 64 20 72 65 61 64 65 72 20 73 68 6f ested reader sho
1a50: 75 6c 64 20 73 74 61 72 74 20 77 69 74 68 20 74 uld start with t
1a60: 68 65 20 64 6f 63 75 6d 65 6e 74 0a 2e 49 50 20 he document..IP
1a70: 5b 31 5d 0a 5c 66 49 64 6f 63 69 64 78 20 6c 61 [1].\fIdocidx la
1a80: 6e 67 75 61 67 65 20 69 6e 74 72 6f 64 75 63 74 nguage introduct
1a90: 69 6f 6e 5c 66 52 0a 2e 50 50 0a 61 6e 64 20 74 ion\fR..PP.and t
1aa0: 68 65 6e 20 70 72 6f 63 65 65 64 20 66 72 6f 6d hen proceed from
1ab0: 20 74 68 65 72 65 20 74 6f 20 74 68 65 20 66 6f there to the fo
1ac0: 72 6d 61 6c 20 73 70 65 63 69 66 69 63 61 74 69 rmal specificati
1ad0: 6f 6e 73 2c 20 69 2e 65 2e 20 74 68 65 0a 64 6f ons, i.e. the.do
1ae0: 63 75 6d 65 6e 74 73 0a 2e 49 50 20 5b 31 5d 0a cuments..IP [1].
1af0: 5c 66 49 64 6f 63 69 64 78 20 6c 61 6e 67 75 61 \fIdocidx langua
1b00: 67 65 20 73 79 6e 74 61 78 5c 66 52 20 61 6e 64 ge syntax\fR and
1b10: 0a 2e 49 50 20 5b 32 5d 0a 5c 66 49 64 6f 63 69 ..IP [2].\fIdoci
1b20: 64 78 20 6c 61 6e 67 75 61 67 65 20 63 6f 6d 6d dx language comm
1b30: 61 6e 64 20 72 65 66 65 72 65 6e 63 65 5c 66 52 and reference\fR
1b40: 2e 0a 2e 50 50 0a 74 6f 20 67 65 74 20 61 20 74 ...PP.to get a t
1b50: 68 6f 72 6f 75 67 68 20 75 6e 64 65 72 73 74 61 horough understa
1b60: 6e 64 69 6e 67 20 6f 66 20 74 68 65 20 6c 61 6e nding of the lan
1b70: 67 75 61 67 65 2e 0a 2e 53 48 20 43 4f 4e 46 49 guage...SH CONFI
1b80: 47 55 52 41 54 49 4f 4e 0a 54 68 65 20 64 6f 63 GURATION.The doc
1b90: 69 64 78 20 65 78 70 6f 72 74 20 70 6c 75 67 69 idx export plugi
1ba0: 6e 20 72 65 63 6f 67 6e 69 7a 65 73 20 74 68 65 n recognizes the
1bb0: 20 66 6f 6c 6c 6f 77 69 6e 67 20 63 6f 6e 66 69 following confi
1bc0: 67 75 72 61 74 69 6f 6e 0a 76 61 72 69 61 62 6c guration.variabl
1bd0: 65 73 20 61 6e 64 20 63 68 61 6e 67 65 73 20 69 es and changes i
1be0: 74 73 20 62 65 68 61 76 69 6f 75 72 20 61 73 20 ts behaviour as
1bf0: 74 68 65 79 20 73 70 65 63 69 66 79 2e 0a 2e 54 they specify...T
1c00: 50 0a 73 74 72 69 6e 67 20 5c 66 49 75 73 65 72 P.string \fIuser
1c10: 5c 66 52 0a 54 68 69 73 20 73 74 61 6e 64 61 72 \fR.This standar
1c20: 64 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 d configuration
1c30: 76 61 72 69 61 62 6c 65 20 63 6f 6e 74 61 69 6e variable contain
1c40: 73 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 s the name of th
1c50: 65 20 75 73 65 72 0a 72 75 6e 6e 69 6e 67 20 74 e user.running t
1c60: 68 65 20 70 72 6f 63 65 73 73 20 77 68 69 63 68 he process which
1c70: 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 65 78 70 invoked the exp
1c80: 6f 72 74 20 70 6c 75 67 69 6e 2e 0a 54 68 65 20 ort plugin..The
1c90: 70 6c 75 67 69 6e 20 70 75 74 73 20 74 68 69 73 plugin puts this
1ca0: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 6e 74 information int
1cb0: 6f 20 74 68 65 20 70 72 6f 76 65 6e 61 6e 63 65 o the provenance
1cc0: 20 63 6f 6d 6d 65 6e 74 20 61 74 20 74 68 65 0a comment at the.
1cd0: 62 65 67 69 6e 6e 69 6e 67 20 6f 66 20 74 68 65 beginning of the
1ce0: 20 67 65 6e 65 72 61 74 65 64 20 64 6f 63 75 6d generated docum
1cf0: 65 6e 74 2e 0a 2e 54 50 0a 73 74 72 69 6e 67 20 ent...TP.string
1d00: 5c 66 49 66 69 6c 65 5c 66 52 0a 54 68 69 73 20 \fIfile\fR.This
1d10: 73 74 61 6e 64 61 72 64 20 63 6f 6e 66 69 67 75 standard configu
1d20: 72 61 74 69 6f 6e 20 76 61 72 69 61 62 6c 65 20 ration variable
1d30: 63 6f 6e 74 61 69 6e 73 20 74 68 65 20 6e 61 6d contains the nam
1d40: 65 20 6f 66 20 74 68 65 20 66 69 6c 65 20 74 68 e of the file th
1d50: 65 0a 69 6e 64 65 78 20 63 61 6d 65 20 66 72 6f e.index came fro
1d60: 6d 2e 20 54 68 69 73 20 76 61 72 69 61 62 6c 65 m. This variable
1d70: 20 6d 61 79 20 6e 6f 74 20 62 65 20 73 65 74 20 may not be set
1d80: 6f 72 20 63 6f 6e 74 61 69 6e 20 74 68 65 20 65 or contain the e
1d90: 6d 70 74 79 0a 73 74 72 69 6e 67 2e 0a 54 68 65 mpty.string..The
1da0: 20 70 6c 75 67 69 6e 20 70 75 74 73 20 74 68 69 plugin puts thi
1db0: 73 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2c 20 69 s information, i
1dc0: 66 20 64 65 66 69 6e 65 64 2c 20 69 2e 65 2e 20 f defined, i.e.
1dd0: 73 65 74 20 61 6e 64 20 6e 6f 74 20 74 68 65 0a set and not the.
1de0: 65 6d 70 74 79 20 73 74 72 69 6e 67 2c 20 69 6e empty string, in
1df0: 74 6f 20 74 68 65 20 70 72 6f 76 65 6e 61 6e 63 to the provenanc
1e00: 65 20 63 6f 6d 6d 65 6e 74 20 61 74 20 74 68 65 e comment at the
1e10: 20 62 65 67 69 6e 6e 69 6e 67 20 6f 66 20 74 68 beginning of th
1e20: 65 0a 67 65 6e 65 72 61 74 65 64 20 64 6f 63 75 e.generated docu
1e30: 6d 65 6e 74 2e 0a 2e 54 50 0a 62 6f 6f 6c 65 61 ment...TP.boolea
1e40: 6e 20 5c 66 49 6e 65 77 6c 69 6e 65 73 5c 66 52 n \fInewlines\fR
1e50: 0a 49 66 20 74 68 69 73 20 66 6c 61 67 20 69 73 .If this flag is
1e60: 20 73 65 74 20 74 68 65 20 70 6c 75 67 69 6e 20 set the plugin
1e70: 77 69 6c 6c 20 62 72 65 61 6b 20 74 68 65 20 67 will break the g
1e80: 65 6e 65 72 61 74 65 64 20 64 6f 63 69 64 78 20 enerated docidx
1e90: 63 6f 64 65 0a 61 63 72 6f 73 73 20 6c 69 6e 65 code.across line
1ea0: 73 2c 20 77 69 74 68 20 65 61 63 68 20 6d 61 72 s, with each mar
1eb0: 6b 75 70 20 63 6f 6d 6d 61 6e 64 20 6f 6e 20 61 kup command on a
1ec0: 20 73 65 70 61 72 61 74 65 20 6c 69 6e 65 2e 0a separate line..
1ed0: 2e 73 70 0a 49 66 20 74 68 69 73 20 66 6c 61 67 .sp.If this flag
1ee0: 20 69 73 20 6e 6f 74 20 73 65 74 20 28 74 68 65 is not set (the
1ef0: 20 64 65 66 61 75 6c 74 29 2c 20 74 68 65 20 77 default), the w
1f00: 68 6f 6c 65 20 64 6f 63 75 6d 65 6e 74 20 77 69 hole document wi
1f10: 6c 6c 20 62 65 0a 77 72 69 74 74 65 6e 20 6f 6e ll be.written on
1f20: 20 61 20 73 69 6e 67 6c 65 20 6c 69 6e 65 2c 20 a single line,
1f30: 77 69 74 68 20 6d 69 6e 69 6d 75 6d 20 73 70 61 with minimum spa
1f40: 63 69 6e 67 20 62 65 74 77 65 65 6e 20 61 6c 6c cing between all
1f50: 20 65 6c 65 6d 65 6e 74 73 2e 0a 2e 54 50 0a 62 elements...TP.b
1f60: 6f 6f 6c 65 61 6e 20 5c 66 49 69 6e 64 65 6e 74 oolean \fIindent
1f70: 65 64 5c 66 52 0a 49 66 20 74 68 69 73 20 66 6c ed\fR.If this fl
1f80: 61 67 20 69 73 20 73 65 74 20 74 68 65 20 70 6c ag is set the pl
1f90: 75 67 69 6e 20 77 69 6c 6c 20 69 6e 64 65 6e 74 ugin will indent
1fa0: 20 74 68 65 20 6d 61 72 6b 75 70 20 63 6f 6d 6d the markup comm
1fb0: 61 6e 64 73 0a 61 63 63 6f 72 64 69 6e 67 20 74 ands.according t
1fc0: 6f 20 74 68 65 20 73 74 72 75 63 74 75 72 65 20 o the structure
1fd0: 6f 66 20 69 6e 64 69 63 65 73 2e 20 54 6f 20 6d of indices. To m
1fe0: 61 6b 65 20 74 68 69 73 20 77 6f 72 6b 20 74 68 ake this work th
1ff0: 69 73 20 61 6c 73 6f 0a 69 6d 70 6c 69 65 73 20 is also.implies
2000: 74 68 61 74 20 5c 66 42 6e 65 77 6c 69 6e 65 73 that \fBnewlines
2010: 5c 66 52 20 69 73 20 73 65 74 2e 20 54 68 69 73 \fR is set. This
2020: 20 65 66 66 65 63 74 20 69 73 20 69 6e 64 65 70 effect is indep
2030: 65 6e 64 65 6e 74 20 6f 66 20 74 68 65 0a 76 61 endent of the.va
2040: 6c 75 65 20 66 6f 72 20 5c 66 42 61 6c 69 67 6e lue for \fBalign
2050: 65 64 5c 66 52 20 68 6f 77 65 76 65 72 2e 0a 2e ed\fR however...
2060: 73 70 0a 49 66 20 74 68 69 73 20 66 6c 61 67 20 sp.If this flag
2070: 69 73 20 6e 6f 74 20 73 65 74 20 28 74 68 65 20 is not set (the
2080: 64 65 66 61 75 6c 74 29 2c 20 74 68 65 20 6f 75 default), the ou
2090: 74 70 75 74 20 69 73 20 66 6f 72 6d 61 74 74 65 tput is formatte
20a0: 64 20 61 73 20 70 65 72 0a 74 68 65 20 76 61 6c d as per.the val
20b0: 75 65 73 20 6f 66 20 5c 66 42 6e 65 77 6c 69 6e ues of \fBnewlin
20c0: 65 73 5c 66 52 20 61 6e 64 20 5c 66 42 61 6c 69 es\fR and \fBali
20d0: 67 6e 65 64 5c 66 52 2c 20 61 6e 64 20 6e 6f 20 gned\fR, and no
20e0: 69 6e 64 65 6e 74 69 6e 67 20 69 73 0a 64 6f 6e indenting is.don
20f0: 65 2e 0a 2e 54 50 0a 62 6f 6f 6c 65 61 6e 20 5c e...TP.boolean \
2100: 66 49 61 6c 69 67 6e 65 64 5c 66 52 0a 49 66 20 fIaligned\fR.If
2110: 74 68 69 73 20 66 6c 61 67 20 69 73 20 73 65 74 this flag is set
2120: 20 74 68 65 20 67 65 6e 65 72 61 74 6f 72 20 65 the generator e
2130: 6e 73 75 72 65 73 20 74 68 61 74 20 74 68 65 20 nsures that the
2140: 61 72 67 75 6d 65 6e 74 73 20 66 6f 72 20 74 68 arguments for th
2150: 65 0a 5c 66 42 6d 61 6e 70 61 67 65 5c 66 52 20 e.\fBmanpage\fR
2160: 61 6e 64 20 5c 66 42 75 72 6c 5c 66 52 20 63 6f and \fBurl\fR co
2170: 6d 6d 61 6e 64 73 20 69 6e 20 61 20 6b 65 79 77 mmands in a keyw
2180: 6f 72 64 20 73 65 63 74 69 6f 6e 20 61 72 65 20 ord section are
2190: 61 6c 69 67 6e 65 64 0a 76 65 72 74 69 63 61 6c aligned.vertical
21a0: 6c 79 20 66 6f 72 20 61 20 6e 69 63 65 20 74 61 ly for a nice ta
21b0: 62 6c 65 20 65 66 66 65 63 74 2e 20 54 6f 20 6d ble effect. To m
21c0: 61 6b 65 20 74 68 69 73 20 77 6f 72 6b 20 74 68 ake this work th
21d0: 69 73 20 61 6c 73 6f 0a 69 6d 70 6c 69 65 73 20 is also.implies
21e0: 74 68 61 74 20 5c 66 42 6e 65 77 6c 69 6e 65 73 that \fBnewlines
21f0: 5c 66 52 20 69 73 20 73 65 74 2e 20 54 68 69 73 \fR is set. This
2200: 20 65 66 66 65 63 74 20 69 73 20 69 6e 64 65 70 effect is indep
2210: 65 6e 64 65 6e 74 20 6f 66 20 74 68 65 0a 76 61 endent of the.va
2220: 6c 75 65 20 66 6f 72 20 5c 66 42 69 6e 64 65 6e lue for \fBinden
2230: 74 65 64 5c 66 52 20 68 6f 77 65 76 65 72 2e 0a ted\fR however..
2240: 2e 73 70 0a 49 66 20 74 68 69 73 20 66 6c 61 67 .sp.If this flag
2250: 20 69 73 20 6e 6f 74 20 73 65 74 20 28 74 68 65 is not set (the
2260: 20 64 65 66 61 75 6c 74 29 2c 20 74 68 65 20 6f default), the o
2270: 75 74 70 75 74 20 69 73 20 66 6f 72 6d 61 74 74 utput is formatt
2280: 65 64 20 61 73 20 70 65 72 0a 74 68 65 20 76 61 ed as per.the va
2290: 6c 75 65 73 20 6f 66 20 5c 66 42 6e 65 77 6c 69 lues of \fBnewli
22a0: 6e 65 73 5c 66 52 20 61 6e 64 20 5c 66 42 69 6e nes\fR and \fBin
22b0: 64 65 6e 74 65 64 5c 66 52 2c 20 61 6e 64 20 6e dented\fR, and n
22c0: 6f 20 61 6c 69 67 6e 6d 65 6e 74 20 69 73 0a 64 o alignment is.d
22d0: 6f 6e 65 2e 0a 2e 50 50 0a 5c 66 49 4e 6f 74 65 one...PP.\fINote
22e0: 5c 66 52 20 74 68 61 74 20 74 68 69 73 20 70 6c \fR that this pl
22f0: 75 67 69 6e 20 69 67 6e 6f 72 65 73 20 74 68 65 ugin ignores the
2300: 20 73 74 61 6e 64 61 72 64 20 63 6f 6e 66 69 67 standard config
2310: 75 72 61 74 69 6f 6e 0a 76 61 72 69 61 62 6c 65 uration.variable
2320: 73 20 5c 66 42 66 6f 72 6d 61 74 5c 66 52 2c 20 s \fBformat\fR,
2330: 61 6e 64 20 5c 66 42 6d 61 70 5c 66 52 2c 20 61 and \fBmap\fR, a
2340: 6e 64 20 74 68 65 69 72 20 76 61 6c 75 65 73 2e nd their values.
2350: 0a 2e 53 48 20 22 4b 45 59 57 4f 52 44 20 49 4e ..SH "KEYWORD IN
2360: 44 45 58 20 53 45 52 49 41 4c 49 5a 41 54 49 4f DEX SERIALIZATIO
2370: 4e 20 46 4f 52 4d 41 54 22 0a 48 65 72 65 20 77 N FORMAT".Here w
2380: 65 20 73 70 65 63 69 66 79 20 74 68 65 20 66 6f e specify the fo
2390: 72 6d 61 74 20 75 73 65 64 20 62 79 20 74 68 65 rmat used by the
23a0: 20 64 6f 63 74 6f 6f 6c 73 20 76 32 20 70 61 63 doctools v2 pac
23b0: 6b 61 67 65 73 20 74 6f 0a 73 65 72 69 61 6c 69 kages to.seriali
23c0: 7a 65 20 6b 65 79 77 6f 72 64 20 69 6e 64 69 63 ze keyword indic
23d0: 65 73 20 61 73 20 69 6d 6d 75 74 61 62 6c 65 20 es as immutable
23e0: 76 61 6c 75 65 73 20 66 6f 72 20 74 72 61 6e 73 values for trans
23f0: 70 6f 72 74 2c 0a 63 6f 6d 70 61 72 69 73 6f 6e port,.comparison
2400: 2c 20 65 74 63 2e 0a 2e 50 50 0a 57 65 20 64 69 , etc...PP.We di
2410: 73 74 69 6e 67 75 69 73 68 20 62 65 74 77 65 65 stinguish betwee
2420: 6e 20 5c 66 49 72 65 67 75 6c 61 72 5c 66 52 20 n \fIregular\fR
2430: 61 6e 64 20 5c 66 49 63 61 6e 6f 6e 69 63 61 6c and \fIcanonical
2440: 5c 66 52 0a 73 65 72 69 61 6c 69 7a 61 74 69 6f \fR.serializatio
2450: 6e 73 2e 20 57 68 69 6c 65 20 61 20 6b 65 79 77 ns. While a keyw
2460: 6f 72 64 20 69 6e 64 65 78 20 6d 61 79 20 68 61 ord index may ha
2470: 76 65 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 65 ve more than one
2480: 20 72 65 67 75 6c 61 72 0a 73 65 72 69 61 6c 69 regular.seriali
2490: 7a 61 74 69 6f 6e 20 6f 6e 6c 79 20 65 78 61 63 zation only exac
24a0: 74 6c 79 20 6f 6e 65 20 6f 66 20 74 68 65 6d 20 tly one of them
24b0: 77 69 6c 6c 20 62 65 20 5c 66 49 63 61 6e 6f 6e will be \fIcanon
24c0: 69 63 61 6c 5c 66 52 2e 0a 2e 50 50 0a 2e 54 50 ical\fR...PP..TP
24d0: 0a 72 65 67 75 6c 61 72 20 73 65 72 69 61 6c 69 .regular seriali
24e0: 7a 61 74 69 6f 6e 0a 2e 52 53 0a 2e 49 50 20 5b zation..RS..IP [
24f0: 31 5d 0a 41 6e 20 69 6e 64 65 78 20 73 65 72 69 1].An index seri
2500: 61 6c 69 7a 61 74 69 6f 6e 20 69 73 20 61 20 6e alization is a n
2510: 65 73 74 65 64 20 54 63 6c 20 64 69 63 74 69 6f ested Tcl dictio
2520: 6e 61 72 79 2e 0a 2e 49 50 20 5b 32 5d 0a 54 68 nary...IP [2].Th
2530: 69 73 20 64 69 63 74 69 6f 6e 61 72 79 20 68 6f is dictionary ho
2540: 6c 64 73 20 61 20 73 69 6e 67 6c 65 20 6b 65 79 lds a single key
2550: 2c 20 5c 66 42 64 6f 63 74 6f 6f 6c 73 3a 3a 69 , \fBdoctools::i
2560: 64 78 5c 66 52 2c 20 61 6e 64 20 69 74 73 0a 76 dx\fR, and its.v
2570: 61 6c 75 65 2e 20 54 68 69 73 20 76 61 6c 75 65 alue. This value
2580: 20 68 6f 6c 64 73 20 74 68 65 20 63 6f 6e 74 65 holds the conte
2590: 6e 74 73 20 6f 66 20 74 68 65 20 69 6e 64 65 78 nts of the index
25a0: 2e 0a 2e 49 50 20 5b 33 5d 0a 54 68 65 20 63 6f ...IP [3].The co
25b0: 6e 74 65 6e 74 73 20 6f 66 20 74 68 65 20 69 6e ntents of the in
25c0: 64 65 78 20 61 72 65 20 61 20 54 63 6c 20 64 69 dex are a Tcl di
25d0: 63 74 69 6f 6e 61 72 79 20 68 6f 6c 64 69 6e 67 ctionary holding
25e0: 20 74 68 65 20 74 69 74 6c 65 20 6f 66 0a 74 68 the title of.th
25f0: 65 20 69 6e 64 65 78 2c 20 61 20 6c 61 62 65 6c e index, a label
2600: 2c 20 61 6e 64 20 74 68 65 20 6b 65 79 77 6f 72 , and the keywor
2610: 64 73 20 61 6e 64 20 72 65 66 65 72 65 6e 63 65 ds and reference
2620: 73 2e 20 54 68 65 20 72 65 6c 65 76 61 6e 74 20 s. The relevant
2630: 6b 65 79 73 0a 61 6e 64 20 74 68 65 69 72 20 76 keys.and their v
2640: 61 6c 75 65 73 20 61 72 65 0a 2e 52 53 0a 2e 54 alues are..RS..T
2650: 50 0a 5c 66 42 74 69 74 6c 65 5c 66 52 0a 54 68 P.\fBtitle\fR.Th
2660: 65 20 76 61 6c 75 65 20 69 73 20 61 20 73 74 72 e value is a str
2670: 69 6e 67 20 63 6f 6e 74 61 69 6e 69 6e 67 20 74 ing containing t
2680: 68 65 20 74 69 74 6c 65 20 6f 66 20 74 68 65 20 he title of the
2690: 69 6e 64 65 78 2e 0a 2e 54 50 0a 5c 66 42 6c 61 index...TP.\fBla
26a0: 62 65 6c 5c 66 52 0a 54 68 65 20 76 61 6c 75 65 bel\fR.The value
26b0: 20 69 73 20 61 20 73 74 72 69 6e 67 20 63 6f 6e is a string con
26c0: 74 61 69 6e 69 6e 67 20 61 20 6c 61 62 65 6c 20 taining a label
26d0: 66 6f 72 20 74 68 65 20 69 6e 64 65 78 2e 0a 2e for the index...
26e0: 54 50 0a 5c 66 42 6b 65 79 77 6f 72 64 73 5c 66 TP.\fBkeywords\f
26f0: 52 0a 54 68 65 20 76 61 6c 75 65 20 69 73 20 61 R.The value is a
2700: 20 54 63 6c 20 64 69 63 74 69 6f 6e 61 72 79 2c Tcl dictionary,
2710: 20 75 73 69 6e 67 20 74 68 65 20 6b 65 79 77 6f using the keywo
2720: 72 64 73 20 6b 6e 6f 77 6e 20 74 6f 20 74 68 65 rds known to the
2730: 20 69 6e 64 65 78 0a 61 73 20 6b 65 79 73 2e 20 index.as keys.
2740: 54 68 65 20 61 73 73 6f 63 69 61 74 65 64 20 76 The associated v
2750: 61 6c 75 65 73 20 61 72 65 20 6c 69 73 74 73 20 alues are lists
2760: 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 69 containing the i
2770: 64 65 6e 74 69 66 69 65 72 73 20 6f 66 0a 74 68 dentifiers of.th
2780: 65 20 72 65 66 65 72 65 6e 63 65 73 20 61 73 73 e references ass
2790: 6f 63 69 61 74 65 64 20 77 69 74 68 20 74 68 61 ociated with tha
27a0: 74 20 70 61 72 74 69 63 75 6c 61 72 20 6b 65 79 t particular key
27b0: 77 6f 72 64 2e 0a 2e 73 70 0a 41 6e 79 20 72 65 word...sp.Any re
27c0: 66 65 72 65 6e 63 65 20 69 64 65 6e 74 69 66 69 ference identifi
27d0: 65 72 20 75 73 65 64 20 69 6e 20 74 68 65 73 65 er used in these
27e0: 20 6c 69 73 74 73 20 68 61 73 20 74 6f 20 65 78 lists has to ex
27f0: 69 73 74 20 61 73 20 61 20 6b 65 79 20 69 6e 0a ist as a key in.
2800: 74 68 65 20 5c 66 42 72 65 66 65 72 65 6e 63 65 the \fBreference
2810: 73 5c 66 52 20 64 69 63 74 69 6f 6e 61 72 79 2c s\fR dictionary,
2820: 20 73 65 65 20 74 68 65 20 6e 65 78 74 20 69 74 see the next it
2830: 65 6d 20 66 6f 72 20 69 74 73 0a 64 65 66 69 6e em for its.defin
2840: 69 74 69 6f 6e 2e 0a 2e 54 50 0a 5c 66 42 72 65 ition...TP.\fBre
2850: 66 65 72 65 6e 63 65 73 5c 66 52 0a 54 68 65 20 ferences\fR.The
2860: 76 61 6c 75 65 20 69 73 20 61 20 54 63 6c 20 64 value is a Tcl d
2870: 69 63 74 69 6f 6e 61 72 79 2c 20 75 73 69 6e 67 ictionary, using
2880: 20 74 68 65 20 69 64 65 6e 74 69 66 69 65 72 73 the identifiers
2890: 20 66 6f 72 20 74 68 65 0a 72 65 66 65 72 65 6e for the.referen
28a0: 63 65 73 20 6b 6e 6f 77 6e 20 74 6f 20 74 68 65 ces known to the
28b0: 20 69 6e 64 65 78 20 61 73 20 6b 65 79 73 2e 20 index as keys.
28c0: 54 68 65 20 61 73 73 6f 63 69 61 74 65 64 20 76 The associated v
28d0: 61 6c 75 65 73 20 61 72 65 0a 32 2d 65 6c 65 6d alues are.2-elem
28e0: 65 6e 74 20 6c 69 73 74 73 20 63 6f 6e 74 61 69 ent lists contai
28f0: 6e 69 6e 67 20 74 68 65 20 74 79 70 65 20 61 6e ning the type an
2900: 64 20 6c 61 62 65 6c 20 6f 66 20 74 68 65 20 72 d label of the r
2910: 65 66 65 72 65 6e 63 65 2c 20 69 6e 0a 74 68 69 eference, in.thi
2920: 73 20 6f 72 64 65 72 2e 0a 2e 73 70 0a 41 6e 79 s order...sp.Any
2930: 20 6b 65 79 20 68 65 72 65 20 68 61 73 20 74 6f key here has to
2940: 20 62 65 20 61 73 73 6f 63 69 61 74 65 64 20 77 be associated w
2950: 69 74 68 20 61 74 20 6c 65 61 73 74 20 6f 6e 65 ith at least one
2960: 20 6b 65 79 77 6f 72 64 2c 0a 69 2e 65 2e 20 6f keyword,.i.e. o
2970: 63 63 75 72 20 69 6e 20 61 74 20 6c 65 61 73 74 ccur in at least
2980: 20 6f 6e 65 20 6f 66 20 74 68 65 20 72 65 66 65 one of the refe
2990: 72 65 6e 63 65 20 6c 69 73 74 73 20 77 68 69 63 rence lists whic
29a0: 68 20 61 72 65 20 74 68 65 20 76 61 6c 75 65 73 h are the values
29b0: 0a 69 6e 20 74 68 65 20 5c 66 42 6b 65 79 77 6f .in the \fBkeywo
29c0: 72 64 73 5c 66 52 20 64 69 63 74 69 6f 6e 61 72 rds\fR dictionar
29d0: 79 2c 20 73 65 65 20 70 72 65 76 69 6f 75 73 20 y, see previous
29e0: 69 74 65 6d 20 66 6f 72 20 69 74 73 0a 64 65 66 item for its.def
29f0: 69 6e 69 74 69 6f 6e 2e 0a 2e 52 45 0a 2e 49 50 inition...RE..IP
2a00: 20 5b 34 5d 0a 54 68 65 20 5c 66 49 74 79 70 65 [4].The \fItype
2a10: 5c 66 52 20 6f 66 20 61 20 72 65 66 65 72 65 6e \fR of a referen
2a20: 63 65 20 63 61 6e 20 62 65 20 6f 6e 65 20 6f 66 ce can be one of
2a30: 20 74 77 6f 20 76 61 6c 75 65 73 2c 0a 2e 52 53 two values,..RS
2a40: 0a 2e 54 50 0a 5c 66 42 6d 61 6e 70 61 67 65 5c ..TP.\fBmanpage\
2a50: 66 52 0a 54 68 65 20 69 64 65 6e 74 69 66 69 65 fR.The identifie
2a60: 72 20 6f 66 20 74 68 65 20 72 65 66 65 72 65 6e r of the referen
2a70: 63 65 20 69 73 20 69 6e 74 65 72 70 72 65 74 65 ce is interprete
2a80: 64 20 61 73 20 73 79 6d 62 6f 6c 69 63 20 66 69 d as symbolic fi
2a90: 6c 65 20 6e 61 6d 65 2c 0a 72 65 66 65 72 69 6e le name,.referin
2aa0: 67 20 74 6f 20 6f 6e 65 20 6f 66 20 74 68 65 20 g to one of the
2ab0: 64 6f 63 75 6d 65 6e 74 73 20 74 68 65 20 69 6e documents the in
2ac0: 64 65 78 20 77 61 73 20 6d 61 64 65 20 66 6f 72 dex was made for
2ad0: 2e 0a 2e 54 50 0a 5c 66 42 75 72 6c 5c 66 52 0a ...TP.\fBurl\fR.
2ae0: 54 68 65 20 69 64 65 6e 74 69 66 69 65 72 20 6f The identifier o
2af0: 66 20 74 68 65 20 72 65 66 65 72 65 6e 63 65 20 f the reference
2b00: 69 73 20 69 6e 74 65 72 70 72 65 74 65 64 20 61 is interpreted a
2b10: 73 20 61 6e 20 75 72 6c 2c 20 72 65 66 65 72 69 s an url, referi
2b20: 6e 67 20 74 6f 0a 73 6f 6d 65 20 65 78 74 65 72 ng to.some exter
2b30: 6e 61 6c 20 6c 6f 63 61 74 69 6f 6e 2c 20 6c 69 nal location, li
2b40: 6b 65 20 61 20 77 65 62 73 69 74 65 2c 20 65 74 ke a website, et
2b50: 63 2e 0a 2e 52 45 0a 2e 52 45 0a 2e 54 50 0a 63 c...RE..RE..TP.c
2b60: 61 6e 6f 6e 69 63 61 6c 20 73 65 72 69 61 6c 69 anonical seriali
2b70: 7a 61 74 69 6f 6e 0a 54 68 65 20 63 61 6e 6f 6e zation.The canon
2b80: 69 63 61 6c 20 73 65 72 69 61 6c 69 7a 61 74 69 ical serializati
2b90: 6f 6e 20 6f 66 20 61 20 6b 65 79 77 6f 72 64 20 on of a keyword
2ba0: 69 6e 64 65 78 20 68 61 73 20 74 68 65 20 66 6f index has the fo
2bb0: 72 6d 61 74 20 61 73 0a 73 70 65 63 69 66 69 65 rmat as.specifie
2bc0: 64 20 69 6e 20 74 68 65 20 70 72 65 76 69 6f 75 d in the previou
2bd0: 73 20 69 74 65 6d 2c 20 61 6e 64 20 74 68 65 6e s item, and then
2be0: 20 61 64 64 69 74 69 6f 6e 61 6c 6c 79 20 73 61 additionally sa
2bf0: 74 69 73 66 69 65 73 20 74 68 65 0a 63 6f 6e 73 tisfies the.cons
2c00: 74 72 61 69 6e 74 73 20 62 65 6c 6f 77 2c 20 77 traints below, w
2c10: 68 69 63 68 20 6d 61 6b 65 20 69 74 20 75 6e 69 hich make it uni
2c20: 71 75 65 20 61 6d 6f 6e 67 20 61 6c 6c 20 74 68 que among all th
2c30: 65 20 70 6f 73 73 69 62 6c 65 0a 73 65 72 69 61 e possible.seria
2c40: 6c 69 7a 61 74 69 6f 6e 73 20 6f 66 20 74 68 65 lizations of the
2c50: 20 6b 65 79 77 6f 72 64 20 69 6e 64 65 78 2e 0a keyword index..
2c60: 2e 52 53 0a 2e 49 50 20 5b 31 5d 0a 54 68 65 20 .RS..IP [1].The
2c70: 6b 65 79 73 20 66 6f 75 6e 64 20 69 6e 20 61 6c keys found in al
2c80: 6c 20 74 68 65 20 6e 65 73 74 65 64 20 54 63 6c l the nested Tcl
2c90: 20 64 69 63 74 69 6f 6e 61 72 69 65 73 20 61 72 dictionaries ar
2ca0: 65 20 73 6f 72 74 65 64 20 69 6e 0a 61 73 63 65 e sorted in.asce
2cb0: 6e 64 69 6e 67 20 64 69 63 74 69 6f 6e 61 72 79 nding dictionary
2cc0: 20 6f 72 64 65 72 2c 20 61 73 20 67 65 6e 65 72 order, as gener
2cd0: 61 74 65 64 20 62 79 20 54 63 6c 27 73 20 62 75 ated by Tcl's bu
2ce0: 69 6c 74 69 6e 20 63 6f 6d 6d 61 6e 64 0a 5c 66 iltin command.\f
2cf0: 42 6c 73 6f 72 74 20 2d 69 6e 63 72 65 61 73 69 Blsort -increasi
2d00: 6e 67 20 2d 64 69 63 74 5c 66 52 2e 0a 2e 49 50 ng -dict\fR...IP
2d10: 20 5b 32 5d 0a 54 68 65 20 72 65 66 65 72 65 6e [2].The referen
2d20: 63 65 73 20 6c 69 73 74 65 64 20 66 6f 72 20 65 ces listed for e
2d30: 61 63 68 20 6b 65 79 77 6f 72 64 20 6f 66 20 74 ach keyword of t
2d40: 68 65 20 69 6e 64 65 78 2c 20 69 66 20 61 6e 79 he index, if any
2d50: 2c 20 61 72 65 0a 6c 69 73 74 65 64 20 69 6e 20 , are.listed in
2d60: 61 73 63 65 6e 64 69 6e 67 20 64 69 63 74 69 6f ascending dictio
2d70: 6e 61 72 79 20 6f 72 64 65 72 20 6f 66 20 74 68 nary order of th
2d80: 65 69 72 20 5c 66 49 6c 61 62 65 6c 73 5c 66 52 eir \fIlabels\fR
2d90: 2c 20 61 73 0a 67 65 6e 65 72 61 74 65 64 20 62 , as.generated b
2da0: 79 20 54 63 6c 27 73 20 62 75 69 6c 74 69 6e 20 y Tcl's builtin
2db0: 63 6f 6d 6d 61 6e 64 20 5c 66 42 6c 73 6f 72 74 command \fBlsort
2dc0: 20 2d 69 6e 63 72 65 61 73 69 6e 67 20 2d 64 69 -increasing -di
2dd0: 63 74 5c 66 52 2e 0a 2e 52 45 0a 2e 50 50 0a 2e ct\fR...RE..PP..
2de0: 53 48 20 22 42 55 47 53 2c 20 49 44 45 41 53 2c SH "BUGS, IDEAS,
2df0: 20 46 45 45 44 42 41 43 4b 22 0a 54 68 69 73 20 FEEDBACK".This
2e00: 64 6f 63 75 6d 65 6e 74 2c 20 61 6e 64 20 74 68 document, and th
2e10: 65 20 70 61 63 6b 61 67 65 20 69 74 20 64 65 73 e package it des
2e20: 63 72 69 62 65 73 2c 20 77 69 6c 6c 20 75 6e 64 cribes, will und
2e30: 6f 75 62 74 65 64 6c 79 20 63 6f 6e 74 61 69 6e oubtedly contain
2e40: 0a 62 75 67 73 20 61 6e 64 20 6f 74 68 65 72 20 .bugs and other
2e50: 70 72 6f 62 6c 65 6d 73 2e 0a 50 6c 65 61 73 65 problems..Please
2e60: 20 72 65 70 6f 72 74 20 73 75 63 68 20 69 6e 20 report such in
2e70: 74 68 65 20 63 61 74 65 67 6f 72 79 20 5c 66 49 the category \fI
2e80: 64 6f 63 74 6f 6f 6c 73 5c 66 52 20 6f 66 20 74 doctools\fR of t
2e90: 68 65 0a 5c 66 49 54 63 6c 6c 69 62 20 53 46 20 he.\fITcllib SF
2ea0: 54 72 61 63 6b 65 72 73 5c 66 52 20 5b 68 74 74 Trackers\fR [htt
2eb0: 70 3a 2f 2f 73 6f 75 72 63 65 66 6f 72 67 65 2e p://sourceforge.
2ec0: 6e 65 74 2f 74 72 61 63 6b 65 72 2f 3f 67 72 6f net/tracker/?gro
2ed0: 75 70 5f 69 64 3d 31 32 38 38 33 5d 2e 0a 50 6c up_id=12883]..Pl
2ee0: 65 61 73 65 20 61 6c 73 6f 20 72 65 70 6f 72 74 ease also report
2ef0: 20 61 6e 79 20 69 64 65 61 73 20 66 6f 72 20 65 any ideas for e
2f00: 6e 68 61 6e 63 65 6d 65 6e 74 73 20 79 6f 75 20 nhancements you
2f10: 6d 61 79 20 68 61 76 65 20 66 6f 72 20 65 69 74 may have for eit
2f20: 68 65 72 0a 70 61 63 6b 61 67 65 20 61 6e 64 2f her.package and/
2f30: 6f 72 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e or documentation
2f40: 2e 0a 2e 53 48 20 4b 45 59 57 4f 52 44 53 0a 64 ...SH KEYWORDS.d
2f50: 6f 63 69 64 78 2c 20 64 6f 63 74 6f 6f 6c 73 2c ocidx, doctools,
2f60: 20 65 78 70 6f 72 74 2c 20 69 6e 64 65 78 2c 20 export, index,
2f70: 73 65 72 69 61 6c 69 7a 61 74 69 6f 6e 0a 2e 53 serialization..S
2f80: 48 20 43 41 54 45 47 4f 52 59 0a 54 65 78 74 20 H CATEGORY.Text
2f90: 66 6f 72 6d 61 74 74 65 72 20 70 6c 75 67 69 6e formatter plugin
2fa0: 0a 2e 53 48 20 43 4f 50 59 52 49 47 48 54 0a 2e ..SH COPYRIGHT..
2fb0: 6e 66 0a 43 6f 70 79 72 69 67 68 74 20 28 63 29 nf.Copyright (c)
2fc0: 20 32 30 30 39 20 41 6e 64 72 65 61 73 20 4b 75 2009 Andreas Ku
2fd0: 70 72 69 65 73 20 3c 61 6e 64 72 65 61 73 5f 6b pries <andreas_k
2fe0: 75 70 72 69 65 73 40 75 73 65 72 73 2e 73 6f 75 [email protected]
2ff0: 72 63 65 66 6f 72 67 65 2e 6e 65 74 3e 0a 0a 2e rceforge.net>...
3000: 66 69 fi
