view release on metacpan or  search on metacpan

Manual.pod  view on Meta::CPAN

  cd SystemPerl*

=item

Make sure the C<SYSTEMC> environment variable points to your SystemC
installed directory; or that C<SYSTEMC_INCLUDE> points to the include
directory with systemc.h in it, and that C<SYSTEMC_LIBDIR> points to the
directory with libsystemc.a in it.  If using bash, this would consist of
the line

    export SYSTEMC=/path/to/systemc
    export SYSTEMC_INCLUDE=/path/to/systemc/include   # with systemc.h
    export SYSTEMC_LIBDIR=/path/to/systemc/lib    # with libsystemc.a

in your C<~/.bashrc> file.

If different than the above, make sure the C<SYSTEMC_KIT> environment
variable points to your original SystemC source code kit.

Type C<perl Makefile.PL> to configure SystemPerl for your system.

You may get a warning message about needing Verilog::Netlist, if so
you need to install or upgrade the C<verilog-perl> package from CPAN.

=item

Type C<make> to compile SystemPerl.

If you get a error message ``y.tab.c: error: parse error before
goto,'' there is a problem between Bison and GCC.  The simplest fix is
to edit y.tab.c to comment out ``__attribute__ ((unused))''.

=item

Type C<make test> to check the compilation.

=item

You can see examples under the test_dir directory.  The *.sp files are
"inline" converted, while the *.h and *.cpp files are expanded from
the .sp files.

=item

Type C<make install> to install the programs and any data files and
documentation.

=item

Add a C<SYSTEMPERL> environment variable that points to the directory
of this kit (the directory you typed ``make install'' inside, not your
site-perl directory.)  If using bash, this would consist of the line

  export SYSTEMPERL=/path/to/systemperl

in your C<~/.bashrc> file.

=item

Optionally add a C<SYSTEMPERL_INCLUDE> environment variable if for some
reason you wish to relocate the include files (the files under the kit's
src directory).  For example distributions often want to relocate the
SystemPerl includes into the standard system include directory.  Note that
these files are not installed with C<make install> (as Perl doesn't provide
a standard way to install includes), which is why SYSTEMPERL or
SYSTEMPERL_INCLUDE must point to them.

=back

=head1 DISTRIBUTION

SystemPerl is part of the L<http://www.veripool.org/> free SystemC software
tool suite.  The latest version is available from CPAN and from
L<http://www.veripool.org/systemperl>.

Copyright 2001-2014 by Wilson Snyder.  This package is free software; you
can redistribute it and/or modify it under the terms of either the GNU
Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0.

This code is provided with no warranty of any kind, and is used entirely at
your own risk.

=head1 AUTHORS

Wilson Snyder <wsnyder@wsnyder.org>.

=head1 SEE ALSO

=head2 Primary Documentation:

L<SystemC::Manual> (This document)

=head2 Language Documentation:

L<SystemC::SystemPerl>

=head2 Programs:

L<sp_includer>, L<sp_makecheck>, L<sp_preproc>

=head2 Major modules:

L<SystemC::Netlist>, L<SystemC::Parser>

=head2 Submodules:

L<SystemC::Coverage>
L<SystemC::Coverage::Item>
L<SystemC::Coverage::ItemKey>

L<SystemC::Netlist>
L<SystemC::Netlist::AutoCover>
L<SystemC::Netlist::AutoTrace>
L<SystemC::Netlist::Cell>
L<SystemC::Netlist::Class>
L<SystemC::Netlist::CoverGroup>
L<SystemC::Netlist::CoverPoint>
L<SystemC::Netlist::File>
L<SystemC::Netlist::Method>
L<SystemC::Netlist::Module>
L<SystemC::Netlist::Net>