Tcl Extension Architecture (TEA) Sample Extension

Check-in [52643c949e]
Login
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to [email protected]
or submit via the online form by Sep 9.

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:[Bug 2994714]: Improve documentation in many ways to more closely approximate what Tcl supports.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 52643c949e7ecb1db63a69dc5204145dbb47f12a
User & Date: dkf 2010-04-30 12:55:45
Context
2010-08-12
01:19
* configure, configure.in: TEA 3.8 update, just include tcl.m4, modify TEA_INIT version and run autoconf 2.59
check-in: 9691facd48 user: hobbs tags: trunk
2010-04-30
12:55
[Bug 2994714]: Improve documentation in many ways to more closely approximate what Tcl supports. check-in: 52643c949e user: dkf tags: trunk
2010-04-29
12:42
[Enh 2788534] add package require to doc check-in: 42c9473487 user: nijtmans tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to ChangeLog.






1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59




2010-04-29  Jan Nijtmans <[email protected]>

	* doc/sha1.n [Enh 2788534] add package require to doc

2010-04-23  Jan Nijtmans <[email protected]>

	* configure: Regenerated to use latest TEA tcl.m4.
	* [Bug 2782806] sample package's test cases fail
	* Always define BUILD_sample, even on UNIX.

2010-02-19  Stuart Cassoff  <[email protected]>

	* tcl.m4: Correct compiler/linker flags
	for threaded builds on OpenBSD.
	* configure: Regenerated to use latest TEA tcl.m4.

2010-01-19  Jan Nijtmans <[email protected]>

	* configure: Regenerated to use latest TEA tcl.m4.

2009-04-27  Jeff Hobbs  <[email protected]>

	* tcl.m4 (TEA_CONFIG_CFLAGS): harden the check to add _r to CC on
	AIX with threads.

2009-03-26  Jan Nijtmans <[email protected]>

	* configure: Regenerated to use latest TEA tcl.m4.

2009-03-20  Andreas Kupries <[email protected]>

	* configure: Regenerated to get my latest updates to tcl.m4 (See
	tclconfig/ChangeLog).

	NOTE: This pulled in an unexpected set of changes regarding
	SHLIB_VERSION and SHARED_LIB_SUFFIX, indicating that configure was
	not regenerated since some older change to tcl.m4.

2009-03-18  Stuart Cassoff  <[email protected]>

	* Makefile.in: Removed offending 'rm -f' line [Bug 2429444].

2009-03-11  Joe English  <[email protected]>

	* pkgIndex.tcl.in: use @[email protected] instead of "Tclsha1"
	[Bug 1960628].

2008-12-20  Daniel Steffen  <[email protected]>

	* Makefile.in: use INSTALL_LIBRARY instead of INSTALL_PROGRAM to
	install libraries, avoids breakage from tcl's install-strip when
	built as a bundled package.

2008-06-18  Pat Thoyts  <[email protected]>

	* win/makefile.vc: Updated win build files. Added new option to
	* win/rules.vc:    nmakehlp to qualify a path name for use in setting
	* win/nmakehlp.c:  up paths for test.

>
>
>
>
>


|




|
|



|
<








|
|











|
|



|



|
|




|
|







1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
2010-04-30  Donal K. Fellows  <[email protected]>

	* doc/sha1.n: [Bug 2994714]: Updated documentation formatting to more
	closely follow Tcl's best practice guidelines in many aspects.

2010-04-29  Jan Nijtmans <[email protected]>

	* doc/sha1.n [Enh 2788534]: add package require to doc

2010-04-23  Jan Nijtmans <[email protected]>

	* configure: Regenerated to use latest TEA tcl.m4.
	* [Bug 2782806]: sample package's test cases fail
	Always define BUILD_sample, even on UNIX.

2010-02-19  Stuart Cassoff  <[email protected]>

	* tcl.m4: Correct compiler/linker flags for threaded builds on OpenBSD.

	* configure: Regenerated to use latest TEA tcl.m4.

2010-01-19  Jan Nijtmans <[email protected]>

	* configure: Regenerated to use latest TEA tcl.m4.

2009-04-27  Jeff Hobbs  <[email protected]>

	* tcl.m4 (TEA_CONFIG_CFLAGS): harden the check to add _r to CC on AIX
	with threads.

2009-03-26  Jan Nijtmans <[email protected].net>

	* configure: Regenerated to use latest TEA tcl.m4.

2009-03-20  Andreas Kupries <[email protected]>

	* configure: Regenerated to get my latest updates to tcl.m4 (See
	tclconfig/ChangeLog).

	NOTE: This pulled in an unexpected set of changes regarding
	SHLIB_VERSION and SHARED_LIB_SUFFIX, indicating that configure was not
	regenerated since some older change to tcl.m4.

2009-03-18  Stuart Cassoff  <[email protected]>

	* Makefile.in: [Bug 2429444]: Removed offending 'rm -f' line.

2009-03-11  Joe English  <[email protected]>

	* pkgIndex.tcl.in: [Bug 1960628]: use @[email protected] instead of
	"Tclsha1".

2008-12-20  Daniel Steffen  <[email protected]>

	* Makefile.in: use INSTALL_LIBRARY instead of INSTALL_PROGRAM to
	install libraries, avoids breakage from tcl's install-strip when built
	as a bundled package.

