aboutsummaryrefslogtreecommitdiff
path: root/pd/doc/1.manual
diff options
context:
space:
mode:
Diffstat (limited to 'pd/doc/1.manual')
-rw-r--r--pd/doc/1.manual/1.introduction.txt14
-rw-r--r--pd/doc/1.manual/index.htm2
-rw-r--r--pd/doc/1.manual/x1.htm82
-rw-r--r--pd/doc/1.manual/x2.htm8
-rw-r--r--pd/doc/1.manual/x3.htm56
-rw-r--r--pd/doc/1.manual/x5.htm64
6 files changed, 80 insertions, 146 deletions
diff --git a/pd/doc/1.manual/1.introduction.txt b/pd/doc/1.manual/1.introduction.txt
index 97967523..f3979d23 100644
--- a/pd/doc/1.manual/1.introduction.txt
+++ b/pd/doc/1.manual/1.introduction.txt
@@ -1,8 +1,7 @@
PD_VERSION
A real-time graphical programming environment for live interactive
-computer music, Pd works on SGI machines, Microsoft Windows,
-Linux, and Mac OSX.
+computer music, Pd works on Linux, Macintosh OSX, and Microsoft Windows.
Pd is copyrighted, but is free for you to use for any reasonable purpose.
See the file:
@@ -13,11 +12,12 @@ Reference documentation for Pd lives in:
or:
http://www.crca.ucsd.edu/~msp/Pd_documentation/index.htm
-Much more documentation and other resources live on:
+More extensive FLOSS documentation is available on:
+ http://en.flossmanuals.net/PureData/ (English)
+ http://fr.flossmanuals.net/PureData/ (Francais)
+
+Information of all sorts (guides, development, meetings, etc):
http://puredata.org
The Pd mailing list archive lives in:
- http://iem.kug.ac.at/mailinglists/pd-list/
-
-
-Many more useful links are listed in the HTML documentation, section 1.2.
+ http://iem.at/mailinglists/pd-list/
diff --git a/pd/doc/1.manual/index.htm b/pd/doc/1.manual/index.htm
index 519a5102..4e8bb364 100644
--- a/pd/doc/1.manual/index.htm
+++ b/pd/doc/1.manual/index.htm
@@ -51,7 +51,7 @@ can be found at:
<LI> <A href="x2.htm#s3.2"> depth first message passing </A>
<LI> <A href="x2.htm#s3.3">
hot and cold inlets and right to left outlet order </A>
- <LI> <A href="x2.htm#s3.3"> message boxes </A>
+ <LI> <A href="x2.htm#s3.4"> message boxes </A>
</OL>
<LI> <A href="x2.htm#s4"> audio signals </A>
<OL>
diff --git a/pd/doc/1.manual/x1.htm b/pd/doc/1.manual/x1.htm
index 00fa7da1..92585e69 100644
--- a/pd/doc/1.manual/x1.htm
+++ b/pd/doc/1.manual/x1.htm
@@ -48,20 +48,16 @@ This manual has five sections:
<LI> <A href="x5.htm"> release notes and known bugs </A>
</OL>
-<P> In order to consult the reference and example patches, you'll first have
-to get Pd started as explained in this manual.
-
<P>
For a list of all the objects you can use in Pd, see the text file,
"0.INTRO.txt" in the directory, "../5.reference". To get help on any
Pd object you can right click on it; or you can browse the help patches
-by choosing "Pure Documentation..." in the Pd help menu and looking in
+by choosing "Browser..." in the Pd help menu and looking in
5.reference.
<P>
-The example patches are also available from the "Pure Documentation..." item
-in Pd's
-"help" menu. The example patches appear in subdirectories named
+The example patches are also available from the "Browser..." item
+in Pd's "help" menu. They appear in subdirectories named
"2.control.examples", "3.audio.examples" and "4.fft.examples." Some additional
patches in "7.stuff" might also be helpful.
@@ -70,73 +66,53 @@ To get started writing your own C extensions, refer to chapter 4 of this manual.
<H3> <A name=s2> 1.2. other resources </A> </H3>
-<P> There is a new Pd community web site,
+<P> There is a very extensive Pd community web site,
<a href="http://www.pure-data.info/"> pure-data.info</a>, which aims to be the
central resource for Pd, from documentation and
downloads; to forums, member pages, and a patch exchange.
-<P> There is a growing number of Pd-related projects hosted at
-<A HREF="http://pure-data.sf.net">SourceForge</A>. This is open to all Pd
-developers, and all are encouraged to join; send an email to the pd-dev list
-(see below).
+<P> More documentation is avalable on the Pd FLOSS site:
+<A href=http://en.flossmanuals.net/PureData/>
+en.flossmanuals.net/PureData/</A> (English) and
+<A href=http://fr.flossmanuals.net/PureData/>
+fr.flossmanuals.net/PureData/</A> (French).
<P>
-Most of the interesting resources related to Pd show up on the Pd mailing list,
+Most of the interesting news related to Pd shows up on the Pd mailing list,
maintained by Iohannes Zmoelnig. To subscribe or browse the archives
visit:
- <A href="http://iem.kug.ac.at/mailinglists/pd-list/">
- http://iem.kug.ac.at/mailinglists/pd-list/</A>.
+ <A href="http://iem.at/mailinglists/pd-list/">
+ http://iem.at/mailinglists/pd-list/</A>.
-. This is the
+This is the
best source of recent information regarding installation problems and bugs. It
is perfectly reasonable to post "newbie" questions on this list; alternatively
you can contact msp@ucsd.edu for help.
-<P> Many extensions to Pd are announced on the mailing list. In particular,
-for people interested in graphics, there is a A 3D graphics rendering package,
-named GEM, based on OpenGL, written by Mark Danks, adapted to Linux by
-Guenter Geiger, and now maintained by Iohannes Zmoelnig. GEM runs on
-Windows and Linux and probably will run with some coaxing on IRIX. You can get
-it from: <A href="http://iem.kug.ac.at/GEM">http://iem.kug.ac.at/GEM</A> .
-
-<P> At least three video processing packages are available for Pd. The oldest
-is Framestein, by Juha Vehvilainen. This runs on Windows only: <A
-href="http://framestein.org"> http://framestein.org </A>.
-The newer PDP
-library, by Tom Schouten, and its extension <A
-href="http://ydegoyon.free.fr/pidip.html"> PiDiP </A> by Yves Degoyon, run well
-in linux and have been ported to Windows and MacOS.
-Mathieu Bouchard has written <A href=http://artengine.ca/gridflow/>
-Gridflow </A>, which runs on linux and MacOSX. The mathematical operators are
-more powerful than in PDP, and the design makes smarter use of cache behavior
-in modern CPUs.
-
-<P> the Pd extended package, maintained by Hans-Christof Steiner, can be
+<P> the Pd Extended package, maintained by Hans-Christophe Steiner, can be
downloaded from the <A href=http://sourceforge.net/projects/pure-data/> Pd's
sourceforge site </A>. All this and much more is described in detail on <A
href="http://puredata.info/"> http://puredata.info/</A>.
+<P> Many extensions to Pd are announced on the mailing list. In particular,
+for people interested in graphics, there is a 3D graphics rendering package,
+named GEM, based on OpenGL, written by Mark Danks, adapted to Linux by
+Guenter Geiger, and now maintained by Iohannes Zmoelnig. You can get
+it from: <A href="http://iem.at/GEM">http://iem.kug.ac.at/GEM</A>, or by
+installing Pd Extended.
<P>
-Here are some more Pd links (in the order I found them): <BR>
-
+Here are some more Pd links (updated 2/2011): <BR>
+<a href="http://obiwannabe.co.uk/tutorials/html/tutorials_main.html">
+Andy Farnell's Tutorial</A><BR>
+<a href="http://sites.google.com/site/porres/TutorialPd.zip">
+Alexandre Porres's Tutorial (Portuguese)</A><BR>
+<A HREF="http://www.crca.ucsd.edu/~msp/techniques.htm">
+Puckette's book, <I> Theory and Techniques of Electronic Music</A> </I> <br>
<a href="http://www.crca.ucsd.edu/~msp"> Miller Puckette's home page</a><br>
-<a href="http://gige.epy.co.at/"> Guenter Geiger's home page</a><br>
-<a href="http://www.danks.org/mark"> Mark Dank's home page</a><br>
-<a href="http://iem.kug.ac.at/~zmoelnig/index.html">
+<a href="http://iem.at/~zmoelnig/index.html">
Johannes M Zmoelnig</a><br>
-<a href="http://suita.chopin.edu.pl/~czaja/miXed/externs/xeq.html">
-Krzysztof Czaja's MIDI file support </a><br>
-<a href="http://www.davesabine.com/media/puredata.asp?action=pddp">
-David Sabine's Pd Documentation Project:
-new, highly detailed help windows</a><br>
<a href="http://www-ccrma.stanford.edu/planetccrma/software/soundapps.html#pd">
-Fernando Pablo Lopez's augmented Pd RPMs from Planet CCRMA</a><br>
-<a href="http://suita.chopin.edu.pl/~czaja/miXed/externs/cyclone.html">
-Cyclone - Krzysztof Czaja's Max compatibility library</a><br>
-On-line book:
-<A HREF="http://www.crca.ucsd.edu/~msp/techniques.htm"
-<I> Theory and Techniques of Electronic Music </I> <br>
-
+Fernando Pablo Lopez's RPMs from Planet CCRMA</a><br>
</BODY>
</HTML>
diff --git a/pd/doc/1.manual/x2.htm b/pd/doc/1.manual/x2.htm
index 05b4d84b..771c9c3e 100644
--- a/pd/doc/1.manual/x2.htm
+++ b/pd/doc/1.manual/x2.htm
@@ -21,11 +21,9 @@
<P> The purpose of this chapter is to describe Pd's design and how it is
supposed to work. Practical details about how to obtain, install, and run Pd
-are described in the next chapter. To learn digital audio processing basics
-such as how to generate time-varying sounds that don't click or fold over, try
-the on-line book,
-<A HREF="http://www.crca.ucsd.edu/~msp/techniques.htm"
-<I> Theory and Techniques of Electronic Music </I></A>.
+are described in the <A href=x3.htm>next chapter</A>. Links to more extensive guidaes (and to
+more theoretical information about computer music) can be found in the
+<A href=x1.htm>previous chapter</A>.
<H3> <A name=s1> 2.1 overview </A> </H3>
diff --git a/pd/doc/1.manual/x3.htm b/pd/doc/1.manual/x3.htm
index 833d6ac7..747c6548 100644
--- a/pd/doc/1.manual/x3.htm
+++ b/pd/doc/1.manual/x3.htm
@@ -17,18 +17,22 @@
<BR><BR>
</P>
+<P> The following are basic instructions on how to get Pd installed and running
+on your machine. More details are maintined online on the
+<A href=http://www.pure-data.info/>pure-data.info</A> site.
+
<P>Pd runs under Microsoft Windows, Linux, and MacOS (10.2 or later). How to
get Pd up and running depends on your operating system, but the overall strategy
is the same. You must first get and install it, and then untangle whatever
problems arise in handling audio and MIDI input and output, and finally get Pd
to meet its real-time obligations reliably.
-<P> Installation instructions are platform-specfic; the following four
+<P> Installation instructions are platform-specfic; the following three
sections
will describe what to do for various operating systems you might have.
In case of trouble also consult the Pd mailing list archive on
- <A href="http://iem.kug.ac.at/mailinglists/pd-list/">
- http://iem.kug.ac.at/mailinglists/pd-list/</A>
+ <A href="http://iem.at/mailinglists/pd-list/">
+ http://iem.at/mailinglists/pd-list/</A>
, which often has late-breaking news about configuration problems and solutions.
The rest of this section describes how to get audio and MIDI to work.
@@ -217,9 +221,10 @@ compile your own copy of Pd and that is the approach described here.
<P> Before you start, you might want to check that you have the resources Pd
needs. The main things you need are the C compiler, X windows (including
-the X development package for Pd to link against) and TK. It's almost
-always enough to load "tcl-devel" and "tk-devel" packages using yum or
-apt-get.
+the X development package for Pd to link against), TK, and the ALSA "devel"
+headers. It should be
+enough to load "tcl-devel", "tk-devel", and "alsa-devel" packages using
+yum or apt-get.
<P>
Download Pd, perhaps from
@@ -244,7 +249,7 @@ to "pd/src" and type
<PRE>
To enable debugging (and losing code optimization) add "--enable-debug".
- To use Portaudio version 19 (experimental), add "--enable-portaudio".
+ To use Portaudio, add "--enable-portaudio".
To put Pd in /usr/bin instead of /usr/local/bin, add "--prefix=/bin".
</PRE>
@@ -291,15 +296,13 @@ audio latency your audio system can handle.
<H3> Audio hardware in Linux </H3>
<P>
-Be forewarned: installing and testing audio and MIDI drivers in Linux can take
+Installing and testing audio and MIDI drivers in Linux can take
days or weeks. There apears to be no single place where you can get detailed
-information on Linux audio. One good source of information lives at:
-<A href=http://www.djcj.org/LAU/guide/index.php>
-http://www.djcj.org/LAU/guide/index.php </A>.
+information on Linux audio.
<P>
-There are two widely-used driver sets, called "OSS" and "ALSA". OSS is
-included in the standard Linux kernels since version 2.2. However, for some
+There are two widely-used driver sets, called "OSS" and "ALSA". ALSA is
+included in the standard Linux kernel since 2.4 or so. However, for some
audio cards you can find newer versions than are included in the kernel
releases. You can get ALSA from
@@ -307,14 +310,11 @@ releases. You can get ALSA from
http://www.alsa-project.org/</A> .
<P> ALSA is able to emulate OSS, so that you can usually run Pd using the
-default "OSS" settings even if it's actually ALSA that's running.
-ALSA is newer, hence less stable and harder to use, than OSS.
-Installing ALSA can be tricky and/or confusing.
+"OSS" driver settings even if it's actually ALSA that's running.
-<P> By default, Pd uses OSS. If you are running ALSA, Pd will use ALSA's OSS
-emulation. To make Pd use ALSA "natively", i.e., the way ALSA is designed
-to be used, include the "-alsa" flag in the command line or bang on the "media"
-menu items.
+<P> By default, Pd uses ALSA. You can ask Pd to use ALSA's OSS emulation by
+adding the "-oss" flag to the command line or fooling with the "media" menu
+items.
<P> You can add ALSA devices by name on the Pd command line:
<PRE>
@@ -330,7 +330,7 @@ also the Pd mailing list archives.
<H6> RME 9652 (Hammerfall) </H6>
-<P> This is the best sound card out there; it costs around $500 and has 3 ADAT
+<P> This is the best PCI sound card out there; it costs around $500 and has 3 ADAT
I/O ports and one SPDIF. There is a "baby hammerfall" also, which I think is
the "9632." DO NOT CONFUSE THE 9652/9632 WITH OTHER RME BOARDS WHICH MIGHT
NOT WORK WITH PD.
@@ -349,16 +349,14 @@ with between 4 and 10 channels in and out, for
which there are ALSA drivers. These are also very good, and they are a
bit cheaper than Hammerfalls. The driver name is "ice1712".
-<P> Alsa provides an "envy24control" program (in "utils". You should run
-this and check that your ice1712's sync source is internal if you have no
-SPDIF input, or "SPDIF" if you do. I think the default is now "internal"
-but don't take it for granted...
+<H6> USB sound devices</H6>
-<H6> warning about i810/i815 drivers...</H6>
+<P> Ed Kelly reports success with the Lexicon series of USB 1.0 devices (e.g.,
+the Omega Studio; apparently 4 channels in and 4 out). Also known to work well is the
+Edirol box (2 channels in and out).
-<P>As of RedHat 7.0, motherboards with native i810 audio systems didn't work in
-full duplex (they crashed linux). Either run Pd -noadc or else (better)
-install ALSA. This ought to be fixed by now...
+<P> As of Feb. 2011, USB 2.0 devices are starting to appear but the ALSA
+driver support is not yet there; watch the Pd mailing list.
<H3> <A name="s1.3"> 3.4. Installing Pd in Macintosh OSX </A> </H3>
diff --git a/pd/doc/1.manual/x5.htm b/pd/doc/1.manual/x5.htm
index c07d48dd..a781ae5c 100644
--- a/pd/doc/1.manual/x5.htm
+++ b/pd/doc/1.manual/x5.htm
@@ -20,6 +20,11 @@
<H3> <A name="s2"> 5.1. release notes </A> </H3>
+<P> ------------------ 0.43 ---------------------------
+
+<P> Completely new TCL front end, thanks to Hans-Christophe Steiner,
+Iohannes Zmoelnig, and others.
+
<P> ------------------ 0.42-5 ---------------------------
<P> broken abs~ and log~ fixed
@@ -1665,53 +1670,9 @@ The following max-like objects are included:
<H3> <A name="s2"> 5.2. known bugs </A> </H3>
-<P> In the list below, starred items are still things needing attention.
-This list is no longer maintained; see the sourceforge bug tracker on
-https://sourceforge.net/tracker/?group_id=55736
-
-<P> *1. Timing of MIDI input/output is very shaky. Audio I/O is primitive, but
-there's at least a way to detect errors now for linux and NT.
-
-<P> *2. There is no flow control for graphical updates yet; the
-real-time process can easily block trying to write too fast to the GUI.
-
-<P> 3. PD dies if your patch has an infinite loop [fixed in 0.30 release.]
-
-<P> *4. If you cut a box which is a "Pd" or abstraction whose subpatch has
-items selected, Pd dies.
-
-<P> *5. Tables and other drawable items can draw far outside the window; there's
-no sanity check, Huge tables (>1000 points) are only partially drawn
-(the first 1000 points.)
-
-<P> 6. There's no way to order force a delread~ to make it read after
-a delwrite~ has written. [but see under 3.audio.examples how to do this now.]
-
-<P> 7. Pd doesn't know to suspend graphics updates when you minimize objects.
-Presumably minimization makes things better but it doesn't cut off graphics
-computation entirely as it should. [fixed for 0.34]
-
-<P> 8. If you load a nonexistent extern you get a spurious message,
-"consistency check failed: canvas_setargs". [fixed for 0.27 release.]
-
-<P> 9. Typing backslashes into objects upsets Tk [0.29 should suppress all
-backslashes; a real fix might come later.]
-
-<P> 10. Never type a dollar sign into a comment; you may have trouble
-opening your patch afterward... [fixed somewhere around 0.32]
-
-<P> *11. You'd better Turn DSP off before you type into a box that currently
-holds a "pd" object with tilde objects in the subpatch.
-
-<P> *12. In Linux, if you hit control C while Pd is opening MIDI, Pd hangs.
-
-<P> *13. In linux, Pd doesn't report audio data-late errors yet.
-
-<P> *14. Several objects, notably dac~, adc~, and env~, are incompatible with
-uses of block~ or switch~ objects that change block size from the default of
-64. Using switch~ without reblocking causes no problem. Don't try to
-read/write delay lines or use send~/receive~, or throw~/catch~, between
-windows with different block sizes.
+<P> These are now tracked on the
+<A href=https://sourceforge.net/projects/pure-data/>
+Pd Sourceforge project page</A>.
<H3> <A name="s3"> 5.3. differences from Max/MSP </A> </H3>
@@ -1721,10 +1682,11 @@ Pd than in Max/MSP, the choices in Pd tend to hew to those in Max/MSP.
Moreover, some effort has been undertaken (but more is needed) to make the
two interoperable.
-<P> You can use Pd to import and export patches to Max/MSP; just save as
-text to a file with extension ".pat", and then open it in Pd. You'll at
-least get something. If you stick to common or commonizable features
-you can actually develop patches for both platforms.
+<P> You can use Pd to import and export patches to Max/MSP; just save as text to
+a file with extension ".pat", and then open in the other program. You'll at
+least get something. If you stick to common or commonizable features you can
+actually develop patches for both platforms. Pd importing of Max patches works
+best if you use the Pd Extended package; there are many more compatible objects.
<P> When specific objects exist on one platform and not on the other, it's
often possible to make abstractions to imitate the missing objects, in a