This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update epigraphs with the one for v5.17.9
[perl5.git] / Porting / Glossary
index e43fa89..4b5ded2 100644 (file)
@@ -289,10 +289,10 @@ config_arg0 (Options.U):
        command, as reported by the shell in the $0 variable.
 
 config_argc (Options.U):
-       This variable countains the number of command-line arguments
+       This variable contains the number of command-line arguments
        passed to Configure, as reported by the shell in the $# variable.
-       The individual arguments are stored as variables config_argc1,
-       config_argc2, etc.
+       The individual arguments are stored as variables config_arg1,
+       config_arg2, etc.
 
 config_args (Options.U):
        This variable contains a single string giving the command-line
@@ -528,7 +528,7 @@ d_casti32 (d_casti32.U):
 
 d_castneg (d_castneg.U):
        This variable conditionally defines CASTNEG, which indicates
-       wether the C compiler can cast negative float to unsigned.
+       whether the C compiler can cast negative float to unsigned.
 
 d_charvspr (d_vprintf.U):
        This variable conditionally defines CHARVSPRINTF if this system
@@ -749,7 +749,7 @@ d_eofnblk (nblock_io.U):
 
 d_eunice (Guess.U):
        This variable conditionally defines the symbols EUNICE and VAX, which
-       alerts the C program that it must deal with ideosyncracies of VMS.
+       alerts the C program that it must deal with idiosyncrasies of VMS.
 
 d_faststdio (d_faststdio.U):
        This variable conditionally defines the HAS_FAST_STDIO symbol,
@@ -941,7 +941,7 @@ d_getcwd (d_getcwd.U):
 
 d_getespwnam (d_getespwnam.U):
        This variable conditionally defines HAS_GETESPWNAM if getespwnam() is
-       available to retrieve enchanced (shadow) password entries by name.
+       available to retrieve enhanced (shadow) password entries by name.
 
 d_getfsstat (d_getfsstat.U):
        This variable conditionally defines the HAS_GETFSSTAT symbol, which
@@ -1271,10 +1271,30 @@ d_inetpton (d_inetpton.U):
 d_int64_t (d_int64_t.U):
        This symbol will be defined if the C compiler supports int64_t.
 
+d_ip_mreq (d_socket.U):
+       This variable conditionally defines the HAS_IP_MREQ symbol, which
+       indicates the availability of a struct ip_mreq.
+
+d_ip_mreq_source (d_socket.U):
+       This variable conditionally defines the HAS_IP_MREQ_SOURCE symbol,
+       which indicates the availability of a struct ip_mreq_source.
+
+d_ipv6_mreq (d_socket.U):
+       This variable conditionally defines the HAS_IPV6_MREQ symbol, which
+       indicates the availability of a struct ipv6_mreq.
+
+d_ipv6_mreq_source (d_socket.U):
+       This variable conditionally defines the HAS_IPV6_MREQ_SOURCE symbol,
+       which indicates the availability of a struct ipv6_mreq_source.
+
 d_isascii (d_isascii.U):
        This variable conditionally defines the HAS_ISASCII constant,
        which indicates to the C program that isascii() is available.
 
+d_isblank (d_isblank.U):
+       This variable conditionally defines the HAS_ISBLANK constant,
+       which indicates to the C program that isblank() is available.
+
 d_isfinite (d_isfinite.U):
        This variable conditionally defines the HAS_ISFINITE symbol, which
        indicates to the C program that the isfinite() routine is available.
@@ -1399,7 +1419,7 @@ d_memcpy (d_memcpy.U):
 d_memmove (d_memmove.U):
        This variable conditionally defines the HAS_MEMMOVE symbol, which
        indicates to the C program that the memmove() routine is available
-       to copy potentatially overlapping blocks of memory.
+       to copy potentially overlapping blocks of memory.
 
 d_memset (d_memset.U):
        This variable conditionally defines the HAS_MEMSET symbol, which
@@ -1617,43 +1637,52 @@ d_portable (d_portable.U):
        indicates to the C program that it should not assume that it is
        running on the machine it was compiled on.
 
+d_prctl (d_prctl.U):
+       This variable conditionally defines the HAS_PRCTL symbol, which
+       indicates to the C program that the prctl() routine is available.
+
+d_prctl_set_name (d_prctl.U):
+       This variable conditionally defines the HAS_PRCTL_SET_NAME symbol,
+       which indicates to the C program that the prctl() routine supports
+       the PR_SET_NAME option.
+
 d_PRId64 (quadfio.U):
        This variable conditionally defines the PERL_PRId64 symbol, which
