README
1This is a sample extension showing an implementation of the Tcl Extension
2Architecture (TEA). Please see the webpage
3
4 http://www.tcl.tk/doc/tea/
5
6for more details on TEA. You can also read the enclosed "tea.pdf" document
7for instructions on how to adapt this sample extension to your extension.
8
9This package is a freely available open source package. You can do
10virtually anything you like with it, such as modifying it, redistributing
11it, and selling it either in whole or in part. See the file
12"license.terms" for complete information.
13
14CONTENTS
15========
16The following is a short description of the files you will find in
17the sample extension.
18
19Makefile.in Makefile template. The configure script uses this file to
20 produce the final Makefile.
21
22README This file
23
24README.pam A description of the extension itself.
25
26aclocal.m4 Generated file. Do not edit. Autoconf uses this as input
27 when generating the final configure script. See "tcl.m4"
28 below.
29
30configure Generated file. Do not edit. This must be regenerated
31 anytime configure.in or tclconfig/tcl.m4 changes.
32
33configure.in Configure script template. Autoconf uses this file as input
34 to produce the final configure script.
35
36pkgIndex.tcl.in Package index template. The configure script will use
37 this file as input to create pkgIndex.tcl.
38
39sample.c Core Secure Hash Algorithm code.
40
41sample.h Header file for functions in the C files.
42
43sha1.n Unix nroff man page
44
45tclsample.c Implementation of new Tcl command "sha1".
46
47tea.pdf PDF file describing the current implementation of the
48 Tcl Extension Architecture
49
50tclconfig/ This directory contains various template files that build
51 the configure script. They should not need modification.
52
53 install-sh Program used for copying binaries and script files
54 to their install locations.
55
56 tcl.m4 Collection of Tcl autoconf macros. Included by
57 aclocal.m4 to define SC_* macros.
58
59UNIX BUILD
60==========
61
62Building under most UNIX systems is easy, just run the configure script
63and then run make. For more information about the build process, see
64the tcl/unix/README file in the Tcl src dist. The following minimal
65example will install the extension in the /opt/tcl directory.
66
67 $ cd sampleextension
68 $ ./configure --prefix=/opt/tcl
69 $ make
70 $ make install
71
72WINDOWS BUILD
73=============
74
75The recommended method to build extensions under windows is to use the
76Msys + Mingw build process. This provides a Unix-style build while
77generating native Windows binaries. Using the Msys + Mingw build tools
78means that you can use the same configure script as per the Unix build
79to create a Makefile. See the tcl/win/README file for the URL of
80the Msys + Mingw download.
81
82If you have VC++ then you may wish to use the files in the win
83subdirectory and build the extension using just VC++. These files have
84been designed to be as generic as possible but will require some
85additional maintenance by the project developer to synchronise with
86the TEA configure.in and Makefile.in files. Instructions for using the
87VC++ makefile are written in the first part of the Makefile.vc
88file.
89
90INSTALLATION
91============
92
93The installation of a TEA package is structure like so:
94
95 $exec_prefix
96 / \
97 lib bin
98 | |
99 PACKAGEx.y (dependent .dll files on Windows)
100 |
101 pkgIndex.tcl (.so|.dll files)
102
103The main .so|.dll library file gets installed in the versioned PACKAGE
104directory, which is OK on all platforms because it will be directly
105referenced with by 'load' in the pkgIndex.tcl file. Dependent DLL files on
106Windows must go in the bin directory (or other directory on the user's
107PATH) in order for them to be found.
108
README.mmap
1tcl-mmap - Tcl Interface to POSIX mmap
2
3A Tcl interface to the POSIX mmap(2) system call and related. It
4provides a Tcl package that allows Tcl scripts to:
5 1) Memory map files for improved access efficiency
6 2) Easily establish shared memory between related
7 processes by memory mapping /dev/zero
8 3) Implement cyclic log files.
9
10For instructions on how to use, consult the tcl-mmap (n) man page.
11
12To make type:
13
14 ./configure
15 make
16 make install
17
18The configure script will deduce $PREFIX from the tcl installation.
19The generated Makefile uses the file $PREFIX/lib/tclConfig.sh that was left by
20the make of tcl for most of its configuration parameters.
21
22The Makefile generates pkgIndex.tcl files that are compatible with tcl >= 7.6.
23
24Written by: Alexandros Stergiakis (sterg@kth.se)
25
26Use at your own risk.
27
28 Copyright (C) 2008 Alexandros Stergiakis
29
30 This program is free software: you can redistribute it and/or modify
31 it under the terms of the GNU General Public License as published by
32 the Free Software Foundation, either version 3 of the License, or
33 (at your option) any later version.
34
35 This program is distributed in the hope that it will be useful,
36 but WITHOUT ANY WARRANTY; without even the implied warranty of
37 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
38 GNU General Public License for more details.
39
40 You should have received a copy of the GNU General Public License
41 along with this program. If not, see <http://www.gnu.org/licenses/>.
42