To use the toolkit, an appropriate version of Perl must be installed.

Installation on Windows

Supported versions (Windows)

The supported versions of Perl on Windows are 64-bit versions 5.24, 5.26, 5.28, 5.30 and 5.32 of ActiveState ActivePerl and Strawberry Perl. ActivePerl is available for download from https://www.activestate.com/. Strawberry Perl can be downloaded from https://strawberryperl.com/.

Determine which version of Perl you are using (Windows)

To find out which version of perl you have, type the following at a command prompt:

    perl -v

This will report the Perl version and copyright. The first line gives the version number. For example:

This is perl 5, version 26, subversion 2 (v5.26.2) built for MSWin32-x64-multi-thread

If it reports built for MSWin32-x64... then the 64 bit version of Mascot Parser is required. If it reports built for MSWin32-x86... then the 32 bit version of Mascot Parser is required. In this case, please use Parser 2.7 or earlier.

Find the correct version of the Mascot Parser Files (Windows)

The correct Mascot Parser files will be in the following directories:

Perl version	Directory
ActivePerl/Strawberry Perl 5.24.x	perl524
ActivePerl/Strawberry Perl 5.26.x	perl526
ActivePerl/Strawberry Perl 5.28.x	perl528
ActivePerl/Strawberry Perl 5.30.x	perl530
ActivePerl/Strawberry Perl 5.32.x	perl532

Copy the two files to a suitable location (Windows)

To use Mascot Parser in your program, the files msparser.pm must either be in the same directory as your program, or in a directory searched by the Perl interpreter.
In either case, msparser.dll must be copied into a subdirectory auto\msparser that is relative to msparser.pm. For example:

C:\msparser\perl526>dir

Directory of C:\msparser\perl526

19/07/2019  08:56    <DIR>          .
19/07/2019  08:56    <DIR>          ..
19/07/2019  08:56    <DIR>          auto
18/07/2019  15:59           582,464 msparser.pm
               1 File(s)        582,464 bytes
               3 Dir(s)  862,835,568,640 bytes free


C:\msparser\perl526>dir auto\msparser

Directory of C:\msparser\perl526\auto\msparser


19/07/2019  15:05    <DIR>          .
19/07/2019  15:05    <DIR>          ..
18/07/2019  16:34        25,823,927 msparser.dll
               1 File(s)     25,823,927 bytes
               2 Dir(s)  862,835,568,640 bytes free

Define the module path (Windows)

If the msparser.pm file is not in the current directory, there are four alternative ways to define the module search path:

Define or modify PERL5LIB:
You can define the PERL5LIB environment variable to point to the directory where Mascot Parser Perl files are located.
Add use lib into your program:
You can use the lib module to add the directory where Mascot Parser Perl files are located to the module search path:
```
use lib 'c:\path\to\msparser\perl_files';
```
Use the -I command-line flag:
You can use the -I command-line flag when running Perl to add a directory to the module search path.
Global installation:
You can copy the Mascot Parser Perl files to C:\Perl\site\lib directory as follows:
- Copy msparser.pm into C:\Perl64\site\lib
- Make a directory C:\Perl64\site\lib\auto\msparser
- Copy msparser.dll into C:\Perl64\site\lib\auto\msparser
(The directories above assume that ActivePerl is installed in C:\Perl64).

Install Microsoft Runtime Libraries (Windows)

You may also need to install the Microsoft Visual C++ 2015 Update 1 (or later) Redistributable Package
To check if you need this:

Download and run depends.exe from https://www.dependencywalker.com/ or Dependencies program from https://github.com/lucasg/Dependencies
Open msparser.dll in the program.
If it reports that the dependent MSVCR140.dll and MSVCP140.dll are missing, download the Visual C++ 2015 Update 1 (or later) redistributable package from the Microsoft Download Center: https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0
Choose vc_redist.x86.exe for 32-bit and vc_redist.x64.exe for 64-bit

Test the installation (Windows)

Type the following at a command prompt:

    perl -e "use msparser;"

This should give no output and just return to the command prompt.

Installation on Linux platforms

Supported versions (Linux)

Different releases and builds of Perl are supported on 64-bit Linux. Support for 32-bit Linux has been discontinued. This version of Mascot Parser provides the following builds of the Perl module:

