Integrate with Sarathy.
[p5sagit/p5-mst-13.2.git] / Porting / Glossary
index 44012c4..f5ac6da 100644 (file)
@@ -26,7 +26,8 @@ afs (afs.U):
 
 alignbytes (alignbytes.U):
        This variable holds the number of bytes required to align a
-       double. Usual values are 2, 4 and 8.
+       double-- or a long double when applicable. Usual values are
+       2, 4 and 8.  The default is eight, for safety.
 
 ansi2knr (ansi2knr.U):
        This variable is set if the user needs to run ansi2knr.  
@@ -130,8 +131,8 @@ bin (bin.U):
        this variable must be prepared to deal with ~name substitution.
 
 bincompat5005 (bincompat5005.U):
-       This variable contains y if Perl 5.006 should be binary-compatible
-       with Perl 5.005.
+       This variable contains y if this version of Perl should be
+       binary-compatible with Perl 5.005.
 
 binexp (bin.U):
        This is the same as the bin variable, but is filename expanded at
@@ -193,6 +194,8 @@ ccflags (ccflags.U):
 
 ccsymbols (Cppsym.U):
        The variable contains the symbols defined by the C compiler alone.
+       The symbols defined by cpp or by cc when it calls cpp are not in
+       this list, see cppsymbols and cppccsymbols.
        The list is a space-separated list of symbol=value tokens.
 
 cf_by (cf_who.U):
@@ -266,9 +269,9 @@ cpp_stuff (cpp_stuff.U):
        used by the C preprocessor.
 
 cppccsymbols (Cppsym.U):
-       The variable contains the symbols defined by both
-       the bare C compiler and during a compilation that
-       includes stdio.h.
+       The variable contains the symbols defined by the C compiler
+       when it calls cpp.  The symbols defined by the cc alone or cpp
+       alone are not in this list, see ccsymbols and cppsymbols.
        The list is a space-separated list of symbol=value tokens.
 
 cppflags (ccflags.U):
@@ -300,8 +303,9 @@ cppstdin (cppstdin.U):
        preprocessor symbols.
 
 cppsymbols (Cppsym.U):
-       The variable contains the symbols during a compilation
-       that includes stdio.h.
+       The variable contains the symbols defined by the C preprocessor
+       alone.  The symbols defined by cc or by cc when it calls cpp are
+       not in this list, see ccsymbols and cppccsymbols.
        The list is a space-separated list of symbol=value tokens.
 
 crosscompile (crosscompile.U):
@@ -359,9 +363,10 @@ d_bcopy (d_bcopy.U):
 
 d_bincompat5005 (bincompat5005.U):
        This variable conditionally defines BINCOMPAT5005 so that embed.h
-       can take special action if Perl 5.006 should be binary-compatible
-       with Perl 5.005.  This is impossible for builds that use features
-       like threads and multiplicity it is always $undef for those versions.
+       can take special action if this version of Perl should be
+       binary-compatible with Perl 5.005.  This is impossible for builds
+       that use features like threads and multiplicity it is always $undef
+       for those versions.
 
 d_bsd (Guess.U):
        This symbol conditionally defines the symbol BSD when running on a
@@ -565,9 +570,13 @@ d_fpathconf (d_pathconf.U):
        to determine file-system related limits and options associated
        with a given open file descriptor.
 
-d_fpos64_t (io64.U):
+d_fpos64_t (d_fpos64_t.U):
        This symbol will be defined if the C compiler supports fpos64_t.
 
+d_frexpl (d_frexpl.U):
+       This variable conditionally defines the HAS_FREXPL symbol, which
+       indicates to the C program that the frexpl() routine is available.
+
 d_fs_data_s (d_fs_data_s.U):
        This variable conditionally defines the HAS_STRUCT_FS_DATA symbol,
        which indicates that the struct fs_data is supported.
