relax restrictions on constant names a bit (from M J T Guy)
[p5sagit/p5-mst-13.2.git] / Porting / Glossary
index bde26b7..71d97f8 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.  
@@ -193,8 +194,6 @@ 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):
@@ -268,9 +267,9 @@ cpp_stuff (cpp_stuff.U):
        used by the C preprocessor.
 
 cppccsymbols (Cppsym.U):
-       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 variable contains the symbols defined by both
+       the bare C compiler and during a compilation that
+       includes stdio.h.
        The list is a space-separated list of symbol=value tokens.
 
 cppflags (ccflags.U):
@@ -302,9 +301,8 @@ cppstdin (cppstdin.U):
        preprocessor symbols.
 
 cppsymbols (Cppsym.U):
-       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 variable contains the symbols during a compilation
+       that includes stdio.h.
        The list is a space-separated list of symbol=value tokens.
 
 crosscompile (crosscompile.U):
@@ -568,7 +566,7 @@ 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_fs_data_s (d_fs_data_s.U):
@@ -609,6 +607,15 @@ d_Gconvert (d_gconvert.U):
        d_Gconvert='gcvt((x),(n),(b))'
        d_Gconvert='sprintf((b),"%.*g",(n),(x))'
 
+d_getcwd (d_getcwd.U):
+       This variable conditionally defines the HAS_GETCWD symbol, which
+       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
@@ -780,6 +787,10 @@ d_htonl (d_htonl.U):
        This variable conditionally defines HAS_HTONL if htonl() and its
        friends are available to do network order byte swapping.
 
+d_iconv (d_iconv.U):
+       This variable conditionally defines the HAS_ICONV symbol, which
+       indicates to the C program that the iconv() routine is available.
+
 d_index (d_strchr.U):
        This variable conditionally defines HAS_INDEX if index() and
        rindex() are available for string searching.
@@ -789,7 +800,7 @@ 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):
@@ -831,6 +842,12 @@ 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.
@@ -880,14 +897,38 @@ d_mkdir (d_mkdir.U):
        indicates to the C program that the mkdir() routine is available
        to create directories..
 
+d_mkdtemp (d_mkdtemp.U):
+       This variable conditionally defines the HAS_MKDTEMP symbol, which
+       indicates to the C program that the mkdtemp() routine is available
+       to exclusively create a uniquely named temporary directory.
+
 d_mkfifo (d_mkfifo.U):
        This variable conditionally defines the HAS_MKFIFO symbol, which
        indicates to the C program that the mkfifo() routine is available.
 
+d_mkstemp (d_mkstemp.U):
+       This variable conditionally defines the HAS_MKSTEMP symbol, which
+       indicates to the C program that the mkstemp() routine is available
+       to exclusively create and open a uniquely named temporary file.
+
+d_mkstemps (d_mkstemps.U):
+       This variable conditionally defines the HAS_MKSTEMPS symbol, which
+       indicates to the C program that the mkstemps() routine is available
+       to exclusively create and open a uniquely named (with a suffix)
+       temporary file.
+
 d_mktime (d_mktime.U):
        This variable conditionally defines the HAS_MKTIME symbol, which
        indicates to the C program that the mktime() routine is available.
 
+d_mmap (d_mmap.U):
+       This variable conditionally defines HAS_MMAP if mmap() is
+       available to map a file into memory.
+
+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.
+
 d_msg (d_msg.U):
        This variable conditionally defines the HAS_MSG symbol, which
        indicates that the entire msg*(2) library is present.
@@ -933,6 +974,14 @@ d_msgsnd (d_msgsnd.U):
        This variable conditionally defines the HAS_MSGSND symbol, which
        indicates to the C program that the msgsnd() routine is available.
 
+d_msync (d_msync.U):
+       This variable conditionally defines HAS_MSYNC if msync() is
+       available to synchronize a mapped file.
+
+d_munmap (d_munmap.U):
+       This variable conditionally defines HAS_MUNMAP if munmap() is
+       available to unmap a region mapped by mmap().
+
 d_mymalloc (mallocsrc.U):
        This variable conditionally defines MYMALLOC in case other parts
        of the source want to take special action if MYMALLOC is used.
