This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
add $Config('scriptdir'} on VMS
[perl5.git] / pod / perlembed.pod
index 3209678..ecbe1f6 100644 (file)
@@ -12,7 +12,7 @@ Do you want to:
 
 =item B<Use C from Perl?>
 
-Read L<perlcall> and L<perlxs>.
+Read L<perlxstut>, L<perlxs>, L<h2xs>, L<perlguts>, and L<perlapi>.
 
 =item B<Use a Unix program from Perl?>
 
@@ -20,7 +20,7 @@ Read about back-quotes and about C<system> and C<exec> in L<perlfunc>.
 
 =item B<Use Perl from Perl?>
 
-Read about L<perlfunc/do> and L<perlfunc/eval> and L<perlfunc/require>
+Read about L<perlfunc/do> and L<perlfunc/eval> and L<perlfunc/require> 
 and L<perlfunc/use>.
 
 =item B<Use C from C?>
@@ -35,27 +35,49 @@ Read on...
 
 =head2 ROADMAP
 
-L<Compiling your C program>
+=over 5
+
+=item *
+
+Compiling your C program
+
+=item *
+
+Adding a Perl interpreter to your C program
+
+=item *
+
+Calling a Perl subroutine from your C program
+
+=item *
 
-There's one example in each of the nine sections:
+Evaluating a Perl statement from your C program
 
-L<Adding a Perl interpreter to your C program>
+=item *
 
-L<Calling a Perl subroutine from your C program>
+Performing Perl pattern matches and substitutions from your C program
 
-L<Evaluating a Perl statement from your C program>
+=item *
 
-L<Performing Perl pattern matches and substitutions from your C program>
+Fiddling with the Perl stack from your C program
 
-L<Fiddling with the Perl stack from your C program>
+=item *
 
-L<Maintaining a persistent interpreter>
+Maintaining a persistent interpreter
 
-L<Maintaining multiple interpreter instances>
+=item *
 
-L<Using Perl modules, which themselves use C libraries, from your C program>
+Maintaining multiple interpreter instances
 
-L<Embedding Perl under Win32>
+=item *
+
+Using Perl modules, which themselves use C libraries, from your C program
+
+=item *
+
+Embedding Perl under Win32
+
+=back 
 
 =head2 Compiling your C program
 
@@ -103,8 +125,8 @@ L<Adding a Perl interpreter to your C program>, on my Linux box:
     -L/usr/local/lib/perl5/i586-linux/5.003/CORE
     -o interp interp.c -lperl -lm
 