@@ -611,6 +620,10 @@ d_getcwd (d_getcwd.U):
        indicates to the C program that the getcwd() routine is available
        to get the current working directory.
 
+d_getfsstat (d_getfsstat.U):
+       This variable conditionally defines the HAS_GETFSSTAT symbol, which
+       indicates to the C program that the getfsstat() routine is available.
+
 d_getgrent (d_getgrent.U):
        This variable conditionally defines the HAS_GETGRENT symbol, which
        indicates to the C program that the getgrent() routine is available
@@ -795,13 +808,21 @@ d_inetaton (d_inetaton.U):
        indicates to the C program that the inet_aton() function is available
        to parse IP address "dotted-quad" strings.
 
-d_int64t (d_int64t.U):
+d_int64_t (d_int64_t.U):
        This symbol will be defined if the C compiler supports int64_t.
 
 d_isascii (d_isascii.U):
        This variable conditionally defines the HAS_ISASCII constant,
        which indicates to the C program that isascii() is available.
 
+d_isnan (d_isnan.U):
+       This variable conditionally defines the HAS_ISNAN symbol, which
+       indicates to the C program that the isnan() routine is available.
+
+d_isnanl (d_isnanl.U):
+       This variable conditionally defines the HAS_ISNANL symbol, which
+       indicates to the C program that the isnanl() routine is available.
+
 d_killpg (d_killpg.U):
        This variable conditionally defines the HAS_KILLPG symbol, which
        indicates to the C program that the killpg() routine is available
@@ -837,10 +858,20 @@ d_longlong (d_longlong.U):
        This variable conditionally defines HAS_LONG_LONG if 
        the long long type is supported.
 
+d_lseekproto (d_lseekproto.U):
+       This variable conditionally defines the HAS_LSEEK_PROTO symbol,
+       which indicates to the C program that the system provides
+       a prototype for the lseek() function.  Otherwise, it is
+       up to the program to supply one.
+
 d_lstat (d_lstat.U):
        This variable conditionally defines HAS_LSTAT if lstat() is
        available to do file stats on symbolic links.
 
+d_madvise (d_madvise.U):
+       This variable conditionally defines HAS_MADVISE if madvise() is
+       available to map a file into memory.
+
 d_mblen (d_mblen.U):
        This variable conditionally defines the HAS_MBLEN symbol, which
        indicates to the C program that the mblen() routine is available
@@ -914,6 +945,10 @@ d_mmap (d_mmap.U):
        This variable conditionally defines HAS_MMAP if mmap() is
        available to map a file into memory.
 
+d_modfl (d_modfl.U):
+       This variable conditionally defines the HAS_MODFL symbol, which
+       indicates to the C program that the modfl() routine is available.
+
 d_mprotect (d_mprotect.U):
        This variable conditionally defines HAS_MPROTECT if mprotect() is
        available to modify the access protection of a memory mapped file.
@@ -984,7 +1019,7 @@ d_nv_preserves_uv (perlxv.U):
        This variable indicates whether a variable of type nvtype
        can preserve all the bits a variable of type uvtype.
 
-d_off64_t (io64.U):
+d_off64_t (d_off64_t.U):
        This symbol will be defined if the C compiler supports off64_t.
 
 d_old_pthread_create_joinable (d_pthrattrj.U):
@@ -1017,6 +1052,11 @@ d_pause (d_pause.U):
        indicates to the C program that the pause() routine is available
        to suspend a process until a signal is received.
 
+d_perl_otherlibdirs (otherlibdirs.U):
+       This variable conditionally defines PERL_OTHERLIBDIRS, which
+       contains a colon-separated set of paths for the perl binary to
+       include in @INC.  See also otherlibdirs.
+
 d_phostname (d_gethname.U):
        This variable conditionally defines the HAS_PHOSTNAME symbol, which
        contains the shell command which, when fed to popen(), may be