@@ -942,7 +991,11 @@ d_nice (d_nice.U):
        This variable conditionally defines the HAS_NICE symbol, which
        indicates to the C program that the nice() routine is available.
 
-d_off64_t (io64.U):
+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 (d_off64_t.U):
        This symbol will be defined if the C compiler supports off64_t.
 
 d_old_pthread_create_joinable (d_pthrattrj.U):
@@ -1316,6 +1369,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.
@@ -1858,6 +1914,10 @@ i_grp (i_grp.U):
        This variable conditionally defines the I_GRP symbol, and indicates
        whether a C program should include <grp.h>.
 
+i_iconv (i_iconv.U):
+       This variable conditionally defines the I_ICONV symbol, and indicates
+       whether a C program should include <iconv.h>.
+
 i_inttypes (i_inttypes.U):
        This variable conditionally defines the I_INTTYPES symbol,
        and indicates whether a C program should include <inttypes.h>.
@@ -1994,6 +2054,18 @@ i_sysioctl (i_sysioctl.U):
        indicates to the C program that <sys/ioctl.h> exists and should
        be included.
 
+i_syslog (i_syslog.U):
+       This variable conditionally defines the I_SYSLOG symbol,
+       and indicates whether a C program should include <syslog.h>.
+
+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>.
@@ -2062,6 +2134,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>.
@@ -2121,12 +2197,18 @@ ignore_versioned_solibs (libs.U):
 inc_version_list (inc_version_list.U):
        This variable specifies the list of subdirectories in over
        which perl.c:incpush() and lib/lib.pm will automatically
-       search when adding directories to @INC.  This is only useful
+       search when adding directories to @INC.  The elements in
+       the list are separated by spaces.  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.
 
+inc_version_list_init (inc_version_list.U):
+       This variable holds the same list as inc_version_list, but
+       each item is enclosed in double quotes and separated by commas, 
+       suitable for use in the PERL_INC_VERSION_LIST initialization.
+
 incpath (usrinc.U):
        This variable must preceed the normal include path to get hte
        right one, as in "$incpath/usr/include" or "$incpath/usr/lib".
@@ -2303,6 +2385,21 @@ libs (libs.U):
        This variable holds the additional libraries we want to use.
        It is up to the Makefile to deal with it.
 
+libsdirs (libs.U):
+       This variable holds the directory names aka dirnames of the libraries
+       we found and accepted, duplicates are removed.
+
+libsfiles (libs.U):
+       This variable holds the filenames aka basenames of the libraries
+       we found and accepted.
+
+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
@@ -2468,6 +2565,11 @@ mkdir (Loc.U):
        full pathname (if any) of the mkdir program.  After Configure runs,
        the value is reset to a plain "mkdir" and is not useful.
 
+mmaptype (d_mmap.U):
+       This symbol contains the type of pointer returned by mmap()
+       (and simultaneously the type of the first argument).
+       It can be 'void *' or 'caddr_t'.
+
 models (models.U):
        This variable contains the list of memory models supported by this
        system.  Possible component values are none, split, unsplit, small,
@@ -2630,16 +2732,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.
@@ -2683,6 +2789,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.
@@ -2752,6 +2873,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,
@@ -2967,6 +3093,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,
@@ -3111,6 +3242,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):
@@ -3226,10 +3358,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
@@ -3243,16 +3388,12 @@ 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,
        and indicates that long doubles should be used when available.
 
-uselonglong (uselonglong.U):
-       This variable conditionally defines the USE_LONG_LONG symbol,
-       and indicates that long longs should be used when available.
-
 usemorebits (usemorebits.U):
        This variable conditionally defines the USE_MORE_BITS symbol,
        and indicates that explicit 64-bit interfaces and long doubles
@@ -3383,7 +3524,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.
@@ -3402,6 +3543,23 @@ 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.