[Subversion] / PEAK / INSTALL.txt  

Diff of /PEAK/INSTALL.txt

Parent Directory | Revision Log

version 1175, Mon Jun 9 22:34:35 2003 UTC version 1713, Sun Mar 7 23:51:25 2004 UTC
Line 1 
Line 1 
 Installing PEAK  Installing PEAK
   
  PEAK Release 0.5 alpha 2   PEAK Release 0.5 alpha 4
   
  Copyright (C) 1996-2003 by Phillip J. Eby and Tyler C. Sarna.   Copyright (C) 1996-2004 by Phillip J. Eby and Tyler C. Sarna.
  All rights reserved.  This software may be used under the same terms   All rights reserved.  This software may be used under the same terms
  as Zope or Python.  THERE ARE ABSOLUTELY NO WARRANTIES OF ANY KIND.   as Zope or Python.  THERE ARE ABSOLUTELY NO WARRANTIES OF ANY KIND.
  Code quality varies between modules, from "beta" to "experimental   Code quality varies between modules, from "beta" to "experimental
Line 39 
Line 39 
   
   (Note: for the Win32 installer release, just run the .exe file.)    (Note: for the Win32 installer release, just run the .exe file.)
   
  SCRIPTS   SCRIPTS, BATCH FILES, AND '#!'
   
   PEAK installs a Python script named 'peak'.  'peak' is an application    PEAK installs a Python script named 'peak'.  'peak' is an application
   bootstrap script that can invoke any object that is referenceable via    bootstrap script that can invoke any object that is referenceable via
Line 55 
Line 55 
   followed by the appropriate arguments.  You should of course substitute the    followed by the appropriate arguments.  You should of course substitute the
   correct path to your Python installation's "scripts" directory.    correct path to your Python installation's "scripts" directory.
   
     The 'peak' script is designed for use as a '#!' command interpreter for
     certain file types, such as ZConfig configuration files.  Some Unixes,
     however, do not support using scripts as '#!' interpreters.  To work around
     this, there is a (currently experimental) 'invoke' program you can build.  To
     build the 'invoke' program, go to the directory you unpacked the PEAK source
     in, and type::
   
       gcc -o invoke scripts/invoke.c
   
     This will build an 'invoke' executable, which you can then place on your
     system's path or other appropriate location.  You can then use '#!' lines
     like this (replacing '/usr/local/bin' with the directory where you installed
     'invoke', of course)::
   
       #!/usr/local/bin/invoke peak EventDriven
       ...rest of config file goes here
   
     'invoke' allows an arbitrary number of space-separated arguments to be passed
     to the command it invokes, thus working around various Unixes' '#!' parsing
     problems, as well as the "can't use a script as an interpreter" problem.  It
     also searches the system PATH for the specified command.  You may find this
     useful for non-PEAK script interpreters as well.
   
   
   
     The interpretation of '#!' lines is highly OS-dependent.  Some operating
     systems limit the length of '#!' lines to 32, 80, 127, or 255 characters.
     Some operating systems require a space after '#!', and or require the path
     that follows to be absolute.  Some operating systems will search the 'PATH'
     environment variable for the specified interpreter, others will not.  When
     creating programs that use '#!' lines, or using such programs written by
     others, be sure to adjust the line as appropriate for your operating system.
     For more information on this subject, you can visit the
     "shebang site":http://homepages.cwi.nl/~aeb/std/shebang/, which lists useful
     '#!' line information for various operating systems.
   
     Note that Windows does not support '#!' lines at all, so programs that use
     them must be run using batch files when run on Windows, unless you have a
     Unix-like shell available (e.g. Cygwin).
   
   
  TESTING YOUR INSTALLATION   TESTING YOUR INSTALLATION
   
Line 80 
Line 120 
     python C:\Python22\Scripts\peak test      python C:\Python22\Scripts\peak test
   
   
   
  THIRD PARTY SOFTWARE INCLUDED WITH PEAK   THIRD PARTY SOFTWARE INCLUDED WITH PEAK
   
   Aaron Watters' 'kjbuckets' Module    Aaron Watters' 'kjbuckets' Module
Line 92 
Line 133 
    'kjbuckets' is copyright Aaron Watters and contributors; please see     'kjbuckets' is copyright Aaron Watters and contributors; please see
    the 'src/kjbuckets/COPYRIGHT.txt' file for details of its license.     the 'src/kjbuckets/COPYRIGHT.txt' file for details of its license.
   
   
   The Zope 3 'persistence' and 'ZConfig' Packages    The Zope 3 'persistence' and 'ZConfig' Packages
   
    PEAK includes a copy of the following packages from the Zope X3 Milestone 2     PEAK includes a copy of the following packages from the Zope X3 Milestone 2
Line 103 
Line 143 
   
    - 'ZConfig'     - 'ZConfig'
   
    These packages are automatically installed alongside PEAK in your     (Also, if you are using a Python version that does not include the 'datetime'
      or 'csv' packages (i.e. versions < 2.3), replacement versions are installed
      as well.)  These packages are automatically installed alongside PEAK in your
    'site-packages' directory, unless you specify an alternate installation     'site-packages' directory, unless you specify an alternate installation
    location to 'setup.py'.  Note that this will overwrite any existing     location to 'setup.py'.  Note that this will overwrite any existing
    installation of these packages.     installation of these packages.
Line 116 
Line 158 
    will not install any of the Zope packages listed above, in order to avoid     will not install any of the Zope packages listed above, in order to avoid
    overwriting newer versions from your Zope installation.     overwriting newer versions from your Zope installation.
   
    The 'persistence' and 'ZConfig' packages are Copyright Zope Corporation     The 'datetime', 'persistence' and 'ZConfig' packages are Copyright Zope
    and contributors; please see the 'LICENSE.txt' files in their directories     Corporation and contributors; please see the 'LICENSE.txt' files in their
    for details of their licenses.     directories for details of their licenses.
   
   
   The 'fcgiapp' Module    The 'fcgiapp' Module
   

Generate output suitable for use with a patch program
Legend:
Removed from v.1175  
changed lines
  Added in v.1713
cvs-admin@eby-sarna.com

Powered by ViewCVS 1.0-dev

ViewCVS and CVS Help