@@ -1123,6 +1163,10 @@ d_pwquota (i_pwd.U):
        This variable conditionally defines PWQUOTA, which indicates
        that struct passwd contains pw_quota.
 
+d_qgcvt (d_qgcvt.U):
+       This variable conditionally defines the HAS_QGCVT symbol, which
+       indicates to the C program that the qgcvt() routine is available.
+
 d_quad (quadtype.U):
        This variable, if defined, tells that there's a 64-bit integer type,
        quadtype.
@@ -1358,6 +1402,9 @@ d_socket (d_socket.U):
        This variable conditionally defines HAS_SOCKET, which indicates
        that the BSD socket interface is supported.
 
+d_socklen_t (d_socklen_t.U):
+       This symbol will be defined if the C compiler supports socklen_t.
+
 d_sockpair (d_socket.U):
        This variable conditionally defines the HAS_SOCKETPAIR symbol, which
        indicates that the BSD socketpair() is supported.
@@ -1551,6 +1598,9 @@ d_ustat (d_ustat.U):
        This variable conditionally defines HAS_USTAT if ustat() is
        available to query file system statistics by dev_t.
 
+d_vendorarch (vendorarch.U):
+       This variable conditionally defined PERL_VENDORARCH.
+
 d_vendorbin (vendorbin.U):
        This variable conditionally defines PERL_VENDORBIN.
 
@@ -1904,6 +1954,10 @@ i_iconv (i_iconv.U):
        This variable conditionally defines the I_ICONV symbol, and indicates
        whether a C program should include <iconv.h>.
 
+i_ieeefp (i_ieeefp.U):
+       This variable conditionally defines the I_IEEEFP symbol, and indicates
+       whether a C program should include <ieeefp.h>.
+
 i_inttypes (i_inttypes.U):
        This variable conditionally defines the I_INTTYPES symbol,
        and indicates whether a C program should include <inttypes.h>.
@@ -2013,6 +2067,10 @@ i_string (i_string.U):
        This variable conditionally defines the I_STRING symbol, which
        indicates that <string.h> should be included rather than <strings.h>.
 
+i_sunmath (i_sunmath.U):
+       This variable conditionally defines the I_SUNMATH symbol, and indicates
+       whether a C program should include <sunmath.h>.
+
 i_sysaccess (i_sysaccess.U):
        This variable conditionally defines the I_SYS_ACCESS symbol,
        and indicates whether a C program should include <sys/access.h>.
@@ -2048,6 +2106,10 @@ i_sysmman (i_sysmman.U):
        This variable conditionally defines the I_SYS_MMAN symbol, and
        indicates whether a C program should include <sys/mman.h>.
 
+i_sysmode (i_sysmode.U):
+       This variable conditionally defines the I_SYSMODE symbol,
+       and indicates whether a C program should include <sys/mode.h>.
+
 i_sysmount (i_sysmount.U):
        This variable conditionally defines the I_SYSMOUNT symbol,
        and indicates whether a C program should include <sys/mount.h>.
@@ -2116,6 +2178,10 @@ i_sysun (i_sysun.U):
        to the C program that it should include <sys/un.h> to get UNIX
        domain socket definitions.
 
+i_sysutsname (i_sysutsname.U):
+       This variable conditionally defines the I_SYSUTSNAME symbol,
+       and indicates whether a C program should include <sys/utsname.h>.
+
 i_sysvfs (i_sysvfs.U):
        This variable conditionally defines the I_SYSVFS symbol,
        and indicates whether a C program should include <sys/vfs.h>.
@@ -2278,6 +2344,11 @@ installusrbinperl (instubperl.U):
        /usr/bin/perl in addition to
        $installbin/perl
 
+installvendorarch (vendorarch.U):
+       This variable is really the same as vendorarchexp but may differ on
+       those systems using AFS. For extra portability, only this variable
+       should be used in makefiles.
+
 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
@@ -2375,6 +2446,9 @@ libsfound (libs.U):
        This variable holds the full pathnames of the libraries
        we found and accepted.
 
