Macros Pertaining To Installation

Another family of macros determine which items will be installed during the "install" step. For maximum flexibility, no items are ever installed automatically. For example, in order to install a binary which was built by the current Makefile, it is necessary to list that binary explicitly in the list of binaries to install. In addition, a variation on install, called publish, is supported, in which items will be installed into the local build area by the "all" target, but not installed into the final installed area given by the configure prefix. The macros which control installation are:

• HD_INSTALL_EXTRA: Explicit targets which will be "maked" at publish and install time, and which take custom actions which do not fit into any category. This should be used sparingly.
• HD_INSTALL_ONLY_EXTRA: Explicit targets which will be "maked" only at install time, and which take custom actions which do not fit into any category. This should be used sparingly.
• HD_INSTALL_HEADERS: C and/or C++ header files to be installed into the top-level include/ directory. Not every header file necessarily needs to be installed. It is recommended that some care go into designing header files so that no more are installed than necessary. If the macro HD_INC_SUBDIR is also defined, the files will be installed in a subdirectory of the top-level include directory with the defined name instead (i.e. include/(HD_INC_SUBDIR)).
• HD_INSTALL_HELP: Help/documentation files to be installed into the top-level help/ directory.
• HD_INSTALL_LIBRARIES: Libraries to be installed into the top-level lib/ directory.
• HD_INSTALL_PERL_LIBS: Perl libraries to be installed into the top-level lib/perl directory. If the macro HD_PERL_SUBDIR is also defined, the libraries will be installed in a subdirectory of the top-level lib/perl with the defined name instead (i.e. lib/perl/(HD_PERL_SUBDIR)).
• HD_INSTALL_PERL_SCRIPTS: Perl scripts to be installed into the top-level scripts directory (currently the same as the top-level bin/ directory). At install time, Perl scripts will be edited to make sure that they use the version of Perl specified in the LHEA_PERL environment variable.
• HD_INSTALL_PFILES: Parameter files to be installed into the top-level syspfiles/ directory.
• HD_INSTALL_PYTHON_LIBS: Python libraries to be installed into the top-level lib/python directory. If the macro HD_PYTHON_SUBDIR is also defined, the libraries will be installed in a subdirectory of the top-level lib/python with the defined name instead (i.e. lib/python/(HD_PYTHON_SUBDIR)).
• HD_INSTALL_PYTHON_SCRIPTS: Python scripts to be installed into the top-level scripts directory (currently the same as the top-level bin/ directory).
• HD_INSTALL_REFDATA: Data files to be installed into the top-level refdata/ directory. If the macro HD_REFDATA_SUBDIR is also defined, the files will be installed in a subdirectory of the top-level refdata directory with the defined name instead (i.e. refdata/(HD_REFDATA_SUBDIR)).
• HD_INSTALL_TASKS: Compiled tasks to be installed into the top-level bin/ directory.
• HD_INSTALL_SHELL_SCRIPTS: Shell scripts to be installed into the top-level scripts directory (currently the same as the top-level /bin directory).
• HD_INSTALL_XML: XML files to be installed into the top-level xml directory. If the macro HD_XML_SUBDIR is also defined, the files will be installed in a subdirectory of the top-level xml directory with the defined name instead (i.e. xml/(HD_XML_SUBDIR)).

All items specified in the above macros will also be installed automatically as part of the "publish" step. In addition, the publish step publishes the items listed in the following macros:

• HD_PUBLISH_HEADERS: C and/or C++ header files to be published into the local build include/ directory. Not every header file necessarily needs to be published.
• HD_PUBLISH_HELP: Help/documentation files to be published into the local build help/ directory.
• HD_PUBLISH_LIBRARIES: Libraries to be published into the local build lib/ directory.
• HD_PUBLISH_PERL_LIBS: Perl libraries to be published into the local build lib/perl directory.
• HD_PUBLISH_PERL_SCRIPTS: Perl scripts to be published into the local build scripts directory (same as the local build tasks directory). At publish time, Perl scripts will be edited to make sure that they use the version of Perl specified in the LHEA_PERL environment variable.
• HD_PUBLISH_PFILES: Parameter files to be published into the local build syspfiles/ directory.
• HD_PUBLISH_REFDATA: Data files to be published into the local build refdata/ directory.
• HD_PUBLISH_TASKS: Compiled tasks to be published into the local build bin/ directory.
• HD_PUBLISH_SHELL_SCRIPTS: Shell scripts to be published into the local build scripts directory (same as the local build tasks directory).