-       indiciates that stdio has a symbol to print 64-bit decimal numbers.
+       indicates that stdio has a symbol to print 64-bit decimal numbers.
 
 d_PRIeldbl (longdblfio.U):
        This variable conditionally defines the PERL_PRIfldbl symbol, which
-       indiciates that stdio has a symbol to print long doubles.
+       indicates that stdio has a symbol to print long doubles.
 
 d_PRIEUldbl (longdblfio.U):
        This variable conditionally defines the PERL_PRIfldbl symbol, which
-       indiciates that stdio has a symbol to print long doubles.
+       indicates that stdio has a symbol to print long doubles.
        The 'U' in the name is to separate this from d_PRIeldbl so that even
        case-blind systems can see the difference.
 
 d_PRIfldbl (longdblfio.U):
        This variable conditionally defines the PERL_PRIfldbl symbol, which
-       indiciates that stdio has a symbol to print long doubles.
+       indicates that stdio has a symbol to print long doubles.
 
 d_PRIFUldbl (longdblfio.U):
        This variable conditionally defines the PERL_PRIfldbl symbol, which
-       indiciates that stdio has a symbol to print long doubles.
+       indicates that stdio has a symbol to print long doubles.
        The 'U' in the name is to separate this from d_PRIfldbl so that even
        case-blind systems can see the difference.
 
 d_PRIgldbl (longdblfio.U):
        This variable conditionally defines the PERL_PRIfldbl symbol, which
-       indiciates that stdio has a symbol to print long doubles.
+       indicates that stdio has a symbol to print long doubles.
 
 d_PRIGUldbl (longdblfio.U):
        This variable conditionally defines the PERL_PRIfldbl symbol, which
-       indiciates that stdio has a symbol to print long doubles.
+       indicates that stdio has a symbol to print long doubles.
        The 'U' in the name is to separate this from d_PRIgldbl so that even
        case-blind systems can see the difference.
 
 d_PRIi64 (quadfio.U):
        This variable conditionally defines the PERL_PRIi64 symbol, which
-       indiciates that stdio has a symbol to print 64-bit decimal numbers.
+       indicates that stdio has a symbol to print 64-bit decimal numbers.
 
 d_printf_format_null (d_attribut.U):
        This variable conditionally defines PRINTF_FORMAT_NULL_OK, which
@@ -1661,20 +1690,20 @@ d_printf_format_null (d_attribut.U):
 
 d_PRIo64 (quadfio.U):
        This variable conditionally defines the PERL_PRIo64 symbol, which
-       indiciates that stdio has a symbol to print 64-bit octal numbers.
+       indicates that stdio has a symbol to print 64-bit octal numbers.
 
 d_PRIu64 (quadfio.U):
        This variable conditionally defines the PERL_PRIu64 symbol, which
-       indiciates that stdio has a symbol to print 64-bit unsigned decimal
+       indicates that stdio has a symbol to print 64-bit unsigned decimal
        numbers.
 
 d_PRIx64 (quadfio.U):
        This variable conditionally defines the PERL_PRIx64 symbol, which
-       indiciates that stdio has a symbol to print 64-bit hexadecimal numbers.
+       indicates that stdio has a symbol to print 64-bit hexadecimal numbers.
 
 d_PRIXU64 (quadfio.U):
        This variable conditionally defines the PERL_PRIXU64 symbol, which
-       indiciates that stdio has a symbol to print 64-bit hExADECimAl numbers.
+       indicates that stdio has a symbol to print 64-bit hExADECimAl numbers.
        The 'U' in the name is to separate this from d_PRIx64 so that even
        case-blind systems can see the difference.
 
@@ -1824,7 +1853,7 @@ d_scm_rights (d_socket.U):
 
 d_SCNfldbl (longdblfio.U):
        This variable conditionally defines the PERL_PRIfldbl symbol, which
-       indiciates that stdio has a symbol to scan long doubles.
+       indicates that stdio has a symbol to scan long doubles.
 
 d_seekdir (d_readdir.U):
        This variable conditionally defines HAS_SEEKDIR if seekdir() is
@@ -2062,6 +2091,11 @@ d_sigsetjmp (d_sigsetjmp.U):
        which indicates that the sigsetjmp() routine is available to
        call setjmp() and optionally save the process's signal mask.
 
+d_sin6_scope_id (d_socket.U):
+       This variable conditionally defines the HAS_SIN6_SCOPE_ID symbol, which
+       indicates that a struct sockaddr_in6 structure has the sin6_scope_id
+       member.
+
 d_sitearch (sitearch.U):
        This variable conditionally defines SITEARCH to hold the pathname
        of architecture-dependent library files for $package.  If
