NOTES-VMS.md

   1 Notes for the OpenVMS platform
   2 ==============================
   3
   4  - [Requirement details](#requirement-details)
   5  - [About ANSI C compiler](#about-ansi-c-compiler)
   6  - [About ODS-5 directory names and Perl](#about-ods-5-directory-names-and-perl)
   7  - [About MMS and DCL](#about-mms-and-dcl)
   8  - [About debugging](#about-debugging)
   9  - [Checking the distribution](#checking-the-distribution)
  10
  11
  12 Requirement details
  13 -------------------
  14
  15 In addition to the requirements and instructions listed
  16 in [INSTALL.md](INSTALL.md), this are required as well:
  17
  18   * At least ODS-5 disk organization for source and build.
  19     Installation can be done on any existing disk organization.
  20
  21 About ANSI C compiler
  22 ---------------------
  23
  24 An ANSI C compiled is needed among other things.  This means that
  25 VAX C is not and will not be supported.
  26
  27 We have only tested with DEC C (aka HP VMS C / VSI C) and require
  28 version 7.1 or later.  Compiling with a different ANSI C compiler may
  29 require some work.
  30
  31 Please avoid using C RTL feature logical names `DECC$*` when building
  32 and testing OpenSSL.  Most of all, they can be disruptive when
  33 running the tests, as they affect the Perl interpreter.
  34
  35 About ODS-5 directory names and Perl
  36 ------------------------------------
  37
  38 It seems that the perl function canonpath() in the `File::Spec` module
  39 doesn't treat file specifications where the last directory name
  40 contains periods very well.  Unfortunately, some versions of VMS tar
  41 will keep the periods in the OpenSSL source directory instead of
  42 converting them to underscore, thereby leaving your source in
  43 something like `[.openssl-1^.1^.0]`.  This will lead to issues when
  44 configuring and building OpenSSL.
  45
  46 We have no replacement for Perl's canonpath(), so the best workaround
  47 for now is to rename the OpenSSL source directory, as follows (please
  48 adjust for the actual source directory name you have):
  49
  50     $ rename openssl-1^.1^.0.DIR openssl-1_1_0.DIR
  51
  52 About MMS and DCL
  53 -----------------
  54
  55 MMS has certain limitations when it comes to line length, and DCL has
  56 certain limitations when it comes to total command length.  We do
  57 what we can to mitigate, but there is the possibility that it's not
  58 enough.  Should you run into issues, a very simple solution is to set
  59 yourself up a few logical names for the directory trees you're going
  60 to use.
  61
  62 About debugging
  63 ---------------
  64
  65 If you build for debugging, the default on VMS is that image
  66 activation starts the debugger automatically, giving you a debug
  67 prompt.  Unfortunately, this disrupts all other uses, such as running
  68 test programs in the test framework.
  69
  70 Generally speaking, if you build for debugging, only use the programs
  71 directly for debugging.  Do not try to use them from a script, such
  72 as running the test suite.
  73
  74 ### The following is not available on Alpha
  75
  76 As a compromise, we're turning off the flag that makes the debugger
  77 start automatically.  If there is a program that you need to debug,
  78 you need to turn that flag back on first, for example:
  79
  80     $ set image /flag=call_debug [.test]evp_test.exe
  81
  82 Then just run it and you will find yourself in a debugging session.
  83 When done, we recommend that you turn that flag back off:
  84
  85     $ set image /flag=nocall_debug [.test]evp_test.exe
  86
  87 Checking the distribution
  88 -------------------------
  89
  90 There have been reports of places where the distribution didn't quite
  91 get through, for example if you've copied the tree from a NFS-mounted
  92 Unix mount point.
  93
  94 The easiest way to check if everything got through as it should is to
  95 check that this file exists:
  96
  97     [.include.openssl]configuration^.h.in
  98
  99 The best way to get a correct distribution is to download the gzipped
 100 tar file from ftp://ftp.openssl.org/source/, use `GZIP -d` to uncompress
 101 it and `VMSTAR` to unpack the resulting tar file.
 102
 103 Gzip and VMSTAR are available here:
 104
 105    <http://antinode.info/dec/index.html#Software>
 106
 107 Should you need it, you can find UnZip for VMS here:
 108
 109    <http://www.info-zip.org/UnZip.html>
 110
 111  How the value of 'arch' is determined
 112  -------------------------------------
 113
 114  'arch' is mentioned in INSTALL.  It's value is determined like this:
 115
 116     arch = f$edit( f$getsyi( "arch_name"), "upcase")