-(That's all one line.)  On my DEC Alpha running 5.003_05, the incantation
-is a bit different:
+(That's all one line.)  On my DEC Alpha running old 5.003_05, the 
+incantation is a bit different:
 
     % cc -O2 -Olimit 2900 -DSTANDARD_C -I/usr/local/include
     -I/usr/local/lib/perl5/alpha-dec_osf/5.00305/CORE
@@ -139,7 +161,7 @@ you:
 
 If the B<ExtUtils::Embed> module isn't part of your Perl distribution,
 you can retrieve it from
-http://www.perl.com/perl/CPAN/modules/by-module/ExtUtils::Embed.  (If
+http://www.perl.com/perl/CPAN/modules/by-module/ExtUtils/.  (If
 this documentation came from your Perl distribution, then you're
 running 5.004 or better and you already have it.)
 
@@ -151,7 +173,7 @@ information you may find useful.
 
 In a sense, perl (the C program) is a good example of embedding Perl
 (the language), so I'll demonstrate embedding with I<miniperlmain.c>,
-from the source distribution.  Here's a bastardized, nonportable
+included in the source distribution.  Here's a bastardized, nonportable
 version of I<miniperlmain.c> containing the essentials of embedding:
 
     #include <EXTERN.h>               /* from the Perl distribution     */
@@ -194,13 +216,13 @@ or
 
 You can also read and execute Perl statements from a file while in the
 midst of your C program, by placing the filename in I<argv[1]> before
-calling I<perl_run()>.
+calling I<perl_run>.
 
 =head2 Calling a Perl subroutine from your C program
 
-To call individual Perl subroutines, you can use any of the B<perl_call_*>
-functions documented in the L<perlcall> manpage.
-In this example we'll use I<perl_call_argv>.
+To call individual Perl subroutines, you can use any of the B<call_*>
+functions documented in L<perlcall>.
+In this example we'll use C<call_argv>.
 
 That's shown below, in a program I'll call I<showtime.c>.
 
@@ -219,7 +241,7 @@ That's shown below, in a program I'll call I<showtime.c>.
 
         /*** skipping perl_run() ***/
 
-        perl_call_argv("showtime", G_DISCARD | G_NOARGS, args);
+        call_argv("showtime", G_DISCARD | G_NOARGS, args);
 
         perl_destruct(my_perl);
         perl_free(my_perl);
@@ -255,59 +277,59 @@ and package C<END {}> blocks.
 
 If you want to pass arguments to the Perl subroutine, you can add
 strings to the C<NULL>-terminated C<args> list passed to
-I<perl_call_argv>.  For other data types, or to examine return values,
-you'll need to manipulate the Perl stack.  That's demonstrated in the
-last section of this document: L<Fiddling with the Perl stack from
-your C program>.
+I<call_argv>.  For other data types, or to examine return values,
+you'll need to manipulate the Perl stack.  That's demonstrated in
+L<Fiddling with the Perl stack from your C program>.
 
 =head2 Evaluating a Perl statement from your C program
 
 Perl provides two API functions to evaluate pieces of Perl code.
-These are L<perlguts/perl_eval_sv()> and L<perlguts/perl_eval_pv()>.
+These are L<perlapi/eval_sv> and L<perlapi/eval_pv>.
 
 Arguably, these are the only routines you'll ever need to execute
-snippets of Perl code from within your C program.  Your code can be
-as long as you wish; it can contain multiple statements; it can employ
-L<perlfunc/use>, L<perlfunc/require> and L<perlfunc/do> to include
-external Perl files.
+snippets of Perl code from within your C program.  Your code can be as
+long as you wish; it can contain multiple statements; it can employ
+L<perlfunc/use>, L<perlfunc/require>, and L<perlfunc/do> to
+include external Perl files.
 
-I<perl_eval_pv()> lets us evaluate individual Perl strings, and then
+I<eval_pv> lets us evaluate individual Perl strings, and then
 extract variables for coercion into C types.  The following program,
 I<string.c>, executes three Perl strings, extracting an C<int> from
 the first, a C<float> from the second, and a C<char *> from the third.
 
    #include <EXTERN.h>
    #include <perl.h>
-   
+
    static PerlInterpreter *my_perl;
-   
+
    main (int argc, char **argv, char **env)
    {
+       STRLEN n_a;
        char *embedding[] = { "", "-e", "0" };
-   
+
        my_perl = perl_alloc();
        perl_construct( my_perl );
-   
+
        perl_parse(my_perl, NULL, 3, embedding, NULL);
        perl_run(my_perl);
-   
+
        /** Treat $a as an integer **/
-       perl_eval_pv("$a = 3; $a **= 2", TRUE);
-       printf("a = %d\n", SvIV(perl_get_sv("a", FALSE)));
-   
+       eval_pv("$a = 3; $a **= 2", TRUE);
+       printf("a = %d\n", SvIV(get_sv("a", FALSE)));
+
        /** Treat $a as a float **/
-       perl_eval_pv("$a = 3.14; $a **= 2", TRUE);
-       printf("a = %f\n", SvNV(perl_get_sv("a", FALSE)));
-   
+       eval_pv("$a = 3.14; $a **= 2", TRUE);
+       printf("a = %f\n", SvNV(get_sv("a", FALSE)));
+
        /** Treat $a as a string **/
-       perl_eval_pv("$a = 'rekcaH lreP rehtonA tsuJ'; $a = reverse($a);", TRUE);
-       printf("a = %s\n", SvPV(perl_get_sv("a", FALSE), na));
-   
+       eval_pv("$a = 'rekcaH lreP rehtonA tsuJ'; $a = reverse($a);", TRUE);
+       printf("a = %s\n", SvPV(get_sv("a", FALSE), n_a));
+
        perl_destruct(my_perl);
        perl_free(my_perl);
    }
 
-All of those strange functions with I<sv> in their names help convert Perl scalars to C types.  They're described in L<perlguts>.
+All of those strange functions with I<sv> in their names help convert Perl scalars to C types.  They're described in L<perlguts> and L<perlapi>.
 
 If you compile and run I<string.c>, you'll see the results of using
 I<SvIV()> to create an C<int>, I<SvNV()> to create a C<float>, and
@@ -320,11 +342,12 @@ I<SvPV()> to create a string:
 In the example above, we've created a global variable to temporarily
 store the computed value of our eval'd expression.  It is also
 possible and in most cases a better strategy to fetch the return value
-from L<perl_eval_pv> instead.  Example:
+from I<eval_pv()> instead.  Example:
 
    ...
-   SV *val = perl_eval_pv("reverse 'rekcaH lreP rehtonA tsuJ'", TRUE);
-   printf("%s\n", SvPV(val,na));
+   STRLEN n_a;
+   SV *val = eval_pv("reverse 'rekcaH lreP rehtonA tsuJ'", TRUE);
+   printf("%s\n", SvPV(val,n_a));
    ...
 
 This way, we avoid namespace pollution by not creating global
@@ -332,11 +355,11 @@ variables and we've simplified our code as well.
 
 =head2 Performing Perl pattern matches and substitutions from your C program
 
-The I<perl_eval_sv()> function lets us evaluate chunks of Perl code, so we can
+The I<eval_sv()> function lets us evaluate strings of Perl code, so we can
 define some functions that use it to "specialize" in matches and
 substitutions: I<match()>, I<substitute()>, and I<matches()>.
 
-   char match(SV *string, char *pattern);
+   I32 match(SV *string, char *pattern);
 
 Given a string and a pattern (e.g., C<m/clasp/> or C</\b\w*\b/>, which
 in your C program might appear as "/\\b\\w*\\b/"), match()
@@ -352,7 +375,7 @@ made.
    int matches(SV *string, char *pattern, AV **matches);
 
 Given an C<SV>, a pattern, and a pointer to an empty C<AV>,
-matches() evaluates C<$string =~ $pattern> in an array context, and
+matches() evaluates C<$string =~ $pattern> in a list context, and
 fills in I<matches> with the array elements, returning the number of matches found.
 
 Here's a sample program, I<match.c>, that uses all three (long lines have
@@ -360,49 +383,51 @@ been wrapped here):
 
  #include <EXTERN.h>
  #include <perl.h>
