tcl-mod_dtcl-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dav...@apache.org
Subject cvs commit: tcl-moddtcl/docs documentation.txt
Date Thu, 03 May 2001 11:49:10 GMT
davidw      01/05/03 04:49:10

  Modified:    .        Makefile
               docs     documentation.txt
  Log:
  Fixed up makefile a bit to generate .txt documentation.
  
  Revision  Changes    Path
  1.13      +8 -5      tcl-moddtcl/Makefile
  
  Index: Makefile
  ===================================================================
  RCS file: /home/cvs/tcl-moddtcl/Makefile,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- Makefile	2001/03/13 12:00:42	1.12
  +++ Makefile	2001/05/03 11:49:06	1.13
  @@ -1,4 +1,4 @@
  -# $Id: Makefile,v 1.12 2001/03/13 12:00:42 davidw Exp $
  +# $Id: Makefile,v 1.13 2001/05/03 11:49:06 davidw Exp $
   
   # Changed to use the Tcl variables from tclConfig.sh
   
  @@ -22,10 +22,10 @@
   
   all: builddtcl_test shared
   
  -static: $(OBJECTS)
  +static: $(OBJECTS) docs/documentation.txt
   	$(TCL_STLIB_LD) $(STATICLIB) $(OBJECTS) 
   
  -shared: $(OBJECTS)
  +shared: $(OBJECTS) docs/documentation.txt
   	$(TCL_SHLIB_LD) -o $(SHLIB) $(OBJECTS) $(TCL_LIB_SPEC) $(TCL_LIBS)
   
   # I don't have too many C files, so it's just clearer to do things by
  @@ -43,12 +43,15 @@
   	$(COMPILE)
   
   clean: 
  -	-rm -f $(STATICLIB) $(SHLIB) *.o *~
  +	-rm -f $(STATICLIB) $(SHLIB) *.o *~ docs/documentation.txt
   
   version: 
   	./cvsversion.tcl
   
  -dist: clean version
  +docs/documentation.txt:
  +	if test -x `which lynx` ; then 	lynx -dump ./docs/documentation.html > ./docs/documentation.txt