`.so` filename	Linux - 64bit
msparser516-thread-multi_64.so	X
msparser518-thread-multi_64.so	X
msparser520-thread-multi_64.so	X
msparser522-thread-multi_64.so	X
msparser524-thread-multi_64.so	X
msparser526-thread-multi_64.so	X
msparser528-thread-multi_64.so	X
msparser530-thread-multi_64.so	X
msparser532-thread-multi_64.so	X
msparser534-thread-multi_64.so	X

You need to determine which .so file matches your version of Perl, and then make a soft link or rename it to msparser.so.

Determine which version of Perl you are using (Linux)

To find out which version of perl you have, type the following at a shell prompt:

perl -v

This will report the Perl version and copyright. The first line gives the version number. For example:

This is perl 5, version 26, subversion 1 (v5.26.1) built for x86_64-linux-thread-multi

Find the correct version of the Mascot Parser Files (Linux)

The correct Mascot Parser files will be in the following directories:

Perl version	Directory
5.16.x	perl516
5.18.x	perl518
5.20.x	perl520
5.22.x	perl522
5.24.x	perl524
5.26.x	perl526
5.28.x	perl528
5.30.x	perl530
5.32.x	perl532
5.34.x	perl534

Determine Perl build options (Linux)

In earlier versions of Parser, the naming convention of the shared library was:

msparser[ver][-thread][-multi][-64int][_64].so

This version of Parser only ships with:

msparser[ver]-thread-multi_64.so

For reference, the build options [-thread], [-multi] and [-64int] refer to the following:

[-thread]

Type perl -V (note the uppercase V) and look for the line starting usethreads or useithreads. For example:

   usethreads=define useithreads=define ...

If usethreads is define, then you will need an .so file with -thread in the name. (This option is no longer supported in Mascot Parser)

[-multi]

Type perl -V (as above) and look for the line containing usemultiplicity. If it is define, then you will need an .so file with -multi in the name. (This option is no longer supported in Mascot Parser)

[-64int]

Type perl -V (as above) and look for the line containing use64bitint. If it is define, then you will need an .so file with -64int in the name. (This option is no longer supported in Mascot Parser)

[_64]

Type perl -V (as above) and look for the line containing ptrsize. For example:

  intsize=4, longsize=8, ptrsize=8, doublesize=8, byteorder=12345678

If ptrsize is 8, then you will need an .so file with _64 in the name.

If any of the required build options are missing, we recommend compiling Perl from source or installing a supported version of ActiveState ActivePerl from https://activestate.com.

Copy the two files to a suitable location (Linux)

To use Mascot Parser in your program, the file msparser.pm must either be in the same directory as your program, or in a directory searched by the Perl interpreter.

In both cases, msparser.so must be in the directory auto/msparser relative to msparser.pm.
In that directory, make a soft link msparser.so to the msparser[ver]-thread-multi_64.so file

Define the module path (Linux)

If the msparser.pm file is not in the current directory, there are four alternative ways to define the module search path:

Define or modify PERL5LIB:
You can define the PERL5LIB environment variable to point to the directory where Mascot Parser Perl files are located.
Add use lib into your program: You can use the lib module to add the directory where Mascot Parser Perl files are located to the module search path:
```
use lib '/path/to/msparser/perl_files';
```
Use the -I command-line flag: You can use the -I command-line flag when running Perl to add a directory to the module search path.
Global installation: You can copy the Mascot Parser Perl files to the site_perl directory as follows. Note that the exact path will depend on your distribution and how Perl has been configured; the following example is from CentOS 7 64-bit:
- Copy msparser.pm into /usr/local/lib64/perl5/site_perl/5.16.3/x86_64-linux-thread-multi/
- Make a directory /usr/local/lib64/perl5/site_perl/5.16.3/x86_64-linux-thread-multi/auto/msparser
- Copy msparser516-thread-multi.so into /usr/local/lib/perl5/site_perl/5.16.3/x86_64-linux-thread-multi/auto/msparser
- Make a soft link msparser.so in /usr/local/lib/perl5/site_perl/5.16.1/x86_64-linux-thread-multi/auto/msparser

Using the Perl toolkit

Reasonable proficiency in Perl programming will be required. Please see Quickstart: how to open a results file and Examples for the results file module.

Perl toolkit installation [Installing Mascot Parser]

Installation on Windows

Installation on Linux platforms

Using the Perl toolkit

Perl toolkit installation
[Installing Mascot Parser]