Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages

RedHat 9 (Linux i386) - man page for extutils::mm_unix (redhat section 3pm)

ExtUtils::MM_Unix(3pm)		 Perl Programmers Reference Guide	   ExtUtils::MM_Unix(3pm)

NAME
       ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker

SYNOPSIS
       "require ExtUtils::MM_Unix;"

DESCRIPTION
       The methods provided by this package are designed to be used in conjunction with ExtU-
       tils::MakeMaker. When MakeMaker writes a Makefile, it creates one or more objects that
       inherit their methods from a package "MM". MM itself doesn't provide any methods, but it
       ISA ExtUtils::MM_Unix class. The inheritance tree of MM lets operating specific packages
       take the responsibility for all the methods provided by MM_Unix. We are trying to reduce
       the number of the necessary overrides by defining rather primitive operations within ExtU-
       tils::MM_Unix.

       If you are going to write a platform specific MM package, please try to limit the neces-
       sary overrides to primitive methods, and if it is not possible to do so, let's work out
       how to achieve that gain.

       If you are overriding any of these methods in your Makefile.PL (in the MY class), please
       report that to the makemaker mailing list. We are trying to minimize the necessary method
       overrides and switch to data driven Makefile.PLs wherever possible. In the long run less
       methods will be overridable via the MY class.

