Mention perlebcdic and perlposix-bc.
[p5sagit/p5-mst-13.2.git] / Porting / Glossary
index 71d97f8..c148f11 100644 (file)
@@ -131,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
@@ -175,6 +175,7 @@ cc (cc.U):
        This variable holds the name of a command to execute a C compiler which
        can resolve multiple global references that happen to have the same
        name.  Usual values are 'cc', 'Mcc', 'cc -M', and 'gcc'.
+       Fervent ANSI compilers may be called 'c89'. AIX has xlc.
 
 cccdlflags (dlsrc.U):
        This variable contains any special flags that might need to be
@@ -192,8 +193,14 @@ ccflags (ccflags.U):
        This variable contains any additional C compiler flags desired by
        the user.  It is up to the Makefile to use this.
 
+ccflags_uselargefiles (uselfs.U):
+       This variable contains the compiler flags needed by large file builds
+       and added to ccflags by hints files.
+
 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):
@@ -267,9 +274,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):
@@ -301,8 +308,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):
@@ -360,9 +368,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
@@ -502,10 +511,6 @@ d_endsent (d_endsent.U):
        This variable conditionally defines HAS_ENDSERVENT if endservent() is
        available to close whatever was being used for service queries.
 
-d_endspent (d_endspent.U):
-       This variable conditionally defines HAS_ENDSPENT if endspent() is
-       available to finalize the scan of SysV shadow password entries.
-
 d_eofnblk (nblock_io.U):
        This variable conditionally defines EOF_NONBLOCK if EOF can be seen
        when reading from a non-blocking I/O source.
