!!!!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!                                                                             !
!  This is a VERY EARLY PRE-RELEASE of Pd.  Nothing is frozen yet; anything   !
!  you use might change incompatibly in a future release.                     !
!                                                                             !
!!!!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

PD ONLINE DOCUMENTATION PART 1: INTRODUCTION

This is part 1 of the online documentation for the Pd program.  Pd (which
stands for "Pure Data") is a real-time graphical programming environment for
audio and graphics analysis and rendering.  Pd's audio functions are
built-in; graphical computations require a separate package named GEM
("Graphics Environment for Multimedia").

Both Pd and GEM are copyrighted.  They are free for you to use for
any reasonable purpose.  Here is Pd's copyright notice:

    This software is copyrighted by the Regents of the University of
    California.   The following terms apply to all files associated with the
    software unless explicitly disclaimed in individual files.

    The authors hereby grant permission to use, copy, modify, distribute,
    and license this software and its documentation for any purpose, provided
    that existing copyright notices are retained in all copies and that this
    notice is included verbatim in any distributions. No written agreement,
    license, or royalty fee is required for any of the authorized uses.
    Modifications to this software may be copyrighted by their authors
    and need not follow the licensing terms described here, provided that
    the new terms are clearly indicated on the first page of each file where
    they apply.

    IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
    FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
    ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
    DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

    THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE
    IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
    NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
    MODIFICATIONS.

    RESTRICTED RIGHTS: Use, duplication or disclosure by the government
    is subject to the restrictions as set forth in subparagraph (c) (1) (ii)
    of the Rights in Technical Data and Computer Software Clause as DFARS
    252.227-7013 and FAR 52.227-19.

GEM has almost the some copyright, except substitute Mark Danks whereever you
see the Regents of the Unversity of California (look in the GEM distribution
for the full notice).

SYSTEM REQUIREMENTS.

Pd and GEM are available for SGIs, IBM PC compatibles (running NT or W95) and
Linux.

On SGI, Pd runs on SGI IRIX 5.x and up; GEM requires IRIX 6.2 or higher.

GETTING AND INSTALLING PD and GEM.

IRIX.  Connect to crca-ftp.ucsd.edu
as "anonymous," cd to pub/msp, and get pd-0.xx.tar.Z.  You can unpack
this into any directory you please; the executable is pd/bin/pd.  The
executable looks at its command line to figure out where it is, so make an
alias to pd's absolute pathname to invoke it.

PC.   Connect to crca-ftp.ucsd.edu
as "anonymous," cd to pub/msp, and get pd-0.xx.zip.  Unzip this to create
a directory \pd, for example.  You can then adjust your path to include
\pd\bin and just invoke "pd" in a command prompt window.

LINUX.  Get Pd from Guenther Geiger at http://iem.mhsg.ac.at/~geiger

Whatever your platform, you'll want to pick up GEM too.  Hit
http:/cybermed.ucsd.edu/~mdanks.

OTHER RESOURCES.

The first public presentation of Pd was given at Kunitachi College of
Music in Tachikawa, Japan; a postscript version is available on the CRCA FTP
site, under the name "pd-kcm.ps."  Another paper is in the 1997 ICMC
proceedings.

Papers on GEM are at http://cybermed.ucsd.edu/mdanks/GEM/  There are currently
out of date because they refer to the Max version of GEM.  There is other
on-line help at this web site as well.

STARTING PD

Pd should be started from a UNIX command line by an absolute or relative
pathname (not via the "$path" variable).  The simplest way to invoke Pd is to
make an alias in your ".cshrc" file (assuming you use the "c" shell) such as:

    alias pd /usr/people/msp/pd/bin/pd

(assuming your Pd distribution landed in /usr/people/msp, for example).

Pd can take the following command line options:

    -rate <sample rate>
    
    	set Pd's logical sample rate in Hertz.  This might or might not
    	change the sample rate of your audio system depending on your
    	operating system.
    	
    -open <file>
    
    	opens the named file.  You can also just type "pd <file>".  Sorry,
    	you can only specify one file this way.

    -lib <file>

    	loads shareable libraries (GEM, for instance).  You can use "-lib"
    	as many times as you wish. 

    -font <pointsize>
    
    	sets the font point size.  The default is 12.

    -help
    
    	get a more complete list of options.

See also the instructions on MIDI and audio for what to do on startup to get
them to work.

    GEM
    	GEM has no command line options.  Just make sure to invoke 
    	    the -lib option, as in
    	    
    	    pd -lib /usr/people/msp/pd/gem/Gem
    	    
USING THE GEM GRAPHICS PACKAGE.

GEM is distributed separately by Mark Danks (mdanks@cybermed.ucsd.edu)
  Goto http://cybermed.ucsd.edu/mdanks.

GETTING HELP.

Pd's user base is quite small.  Just e-mail requests for help to the author:

Miller Puckette
Music Department, UCSD
msp@ucsd.edu

This chapter was last updated for release 0.23.