METHODS
       The following description of methods is still under development. Please refer to the code
       for not suitably documented sections and complain loudly to the makemaker mailing list.

       Not all of the methods below are overridable in a Makefile.PL. Overridable methods are
       marked as (o). All methods are overridable by a platform specific MM_*.pm file (See ExtU-
       tils::MM_VMS) and ExtUtils::MM_OS2).

       SelfLoaded methods

       c_o (o)
	 Defines the suffix rules to compile different flavors of C files to object files.

       cflags (o)
	 Does very much the same as the cflags script in the perl distribution. It doesn't return
	 the whole compiler command line, but initializes all of its parts. The const_cccmd
	 method then actually returns the definition of the CCCMD macro which uses these parts.

       clean (o)
	 Defines the clean target.

       const_cccmd (o)
	 Returns the full compiler call for C programs and stores the definition in CONST_CCCMD.

       const_config (o)
	 Defines a couple of constants in the Makefile that are imported from %Config.

       const_loadlibs (o)
	 Defines EXTRALIBS, LDLOADLIBS, BSLOADLIBS, LD_RUN_PATH. See ExtUtils::Liblist for
	 details.

       constants (o)
	 Initializes lots of constants and .SUFFIXES and .PHONY

       depend (o)
	 Same as macro for the depend attribute.

       dir_target (o)
	 Takes an array of directories that need to exist and returns a Makefile entry for a
	 .exists file in these directories. Returns nothing, if the entry has already been pro-
	 cessed. We're helpless though, if the same directory comes as $(FOO) _and_ as "bar".
	 Both of them get an entry, that's why we use "::".

       dist (o)
	 Defines a lot of macros for distribution support.

       dist_basics (o)
	 Defines the targets distclean, distcheck, skipcheck, manifest, veryclean.

       dist_ci (o)
	 Defines a check in target for RCS.

       dist_core (o)
	 Defines the targets dist, tardist, zipdist, uutardist, shdist

       dist_dir
	 Defines the scratch directory target that will hold the distribution before tar-ing (or
	 shar-ing).

       dist_test
	 Defines a target that produces the distribution in the scratchdirectory, and runs 'perl
	 Makefile.PL; make ;make test' in that subdirectory.

       dlsyms (o)
	 Used by AIX and VMS to define DL_FUNCS and DL_VARS and write the *.exp files.

       dynamic (o)
	 Defines the dynamic target.

       dynamic_bs (o)
	 Defines targets for bootstrap files.

       dynamic_lib (o)
	 Defines how to produce the *.so (or equivalent) files.

       exescan
	 Deprecated method. Use libscan instead.

       extliblist
	 Called by init_others, and calls ext ExtUtils::Liblist. See ExtUtils::Liblist for
	 details.

       find_perl
	 Finds the executables PERL and FULLPERL

       find_tests
	   my $test = $mm->find_tests;

	 Returns a string suitable for feeding to the shell to return all tests in t/*.t.

       Methods to actually produce chunks of text for the Makefile

       The methods here are called for each MakeMaker object in the order specified by @ExtU-
       tils::MakeMaker::MM_Sections.

       fixin
	   $mm->fixin(@files);

	 Inserts the sharpbang or equivalent magic number to a set of @files.

       force (o)
	 Just writes FORCE:

       guess_name
	 Guess the name of this package by examining the working directory's name. MakeMaker
	 calls this only if the developer has not supplied a NAME attribute.

       has_link_code
	 Returns true if C, XS, MYEXTLIB or similar objects exist within this object that need a
	 compiler. Does not descend into subdirectories as needs_linking() does.

       init_dirscan
	 Initializes DIR, XS, PM, C, O_FILES, H, PL_FILES, MAN*PODS, EXE_FILES.

       init_main
	 Initializes AR, AR_STATIC_ARGS, BASEEXT, CONFIG, DISTNAME, DLBASE, EXE_EXT, FULLEXT,
	 FULLPERL, FULLPERLRUN, FULLPERLRUNINST, INST_*, INSTALL*, INSTALLDIRS, LD, LIB_EXT,
	 LIBPERL_A, MAP_TARGET, NAME, OBJ_EXT, PARENT_NAME, PERL, PERL_ARCHLIB, PERL_INC,
	 PERL_LIB, PERL_SRC, PERLRUN, PERLRUNINST, PREFIX, VERSION, VERSION_FROM, VERSION_SYM,
	 XS_VERSION.

       init_others
	 Initializes EXTRALIBS, BSLOADLIBS, LDLOADLIBS, LIBS, LD_RUN_PATH, OBJECT, BOOTDEP, PERL-
	 MAINCC, LDFROM, LINKTYPE, NOOP, FIRST_MAKEFILE, MAKEFILE, NOECHO, RM_F, RM_RF, TEST_F,
	 TOUCH, CP, MV, CHMOD, UMASK_NULL

       init_INST
	     $mm->init_INST;

	 Called by init_main.  Sets up all INST_* variables.

       init_INSTALL
	     $mm->init_INSTALL;

	 Called by init_main.  Sets up all INSTALL_* variables (except INSTALLDIRS) and PREFIX.

       init_PERL
	     $mm->init_PERL;

	 Called by init_main.  Sets up ABSPERL, PERL, FULLPERL and all the *PERLRUN* permuta-
	 tions.

	     PERL is allowed to be miniperl
	     FULLPERL must be a complete perl
	     ABSPERL is PERL converted to an absolute path

	     *PERLRUN contains everything necessary to run perl, find it's
		  libraries, etc...

	     *PERLRUNINST is *PERLRUN + everything necessary to find the
		  modules being built.

       init_PERM
	   $mm->init_PERM

	 Called by init_main.  Initializes PERL_*

       install (o)
	 Defines the install target.

       installbin (o)
	 Defines targets to make and to install EXE_FILES.

       libscan (o)
	 Takes a path to a file that is found by init_dirscan and returns false if we don't want
	 to include this file in the library. Mainly used to exclude RCS, CVS, and SCCS directo-
	 ries from installation.

       linkext (o)
	 Defines the linkext target which in turn defines the LINKTYPE.

       lsdir
	 Takes as arguments a directory name and a regular expression. Returns all entries in the
	 directory that match the regular expression.

       macro (o)
	 Simple subroutine to insert the macros defined by the macro attribute into the Makefile.

       makeaperl (o)
	 Called by staticmake. Defines how to write the Makefile to produce a static new perl.

	 By default the Makefile produced includes all the static extensions in the perl library.
	 (Purified versions of library files, e.g., DynaLoader_pure_p1_c0_032.a are automatically
	 ignored to avoid link errors.)

       makefile (o)
	 Defines how to rewrite the Makefile.

       manifypods (o)
	 Defines targets and routines to translate the pods into manpages and put them into the
	 INST_* directories.

       maybe_command
	 Returns true, if the argument is likely to be a command.

       maybe_command_in_dirs
	 method under development. Not yet used. Ask Ilya :-)

       needs_linking (o)
	 Does this module need linking? Looks into subdirectory objects (see also
	 has_link_code())

       nicetext
	 misnamed method (will have to be changed). The MM_Unix method just returns the argument
	 without further processing.

	 On VMS used to insure that colons marking targets are preceded by space - most Unix
	 Makes don't need this, but it's necessary under VMS to distinguish the target delimiter
	 from a colon appearing as part of a filespec.

       parse_abstract
	 parse a file and return what you think is the ABSTRACT

       parse_version
	 parse a file and return what you think is $VERSION in this file set to.  It will return
	 the string "undef" if it can't figure out what $VERSION is. $VERSION should be for all
	 to see, so our $VERSION or plain $VERSION are okay, but my $VERSION is not.

       pasthru (o)
	 Defines the string that is passed to recursive make calls in subdirectories.

       perl_script
	 Takes one argument, a file name, and returns the file name, if the argument is likely to
	 be a perl script. On MM_Unix this is true for any ordinary, readable file.

       perldepend (o)
	 Defines the dependency from all *.h files that come with the perl distribution.

       perm_rw (o)
	 Returns the attribute "PERM_RW" or the string 644.  Used as the string that is passed to
	 the "chmod" command to set the permissions for read/writeable files.  MakeMaker chooses
	 644 because it has turned out in the past that relying on the umask provokes hard-to-
	 track bug reports.  When the return value is used by the perl function "chmod", it is
	 interpreted as an octal value.

       perm_rwx (o)
	 Returns the attribute "PERM_RWX" or the string 755, i.e. the string that is passed to
	 the "chmod" command to set the permissions for executable files.  See also perl_rw.

       pm_to_blib
	 Defines target that copies all files in the hash PM to their destination and autosplits
	 them. See "DESCRIPTION" in ExtUtils::Install

       post_constants (o)
	 Returns an empty string per default. Dedicated to overrides from within Makefile.PL
	 after all constants have been defined.

       post_initialize (o)
	 Returns an empty string per default. Used in Makefile.PLs to add some chunk of text to
	 the Makefile after the object is initialized.

       postamble (o)
	 Returns an empty string. Can be used in Makefile.PLs to write some text to the Makefile
	 at the end.

       ppd
	 Defines target that creates a PPD (Perl Package Description) file for a binary distribu-
	 tion.

       prefixify
	   $MM->prefixify($var, $prefix, $new_prefix, $default);

	 Using either $MM->{uc $var} || $Config{lc $var}, it will attempt to replace it's $prefix
	 with a $new_prefix.  Should the $prefix fail to match it sill simply set it to the
	 $new_prefix + $default.

	 This is for heuristics which attempt to create directory structures that mirror those of
	 the installed perl.

	 For example:

	     $MM->prefixify('installman1dir', '/usr', '/home/foo', 'man/man1');

	 this will attempt to remove '/usr' from the front of the $MM->{INSTALLMAN1DIR} path
	 (initializing it to $Config{installman1dir} if necessary) and replace it with
	 '/home/foo'.  If this fails it will simply use '/home/foo/man/man1'.

       processPL (o)
	 Defines targets to run *.PL files.

       quote_paren
	 Backslashes parentheses "()" in command line arguments.  Doesn't handle recursive Make-
	 file "$(...)" constructs, but handles simple ones.

       realclean (o)
	 Defines the realclean target.

       replace_manpage_separator
	   my $man_name = $MM->replace_manpage_separator($file_path);

	 Takes the name of a package, which may be a nested package, in the form 'Foo/Bar.pm' and
	 replaces the slash with "::" or something else safe for a man page file name.	Returns
	 the replacement.

       static (o)
	 Defines the static target.

       static_lib (o)
	 Defines how to produce the *.a (or equivalent) files.

       staticmake (o)
	 Calls makeaperl.

       subdir_x (o)
	 Helper subroutine for subdirs

       subdirs (o)
	 Defines targets to process subdirectories.

       test (o)
	 Defines the test targets.

       test_via_harness (override)
	 For some reason which I forget, Unix machines like to have PERL_DL_NONLAZY set for
	 tests.

       test_via_script (override)
	 Again, the PERL_DL_NONLAZY thing.

       tool_autosplit (o)
	 Defines a simple perl call that runs autosplit. May be deprecated by pm_to_blib soon.

       tools_other (o)
	 Defines SHELL, LD, TOUCH, CP, MV, RM_F, RM_RF, CHMOD, UMASK_NULL in the Makefile. Also
	 defines the perl programs MKPATH, WARN_IF_OLD_PACKLIST, MOD_INSTALL. DOC_INSTALL, and
	 UNINSTALL.

       tool_xsubpp (o)
	 Determines typemaps, xsubpp version, prototype behaviour.

       top_targets (o)
	 Defines the targets all, subdirs, config, and O_FILES

       writedoc
	 Obsolete, deprecated method. Not used since Version 5.21.

       xs_c (o)
	 Defines the suffix rules to compile XS files to C.

       xs_cpp (o)
	 Defines the suffix rules to compile XS files to C++.

       xs_o (o)
	 Defines suffix rules to go from XS to object files directly. This is only intended for
	 broken make implementations.

       perl_archive
	 This is internal method that returns path to libperl.a equivalent to be linked to
	 dynamic extensions. UNIX does not have one but other OSs might have one.

       perl_archive_after
	 This is an internal method that returns path to a library which should be put on the
	 linker command line after the external libraries to be linked to dynamic extensions.
	 This may be needed if the linker is one-pass, and Perl includes some overrides for C RTL
	 functions, such as malloc().

       export_list
	 This is internal method that returns name of a file that is passed to linker to define
	 symbols to be exported.  UNIX does not have one but OS2 and Win32 do.

SEE ALSO
       ExtUtils::MakeMaker

perl v5.8.0				    2002-06-01			   ExtUtils::MM_Unix(3pm)


All times are GMT -4. The time now is 12:15 PM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
UNIX.COM Login
Username:
Password:  
Show Password