OS X

Notes on installing and running BBF data model tools under OS X

Prerequisites

In order to use the tool you will need to have a Perl interpreter installed and there're a variety of possibilities to obtain one.

Native

macOS ships with a Perl interpreter out-of-the-box, however it is somewhat dated (e.g. El Capitan provides v5.18.2), so installing a more recent interpreter is recommended.

Homebrew

Homebrew is a very good way to manage additional software packages on macOS so if you're now using it already you might want to check out https://brew.sh/ for the one-line instruction on how to install it.

Once you have homebrew on your system, the following will install the Perl interpreter:

brew install perl

Please note that on El Capitan the system ships with a broken version of libxml2 so in that case you might want to install a custom version and use that with

brew install libxml2

and then PREFIX the additional cpanm lines further down with

PATH="/usr/local/opt/libxml2/bin:$PATH"

Installing required Perl modules

After you picked a suitable Perl interpreter it is required to install additional perl modules which is achieved by the CPAN perl module distribution, a frontend of which is included with any modern perl interpreter.

Now execute the following command install a helper module to simplify CPAN use:

cpan App::cpanminus

and then follow up with the following command to install the required modules:

cpanm Algorithm::Diff Clone Data::Compare String::Tokenizer URI::Split XML::LibXML

Executing the report tool

After following the previous instructions you should now be able to run the report tool natively by simply executing the report.pl script.

Further information

If you need further help on using the report tool you can run the pod2html tool on the report.pl file in order to generate an HTML file with the synopsis of the command like

pod2html report.pl --outfile=report.html

Also please have a look at the extensive user guide in TR-154.