- /** my_perl_eval_sv(code, error_check)
- ** kinda like perl_eval_sv(), 
+
+ /** my_eval_sv(code, error_check)
+ ** kinda like eval_sv(), 
  ** but we pop the return value off the stack 
  **/
- SV* my_perl_eval_sv(SV *sv, I32 croak_on_error)
+ SV* my_eval_sv(SV *sv, I32 croak_on_error)
  {
      dSP;
      SV* retval;
+     STRLEN n_a;
+
      PUSHMARK(SP);
-     perl_eval_sv(sv, G_SCALAR);
+     eval_sv(sv, G_SCALAR);
+
      SPAGAIN;
      retval = POPs;
      PUTBACK;
-     if (croak_on_error && SvTRUE(GvSV(errgv)))
-       croak(SvPVx(GvSV(errgv), na));
+
+     if (croak_on_error && SvTRUE(ERRSV))
+       croak(SvPVx(ERRSV, n_a));
+
      return retval;
  }
+
  /** match(string, pattern)
  **
  ** Used for matches in a scalar context.
  **
  ** Returns 1 if the match was successful; 0 otherwise.
  **/
+
  I32 match(SV *string, char *pattern)
  {
      SV *command = NEWSV(1099, 0), *retval;
+     STRLEN n_a;
+
      sv_setpvf(command, "my $string = '%s'; $string =~ %s",
-             SvPV(string,na), pattern);
-     retval = my_perl_eval_sv(command, TRUE);
+             SvPV(string,n_a), pattern);
+
+     retval = my_eval_sv(command, TRUE);
      SvREFCNT_dec(command);