@@ -2072,6 +2106,15 @@ d_snprintf (d_snprintf.U):
        indicates to the C program that the snprintf () library function
        is available.
 
+d_sockaddr_in6 (d_socket.U):
+       This variable conditionally defines the HAS_SOCKADDR_IN6 symbol, which
+       indicates the availability of a struct sockaddr_in6.
+
+d_sockaddr_sa_len (d_socket.U):
+       This variable conditionally defines the HAS_SOCKADDR_SA_LEN symbol,
+       which indicates that a struct sockaddr structure has the sa_len
+       member.
+
 d_sockatmark (d_sockatmark.U):
        This variable conditionally defines the HAS_SOCKATMARK symbol, which
        indicates to the C program that the sockatmark() routine is available.
@@ -2144,6 +2187,12 @@ d_statfs_s (d_statfs_s.U):
        This variable conditionally defines the HAS_STRUCT_STATFS symbol,
        which indicates that the struct statfs is supported.
 
+d_static_inline (d_static_inline.U):
+       This variable conditionally defines the HAS_STATIC_INLINE symbol,
+       which indicates that the C compiler supports C99-style static
+       inline.  That is, the function can't be called from another
+       translation unit.
+
 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.
@@ -2316,7 +2365,7 @@ d_telldirproto (d_telldirproto.U):
 
 d_time (d_time.U):
        This variable conditionally defines the HAS_TIME symbol, which indicates
-       that the time() routine exists.  The time() routine is normaly
+       that the time() routine exists.  The time() routine is normally
        provided on UNIX systems.
 
 d_timegm (d_timegm.U):
@@ -2325,7 +2374,7 @@ d_timegm (d_timegm.U):
 
 d_times (d_times.U):
        This variable conditionally defines the HAS_TIMES symbol, which indicates
-       that the times() routine exists.  The times() routine is normaly
+       that the times() routine exists.  The times() routine is normally
        provided on UNIX systems. You may have to include <sys/times.h>.
 
 d_tm_tm_gmtoff (i_time.U):
@@ -2427,7 +2476,7 @@ d_voidtty (i_sysioctl.U):
        This variable conditionally defines USE_IOCNOTTY to indicate that the
        ioctl() call with TIOCNOTTY should be used to void tty association.
        Otherwise (on USG probably), it is enough to close the standard file
-       decriptors and do a setpgrp().
+       descriptors and do a setpgrp().
 
 d_volatile (d_volatile.U):
        This variable conditionally defines the HASVOLATILE symbol, which
