Content-type: text/html Manpage of list

list

Section: Misc. Reference Manual Pages (l)
Updated: May 21, 2019
Index Return to Main Contents

NAME

list - Module hierarchy listing using RISC

SYNOPSIS

list [ command ] - [ subcommand ] [ design ]

DESCRIPTION

list is a tool that can be used for both debugging and user purposes. It is a terminal-based utility tool that is meant for listing the structural composition of SystemC models.

USAGE

To use this tool, simply run the `list' program with a command (and optional subcommand) on a SystemC design model.

For instance, you can do `./list [file path]play.cpp'. Notice in this example that no command is included. Running the program with no command will just print out every single component of whatever SystemC model a user specified in default mode. Also note that you can print out the entire structure of a single component of a SystemC model either in default or minimal mode by doing commands like `m-' or `m-m'. In the previous examples, `m-' would print out all of the info for every module of a SystemC model in default mode while `m-m' would do the same thing but in minimal mode. This holds true for all commands, so you can also use, for instance `v-' to print out all the info for every global variable of a SystemC model in default mode.

Note however, that the very second any other subcommand is used besides `m'(minimal mode), only the piece of info specified by that subcommand will be printed. For instance, using the command `v-t' would print out every global variable and its type for a given SystemC model, but no other piece of info like the source file or line number of where those variables originated will be printed.

Lastly to use multiple subcommands at the same time, type them consecutively next to each other with no spaces or other characters in between. For instance, using the command `h-mtv' will print out the types and gobal variables of every hierarchical channel in a SystemC model in minimal mode. Note that the order in which you type in subcommands does not matter, so the command `h-vtm' would produce the same output as `h-mtv'.

OPTIONS

Calling `./list -h' prints a brief summary of available command and subcommand options, as follows:

m: print modules
-m: minimal mode
-t: include module types
-v: print global variables
-s: print submodules
-p: print ports
-h: print hierarchical channels
-f: print member functions
-l: print source location
h: print hierarchical channels
-m: minimal mode
-t: include channel types
-v: print global variables
-s: print submodules
-p: print ports
-h: print hierarchical channels
-f: print member functions
-l: print source location
v: print global variables
-m: minimal mode
-t: include variable types
-l: print source location
p: print primitive channels
-m: minimal mode
-t: include channel types
-l: print source location
i: print interfaces
-m: minimal mode
-a: print out all interfaces (also from headers)
-l: print source location

VERSION

List is release version 0.6.2.

AUTHORS

Spencer Kam <sbkam@uci.edu>

COPYRIGHT

LICENSE

Open source BSD license terms apply.

BUGS, LIMITATIONS

This is an academic proof-of-concept prototype implementation, not commercial-quality software.

This document was created by man2html, using the manual pages.
Time: 23:46:04 GMT, September 13, 2020