+
      return SvIV(retval);
  }
+
  /** substitute(string, pattern)
  **
  ** Used for =~ operations that modify their left-hand side (s/// and tr///)
@@ -410,46 +435,48 @@ been wrapped here):
  ** Returns the number of successful matches, and
  ** modifies the input string if there were any.
  **/
+
  I32 substitute(SV **string, char *pattern)
  {
      SV *command = NEWSV(1099, 0), *retval;
+     STRLEN n_a;
+
      sv_setpvf(command, "$string = '%s'; ($string =~ %s)",
-             SvPV(*string,na), pattern);
-     retval = my_perl_eval_sv(command, TRUE);
+             SvPV(*string,n_a), pattern);
+
+     retval = my_eval_sv(command, TRUE);
      SvREFCNT_dec(command);
-     *string = perl_get_sv("string", FALSE);
+
+     *string = get_sv("string", FALSE);
      return SvIV(retval);
  }
+
  /** matches(string, pattern, matches)
  **
- ** Used for matches in an array context.
+ ** Used for matches in a list context.
  **
  ** Returns the number of matches,
  ** and fills in **matches with the matching substrings
  **/
+
  I32 matches(SV *string, char *pattern, AV **match_list)
  {
      SV *command = NEWSV(1099, 0);
      I32 num_matches;
+     STRLEN n_a;
+
      sv_setpvf(command, "my $string = '%s'; @array = ($string =~ %s)",
-             SvPV(string,na), pattern);
-     my_perl_eval_sv(command, TRUE);
+             SvPV(string,n_a), pattern);
+
+     my_eval_sv(command, TRUE);
      SvREFCNT_dec(command);
-     *match_list = perl_get_av("array", FALSE);
+
+     *match_list = get_av("array", FALSE);
      num_matches = av_len(*match_list) + 1; /** assume $[ is 0 **/
+
      return num_matches;
  }
+
  main (int argc, char **argv, char **env)
  {
      PerlInterpreter *my_perl = perl_alloc();
@@ -457,45 +484,46 @@ been wrapped here):
      AV *match_list;
      I32 num_matches, i;
      SV *text = NEWSV(1099,0);
+     STRLEN n_a;
+
      perl_construct(my_perl);
      perl_parse(my_perl, NULL, 3, embedding, NULL);
+
      sv_setpv(text, "When he is at a convenience store and the bill comes to some amount like 76 cents, Maynard is aware that there is something he *should* do, something that will enable him to get back a quarter, but he has no idea *what*.  He fumbles through his red squeezey changepurse and gives the boy three extra pennies with his dollar, hoping that he might luck into the correct amount.  The boy gives him back two of his own pennies and then the big shiny quarter that is his prize. -RICHH");
+
      if (match(text, "m/quarter/")) /** Does text contain 'quarter'? **/
        printf("match: Text contains the word 'quarter'.\n\n");
      else
        printf("match: Text doesn't contain the word 'quarter'.\n\n");
+
      if (match(text, "m/eighth/")) /** Does text contain 'eighth'? **/
        printf("match: Text contains the word 'eighth'.\n\n");
      else
        printf("match: Text doesn't contain the word 'eighth'.\n\n");
+
      /** Match all occurrences of /wi../ **/
      num_matches = matches(text, "m/(wi..)/g", &match_list);
      printf("matches: m/(wi..)/g found %d matches...\n", num_matches);
+
      for (i = 0; i < num_matches; i++)
-       printf("match: %s\n", SvPV(*av_fetch(match_list, i, FALSE),na));
+       printf("match: %s\n", SvPV(*av_fetch(match_list, i, FALSE),n_a));
      printf("\n");
+
      /** Remove all vowels from text **/
      num_matches = substitute(&text, "s/[aeiou]//gi");
      if (num_matches) {
        printf("substitute: s/[aeiou]//gi...%d substitutions made.\n",
               num_matches);
-       printf("Now text is: %s\n\n", SvPV(text,na));
+       printf("Now text is: %s\n\n", SvPV(text,n_a));
      }
+
      /** Attempt a substitution **/
      if (!substitute(&text, "s/Perl/C/")) {
        printf("substitute: s/Perl/C...No substitution made.\n\n");
      }
+
      SvREFCNT_dec(text);
-     perl_destruct_level = 1;
+     PL_perl_destruct_level = 1;
      perl_destruct(my_perl);
      perl_free(my_perl);
  }
@@ -530,7 +558,7 @@ results--the return value of your Perl subroutine--off the stack.
 
 First you'll need to know how to convert between C types and Perl
 types, with newSViv() and sv_setnv() and newAV() and all their
-friends.  They're described in L<perlguts>.
+friends.  They're described in L<perlguts> and L<perlapi>.
 
 Then you'll need to know how to manipulate the Perl stack.  That's
 described in L<perlcall>.
@@ -567,7 +595,7 @@ deep breath...
       XPUSHs(sv_2mortal(newSViv(a))); /* push the base onto the stack  */
       XPUSHs(sv_2mortal(newSViv(b))); /* push the exponent onto stack  */
       PUTBACK;                      /* make local stack pointer global */
-      perl_call_pv("expo", G_SCALAR); /* call the function             */
+      call_pv("expo", G_SCALAR);      /* call the function             */
       SPAGAIN;                        /* refresh stack pointer         */
                                     /* pop the return value from stack */
       printf ("%d to the %dth power is %d.\n", a, b, POPi);
@@ -629,7 +657,7 @@ the filename into a guaranteed-unique package name, and then compile
 the code into that package using L<perlfunc/eval>.  In the example
 below, each file will only be compiled once.  Or, the application
 might choose to clean out the symbol table associated with the file
-after it's no longer needed.  Using L<perlcall/perl_call_argv>, We'll
+after it's no longer needed.  Using L<perlapi/call_argv>, We'll
 call the subroutine C<Embed::Persistent::eval_file> which lives in the
 file C<persistent.pl> and pass the filename and boolean cleanup/cache
 flag as arguments.
@@ -647,7 +675,8 @@ with L<perlfunc/my> whenever possible.
  #persistent.pl
 
  use strict;
- use vars '%Cache';
+ our %Cache;
+ use Symbol qw(delete_package);
 
  sub valid_package_name {
      my($string) = @_;
@@ -660,20 +689,6 @@ with L<perlfunc/my> whenever possible.
      return "Embed" . $string;
  }
 