+libspath (libs.U):
+       This variable holds the directory names probed for libraries.
+
 libswanted (Myinit.U):
        This variable holds a list of all the libraries we want to
        search.  The order is chosen to pick up the c library
@@ -2688,6 +2762,16 @@ osvers (Oldconfig.U):
        same for this package, hints files might just be os_4.0 or
        os_4.1, etc., not keeping separate files for each little release.
 
+otherlibdirs (otherlibdirs.U):
+       This variable contains a colon-separated set of paths for the perl
+       binary to search for additional library files or modules.
+       These directories will be tacked to the end of @INC.
+       Perl will automatically search below each path for version-
+       and architecture-specific directories.  See inc_version_list
+       for more details.
+       A value of ' ' means 'none' and is used to preserve this value
+       for the next run through Configure.
+
 package (package.U):
        This variable contains the name of the package being constructed.
        It is primarily intended for the use of later Configure units.
@@ -2707,16 +2791,20 @@ patchlevel (patchlevel.U):
        The patchlevel level of this package.
        The value of patchlevel comes from the patchlevel.h file.
        In a version number such as 5.6.1, this is the "6".
-       In patchlevel.h, this is referred to as the "PERL_VERSION".
+       In patchlevel.h, this is referred to as "PERL_VERSION".
 
 path_sep (Unix.U):
        This is an old synonym for p_ in Head.U, the character
        used to separate elements in the command shell search PATH.
 
+perl5 (perl5.U):
+       This variable contains the full path (if any) to a previously
+       installed perl5.005 or later suitable for running the script
+       to determine inc_version_list.
+
 perl (Loc.U):
-       This variable is used internally by Configure to determine the
-       full pathname (if any) of the perl program.  After Configure runs,
-       the value is reset to a plain "perl" and is not useful.
+       This variable is defined but not used by Configure.
+       The value is a plain '' and is not useful.
 
 PERL_REVISION (Oldsyms.U):
        In a Perl version number such as 5.6.2, this is the 5.
@@ -2844,6 +2932,11 @@ rd_nodata (nblock_io.U):
        used, which is a shame because you cannot make the difference between
        no data and an EOF.. Sigh!
 
+revision (patchlevel.U):
+       The value of revision comes from the patchlevel.h file.
+       In a version number such as 5.6.1, this is the "5".
+       In patchlevel.h, this is referred to as "PERL_REVISION".
+
 rm (Loc.U):
        This variable is used internally by Configure to determine the
        full pathname (if any) of the rm program.  After Configure runs,
@@ -3018,6 +3111,11 @@ sitelib (sitelib.U):
        MakeMaker Makefile.PL
        or equivalent.  See INSTALL for details.
 
+sitelib_stem (sitelib.U):
+       This variable is $sitelibexp with any trailing version-specific component
+       removed.  The elements in inc_version_list (inc_version_list.U) can
+       be tacked onto this variable to generate a list of directories to search.
+
 sitelibexp (sitelib.U):
        This variable is the ~name expanded version of sitelib, so that you
        may use it directly in Makefiles or shell scripts.
@@ -3031,6 +3129,9 @@ siteprefixexp (siteprefix.U):
        This variable holds the full absolute path of the directory below
        which the user will install add-on packages.  Derived from siteprefix.
 
+sizesize (sizesize.U):
+       This variable contains the size of a sizetype in bytes.
+
 sizetype (sizetype.U):
        This variable defines sizetype to be something like size_t, 
        unsigned long, or whatever type is used to declare length 
@@ -3059,6 +3160,11 @@ sockethdr (d_socket.U):
 socketlib (d_socket.U):
        This variable has the names of any libraries needed for socket support.
 
+socksizetype (socksizetype.U):
+       This variable holds the type used for the size argument
+       for various socket calls like accept.  Usual values include
+       socklen_t, size_t, and int.
+
 sort (Loc.U):
        This variable is used internally by Configure to determine the
        full pathname (if any) of the sort program.  After Configure runs,