@@ -2616,7 +2665,7 @@ expr (Loc.U):
 extensions (Extensions.U):
        This variable holds a list of all extension files (both XS and
        non-xs linked into the package.  It is propagated to Config.pm
-       and is typically used to test whether a particular extesion
+       and is typically used to test whether a particular extension
        is available.
 
 extern_C (Csym.U):
@@ -3139,6 +3188,11 @@ i_stdarg (i_varhdr.U):
        indicates to the C program that <stdarg.h> exists and should
        be included.
 
+i_stdbool (i_stdbool.U):
+       This variable conditionally defines the I_STDBOOL symbol, which
+       indicates to the C program that <stdbool.h> exists and should
+       be included.
+
 i_stddef (i_stddef.U):
        This variable conditionally defines the I_STDDEF symbol, which
        indicates to the C program that <stddef.h> exists and should
@@ -3349,7 +3403,7 @@ inc_version_list_init (inc_version_list.U):
        suitable for use in the PERL_INC_VERSION_LIST initialization.
 
 incpath (usrinc.U):
-       This variable must preceed the normal include path to get hte
+       This variable must precede the normal include path to get the
        right one, as in "$incpath/usr/include" or "$incpath/usr/lib".
        Value can be "" or "/bsd43" on mips.
 
@@ -3372,7 +3426,7 @@ installarchlib (archlib.U):
 
 installbin (bin.U):
        This variable is the same as binexp unless AFS is running in which case
-       the user is explicitely prompted for it. This variable should always
+       the user is explicitly prompted for it. This variable should always
        be used in your makefiles for maximum portability.
 
 installhtml1dir (html1dir.U):
@@ -3577,6 +3631,11 @@ ld (dlsrc.U):
        On ELF systems, it should be $cc.  Mostly, we'll try to respect
        the hint file setting.
 
+ld_can_script (dlsrc.U):
+       This variable shows if the loader accepts scripts in the form of
+       -Wl,--version-script=ld.script. This is currently only supported
+       for GNU ld on ELF in dynamic loading builds.
+
 lddlflags (dlsrc.U):
        This variable contains any special flags that might need to be
        passed to $ld to create a shared library suitable for dynamic
@@ -4052,8 +4111,9 @@ path_sep (Unix.U):
        used to separate elements in the command shell search PATH.
 
 perl (Loc.U):
-       This variable is defined but not used by Configure.
-       The value is the empty string and is not useful.
+       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.
 
 perl5 (perl5.U):
        This variable contains the full path (if any) to a previously
@@ -4102,6 +4162,16 @@ 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_static_inline (d_static_inline.U):
+       This variable defines the PERL_STATIC_INLINE symbol to
+       the best-guess incantation to use for static inline functions.
+       Possibilities include
+       static inline       (c99)
+       static __inline__   (gcc -ansi)
+       static __inline     (MSVC)
+       static _inline      (older MSVC)
+       static              (c89 compilers)
+
 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
@@ -4714,6 +4784,13 @@ ssizetype (ssizetype.U):
        of bytes or an error condition.  It must be a signed type.
        We will pick a type such that sizeof(SSize_t) == sizeof(Size_t).
 
+st_ino_sign (st_ino_def.U):
+       This variable contains the signedness of struct stat's st_ino.
+       1 for unsigned, -1 for signed.
+
+st_ino_size (st_ino_def.U):
+       This variable contains the size of struct stat's st_ino in bytes.
+
 startperl (startperl.U):
        This variable contains the string to put on the front of a perl
        script to make sure (hopefully) that it runs with perl and not some
@@ -4722,7 +4799,7 @@ startperl (startperl.U):
        eval 'exec perl -S $0 ${1+"$@"}'
        if $running_under_some_shell;
        to guarantee perl startup should the shell execute the script. Note
-       that this magic incatation is not understood by csh.
+       that this magic incantation is not understood by csh.
 
 startsh (startsh.U):
        This variable contains the string to put on the front of a shell
@@ -4967,6 +5044,11 @@ useithreads (usethreads.U):
        and indicates that Perl should be built to use the interpreter-based
        threading implementation.
 
+usekernprocpathname (usekernprocpathname.U):
+       This variable, indicates that we can use sysctl with
+       KERN_PROC_PATHNAME to get a full path for the executable, and hence
+       convert $^X to an absolute path.
+
 uselargefiles (uselfs.U):
        This variable conditionally defines the USE_LARGE_FILES symbol,
        and indicates that large file interfaces should be used when
@@ -4992,7 +5074,7 @@ usemultiplicity (usemultiplicity.U):
 usemymalloc (mallocsrc.U):
        This variable contains y if the malloc that comes with this package
        is desired over the system's version of malloc.  People often include
-       special versions of malloc for effiency, but such versions are often
+       special versions of malloc for efficiency, but such versions are often
        less portable.  See also mallocsrc and mallocobj.
        If this is 'y', then -lmalloc is removed from $libs.
 
@@ -5000,6 +5082,11 @@ usenm (usenm.U):
        This variable contains 'true' or 'false' depending whether the
        nm extraction is wanted or not.
 
+usensgetexecutablepath (usensgetexecutablepath.U):
+       This symbol, if defined, indicates that we can use _NSGetExecutablePath
+       and realpath to get a full path for the executable, and hence convert
+       $^X to an absolute path.
+
 useopcode (Extensions.U):
        This variable holds either 'true' or 'false' to indicate
        whether the Opcode extension should be used.  The sole
@@ -5036,7 +5123,7 @@ userelocatableinc (bin.U):
 usesfio (d_sfio.U):
        This variable is set to true when the user agrees to use sfio.
        It is set to false when sfio is not available or when the user
-       explicitely requests not to use sfio.  It is here primarily so
+       explicitly requests not to use sfio.  It is here primarily so
        that command-line settings can override the auto-detection of
        d_sfio without running into a "WHOA THERE".
 
@@ -5061,10 +5148,14 @@ usevendorprefix (vendorprefix.U):
        This variable tells whether the vendorprefix
        and consequently other vendor* paths are in use.
 
+useversionedarchname (archname.U):
+       This variable indicates whether to include the $api_versionstring
+       as a component of the $archname.
+
 usevfork (d_vfork.U):
        This variable is set to true when the user accepts to use vfork.
        It is set to false when no vfork is available or when the user
-       explicitely requests not to use vfork.
+       explicitly requests not to use vfork.
 
 usrinc (usrinc.U):
        This variable holds the path of the include files, which is