- #borrowed from Safe.pm
- sub delete_package {
-     my $pkg = shift;
-     my ($stem, $leaf);
-
-     no strict 'refs';
-     $pkg = "main::$pkg\::";    # expand to full symbol table name
-     ($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
-
-     my $stem_symtab = *{$stem}{HASH};
-
-     delete $stem_symtab->{$leaf};
- }
-
  sub eval_file {
      my($filename, $delete) = @_;
      my $package = valid_package_name($filename);
@@ -737,6 +752,7 @@ with L<perlfunc/my> whenever possible.
      char *args[] = { "", DO_CLEAN, NULL };
      char filename [1024];
      int exitstatus = 0;
+     STRLEN n_a;
 
      if((perl = perl_alloc()) == NULL) {
         fprintf(stderr, "no memory!");
@@ -753,16 +769,16 @@ with L<perlfunc/my> whenever possible.
 
             /* call the subroutine, passing it the filename as an argument */
             args[0] = filename;
-            perl_call_argv("Embed::Persistent::eval_file",
+            call_argv("Embed::Persistent::eval_file",
                            G_DISCARD | G_EVAL, args);
 
             /* check $@ */
-            if(SvTRUE(GvSV(errgv)))
-                fprintf(stderr, "eval error: %s\n", SvPV(GvSV(errgv),na));
+            if(SvTRUE(ERRSV))
+                fprintf(stderr, "eval error: %s\n", SvPV(ERRSV,n_a));
         }
      }
 
-     perl_destruct_level = 0;
+     PL_perl_destruct_level = 0;
      perl_destruct(perl);
      perl_free(perl);
      exit(exitstatus);
@@ -799,17 +815,19 @@ during a session.  Such an application might sporadically decide to
 release any resources associated with the interpreter.
 
 The program must take care to ensure that this takes place I<before>
-the next interpreter is constructed.  By default, the global variable
-C<perl_destruct_level> is set to C<0>, since extra cleaning isn't
-needed when a program has only one interpreter.
+the next interpreter is constructed.  By default, when perl is not
+built with any special options, the global variable
+C<PL_perl_destruct_level> is set to C<0>, since extra cleaning isn't
+usually needed when a program only ever creates a single interpreter
+in its entire lifetime.
 
-Setting C<perl_destruct_level> to C<1> makes everything squeaky clean:
+Setting C<PL_perl_destruct_level> to C<1> makes everything squeaky clean:
 
- perl_destruct_level = 1;
PL_perl_destruct_level = 1;
 
  while(1) {
      ...
-     /* reset global variables here with perl_destruct_level = 1 */
+     /* reset global variables here with PL_perl_destruct_level = 1 */
      perl_construct(my_perl);
      ...
      /* clean and reset _everything_ during perl_destruct */
@@ -823,9 +841,16 @@ When I<perl_destruct()> is called, the interpreter's syntax parse tree
 and symbol tables are cleaned up, and global variables are reset.
 
 Now suppose we have more than one interpreter instance running at the
-same time.  This is feasible, but only if you used the
-C<-DMULTIPLICITY> flag when building Perl.  By default, that sets
-C<perl_destruct_level> to C<1>.
+same time.  This is feasible, but only if you used the Configure option
+C<-Dusemultiplicity> or the options C<-Dusethreads -Duseithreads> when
+building Perl.  By default, enabling one of these Configure options
+sets the per-interpreter global variable C<PL_perl_destruct_level> to
+C<1>, so that thorough cleaning is automatic.
+
+Using C<-Dusethreads -Duseithreads> rather than C<-Dusemultiplicity>
+is more appropriate if you intend to run multiple interpreters
+concurrently in different threads, because it enables support for
+linking in the thread libraries of your system with the interpreter.
 
 Let's give it a try:
 
@@ -846,22 +871,41 @@ Let's give it a try:
      char *one_args[] = { "one_perl", SAY_HELLO };
      char *two_args[] = { "two_perl", SAY_HELLO };
 
+     PERL_SET_CONTEXT(one_perl);
      perl_construct(one_perl);
+     PERL_SET_CONTEXT(two_perl);
      perl_construct(two_perl);
 
+     PERL_SET_CONTEXT(one_perl);
      perl_parse(one_perl, NULL, 3, one_args, (char **)NULL);
+     PERL_SET_CONTEXT(two_perl);
      perl_parse(two_perl, NULL, 3, two_args, (char **)NULL);
 
+     PERL_SET_CONTEXT(one_perl);
      perl_run(one_perl);
+     PERL_SET_CONTEXT(two_perl);
      perl_run(two_perl);
 
+     PERL_SET_CONTEXT(one_perl);
      perl_destruct(one_perl);
+     PERL_SET_CONTEXT(two_perl);
      perl_destruct(two_perl);
 
+     PERL_SET_CONTEXT(one_perl);
      perl_free(one_perl);
+     PERL_SET_CONTEXT(two_perl);
      perl_free(two_perl);
  }
 
+Note the calls to PERL_SET_CONTEXT().  These are necessary to initialize
+the global state that tracks which interpreter is the "current" one on
+the particular process or thread that may be running it.  It should
+always be used if you have more than one interpreter and are making
+perl API calls on both interpreters in an interleaved fashion.
+
+PERL_SET_CONTEXT(interp) should also be called whenever C<interp> is
+used by a thread that did not create it (using either perl_alloc(), or
+the more esoteric perl_clone()).
 
 Compile as usual:
 
@@ -897,21 +941,14 @@ That's where the glue code can be inserted to create the initial contact between
 Perl and linked C/C++ routines.  Let's take a look some pieces of I<perlmain.c>
 to see how Perl does this:
 
+ static void xs_init (pTHX);
 
- #ifdef __cplusplus
- #  define EXTERN_C extern "C"
- #else
- #  define EXTERN_C extern
- #endif
-
- static void xs_init _((void));
-
- EXTERN_C void boot_DynaLoader _((CV* cv));
- EXTERN_C void boot_Socket _((CV* cv));
+ EXTERN_C void boot_DynaLoader (pTHX_ CV* cv);
+ EXTERN_C void boot_Socket (pTHX_ CV* cv);
 
 
  EXTERN_C void
- xs_init()
+ xs_init(pTHX)
  {
         char *file = __FILE__;
         /* DynaLoader is a special case */
@@ -956,43 +993,35 @@ B<ExtUtils::Embed> can also automate writing the I<xs_init> glue code.
  % cc -c interp.c  `perl -MExtUtils::Embed -e ccopts`
  % cc -o interp perlxsi.o interp.o `perl -MExtUtils::Embed -e ldopts`
 
-Consult L<perlxs> and L<perlguts> for more details.
+Consult L<perlxs>, L<perlguts>, and L<perlapi> for more details.
 
 =head1 Embedding Perl under Win32
 
-At the time of this writing, there are two versions of Perl which run
-under Win32.  Interfacing to Activeware's Perl library is quite
-different from the examples in this documentation, as significant
-changes were made to the internal Perl API.  However, it is possible
-to embed Activeware's Perl runtime, see the Perl for Win32 FAQ:
-http://www.perl.com/perl/faq/win32/Perl_for_Win32_FAQ.html
-
-With the "official" Perl version 5.004 or higher, all the examples
-within this documentation will compile and run untouched, although,
-the build process is slightly different between Unix and Win32.  
+In general, all of the source code shown here should work unmodified under
+Windows.
 
-For starters, backticks don't work under the Win32 native command shell!
+However, there are some caveats about the command-line examples shown.
+For starters, backticks won't work under the Win32 native command shell.
 The ExtUtils::Embed kit on CPAN ships with a script called
 B<genmake>, which generates a simple makefile to build a program from
-a single C source file.  It can be used like so:
+a single C source file.  It can be used like this:
 
  C:\ExtUtils-Embed\eg> perl genmake interp.c
  C:\ExtUtils-Embed\eg> nmake
  C:\ExtUtils-Embed\eg> interp -e "print qq{I'm embedded in Win32!\n}"
 
-You may wish to use a more robust environment such as the MS Developer
-stdio.  In this case, to generate perlxsi.c run:
+You may wish to use a more robust environment such as the Microsoft
+Developer Studio.  In this case, run this to generate perlxsi.c:
 
  perl -MExtUtils::Embed -e xsinit
 
-Create a new project, Insert -> Files into Project: perlxsi.c, perl.lib,
-and your own source files, e.g. interp.c.  Typically you'll find
-perl.lib in B<C:\perl\lib\CORE>, if not, you should see the B<CORE>
-directory relative to C<perl -V:archlib>.
-The studio will also need this path so it knows where to find Perl
-include files.  This path can be added via the Tools -> Options ->
-Directories menu.  Finnally, select Build -> Build interp.exe and
-you're ready to go!
+Create a new project and Insert -> Files into Project: perlxsi.c,
+perl.lib, and your own source files, e.g. interp.c.  Typically you'll
+find perl.lib in B<C:\perl\lib\CORE>, if not, you should see the
+B<CORE> directory relative to C<perl -V:archlib>.  The studio will
+also need this path so it knows where to find Perl include files.
+This path can be added via the Tools -> Options -> Directories menu.
+Finally, select Build -> Build interp.exe and you're ready to go.
 
 =head1 MORAL
 
@@ -1003,28 +1032,38 @@ each from the other, combine them as you wish.
 
 =head1 AUTHOR
 
-Jon Orwant and <F<orwant@tpj.com>> and Doug MacEachern <F<dougm@osf.org>>,
-with small contributions from Tim Bunce, Tom Christiansen, Hallvard Furuseth,
-Dov Grobgeld, and Ilya Zakharevich.
-
-Check out Doug's article on embedding in Volume 1, Issue 4 of The Perl
-Journal.  Info about TPJ is available from http://tpj.com.
+Jon Orwant <F<orwant@tpj.com>> and Doug MacEachern
+<F<dougm@osf.org>>, with small contributions from Tim Bunce, Tom
+Christiansen, Guy Decoux, Hallvard Furuseth, Dov Grobgeld, and Ilya
+Zakharevich.
 
-July 17, 1997
+Doug MacEachern has an article on embedding in Volume 1, Issue 4 of
+The Perl Journal (http://tpj.com).  Doug is also the developer of the
+most widely-used Perl embedding: the mod_perl system
+(perl.apache.org), which embeds Perl in the Apache web server.
+Oracle, Binary Evolution, ActiveState, and Ben Sugars's nsapi_perl
+have used this model for Oracle, Netscape and Internet Information
+Server Perl plugins.
 
-Some of this material is excerpted from Jon Orwant's book: I<Perl 5
-Interactive>, Waite Group Press, 1996 (ISBN 1-57169-064-6) and appears
-courtesy of Waite Group Press.
+July 22, 1998
 
 =head1 COPYRIGHT
 
-Copyright (C) 1995, 1996, 1997 Doug MacEachern and Jon Orwant.  All
+Copyright (C) 1995, 1996, 1997, 1998 Doug MacEachern and Jon Orwant.  All
 Rights Reserved.
 
-Although destined for release with the standard Perl distribution,
-this document is not public domain, nor is any of Perl and its
-documentation.  Permission is granted to freely distribute verbatim
-copies of this document provided that no modifications outside of
-formatting be made, and that this notice remain intact.  You are
-permitted and encouraged to use its code and derivatives thereof in
-your own source code for fun or for profit as you see fit.
+Permission is granted to make and distribute verbatim copies of this
+documentation provided the copyright notice and this permission notice are
+preserved on all copies.
+
+Permission is granted to copy and distribute modified versions of this
+documentation under the conditions for verbatim copying, provided also
+that they are marked clearly as modified versions, that the authors'
+names and title are unchanged (though subtitles and additional
+authors' names may be added), and that the entire resulting derived
+work is distributed under the terms of a permission notice identical
+to this one.
+
+Permission is granted to copy and distribute translations of this
+documentation into another language, under the above conditions for
+modified versions.