2008-06-18  Pat Thoyts  <[email protected]>

	* win/makefile.vc: Updated win build files. Added new option to
	* win/rules.vc:    nmakehlp to qualify a path name for use in setting
	* win/nmakehlp.c:  up paths for test.

Changes to doc/sha1.n.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

55
56

57
58
59




.so man.macros
.TH sha1 n 4.1 "Tcl-Extensions"
.HS sha1 tcl
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
sha1 \- manipulate sha1 message digests
.SH SYNOPSIS
\fBpackage require sample ?0.5?\fR
.sp
\fBsha1\fI ?-log2base log2base? -string string\fR
.br
or
.br
\fBsha1\fI ?-log2base log2base? ?-copychan chanID? -chan chanID\fR
.br
or
.br
\fBsha1\fI -init\fR (returns descriptor)
.br
\fBsha1\fI -update descriptor ?-maxbytes n? ?-copychan chanID? -chan chanID\fR
.br
\fBsha1\fI ?-log2base log2base? -final descriptor\fR
.BE
.SH DESCRIPTION
.PP
SHA1 is NIST's Secure Hashing Algorithm (also known as Secure Hashing
Standard) with the minor modification that they proposed on 7/11/94.
.PP
Switches can be in any order.
.PP
Returns a sha1 digest in base 2 ** log2base ascii representation.
log2base defaults to 4, i.e. hex representation.
.PP
.nf
       log2base   length   chars 
         1          160      01            (binary)
         2           80      0..3
         3           54      0...7         (octal)
         4           40      0..9a..f      (hex)
         5           32      0..9a..v      
         6           27      0..9a..zA..Z_, 
.fo
.PP
(The characters in the digest string have been chosen to be usable in 
filenames so that the sha1 command can be used, for example, 
to digest URLs into shorter strings for filenames in a cache.)
.PP
In the -string version, returns sha1 digest alone of string.
.PP
In the -chan version, returns list of 2 items: length of data
in chanID followed by sha1 digest of all data in chanID.  ChanID is
identifier returned from "open" for example.  If -copychan is supplied,
will also copy all data from chanID to copychanID.

.PP
In the third form, -init returns a descriptor, -update can be called

any number of times with that descriptor and returns the number of
bytes read, and -final returns the result in the same form as the
standalone -chan.




>








|

|



|



|

|

|









|


|
|

|
|


|

|
|
|

|

|
|
|
|
>

<
>
|
|
|
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

58
59
60
61
62
63
64
65
'\"
.so man.macros
.TH sha1 n 4.1 "Tcl-Extensions"
.HS sha1 tcl
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
sha1 \- manipulate sha1 message digests
.SH SYNOPSIS
\fBpackage require sample\fR ?\fB0.5\fR?
.sp
\fBsha1\fR ?\fB\-log2base \fIlog2base\fR? \fB\-string \fIstring\fR
.br
or
.br
\fBsha1\fR ?\fB\-log2base \fIlog2base\fR? ?\fB\-copychan \fIcopyChanID\fR? \fB\-chan \fIchanID\fR
.br
or
.br
\fBsha1 \-init\fR (returns descriptor)
.br
\fBsha1 \-update \fIdescriptor\fR ?\fB\-maxbytes \fIn\fR? ?\fB\-copychan \fIchanID\fR? \fB\-chan \fIchanID\fR
.br
\fBsha1\fR ?\fB\-log2base \fIlog2base\fR? \fB\-final \fIdescriptor\fR
.BE
.SH DESCRIPTION
.PP
SHA1 is NIST's Secure Hashing Algorithm (also known as Secure Hashing
Standard) with the minor modification that they proposed on 7/11/94.
.PP
Switches can be in any order.
.PP
Returns a sha1 digest in base 2 ** log2base ascii representation.
log2base defaults to 4, i.e., hex representation.
.PP
.nf
       \fBlog2base   length    chars\fR
         1          160      01            \fI(binary)\fR
         2           80      0..3
         3           54      0...7         \fI(octal)\fR
         4           40      0..9a..f      \fI(hex)\fR
         5           32      0..9a..v      
         6           27      0..9a..zA..Z_, 
.fi
.PP
(The characters in the digest string have been chosen to be usable in
filenames so that the sha1 command can be used, for example, to digest URLs
into shorter strings for filenames in a cache.)
.PP
In the \fB\-string\fR version, returns sha1 digest alone of \fIstring\fR.
.PP
In the \fB\-chan\fR version, returns list of 2 items: length of data in
\fIchanID\fR followed by sha1 digest of all data in \fIchanID\fR.
\fIChanID\fR is identifier returned from "\fBopen\fR" for example.  If
\fB\-copychan\fR is supplied, will also copy all data from \fIchanID\fR to
\fIcopychanID\fR.
.PP

In the third form, \fB\-init\fR returns a descriptor, \fB\-update\fR can be
called any number of times with that descriptor and returns the number of
bytes read, and \fB\-final\fR returns the result in the same form as the
standalone \fB\-chan\fR.
'\" Local Variables:
'\" mode: nroff
'\" fill-column: 78
'\" End: