A local copy of OpenSSL from GitHub
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

127 lines
4.9 KiB

  1. Notes on Perl
  2. =============
  3. - [General Notes](#general-notes)
  4. - [Perl on Windows](#perl-on-windows)
  5. - [Perl on VMS](#perl-on-vms)
  6. - [Perl on NonStop](#perl-on-nonstop)
  7. - [Required Perl modules](#required-perl-modules)
  8. - [Notes on installing a Perl module](#notes-on-installing-a-perl-module])
  9. General Notes
  10. -------------
  11. For our scripts, we rely quite a bit on Perl, and increasingly on
  12. some core Perl modules. These Perl modules are part of the Perl
  13. source, so if you build Perl on your own, you should be set.
  14. However, if you install Perl as binary packages, the outcome might
  15. differ, and you may have to check that you do get the core modules
  16. installed properly. We do not claim to know them all, but experience
  17. has told us the following:
  18. - on Linux distributions based on Debian, the package `perl` will
  19. install the core Perl modules as well, so you will be fine.
  20. - on Linux distributions based on RPMs, you will need to install
  21. `perl-core` rather than just `perl`.
  22. You MUST have at least Perl version 5.10.0 installed. This minimum
  23. requirement is due to our use of regexp backslash sequence \R among
  24. other features that didn't exist in core Perl before that version.
  25. Perl on Windows
  26. ---------------
  27. There are a number of build targets that can be viewed as "Windows".
  28. Indeed, there are `VC-*` configs targeting VisualStudio C, as well as
  29. MinGW and Cygwin. The key recommendation is to use a Perl installation
  30. that matches the build environment. For example, if you will build
  31. on Cygwin be sure to use the Cygwin package manager to install Perl.
  32. For MSYS builds use the MSYS provided Perl.
  33. For VC-* builds we recommend Strawberry Perl, from <http://strawberryperl.com>.
  34. An alternative is ActiveState Perl, from <http://www.activestate.com/ActivePerl>
  35. for which you may need to explicitly select the Perl module Win32/Console.pm
  36. available via <https://platform.activestate.com/ActiveState>.
  37. Perl on VMS
  38. -----------
  39. You will need to install Perl separately. One way to do so is to
  40. download the source from <http://perl.org/>, unpacking it, reading
  41. `README-VMS.md` and follow the instructions. Another way is to download a
  42. `.PCSI` file from <http://www.vmsperl.com/> and install it using the
  43. POLYCENTER install tool.
  44. Perl on NonStop
  45. ---------------
  46. Perl is installed on HPE NonStop platforms as part of the Scripting Languages
  47. package T1203PAX file. The package is shipped as part of a NonStop RVU
  48. (Release Version Updates) package. Individual SPRs (Software Product Release)
  49. representing fixes can be obtained from the Scout website at
  50. <https://h22204.www2.hpe.com/NEP>. Follow the appropriate set of installation
  51. instructions for your operating system release as described in the
  52. Script Language User Guide available from the NonStop Technical Library.
  53. Required Perl modules
  54. ---------------------
  55. We do our best to limit ourselves to core Perl modules to keep the
  56. requirements down. There are just a few exceptions.
  57. * Text::Template this is required *for building*
  58. To avoid unnecessary initial hurdles, we include a copy of this module
  59. in the source. It will work as a fallback if the module isn't already
  60. installed.
  61. * `Test::More` this is required *for testing*
  62. We require the minimum version to be 0.96, which appeared in Perl 5.13.4,
  63. because that version was the first to have all the features we're using.
  64. This module is required for testing only! If you don't plan on running
  65. the tests, you don't need to bother with this one.
  66. Notes on installing a Perl module
  67. ---------------------------------
  68. There are a number of ways to install a perl module. In all
  69. descriptions below, `Text::Template` will serve as an example.
  70. 1. for Linux users, the easiest is to install with the use of your
  71. favorite package manager. Usually, all you need to do is search
  72. for the module name and to install the package that comes up.
  73. On Debian based Linux distributions, it would go like this:
  74. $ apt-cache search Text::Template
  75. ...
  76. libtext-template-perl - perl module to process text templates
  77. $ sudo apt-get install libtext-template-perl
  78. Perl modules in Debian based distributions use package names like
  79. the name of the module in question, with "lib" prepended and
  80. "-perl" appended.
  81. 2. Install using CPAN. This is very easy, but usually requires root
  82. access:
  83. $ cpan -i Text::Template
  84. Note that this runs all the tests that the module to be installed
  85. comes with. This is usually a smooth operation, but there are
  86. platforms where a failure is indicated even though the actual tests
  87. were successful. Should that happen, you can force an
  88. installation regardless (that should be safe since you've already
  89. seen the tests succeed!):
  90. $ cpan -f -i Text::Template
  91. Note: on VMS, you must quote any argument that contains upper case
  92. characters, so the lines above would be:
  93. $ cpan -i "Text::Template"
  94. and:
  95. $ cpan -f -i "Text::Template"