Regen Configure.
[p5sagit/p5-mst-13.2.git] / Porting / Glossary
index fe4b9c4..f3f99f2 100644 (file)
@@ -38,16 +38,18 @@ aphostname (d_gethname.U):
        it safe when used by a process with super-user privileges.
 
 apiversion (patchlevel.U):
-       This is a number which identifies the lowest version of perl
-       to have an API (for XS extensions) compatible with the present
-       version.  For example, for 5.005_01, the apiversion should be
-       5.005, since 5.005_01 should be binary compatible with 5.005.
-       This should probably be incremented manually somehow, perhaps
-       from patchlevel.h.  For now, we'll guess maintenance subversions
-       will retain binary compatibility.
+       MakeMaker will install add-on modules in a directory with the
+       PERL_APIVERSION version number.  The value is set manually in
+       patchlevel.h.  Normally, for maintenance releases, this is
+       just something like 5.005 or 5.6 or 5.7.  That is, it does not
+       include the subversion number and does not change across
+       maintenance releases.  This is so that add-on extensions can
+       be shared across maintenance versions.  It is unclear how this
+       ought to work for developer versions.  If a release breaks
+       binary compatibility, this number should be increased.
 
 ar (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the ar program.  After Configure runs,
        the value is reset to a plain "ar" and is not useful.
 
@@ -77,7 +79,7 @@ archobjs (Unix.U):
        include os2/os2.obj.
 
 awk (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the awk program.  After Configure runs,
        the value is reset to a plain "awk" and is not useful.
 
@@ -107,7 +109,7 @@ bison (Loc.U):
        The value is a plain '' and is not useful.
 
 byacc (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the byacc program.  After Configure runs,
        the value is reset to a plain "byacc" and is not useful.
 
@@ -131,7 +133,7 @@ castflags (d_castneg.U):
        4 = couldn't cast in argument expression list
 
 cat (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the cat program.  After Configure runs,
        the value is reset to a plain "cat" and is not useful.
 
@@ -192,7 +194,7 @@ clocktype (d_times.U):
        included).
 
 comm (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the comm program.  After Configure runs,
        the value is reset to a plain "comm" and is not useful.
 
@@ -200,6 +202,10 @@ compress (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
 
+CONFIGDOTSH (Oldsyms.U):
+       This is set to 'true' in config.sh so that a shell script
+       sourcing config.sh can tell if it has been sourced already.
+
 contains (contains.U):
        This variable holds the command to do a grep with a proper return
        status.  On most sane systems it is simply "grep".  On insane systems
@@ -207,7 +213,7 @@ contains (contains.U):
        is primarily for the use of other Configure units.
 
 cp (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the cp program.  After Configure runs,
        the value is reset to a plain "cp" and is not useful.
 
@@ -216,7 +222,7 @@ cpio (Loc.U):
        The value is a plain '' and is not useful.
 
 cpp (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the cpp program.  After Configure runs,
        the value is reset to a plain "cpp" and is not useful.
 
@@ -275,7 +281,7 @@ cryptlib (d_crypt.U):
        up to the Makefile to use this.
 
 csh (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the csh program.  After Configure runs,
        the value is reset to a plain "csh" and is not useful.
 
@@ -532,6 +538,10 @@ d_fpathconf (d_pathconf.U):
 d_fpos64_t (io64.U):
        This symbol will be defined if the C compiler supports fpos64_t.
 
+d_fs_data_s (d_statfs.U):
+       This variable conditionally defines the HAS_STRUCT_FS_DATA symbol,
+       which indicates that the struct fs_data is supported.
+
 d_fseeko (d_fseeko.U):
        This variable conditionally defines the HAS_FSEEKO symbol, which
        indicates to the C program that the fseeko() routine is available.
@@ -540,7 +550,7 @@ d_fsetpos (d_fsetpos.U):
        This variable conditionally defines HAS_FSETPOS if fsetpos() is
        available to set the file position indicator.
 
-d_fstatfs (d_statfs.U):
+d_fstatfs (d_fstatfs.U):
        This variable conditionally defines the HAS_FSTATFS symbol, which
        indicates to the C program that the fstatfs() routine is available.
 
@@ -609,7 +619,7 @@ d_getlogin (d_getlogin.U):
 d_getmntent (d_getmntent.U):
        This variable conditionally defines the HAS_GETMNTENT symbol, which
        indicates to the C program that the getmntent() routine is available
-       to iterate through mounted files.
+       to iterate through mounted files to get their mount info.
 
 d_getnbyaddr (d_getnbyad.U):
        This variable conditionally defines the HAS_GETNETBYADDR symbol, which
@@ -1312,6 +1322,10 @@ d_sockpair (d_socket.U):
        This variable conditionally defines the HAS_SOCKETPAIR symbol, which
        indicates that the BSD socketpair() is supported.
 
+d_sqrtl (d_sqrtl.U):
+       This variable conditionally defines the HAS_SQRTL symbol, which
+       indicates to the C program that the sqrtl() routine is available.
+
 d_statblks (d_statblks.U):
        This variable conditionally defines USE_STAT_BLOCKS
        if this system has a stat structure declaring
@@ -1321,12 +1335,16 @@ d_statfs (d_statfs.U):
        This variable conditionally defines the HAS_STATFS symbol, which
        indicates to the C program that the statfs() routine is available.
 
-d_statfsflags (d_statfs.U):
-       This variable conditionally defines the HAS_STRUCT_STATFS_FLAGS
+d_statfs_f_flags (d_statfs.U):
+       This variable conditionally defines the HAS_STRUCT_STATFS_F_FLAGS
        symbol, which indicates to struct statfs from has f_flags member.
        This kind of struct statfs is coming from sys/mount.h (BSD),
        not from sys/statfs.h (SYSV).
 
+d_statfs_s (d_statfs.U):
+       This variable conditionally defines the HAS_STRUCT_STATFS symbol,
+       which indicates that the struct statfs is supported.
+
 d_statvfs (d_statvfs.U):
        This variable conditionally defines the HAS_STATVFS symbol, which
        indicates to the C program that the statvfs() routine is available.
@@ -1481,6 +1499,13 @@ d_union_semun (d_union_semun.U):
        This variable conditionally defines HAS_UNION_SEMUN if the
        union semun is defined by including <sys/sem.h>.
 
+d_ustat (d_ustat.U):
+       This variable conditionally defines HAS_USTAT if ustat() is
+       available to query file system statistics by dev_t.
+
+d_vendorbin (vendorbin.U):
+       This variable conditionally defines PERL_VENDORBIN.
+
 d_vendorlib (vendorlib.U):
        This variable conditionally defines PERL_VENDORLIB.
 
@@ -1540,7 +1565,7 @@ d_xenix (Guess.U):
        the C program that it runs under Xenix.
 
 date (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the date program.  After Configure runs,
        the value is reset to a plain "date" and is not useful.
 
@@ -1597,12 +1622,12 @@ ebcdic (ebcdic.U):
        See trnl.U
 
 echo (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the echo program.  After Configure runs,
        the value is reset to a plain "echo" and is not useful.
 
 egrep (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the egrep program.  After Configure runs,
        the value is reset to a plain "egrep" and is not useful.
 
@@ -1619,7 +1644,7 @@ exe_ext (Unix.U):
        This is an old synonym for _exe.
 
 expr (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the expr program.  After Configure runs,
        the value is reset to a plain "expr" and is not useful.
 
@@ -1697,7 +1722,7 @@ glibpth (libpth.U):
        this platform, libpth is the cleaned-up version.
 
 grep (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the grep program.  After Configure runs,
        the value is reset to a plain "grep" and is not useful.
 
@@ -1713,7 +1738,7 @@ groupstype (groupstype.U):
        gidtype (gid_t), but sometimes it isn't.
 
 gzip (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the gzip program.  After Configure runs,
        the value is reset to a plain "gzip" and is not useful.
 
@@ -1964,6 +1989,10 @@ i_sysstat (i_sysstat.U):
        This variable conditionally defines the I_SYS_STAT symbol,
        and indicates whether a C program should include <sys/stat.h>.
 
+i_sysstatfs (i_sysstatfs.U):
+       This variable conditionally defines the I_SYSSTATFS symbol,
+       and indicates whether a C program should include <sys/statfs.h>.
+
 i_sysstatvfs (i_sysstatvfs.U):
        This variable conditionally defines the I_SYSSTATVFS symbol,
        and indicates whether a C program should include <sys/statvfs.h>.
@@ -1994,6 +2023,10 @@ i_sysun (i_sysun.U):
        to the C program that it should include <sys/un.h> to get UNIX
        domain socket definitions.
 
+i_sysvfs (i_sysvfs.U):
+       This variable conditionally defines the I_SYSVFS symbol,
+       and indicates whether a C program should include <sys/vfs.h>.
+
 i_syswait (i_syswait.U):
        This variable conditionally defines I_SYS_WAIT, which indicates
        to the C program that it should include <sys/wait.h>.
@@ -2016,6 +2049,10 @@ i_unistd (i_unistd.U):
        This variable conditionally defines the I_UNISTD symbol, and indicates
        whether a C program should include <unistd.h>.
 
+i_ustat (i_ustat.U):
+       This variable conditionally defines the I_USTAT symbol, and indicates
+       whether a C program should include <ustat.h>.
+
 i_utime (i_utime.U):
        This variable conditionally defines the I_UTIME symbol, and indicates
        whether a C program should include <utime.h>.
@@ -2100,6 +2137,11 @@ installsitearch (sitearch.U):
        those systems using AFS. For extra portability, only this variable
        should be used in makefiles.
 
+installsitebin (sitebin.U):
+       This variable is usually the same as sitebinexp, unless you are on
+       a system running AFS, in which case they may differ slightly. You
+       should always use this variable within your makefiles for portability.
+
 installsitelib (sitelib.U):
        This variable is really the same as sitelibexp but may differ on
        those systems using AFS. For extra portability, only this variable
@@ -2128,6 +2170,11 @@ installusrbinperl (instubperl.U):
        /usr/bin/perl in addition to
        $installbin/perl
 
+installvendorbin (vendorbin.U):
+       This variable is really the same as vendorbinexp but may differ on
+       those systems using AFS. For extra portability, only this variable
+       should be used in makefiles.
+
 installvendorlib (vendorlib.U):
        This variable is really the same as vendorlibexp but may differ on
        those systems using AFS. For extra portability, only this variable
@@ -2172,7 +2219,7 @@ ldlibpthname (libperl.U):
        string, the hints file must set this to 'none'.
 
 less (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the less program.  After Configure runs,
        the value is reset to a plain "less" and is not useful.
 
@@ -2216,7 +2263,7 @@ lkflags (ccflags.U):
        the user.  It is up to the Makefile to use this.
 
 ln (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the ln program.  After Configure runs,
        the value is reset to a plain "ln" and is not useful.
 
@@ -2260,7 +2307,7 @@ lpr (Loc.U):
        The value is a plain '' and is not useful.
 
 ls (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the ls program.  After Configure runs,
        the value is reset to a plain "ls" and is not useful.
 
@@ -2283,7 +2330,7 @@ mailx (Loc.U):
        The value is a plain '' and is not useful.
 
 make (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the make program.  After Configure runs,
        the value is reset to a plain "make" and is not useful.
 
@@ -2344,7 +2391,7 @@ man3ext (man3dir.U):
        See man3dir.
 
 Mcc (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the Mcc program.  After Configure runs,
        the value is reset to a plain "Mcc" and is not useful.
 
@@ -2359,7 +2406,7 @@ mips_type (usrinc.U):
        Possible values are "BSD 4.3" and "System V".
 
 mkdir (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the mkdir program.  After Configure runs,
        the value is reset to a plain "mkdir" and is not useful.
 
@@ -2379,7 +2426,7 @@ modetype (modetype.U):
        modes for system calls.
 
 more (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the more program.  After Configure runs,
        the value is reset to a plain "more" and is not useful.
 
@@ -2441,7 +2488,7 @@ netdb_net_type (netdbtype.U):
        This is only useful if you have getnetbyaddr(), naturally.
 
 nm (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the nm program.  After Configure runs,
        the value is reset to a plain "nm" and is not useful.
 
@@ -2461,7 +2508,7 @@ nonxs_ext (Extensions.U):
        in the package.  All of them will be built.
 
 nroff (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the nroff program.  After Configure runs,
        the value is reset to a plain "nroff" and is not useful.
 
@@ -2530,6 +2577,24 @@ perl (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
 
+PERL_APIVERSION (Oldsyms.U):
+       This value is manually set in patchlevel.h and is used
+       to set the Configure apiversion variable.
+
+PERL_REVISION (Oldsyms.U):
+       In a Perl version number such as 5.6.2, this is the 5.
+       This value is manually set in patchlevel.h
+
+PERL_SUBVERSION (Oldsyms.U):
+       In a Perl version number such as 5.6.2, this is the 2.
+       Values greater than 50 represent potentially unstable
+       development subversions.
+       This value is manually set in patchlevel.h
+
+PERL_VERSION (Oldsyms.U):
+       In a Perl version number such as 5.6.2, this is the 6.
+       This value is manually set in patchlevel.h
+
 perladmin (perladmin.U):
        Electronic mail address of the perl5 administrator.
 
@@ -2539,7 +2604,7 @@ perlpath (perlpath.U):
        shell scripts and in the "eval 'exec'" idiom.
 
 pg (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the pg program.  After Configure runs,
        the value is reset to a plain "pg" and is not useful.
 
@@ -2558,6 +2623,21 @@ plibpth (libpth.U):
        Its value is prepend to libpth. This variable takes care of special
        machines, like the mips.  Usually, it should be empty.
 
+pm_apiversion (xs_apiversion.U):
+       This variable contains the version of the oldest perl
+       compatible with the present perl.  (That is, pure perl modules
+       written for $pm_apiversion will still work for the current
+       version).  perl.c:incpush() and lib/lib.pm will automatically
+       search in $sitelib for older directories across major versions
+       back to pm_apiversion.  This is only useful if you have a perl
+       library directory tree structured like the default one.  The
+       versioned site_perl library was introduced in 5.005, so that's
+       the default setting for this variable.  It's hard to imagine
+       it changing before Perl6.  It is included here for symmetry
+       with xs_apiveprsion -- the searching algorithms will
+       (presumably) be similar.
+       See the INSTALL file for how this works.
+
 pmake (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
@@ -2620,7 +2700,7 @@ rd_nodata (nblock_io.U):
        no data and an EOF.. Sigh!
 
 rm (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the rm program.  After Configure runs,
        the value is reset to a plain "rm" and is not useful.
 
@@ -2649,7 +2729,7 @@ scriptdirexp (scriptdir.U):
        at configuration time, for programs not wanting to bother with it.
 
 sed (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the sed program.  After Configure runs,
        the value is reset to a plain "sed" and is not useful.
 
@@ -2762,6 +2842,16 @@ sitearchexp (sitearch.U):
        This variable is the ~name expanded version of sitearch, so that you
        may use it directly in Makefiles or shell scripts.
 
+sitebin (sitebin.U):
+       This variable holds the name of the directory in which the user wants
+       to put add-on publicly executable files for the package in question.  It
+       is most often a local directory such as /usr/local/bin. Programs using
+       this variable must be prepared to deal with ~name substitution.
+
+sitebinexp (sitebin.U):
+       This is the same as the sitebin variable, but is filename expanded at
+       configuration time, for use in your makefiles.
+
 sitelib (sitelib.U):
        This variable contains the eventual value of the SITELIB symbol,
        which is the name of the private library for this package.  It may
@@ -2809,7 +2899,7 @@ socketlib (d_socket.U):
        This variable has the names of any libraries needed for socket support.
 
 sort (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the sort program.  After Configure runs,
        the value is reset to a plain "sort" and is not useful.
 
@@ -2976,7 +3066,7 @@ tee (Loc.U):
        The value is a plain '' and is not useful.
 
 test (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the test program.  After Configure runs,
        the value is reset to a plain "test" and is not useful.
 
@@ -2989,12 +3079,12 @@ timetype (d_time.U):
        included). Anyway, the type Time_t should be used.
 
 touch (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the touch program.  After Configure runs,
        the value is reset to a plain "touch" and is not useful.
 
 tr (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the tr program.  After Configure runs,
        the value is reset to a plain "tr" and is not useful.
 
@@ -3008,17 +3098,21 @@ troff (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
 
+uidsign (uidsign.U):
+       This variable contains the signedness of a uidtype.
+       1 for unsigned, -1 for signed.
+
 uidtype (uidtype.U):
        This variable defines Uid_t to be something like uid_t, int, 
        ushort, or whatever type is used to declare user ids in the kernel.
 
 uname (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the uname program.  After Configure runs,
        the value is reset to a plain "uname" and is not useful.
 
 uniq (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the uniq program.  After Configure runs,
        the value is reset to a plain "uniq" and is not useful.
 
@@ -3031,7 +3125,7 @@ usedl (dlsrc.U):
        This variable indicates if the the system supports dynamic
        loading of some sort.  See also dlsrc and dlobj.
 
-uselfs (uselfs.U):
+uselargefiles (uselfs.U):
        This variable conditionally defines the USE_LARGE_FILES symbol,
        and indicates that large file interfaces should be used when
        available.  The use64bits symbol will also be turned on if necessary.
@@ -3115,6 +3209,18 @@ uuname (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
 
+vendorbin (vendorbin.U):
+       This variable contains the eventual value of the VENDORBIN symbol,
+       which is the name of the private directory for exuctables for this package.
+       It may have a ~ on the front. It is up to the makefile to eventually create
+       this directory while performing installation (with ~ substitution).
+       Vendors who distribute perl binaries may place their own
+       extensions and modules in this directory.
+
+vendorbinexp (vendorbin.U):
+       This variable is the ~name expanded version of vendorbin, so that you
+       may use it directly in Makefiles or shell scripts.
+
 vendorlib (vendorlib.U):
        This variable contains the eventual value of the VENDORLIB symbol,
        which is the name of the private library for this package.  It may
@@ -3156,12 +3262,29 @@ xlibpth (libpth.U):
        libraries on this platform, for example CPU-specific libraries
        (on multi-CPU platforms) may be listed here.
 
+xs_apiversion (xs_apiversion.U):
+       This variable contains the version of the oldest perl binary
+       compatible with the present perl.  perl.c:incpush() and
+       lib/lib.pm will automatically search in $sitearch for older
+       directories across major versions back to xs_apiversion.
+       This is only useful if you have a perl library directory tree
+       structured like the default one.
+       See INSTALL for how this works.
+       The versioned site_perl directory was introduced in 5.005,
+       so that is the lowest possible value.
+       Since this can depend on compile time options (such as
+       bincompat) it is set by Configure.  Other non-default sources
+       of potential incompatibility, such as multiplicity, threads,
+       debugging, 64bits, sfio, etc., are not checked for currently,
+       though in principle we could go snooping around in old
+       Config.pm files.
+
 zcat (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
 
 zip (Loc.U):
-       This variable is be used internally by Configure to determine the
+       This variable is used internally by Configure to determine the
        full pathname (if any) of the zip program.  After Configure runs,
        the value is reset to a plain "zip" and is not useful.