@@ -3203,6 +3309,7 @@ subversion (patchlevel.U):
        The subversion level of this package.
        The value of subversion comes from the patchlevel.h file.
        In a version number such as 5.6.1, this is the "1".
+       In patchlevel.h, this is referred to as "PERL_SUBVERSION".
        This is unique to perl.
 
 sysman (sysman.U):
@@ -3318,10 +3425,23 @@ use5005threads (usethreads.U):
        and indicates that Perl should be built to use the 5.005-based
        threading implementation.
 
-use64bits (use64bits.U):
-       This variable conditionally defines the USE_64_BITS symbol,
+use64bitall (use64bits.U):
+       This variable conditionally defines the USE_64_BIT_ALL symbol,
        and indicates that 64-bit integer types should be used
-       when available.
+       when available.  The maximal possible
+       64-bitness is employed: LP64 or ILP64, meaning that you will
+       be able to use more than 2 gigabytes of memory.  This mode is
+       even more binary incompatible than USE_64_BIT_INT. You may not
+       be able to run the resulting executable in a 32-bit CPU at all or
+       you may need at least to reboot your OS to 64-bit mode.
+
+use64bitint (use64bits.U):
+       This variable conditionally defines the USE_64_BIT_INT symbol,
+       and indicates that 64-bit integer types should be used
+       when available.  The minimal possible 64-bitness
+       is employed, just enough to get 64-bit integers into Perl.
+       This may mean using for example "long longs", while your memory
+       may still be limited to 2 gigabytes.
 
 usedl (dlsrc.U):
        This variable indicates if the system supports dynamic
@@ -3335,7 +3455,7 @@ useithreads (usethreads.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.
+       available.
 
 uselongdouble (uselongdbl.U):
        This variable conditionally defines the USE_LONG_DOUBLE symbol,
@@ -3434,6 +3554,19 @@ uvxformat (perlxvf.U):
        This variable contains the format string used for printing
        a Perl UV as an unsigned hexadecimal integer. 
 
+vendorarch (vendorarch.U):
+       This variable contains the value of the PERL_VENDORARCH symbol.
+       It may have a ~ on the front. 
+       The standard distribution will put nothing in this directory.
+       Vendors who distribute perl may wish to place their own
+       architecture-dependent modules and extensions in this directory with
+       MakeMaker Makefile.PL INSTALLDIRS=vendor 
+       or equivalent.  See INSTALL for details.
+
+vendorarchexp (vendorarch.U):
+       This variable is the ~name expanded version of vendorarch, so that you
+       may use it directly in Makefiles or shell scripts.
+
 vendorbin (vendorbin.U):
        This variable contains the eventual value of the VENDORBIN symbol.
        It may have a ~ on the front.
@@ -3456,6 +3589,11 @@ vendorlib (vendorlib.U):
        MakeMaker Makefile.PL INSTALLDIRS=vendor 
        or equivalent.  See INSTALL for details.
 
+vendorlib_stem (vendorlib.U):
+       This variable is $vendorlibexp with any trailing version-specific component
+       removed.  The elements in inc_version_list (inc_version_list.U) can
+       be tacked onto this variable to generate a list of directories to search.
+
 vendorlibexp (vendorlib.U):
        This variable is the ~name expanded version of vendorlib, so that you
        may use it directly in Makefiles or shell scripts.
@@ -3471,7 +3609,7 @@ vendorprefixexp (vendorprefix.U):
 
 version (patchlevel.U):
        The full version number of this package, such as 5.6.1 (or 5_6_1).
-       This combines baserev, patchlevel, and subversion to get the
+       This combines revision, patchlevel, and subversion to get the
        full version number, including any possible subversions.
        This is suitable for use as a directory name, and hence is
        filesystem dependent.