; else echo "You need lynx to create documentation.txt from documentation.html" ; fi
  +
  +dist: clean docs/documentation.txt version
   	(cd .. ; tar -czvf mod_dtcl-`cat mod_dtcl/VERSION`.tar.gz mod_dtcl/ ; )
   
   install: static
  
  
  
  1.3       +104 -28   tcl-moddtcl/docs/documentation.txt
  
  Index: documentation.txt
  ===================================================================
  RCS file: /home/cvs/tcl-moddtcl/docs/documentation.txt,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- documentation.txt	2000/10/19 11:31:41	1.2
  +++ documentation.txt	2001/05/03 11:49:09	1.3
  @@ -19,30 +19,55 @@
          gunzip apache-1.3.X.tar.gz
          tar -xvf apache-1.3.X.tar.gz
          You don't need the Apache sources if you are building a shared
  -       object module. gunzip mod_dtcl-X.X.X.tar.gz
  +       object module. You do, however, need the header files. Some
  +       systems, such as Debian GNU/Linux, provide these independently -
  +       otherwise, you probably still need the sources.
  +       gunzip mod_dtcl-X.X.X.tar.gz
          tar -xvf mod_dtcl-X.X.X.tar.gz
  -    4. Configure, Edit builddtcl.sh and Make
  -       cd apache-1.3.X/
  -       ./configure
  -       cd ../mod_dtcl/
  -       Now edit the builddtcl.sh script. The 3 variables you may need to
  -       change are:
  -          + TCLSH
  -            Name of the tclsh program on your computer.
  -          + APACHE
  -            Location of the Apache sources (for static builds only).
  -          + INC
  -            Location of the Apache headers (you will need this even for
  -            building shared objects).
  -       ./builddtcl.sh static (shared in place of static if you are
  -       building a shared object module
  -       ./builddtcl.sh install (Not necessary if it is a shared object
  -       build)
  -       cd ../apache-1.3.X
  -       ./configure --activate-module=src/modules/mod_dtcl/mod_dtcl.a [
  -       other configure options ]
  -       make
  -       make install
  +    4. Configuring, builddtcl.sh, etc...
  +       Do you want to build mod_dtcl as a shared object (such as a .so
  +       file on Linux, or a .dll on windows), or compile it directly as a
  +       part of the Apache executable? The Apache Software Foundation has
  +       put together a nice [4]manual which explains things in detail.
  +          + For shared objects
  +            cd ../mod_dtcl/
  +            Edit the builddtcl.sh script. The 3 variables you may need to
  +            change are:
  +               o TCLSH
  +                 Name of the tclsh program on your computer.
  +               o APACHE
  +                 Location of the Apache sources (for static builds only).
  +               o INC
  +                 Location of the Apache headers (you will need this even
  +                 for building shared objects).
  +            ./builddtcl.sh shared
  +            cp mod_dtcl.so
  +            /usr/lib/apache/wherever/the/other/shared/objects/reside For
  +            shared object builds, you need to copy the object into the
  +            directory where the other shared objects are kept for your
  +            Apache build. On Debian GNU/Linux systems, for instance, this
  +            is in /usr/lib/apache/1.3/.
  +          + For static builds
  +            cd apache-1.3.X/
  +            ./configure
  +            cd ../mod_dtcl/
  +            Edit the builddtcl.sh script. The 3 variables you may need to
  +            change are:
  +               o TCLSH
  +                 Name of the tclsh program on your computer.
  +               o APACHE
  +                 Location of the Apache sources (for static builds only).
  +               o INC
  +                 Location of the Apache headers (you will need this even
  +                 for building shared objects).
  +            ./builddtcl.sh static
  +            ./builddtcl.sh install
  +            cd ../apache-1.3.X
  +            ./configure --activate-module=src/modules/mod_dtcl/mod_dtcl.a
  +            [ other configure options ]
  +            export EXTRA_LIBS="-ltcl8.X -lm"
  +            make -e
  +            make install
       5. Configure Apache
             + http.conf
               LoadModule dtcl_module /usr/lib/apache/1.3/mod_dtcl.so
  @@ -71,11 +96,18 @@
          buffer_add.
        * Dtcl_Script AfterScript "script"
          Script to be called after each .ttml page.
  +     * Dtcl_Script ErrorScript "script"
  +       This code is called in place of the standard 'error' pages
  +       generated for mod_dtcl. This directive may be useful if you have
  +       sensitive logic that you wish to protect.
        * Dtcl_CacheSize cachesize
          Number of ttml scripts to cache as Tcl Objects. Default is
          MaxRequestsPerChild / 2, or 50, if MaxRequestsPerChild is 0.
  +     * Dtcl_UploadFilesToVar 1/0
  +       If set to 1, files will be uploaded to the variable UPLOAD(data).
  +       Be careful with this, as large files could use up your memory.
          
  -  3) mod_dtcl specific Tcl commands
  +  3) mod_dtcl specific Tcl commands and variables
     
        * buffer_add string
          Add text to output_buffer for later printing. Used internally.
  @@ -102,8 +134,8 @@
        * headers redirect uri
          Redirect from the current page to a new URI. Must be done in the
          first block of TCL code.
  -     * headers setcookie cookie-name cookie-value ?-expires date/time?
  -       ?-domain domain? ?-path path? ?-secure?
  +     * headers setcookie -name cookie-name -value cookie-value ?-expires
  +       date/time? ?-domain domain? ?-path path? ?-secure?
          This command is for setting cookies. Cookie-name is the name of
          the cookie, cookie-value is the data associated with the variable.
          Expires sets an expiration date for the cookie, and must be in the
  @@ -119,6 +151,23 @@
        * dtcl_info
          Prints information on the internals of the module in HTML.
          Currently, only the PID and size of the object cache are reported.
  +     * Note that these variables may be lists if more than one file is
  +       uploaded at a time.
  +       $::request::UPLOAD(filename)
  +       The filename of the uploaded file.
  +       $::request::UPLOAD(name)
  +       The form variable name of the upload.
  +       $::request::UPLOAD(size)
  +       The size of the uploaded file.
  +       $::request::UPLOAD(type)
  +       The content type of the file upload. Not always available!
  +       $::request::UPLOAD(channelname)
  +       The name of a Tcl channel which may be used to manipulate the
  +       uploaded file. If Dtcl_UploadFilesToVar is set, this variable
  +       doesn't get created. If no file is passed to the server, this
  +       variable does not exist! Be sure to check for this.
  +       $::request::UPLOAD(data)
  +       Contents of the uploaded file, if Dtcl_UploadFilesToVar is set.
          
     4) Internals
     
  @@ -141,7 +190,7 @@
          lets you share variables, and most importantly, loaded modules,
          from a common parent (such as one of the InitScripts). When a file
          is loaded, it is transformed into a Tcl script by putting
  -       everything outside of <+ and +> into large hputs statements. When
  +       everything outside of <? and ?> into large hputs statements. When
          the script is complete, it is then inserted into the cache, for
          future use. In fact, if the file modification information doesn't
          change, mod_dtcl will execute the cached version of the script the
  @@ -149,9 +198,36 @@
        * Binary data
          mod_dtcl is capable of outputing binary data, such as images, or
          loading binary data with 'include'.
  +       
  +  5) Upgrading From Older (< 0.9.3) Versions
  +  
  +     * New tags
  +       As of version 0.9.4, mod_dtcl uses <? and ?> instead of <+ and +>
  +       to delimit sections of Tcl code. By default, dtcl is still
  +       compiled with code to parse the <? ?> tags, but it will run faster
  +       if USE_OLD_TAGS is set to 0 in mod_dtcl.h. You can automatically
  +       change your .ttml files to the new format by using the newtags.sh
  +       script in the contrib/ directory. Run it at the top level of your
  +       DocumentRoot.
  +     * headers setcookie
  +       The headers setcookie command now uses the -name and -value flags
  +       for those arguments, whereas this was not necessary in the past.
  +       
  +  6) Getting Help
  +  
  +     * Mailing list
  +       The mod_dtcl mailing list is the best place to go for help when
  +       you have problems.
  +       See the [5]Contact page for information on sending
  +       mail/subscribing.
  +       Mailing list archives are also available at
  +       [6]http://archive.covalent.net, at the bottom of the page.
   
   References
   
      1. http://www.debian.org/Packages/unstable/web/libapache-mod-dtcl.html
      2. http://www.freebsd.org/ports/www.html#mod_dtcl-0.8.1.1
  -   3. file://localhost/home/davidw/workshop/mod_dtcl/docs/download/
  +   3. file://localhost/home/davidw/workshop/tcl-moddtcl/docs/download/
  +   4. http://httpd.apache.org/docs/dso.html
  +   5. http://tcl.apache.org/mod_dtcl/contact.ttml
  +   6. http://archive.covalent.net/
  
  
  

Mime
View raw message