@@ -569,6 +574,10 @@ d_fpathconf (d_pathconf.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.
@@ -612,6 +621,10 @@ d_getcwd (d_getcwd.U):
        indicates to the C program that the getcwd() routine is available
        to get the current working directory.
 
+d_getespwnam (d_getespwnam.U):
+       This variable conditionally defines HAS_GETESPWNAM if getespwnam() is
+       available to retrieve enchanced (shadow) password entries by name.
+
 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.
@@ -731,6 +744,10 @@ d_getprotoprotos (d_getprotoprotos.U):
        prototypes for the various getproto*() functions.  
        See also netdbtype.U for probing for various netdb types.
 
+d_getprpwnam (d_getprpwnam.U):
+       This variable conditionally defines HAS_GETPRPWNAM if getprpwnam() is
+       available to retrieve protected (shadow) password entries by name.
+
 d_getpwent (d_getpwent.U):
        This variable conditionally defines the HAS_GETPWENT symbol, which
        indicates to the C program that the getpwent() routine is available
@@ -758,10 +775,6 @@ d_getservprotos (d_getservprotos.U):
        prototypes for the various getserv*() functions.  
        See also netdbtype.U for probing for various netdb types.
 
-d_getspent (d_getspent.U):
-       This variable conditionally defines HAS_GETSPENT if getspent() is
-       available to retrieve SysV shadow password entries sequentially.
-
 d_getspnam (d_getspnam.U):
        This variable conditionally defines HAS_GETSPNAM if getspnam() is
        available to retrieve SysV shadow password entries by name.
@@ -807,6 +820,14 @@ 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
@@ -852,6 +873,10 @@ 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
@@ -925,6 +950,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.
@@ -995,6 +1024,10 @@ 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_nv_preserves_uv_bits (perlxv.U):
+       This variable indicates how many of bits type uvtype
+       a variable nvtype can preserve.
+
 d_off64_t (d_off64_t.U):
        This symbol will be defined if the C compiler supports off64_t.
 
@@ -1028,6 +1061,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
@@ -1134,6 +1172,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.
@@ -1275,6 +1317,11 @@ d_setprior (d_setprior.U):
        This variable conditionally defines HAS_SETPRIORITY if setpriority()
        is available to set a process's priority.
 
+d_setproctitle (d_setproctitle.U):
+       This variable conditionally defines the HAS_SETPROCTITLE symbol,
+       which indicates to the C program that the setproctitle() routine
+       is available.
+
 d_setpwent (d_setpwent.U):
        This variable conditionally defines the HAS_SETPWENT symbol, which
        indicates to the C program that the setpwent() routine is available
@@ -1318,10 +1365,6 @@ d_setsid (d_setsid.U):
        This variable conditionally defines HAS_SETSID if setsid() is
        available to set the process group ID.
 
-d_setspent (d_setspent.U):
-       This variable conditionally defines HAS_SETSPENT if setspent() is
-       available to initialize the scan of SysV shadow password entries.
-
 d_setvbuf (d_setvbuf.U):
        This variable conditionally defines the HAS_SETVBUF symbol, which
        indicates to the C program that the setvbuf() routine is available
@@ -1565,6 +1608,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.
 
@@ -1767,7 +1813,12 @@ full_sed (Loc_sed.U):
        can share this executable will have the same full pathname to
        'sed.'
 
-gccversion (cc.U):
+gccosandvers (gccvers.U):
+       If GNU cc (gcc) is used, this variable the operating system and
+       version used to compile the gcc.  It is set to '' if not gcc,
+       or if nothing useful can be parsed as the os version.
+
+gccversion (gccvers.U):
        If GNU cc (gcc) is used, this variable holds '1' or '2' to 
        indicate whether the compiler is version 1 or 2.  This is used in
        setting some of the default cflags.  It is set to '' if not gcc.
@@ -1918,10 +1969,18 @@ 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>.
 
+i_libutil (i_libutil.U):
+       This variable conditionally defines the I_LIBUTIL symbol, and indicates
+       whether a C program should include <libutil.h>.
+
 i_limits (i_limits.U):
        This variable conditionally defines the I_LIMITS symbol, and indicates
        whether a C program may include <limits.h> to get symbols like WORD_BIT
@@ -1978,6 +2037,10 @@ i_poll (i_poll.U):
        This variable conditionally defines the I_POLL symbol, and indicates
        whether a C program should include <poll.h>.
 
+i_prot (i_prot.U):
+       This variable conditionally defines the I_PROT symbol, and indicates
+       whether a C program should include <prot.h>.
+
 i_pthread (i_pthread.U):
        This variable conditionally defines the I_PTHREAD symbol,
        and indicates whether a C program should include <pthread.h>.
@@ -2027,6 +2090,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>.
@@ -2300,6 +2367,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
@@ -2353,6 +2425,10 @@ ldflags (ccflags.U):
        This variable contains any additional C loader flags desired by
        the user.  It is up to the Makefile to use this.
 
+ldflags_uselargefiles (uselfs.U):
+       This variable contains the loader flags needed by large file builds
+       and added to ldflags by hints files.
+
 ldlibpthname (libperl.U):
        This variable holds the name of the shared library
        search path, often LD_LIBRARY_PATH.  To get an empty
@@ -2405,6 +2481,12 @@ libswanted (Myinit.U):
        search.  The order is chosen to pick up the c library
        ahead of ucb or bsd libraries for SVR4.
 
+libswanted_uselargefiles (uselfs.U):
+       This variable contains the libraries needed by large file builds
+       and added to ldflags by hints files.  It is a space separated list
+       of the library names without the "lib" prefix or any suffix, just
+       like libswanted..
+
 line (Loc.U):
        This variable is defined but not used by Configure.
        The value is a plain '' and is not useful.
@@ -2667,6 +2749,30 @@ nroff (Loc.U):
        full pathname (if any) of the nroff program.  After Configure runs,
        the value is reset to a plain "nroff" and is not useful.
 
+nveformat (perlxvf.U):
+       This variable contains the format string used for printing
+       a Perl NV using %e-ish floating point format.
+
+nvEformat (perlxvf.U):
+       This variable contains the format string used for printing
+       a Perl NV using %E-ish floating point format.
+
+nvfformat (perlxvf.U):
+       This variable confains the format string used for printing
+       a Perl NV using %f-ish floating point format.
+
+nvFformat (perlxvf.U):
+       This variable confains the format string used for printing
+       a Perl NV using %F-ish floating point format.
+
+nvgformat (perlxvf.U):
+       This variable contains the format string used for printing
+       a Perl NV using %g-ish floating point format.
+
+nvGformat (perlxvf.U):
+       This variable contains the format string used for printing
+       a Perl NV using %G-ish floating point format.
+
 nvsize (perlxv.U):
        This variable is the size of an NV in bytes.
 
@@ -2713,6 +2819,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.
@@ -3052,6 +3168,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.
@@ -3065,6 +3186,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 
@@ -3485,7 +3609,24 @@ uvuformat (perlxvf.U):
 
 uvxformat (perlxvf.U):
        This variable contains the format string used for printing
-       a Perl UV as an unsigned hexadecimal integer. 
+       a Perl UV as an unsigned hexadecimal integer in lowercase abcdef.
+
+uvXformat (perlxvf.U):
+       This variable contains the format string used for printing
+       a Perl UV as an unsigned hexadecimal integer in uppercase ABCDEF.
+
+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.
@@ -3509,6 +3650,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.