help.cli.txt

nb>help
                    COMMAND LINE INTERFACE (CLI)
             incrs: Lists all available increments (sets of related commands)
            <incr>: Enters an increment
            <comm>: Executes a command in an increment already entered
     <incr> <comm>: Executes a command in the specified increment
       help <incr>: Lists the commands available in the specified increment
       help <comm>: Provides help for a command in an increment already entered
help <incr> <comm>: Provides help for a command in the specified increment

Adding "full" at the end of a >help command displays any detailed help
file for the specified increment or command.  >help full is equivalent to
>help <incr> full for the current increment.  The system starts up in the
>nb increment, so >help nb lists the commands that are always available.

The following are used when displaying and entering a command's parameters:
   (...)  denote alternatives for a mandatory parameter
   [...]  denote an optional parameter
       ~  skips an optional parameter
       =  tags an optional parameter
       &  obtains a symbol's value
   "..."  delimits a string with embedded blanks (treated as one parameter)
       /  precedes a comment (rest of input line is ignored)
       \  overrides any special meaning for the next character
Optional parameters must be entered in the same order that they are displayed
by >help <comm>.
nb>incrs
          nb : NodeBase Increment
          nt : NodeBase Tools and Tests
          ct : CodeTools Increment
          nw : Network Increment
          sb : SessionBase Increment
          st : SessionBase Tools and Tests
        pots : POTS Increment
          sn : Service Node Increment
          an : Access Node Increment
nb>help full
help              : Provides help for an increment or command.
  [<str>]         : name of increment
  [<str>]         : name of command ('full' = all commands)
  [full]          : displays full documentation

quit              : Exits the most recent (or all) increments.
  [all]           : exits all increments

incrs             : Displays all available increments.

send              : Sends CLI output to the console or a file.
(                 : where to send CLI output
  cout            : to the console
  prev            : to the previous location
  <str>           : to the file specified
    [t|f]         : append if file already exists? (default=f)
)

read              : Reads commands from a file.
  <str>           : read input from <str>.txt

echo              : Writes the rest of the input line to the console.
  <str>           : the string to be written to the console

cfgparms          : Supports configuration parameters.
(                 : subcommand...
  list            : displays all configuration parameters
  explain         : explains a configuration parameter
    <str>         : name of configuration parameter
  get             : displays a configuration parameter's value
    <str>         : name of configuration parameter
  set             : sets a configuration parameter's value
    <str>         : name of configuration parameter
    <str>         : value of configuration parameter
)

logs              : Interface to the log subsystem.
(                 : subcommand...
  list            : displays info for all logs or the logs in a specific group
    [<str>]       : log group name (default=all)
  groups          : displays all log groups
  explain         : displays documentation for a log
    <str>         : log group name
    (100:999)     : log number
  suppress        : suppresses all the logs in a group
    <str>         : log group name
  (               : setting...
    on            : on
    off           : off
  )
  throttle        : throttles or suppresses a specific log
    <str>         : log group name
    (100:999)     : log number
    (0:100)       : report every Nth log (0=none, 1=all)
  count           : displays the number of logs reported so far
  buffers         : displays all log buffers
    [b|v]         : 'b'=brief 'v'=verbose (default='b')
  write           : writes a buffer's logs to its log file
    (0:7)         : log buffer index
    (0:1000)      : number of logs to send (0=all)
  free            : deletes a log buffer
    (0:7)         : log buffer index
)

alarms            : Interface to the alarm subsystem.
(                 : subcommand...
  list            : counts or displays alarms
    [0:65535]     : index (location in registry)
    [c|s|b|v]     : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')
  explain         : displays documentation for an alarm
    <str>         : alarm name
  clear           : clears an alarm
    <str>         : alarm name
)

symbols           : Supports symbols.
(                 : subcommand...
  list            : displays symbols
    [<str>]       : symbol's name (displays all if omitted)
  set             : sets a symbol's value
    <str>         : symbol's name
    [<str>]       : symbol's value (symbol deleted if omitted)
  assign          : sets a symbol's value to a configuration parameter's
    <str>         : symbol's name
    <str>         : name of configuration parameter
)

stats             : Supports performance statistics.
(                 : subcommand...
  groups          : displays all statistics groups
  show            : displays statistics
    [0:255]       : group number (default=all)
    [0:65535]     : member number (group specific; default=all)
    [b|v]         : 'b'=brief 'v'=verbose (default='b')
    [<str>]       : filename for output (default=console)
  rollover        : starts a new interval
    [t|f]         : clear history prior to this interval? (default=f)
)

status            : Displays system statistics.

sched             : Provides scheduler information.
(                 : subcommand...
  show            : displays thread statistics
    [<str>]       : filename for output (default=console)
  start           : starts tracing context switches
  stop            : stops tracing context switches
  kill            : kills a thread
    (0:99)        : ThreadId
  ticks           : displays InitThread ticks
)

threads           : Counts or displays threads.
  [0:99]          : ThreadId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

daemons           : Displays daemons.
(                 : subcommand...
  list            : counts or displays daemons
    [0:65535]     : index (location in registry)
    [c|s|b|v]     : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')
  set             : disables (off) or enables (on) a daemon
    (0:65535)     : index (location in registry)
  (               : setting...
    on            : on
    off           : off
  )
)

mutexes           : Counts or displays mutexes.
  [0:65535]       : index (location in registry)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

buffers           : Counts or displays message buffers.
  [c|s|v]         : 'c'=count 's'=summary 'v'=verbose (default='s')

deferred          : Displays deferred work items.
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

modules           : Counts or displays modules.
  [0:255]         : ModuleId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

heaps             : Interface to heaps.
(                 : subcommand...
  list            : counts or displays heaps
    [0:7]         : memory type (see mem.* symbols; default=all)
    [c|s|b|v]     : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')
  setsize         : sets the desired size
    (1:7)         : memory type (see mem.* symbols)
    (1:1023)      : size
    [k|m|g]       : 'k'=kB 'm'=MB 'g'=GB
  validate        : validates all heaps
  trace           : controls heap trace tool
    (1:7)         : memory type (see mem.* symbols)
  (               : tracing subcommand...
    reset         : clears the list of allocated blocks
    start         : starts tracing of allocated blocks
    stop          : stops tracing of allocated blocks
    show          : shows allocated blocks
  )
)

pools             : Counts or displays object pools.
  [0:255]         : ObjectPoolId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

audit             : Controls the object pool audit.
(                 : subcommand...
  interval        : sets the audit's frequency
    (0:60)        : seconds between audits (0 = disabled)
  force           : forces the audit to run immediately
)

psignals          : Counts or displays POSIX signals.
  [0:127]         : signal_t (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

singletons        : Displays the singletons registry.
  [b|v]           : 'b'=brief 'v'=verbose (default='b')

tools             : Counts or displays debugging tools.
  [0:65535]       : index (location in registry)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

set               : Controls trace tool settings.
(                 : what to set...
  tools           : trace tools: see >tools command for abbrevations
    <str>         : tools to set: string of tool abbreviations
  (               : setting...
    on            : on
    off           : off
  )
  buffsize        : capacity of trace buffer
    (17:22)       : buffer size (=2^N events)
  wrap            : whether trace buffer can wrap around
    (t|f)         : allow trace buffer to wrap around?
)

include           : Specifies what should be captured by trace tools.
(                 : what to include...
  all             : all activity
  (               : setting...
    on            : on
    off           : off
  )
  faction         : threads in a specific faction
    (0:8)         : faction
  thread          : a specific thread's activity
    (0:99)        : ThreadId
)

exclude           : Specifies what should not be captured by trace tools.
(                 : what to exclude...
  faction         : threads in a specific faction
    (0:8)         : faction
  thread          : a specific thread's activity
    (0:99)        : ThreadId
)

query             : Displays the status of trace tools.
(                 : what to query...
  buffer          : trace buffer
  tools           : trace tools
  selections      : all items included/excluded by trace tools
)

clear             : Clears the trace buffer, tools, or selections.
(                 : what to clear...
  buffer          : trace buffer
  tools           : trace tools
  selections      : all items included/excluded by trace tools
  faction         : threads in a specific faction
    (0:8)         : faction
  factions        : all included/excluded factions
  thread          : a specific thread's activity
    (0:99)        : ThreadId
  threads         : all included/excluded threads
)

start             : Starts tracing.

stop              : Stops tracing.

save              : Saves what was captured by trace tools.
(                 : what to save...
  trace           : events captured by tools that are currently ON
    <str>         : filename for output
    [<str>]       : options: t=suppress times; c=don't move ctors
)

if                : Conditionally executes a CLI command.
  <int>           : symbol for an integer (e.g. &cli.result)
(                 : relational operator...
  <               : less than
  <=              : less than or equal to
  ==              : equal to
  !=              : not equal to
  >               : greater than
  >=              : greater than or equal to
)
  <int>           : value for comparison
  <str>           : command to execute if condition is true
  [else]          : precedes command to execute if condition is false
  [<str>]         : command to execute if condition is false

delay             : Pauses before executing the next command.
  (0:180)         : time (secs)

display           : Displays an object derived from NodeBase::Base.
  <hex>           : pointer to an object derived from Base
  [b|v]           : 'b'=brief 'v'=verbose (default='b')

dump              : Displays memory in hex.
  <hex>           : memory address
  (1:1024)        : number of bytes to display

restart           : Shuts down the system.
(                 : type of shutdown...
  warm            : exits and recreates threads
  cold            : deletes sessions (plus warm actions)
  reload          : reloads data (plus cold and warm actions)
  reboot          : exits and restarts the entire system
  exit            : exits and does not restart the system
)

No additional help is available.
nb>nt
nt>help full
logs              : Interface to the log subsystem.
(                 : subcommand...
  list            : displays info for all logs or the logs in a specific group
    [<str>]       : log group name (default=all)
  groups          : displays all log groups
  explain         : displays documentation for a log
    <str>         : log group name
    (100:999)     : log number
  suppress        : suppresses all the logs in a group
    <str>         : log group name
  (               : setting...
    on            : on
    off           : off
  )
  throttle        : throttles or suppresses a specific log
    <str>         : log group name
    (100:999)     : log number
    (0:100)       : report every Nth log (0=none, 1=all)
  count           : displays the number of logs reported so far
  buffers         : displays all log buffers
    [b|v]         : 'b'=brief 'v'=verbose (default='b')
  write           : writes a buffer's logs to its log file
    (0:7)         : log buffer index
    (0:1000)      : number of logs to send (0=all)
  free            : deletes a log buffer
    (0:7)         : log buffer index
  sort            : sorts the logs in a log file
    <str>         : filename for input (in OutputPath directory)
    <str>         : filename for output
  flood           : enters a loop that generates SW900 logs
    (1:250)       : number of SW900 logs to generate
)

set               : Controls trace tool settings.
(                 : what to set...
  tools           : trace tools: see >tools command for abbrevations
    <str>         : tools to set: string of tool abbreviations
  (               : setting...
    on            : on
    off           : off
  )
  buffsize        : capacity of trace buffer
    (17:22)       : buffer size (=2^N events)
  wrap            : whether trace buffer can wrap around
    (t|f)         : allow trace buffer to wrap around?
  scope           : scope for function tracing
  (               : how to trace function invocations
    full          : full trace of invocations
    counts        : count invocations per function
  )
)

save              : Saves what was captured by trace tools.
(                 : what to save...
  trace           : events captured by tools that are currently ON
    <str>         : filename for output
    [<str>]       : options: t=suppress times; c=don't move ctors
  funcs           : function call statistics
    <str>         : filename for output
  [               : how to sort (default=calls)
    calls         : by number of invocations
    times         : by net time in function
    names         : by function name
  ]
)

tests             : Configures or executes tests.
(                 : subcommand...
  prolog          : file to read before executing a test
    [<str>]       : filename (none if omitted)
  epilog          : file to read after a test passes
    [<str>]       : filename (none if omitted)
  recover         : file to read after a test fails
    [<str>]       : filename (epilog if omitted)
  begin           : executes a test (and concludes any previous one)
    <str>         : test filename
  end             : concludes a test
  failed          : records that the current test failed
    <int>         : failure code
    [<str>]       : explanation for failure
  query           : displays pass/fail counts and (if verbose) all tests
    [b|v]         : 'b'=brief 'v'=verbose (default='b')
  retest          : displays tests that have not passed
  erase           : removes a test from the database
    <str>         : test name
  reset           : resets the testing environment
)

swflags           : Supports flags used to control branching
(                 : subcommand...
  set             : modifies a flag's setting
    (0:31)        : flag identifier
  (               : setting...
    on            : on
    off           : off
  )
  clear           : clears all flags
  query           : displays flags that are on
)

corrupt           : Corrupts a data structure for testing purposes.
(                 : what to corrupt...
  pool            : object pool
    (0:255)       : ObjectPoolId
    (0:1024)      : offset into free queue (0 = head)
)

lbc               : Tests a LeakyBucketCounter function.
(
  init            : Initializes the counter.
    (1:3600)      : capacity of bucket (limit)
    (1:3600)      : time to empty bucket (seconds)
  event           : Updates the counter when an event occurs.
)

q1                : Tests a Q1Way function.
(
  enq             : Adds an item to the end of the queue.
    (0:8)         : item number (0 = nullptr)
  henq            : Adds an item to the front of the queue.
    (0:8)         : item number (0 = nullptr)
  insert          : Inserts item#2 after item#1.
    (0:8)         : item number (0 = nullptr)
    (0:8)         : item number (0 = nullptr)
  deq             : Removes the item at the front of the queue.
  exq             : Removes an item from anywhere in the queue.
    (0:8)         : item number (0 = nullptr)
  first           : Returns the first item in the queue.
  next            : Returns the next item in the queue.
    (0:8)         : item number (0 = nullptr)
  count           : Returns the number of items in the queue.
  empty           : Returns true if the queue is empty.
  purge           : Deletes all the items in the queue.
)

q2                : Tests a Q2Way function.
(
  enq             : Adds an item to the end of the queue.
    (0:8)         : item number (0 = nullptr)
  henq            : Adds an item to the front of the queue.
    (0:8)         : item number (0 = nullptr)
  deq             : Removes the item at the front of the queue.
  exq             : Removes an item from anywhere in the queue.
    (0:8)         : item number (0 = nullptr)
  first           : Returns the first item in the queue.
  next            : Returns the next item in the queue.
    (0:8)         : item number (0 = nullptr)
  last            : Returns the last item in the queue.
  prev            : Returns the previous item.
    (0:8)         : item number (0 = nullptr)
  count           : Returns the number of items in the queue.
  empty           : Returns true if the queue is empty.
  purge           : Deletes all the items in the queue.
)

reg               : Tests a Registry function.
(
  init            : Initializes the registry.
    (0:8)         : maximum number of items in registry
  insert          : Adds an item to the registry.
    (0:8)         : item number (0 = nullptr)
    [0:31]        : registrant id
  remove          : Removes an item from the registry.
    (0:8)         : item number (0 = nullptr)
    [0:31]        : registrant id
  at              : Accesses an item in the registry.
    (0:31)        : registrant id
  first           : Returns the first item in the registry.
    [0:31]        : registrant id
  next            : Returns the next item in the registry.
    (0:8)         : item number (0 = nullptr)
  last            : Returns the last item in the registry.
  prev            : Returns the previous item in the registry.
    (0:8)         : item number (0 = nullptr)
  count           : Returns the number of items in the registry.
)

heap              : Tests a heap function.
(
  create          : Creates the heap.
    (t|d|s|p)     : memory type (temporary|dynamic|slab|protected)
    (0:2048)      : heap's size or slab's size
  destroy         : Destroys the heap.
  alloc           : Allocates a block.
    (0:1024)      : block's size
  blocksize       : Returns a block's size.
    <hex>         : block's address
  display         : Displays the heap.
  free            : Frees a block.
    <hex>         : block's address
  validate        : Validates the heap (if 0) or a block.
    <hex>         : block's address
  size            : Returns the heap's size.
  avail           : Returns the number of bytes available.
  overhead        : Returns the number of bytes of overhead.
)

recover           : Tests thread recovery.
(                 : what to recover from...
  abort           : call abort()
  create          : create the recovery thread
  ctortrap        : trap in recovery thread constructor
  dtortrap        : trap in recovery thread destructor
  delete          : delete the recovery thread
    (t|f)         : perform by 'this' (t) or by another thread (f)
  badptr          : dereference an invalid pointer
  divide          : divide by zero
  exception       : raise a software exception
  loop            : enter an infinite loop
  mutexblock      : block while holding a mutex
  mutexexit       : exit while holding a mutex
  mutextrap       : trap while holding a mutex
  stack           : cause a stack overflow
  raise           : raise a signal
    <str>         : signal's name ('SIG...')
  return          : return from the recovery thread
  terminate       : call terminate()
  trap            : cause a trap
    (t|f)         : perform by 'this' (t) or by another thread (f)
    <str>         : signal's name ('SIG...')
  write           : write to read-only data
)

No additional help is available.
nt>quit
nb>nw
nw>help full
ip                : Executes IP functions.
(                 : function to execute...
  localname       : displays this element's host name
  usesipv6        : displays whether this element uses IPv6
  localaddr       : displays this element's IP address
    [t|f]         : retest local address? (default=f)
  localaddrs      : displays this element's IP addresses
  nametoaddr      : maps a host name/service name to an IP address
    <str>         : name of host
    [<str>]       : name of IP service (or port number)
  addrtoname      : maps an IP address to a host name/service name
    <str>         : IP address and optional port: n.n.n.n[:p]
)

ipports           : Displays IP ports.
  [0:65535]       : ipport_t
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

ipservices        : Displays IP services.
  [0:65535]       : index (location in registry)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

status            : Displays system statistics.

include           : Specifies what should be captured by trace tools.
(                 : what to include...
  all             : all activity
  (               : setting...
    on            : on
    off           : off
  )
  faction         : threads in a specific faction
    (0:8)         : faction
  thread          : a specific thread's activity
    (0:99)        : ThreadId
  peer            : messages to/from from a specific peer address/port
    <str>         : IP address and optional port: n.n.n.n[:p]
  port            : messages received by a specific IP port
    (0:65535)     : ipport_t
)

exclude           : Specifies what should not be captured by trace tools.
(                 : what to exclude...
  faction         : threads in a specific faction
    (0:8)         : faction
  thread          : a specific thread's activity
    (0:99)        : ThreadId
  peer            : messages to/from from a specific peer address/port
    <str>         : IP address and optional port: n.n.n.n[:p]
  port            : messages received by a specific IP port
    (0:65535)     : ipport_t
)

query             : Displays the status of trace tools.
(                 : what to query...
  buffer          : trace buffer
  tools           : trace tools
  selections      : all items included/excluded by trace tools
)

clear             : Clears the trace buffer, tools, or selections.
(                 : what to clear...
  buffer          : trace buffer
  tools           : trace tools
  selections      : all items included/excluded by trace tools
  faction         : threads in a specific faction
    (0:8)         : faction
  factions        : all included/excluded factions
  thread          : a specific thread's activity
    (0:99)        : ThreadId
  threads         : all included/excluded threads
  peer            : messages to/from from a specific peer address/port
    <str>         : IP address and optional port: n.n.n.n[:p]
  peers           : all included/excluded peers
  port            : messages received by a specific IP port
    (0:65535)     : ipport_t
  ports           : all included/excluded IP ports
)

No additional help is available.
nw>quit
nb>sb
sb>help full
factories         : Displays factories.
  [0:255]         : FactoryId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

services          : Displays services.
  [0:511]         : ServiceId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

states            : Displays a service's states.
  (0:511)         : ServiceId
  [0:63]          : State::Id (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

events            : Displays a service's event names.
  (0:511)         : ServiceId
  [0:127]         : EventId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

handlers          : Displays a service's event handlers.
  (0:511)         : ServiceId
  [0:255]         : EventHandlerId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

triggers          : Displays a service's triggers.
  (0:511)         : ServiceId
  [0:63]          : TriggerId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

initiators        : Displays the initiators registered with a trigger.
  (0:511)         : ServiceId
  (0:63)          : TriggerId
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

protocols         : Displays protocols.
  [0:255]         : ProtocolId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

signals           : Displays a protocol's signals.
  (0:255)         : ProtocolId
  [0:63]          : SignalId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

parameters        : Displays a protocol's parameters.
  (0:255)         : ProtocolId
  [0:63]          : ParameterId (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

contexts          : Counts or displays contexts.
  [c|s|v]         : 'c'=count 's'=summary 'v'=verbose (default='s')

ssms              : Counts or displays service state machines.
  [0:511]         : ServiceId (default=all)
  [0:63]          : State::Id (default=all)
  [c|s|v]         : 'c'=count 's'=summary 'v'=verbose (default='s')

msgports          : Counts or displays message ports.
  [0:255]         : FactoryId (default=all)
  [c|s|v]         : 'c'=count 's'=summary 'v'=verbose (default='s')

psms              : Counts or displays protocol state machines.
  [0:255]         : FactoryId (default=all)
  [0:63]          : State::Id (default=all)
  [c|s|v]         : 'c'=count 's'=summary 'v'=verbose (default='s')

messages          : Counts or displays messages.
  [0:255]         : ProtocolId (default=all)
  [0:63]          : SignalId (default=all)
  [c|s|v]         : 'c'=count 's'=summary 'v'=verbose (default='s')

timers            : Counts or displays timers.
  [0:255]         : FactoryId (default=all)
  [c|s|v]         : 'c'=count 's'=summary 'v'=verbose (default='s')

invpools          : Displays invoker pools.
  [0:8]           : faction (default=all)
  [c|s|b|v]       : 'c'=count 's'=summary 'b'=brief 'v'=verbose (default='s')

status            : Displays system statistics.

include           : Specifies what should be captured by trace tools.
(                 : what to include...
  all             : all activity
  (               : setting...
    on            : on
    off           : off
  )
  faction         : threads in a specific faction
    (0:8)         : faction
  thread          : a specific thread's activity
    (0:99)        : ThreadId
  peer            : messages to/from from a specific peer address/port
    <str>         : IP address and optional port: n.n.n.n[:p]
  port            : messages received by a specific IP port
    (0:65535)     : ipport_t
  factory         : messages received by a specific factory
    (0:255)       : FactoryId
  protocol        : messages in a specific protocol
    (0:255)       : ProtocolId
  signal          : messages with a specific protocol and signal
    (0:255)       : ProtocolId
    (0:63)        : SignalId
  service         : contexts in which a specific service is running
    (0:511)       : ServiceId
  timers          : timer registry work
)

exclude           : Specifies what should not be captured by trace tools.
(                 : what to exclude...
  faction         : threads in a specific faction
    (0:8)         : faction
  thread          : a specific thread's activity
    (0:99)        : ThreadId
  peer            : messages to/from from a specific peer address/port
    <str>         : IP address and optional port: n.n.n.n[:p]
  port            : messages received by a specific IP port
    (0:65535)     : ipport_t
  factory         : messages received by a specific factory
    (0:255)       : FactoryId
  protocol        : messages in a specific protocol
    (0:255)       : ProtocolId
  signal          : messages with a specific protocol and signal
    (0:255)       : ProtocolId
    (0:63)        : SignalId
  service         : contexts in which a specific service is running
    (0:511)       : ServiceId
  timers          : timer registry work
)

query             : Displays the status of trace tools.
(                 : what to query...
  buffer          : trace buffer
  tools           : trace tools
  selections      : all items included/excluded by trace tools
)

clear             : Clears the trace buffer, tools, or selections.
(                 : what to clear...
  buffer          : trace buffer
  tools           : trace tools
  selections      : all items included/excluded by trace tools
  faction         : threads in a specific faction
    (0:8)         : faction
  factions        : all included/excluded factions
  thread          : a specific thread's activity
    (0:99)        : ThreadId
  threads         : all included/excluded threads
  peer            : messages to/from from a specific peer address/port
    <str>         : IP address and optional port: n.n.n.n[:p]
  peers           : all included/excluded peers
  port            : messages received by a specific IP port
    (0:65535)     : ipport_t
  ports           : all included/excluded IP ports
  factory         : messages received by a specific factory
    (0:255)       : FactoryId
  factories       : all included/excluded factories
  protocol        : messages in a specific protocol
    (0:255)       : ProtocolId
  protocols       : all included/excluded protocols
  signal          : messages with a specific protocol and signal
    (0:255)       : ProtocolId
    (0:63)        : SignalId
  signals         : all included/excluded signals
  service         : contexts in which a specific service is running
    (0:511)       : ServiceId
  services        : all included/excluded services
  timers          : timer registry work
)

kill              : Kills a PSM's context.
  <hex>           : pointer to a PSM

No additional help is available.
sb>quit
nb>st
st>help full
save              : Saves what was captured by trace tools.
(                 : what to save...
  trace           : events captured by tools that are currently ON
    <str>         : filename for output
    [<str>]       : options: t=suppress times; c=don't move ctors
  funcs           : function call statistics
    <str>         : filename for output
  [               : how to sort (default=calls)
    calls         : by number of invocations
    times         : by net time in function
    names         : by function name
  ]
  msc             : message sequence chart
    <str>         : filename for output
    [t|f]         : include internal data structures? (default=f)
)

tests             : Configures or executes tests.
(                 : subcommand...
  prolog          : file to read before executing a test
    [<str>]       : filename (none if omitted)
  epilog          : file to read after a test passes
    [<str>]       : filename (none if omitted)
  recover         : file to read after a test fails
    [<str>]       : filename (epilog if omitted)
  begin           : executes a test (and concludes any previous one)
    <str>         : test filename
  end             : concludes a test
  failed          : records that the current test failed
    <int>         : failure code
    [<str>]       : explanation for failure
  query           : displays pass/fail counts and (if verbose) all tests
    [b|v]         : 'b'=brief 'v'=verbose (default='b')
  retest          : displays tests that have not passed
  erase           : removes a test from the database
    <str>         : test name
  reset           : resets the testing environment
  verify          : enables or disables the >verify command
  (               : setting...
    on            : on
    off           : off
  )
)

corrupt           : Corrupts a data structure for testing purposes.
(                 : what to corrupt...
  pool            : object pool
    (0:255)       : ObjectPoolId
    (0:1024)      : offset into free queue (0 = head)
  context         : first in-use context
)

inject            : Sends a message FROM a factory or one of its PSMs.
(                 : factory abbreviation...
  CO              : CIP Originator (network side)
    (1:16)        : TestSessionId
  (               : signal abbreviation...
    I             : IAM
      r           : RouteResult
        (0:255)   : selector (FactoryId)
        <int>     : identifier (factory-specific)
      <str>       : calling DN (digit string)
      <str>       : called DN (digit string)
      oclg=[<str>] : original calling DN (digit string)
      ocld=[<str>] : original called DN (digit string)
      m=[0:100000] : media.rxFrom: Switch::PortId
    C             : CPG
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    R             : REL
      (0:20)      : cause: Cause::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
  )
  CT              : CIP Terminator (network side)
    (1:16)        : TestSessionId
  (               : signal abbreviation...
    C             : CPG
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    A             : ANM
      m=[0:100000] : media.rxFrom: Switch::PortId
    R             : REL
      (0:20)      : cause: Cause::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
  )
  PX              : Proxy Call (user side)
    (1:16)        : TestSessionId
  (               : signal abbreviation...
    I             : IAM
      r           : RouteResult
        (0:255)   : selector (FactoryId)
        <int>     : identifier (factory-specific)
      <str>       : calling DN (digit string)
      <str>       : called DN (digit string)
      oclg=[<str>] : original calling DN (digit string)
      ocld=[<str>] : original called DN (digit string)
      m=[0:100000] : media.rxFrom: Switch::PortId
    C             : CPG
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    A             : ANM
      m=[0:100000] : media.rxFrom: Switch::PortId
    R             : REL
      (0:20)      : cause: Cause::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
  )
  PS              : POTS Shelf
  (               : signal abbreviation...
    B             : offhook ('begin')
      (0:100000)  : header.port: Switch::PortId
      m=[0:100000] : media.rxFrom: Switch::PortId
    D             : digits
      (0:100000)  : header.port: Switch::PortId
      <str>       : digit string: (0..9|*|#)*
    A             : alerting
      (0:100000)  : header.port: Switch::PortId
    L             : flash ('link')
      (0:100000)  : header.port: Switch::PortId
    E             : onhook ('end')
      (0:100000)  : header.port: Switch::PortId
  )
  PC              : POTS Call (user side)
    (1:16)        : TestSessionId
  (               : signal abbreviation...
    F             : facility
      (0:100000)  : header.port: Switch::PortId
      f           : facility info
        (0:511)   : sid: ServiceId
        (0:255)   : ind: Facility::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
      c=[0:20]    : cause: Cause::Ind
      p=[0:5]     : progress: Progress::Ind
    S             : supervise
      (0:100000)  : header.port: Switch::PortId
      r=[t|f]     : ring on?
      s=[<str>]   : scan: (x|d|f|df)
      m=[0:100000] : media.rxFrom: Switch::PortId
      c=[0:20]    : cause: Cause::Ind
      [f]         : facility info
        (0:511)   : sid: ServiceId
        (0:255)   : ind: Facility::Ind
    L             : lockout
      (0:100000)  : header.port: Switch::PortId
    R             : release
      (0:100000)  : header.port: Switch::PortId
      (0:20)      : cause: Cause::Ind
  )
  PM              : POTS Multiplexer (network side)
    (1:16)        : TestSessionId
  (               : signal abbreviation...
    B             : offhook ('begin')
      (0:100000)  : header.port: Switch::PortId
      m=[0:100000] : media.rxFrom: Switch::PortId
    D             : digits
      (0:100000)  : header.port: Switch::PortId
      <str>       : digit string: (0..9|*|#)*
    A             : alerting
      (0:100000)  : header.port: Switch::PortId
    L             : flash ('link')
      (0:100000)  : header.port: Switch::PortId
    E             : onhook ('end')
      (0:100000)  : header.port: Switch::PortId
    F             : facility
      (0:100000)  : header.port: Switch::PortId
      f           : facility info
        (0:511)   : sid: ServiceId
        (0:255)   : ind: Facility::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
      c=[0:20]    : cause: Cause::Ind
      p=[0:5]     : progress: Progress::Ind
    P             : progress
      (0:100000)  : header.port: Switch::PortId
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    R             : release
      (0:100000)  : header.port: Switch::PortId
      (0:20)      : cause: Cause::Ind
  )
)

verify            : Checks a message RECEIVED by a factory or one of its PSMs.
(                 : factory abbreviation...
  CO              : CIP Originator (network side)
    [0:16]        : TestSessionId (default=0: next message)
  (               : signal abbreviation...
    C             : CPG
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    A             : ANM
      m=[0:100000] : media.rxFrom: Switch::PortId
    R             : REL
      (0:20)      : cause: Cause::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
  )
  CT              : CIP Terminator (network side)
    [0:16]        : TestSessionId (default=0: next message)
  (               : signal abbreviation...
    I             : IAM
      r           : RouteResult
        (0:255)   : selector (FactoryId)
        <int>     : identifier (factory-specific)
      <str>       : calling DN (digit string)
      <str>       : called DN (digit string)
      oclg=[<str>] : original calling DN (digit string)
      ocld=[<str>] : original called DN (digit string)
      m=[0:100000] : media.rxFrom: Switch::PortId
    C             : CPG
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    R             : REL
      (0:20)      : cause: Cause::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
  )
  PX              : Proxy Call (user side)
    [0:16]        : TestSessionId (default=0: next message)
  (               : signal abbreviation...
    I             : IAM
      r           : RouteResult
        (0:255)   : selector (FactoryId)
        <int>     : identifier (factory-specific)
      <str>       : calling DN (digit string)
      <str>       : called DN (digit string)
      oclg=[<str>] : original calling DN (digit string)
      ocld=[<str>] : original called DN (digit string)
      m=[0:100000] : media.rxFrom: Switch::PortId
    C             : CPG
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    A             : ANM
      m=[0:100000] : media.rxFrom: Switch::PortId
    R             : REL
      (0:20)      : cause: Cause::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
  )
  PS              : POTS Shelf
  (               : signal abbreviation...
    S             : supervise
      (0:100000)  : header.port: Switch::PortId
      r=[t|f]     : ring on?
      s=[<str>]   : scan: (x|d|f|df)
      m=[0:100000] : media.rxFrom: Switch::PortId
      c=[0:20]    : cause: Cause::Ind
      [f]         : facility info
        (0:511)   : sid: ServiceId
        (0:255)   : ind: Facility::Ind
    L             : lockout
      (0:100000)  : header.port: Switch::PortId
    R             : release
      (0:100000)  : header.port: Switch::PortId
      (0:20)      : cause: Cause::Ind
  )
  PC              : POTS Call (user side)
    [0:16]        : TestSessionId (default=0: next message)
  (               : signal abbreviation...
    B             : offhook ('begin')
      (0:100000)  : header.port: Switch::PortId
      m=[0:100000] : media.rxFrom: Switch::PortId
    D             : digits
      (0:100000)  : header.port: Switch::PortId
      <str>       : digit string: (0..9|*|#)*
    A             : alerting
      (0:100000)  : header.port: Switch::PortId
    L             : flash ('link')
      (0:100000)  : header.port: Switch::PortId
    E             : onhook ('end')
      (0:100000)  : header.port: Switch::PortId
    F             : facility
      (0:100000)  : header.port: Switch::PortId
      f           : facility info
        (0:511)   : sid: ServiceId
        (0:255)   : ind: Facility::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
      c=[0:20]    : cause: Cause::Ind
      p=[0:5]     : progress: Progress::Ind
    P             : progress
      (0:100000)  : header.port: Switch::PortId
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    R             : release
      (0:100000)  : header.port: Switch::PortId
      (0:20)      : cause: Cause::Ind
  )
  PM              : POTS Multiplexer (network side)
    [0:16]        : TestSessionId (default=0: next message)
  (               : signal abbreviation...
    F             : facility
      (0:100000)  : header.port: Switch::PortId
      f           : facility info
        (0:511)   : sid: ServiceId
        (0:255)   : ind: Facility::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
      c=[0:20]    : cause: Cause::Ind
      p=[0:5]     : progress: Progress::Ind
    P             : progress
      (0:100000)  : header.port: Switch::PortId
      (0:5)       : progress: Progress::Ind
      m=[0:100000] : media.rxFrom: Switch::PortId
    S             : supervise
      (0:100000)  : header.port: Switch::PortId
      r=[t|f]     : ring on?
      s=[<str>]   : scan: (x|d|f|df)
      m=[0:100000] : media.rxFrom: Switch::PortId
      c=[0:20]    : cause: Cause::Ind
      [f]         : facility info
        (0:511)   : sid: ServiceId
        (0:255)   : ind: Facility::Ind
    L             : lockout
      (0:100000)  : header.port: Switch::PortId
    R             : release
      (0:100000)  : header.port: Switch::PortId
      (0:20)      : cause: Cause::Ind
  )
)

No additional help is available.
st>quit
nb>pots
pots>help full
dns               : Displays the profile(s) in a range of DNs.
  (20000:99999)   : DN
  [20000:99999]   : DN

codes             : Displays service codes.

features          : Displays features that can be assigned to a DN.
  [0:63]          : PotsFeature::Id
  [b|v]           : 'b'=brief 'v'=verbose (default='b')

register          : Adds a new DN.
  (20000:99999)   : DN

deregister        : Deletes a DN.
  (20000:99999)   : DN

subscribe         : Assigns a feature to a DN.
  (20000:99999)   : DN
(                 : feature abbreviation...
  sus             : Suspended Service
  boc             : Barring of Outgoing Calls
  htl             : Hot Line
    (20000:99999) : DN
  wml             : Warm Line
    dn=[20000:99999] : DN (must be valid to activate feature)
    to=[3:9]      : timeout (default=5)
  bic             : Barring of Incoming Calls
  cfu             : Call Forwarding Unconditional
    [20000:99999] : DN
  cfb             : Call Forwarding Busy
    [20000:99999] : DN
  cfn             : Call Forwarding No Answer
    dn=[20000:99999] : DN (must be valid to activate feature)
    to=[12:42]    : timeout (default=30)
  cwt             : Call Waiting
  twc             : Three-Way Calling
  cxf             : Call Transfer
)

activate          : Activates a feature assigned to a DN.
  (20000:99999)   : DN
(                 : feature abbreviation...
  wml             : Warm Line
    dn=[20000:99999] : DN (must be valid to activate feature)
    to=[3:9]      : timeout (default=5)
  cfu             : Call Forwarding Unconditional
    [20000:99999] : DN
  cfb             : Call Forwarding Busy
    [20000:99999] : DN
  cfn             : Call Forwarding No Answer
    dn=[20000:99999] : DN (must be valid to activate feature)
    to=[12:42]    : timeout (default=30)
)

deactivate        : Deactivates a feature assigned to a DN.
  (20000:99999)   : DN
(                 : feature abbreviation...
  wml             : Warm Line
  cfu             : Call Forwarding Unconditional
  cfb             : Call Forwarding Busy
  cfn             : Call Forwarding No Answer
)

unsubscribe       : Removes a feature from a DN.
  (20000:99999)   : DN
(                 : feature abbreviation...
  sus             : Suspended Service
  boc             : Barring of Outgoing Calls
  htl             : Hot Line
  wml             : Warm Line
  bic             : Barring of Incoming Calls
  cfu             : Call Forwarding Unconditional
  cfb             : Call Forwarding Busy
  cfn             : Call Forwarding No Answer
  cwt             : Call Waiting
  twc             : Three-Way Calling
  cxf             : Call Transfer
)

reset             : Resets a DN to its initial state.
  (20000:99999)   : DN

tsports           : Displays the circuit(s) in a range of timeswitch ports.
  (0:100000)      : Switch::PortId
  [0:100000]      : Switch::PortId

tones             : Displays tones.
  [0:15]          : Tone::Id (default=all)
  [b|v]           : 'b'=brief 'v'=verbose (default='b')

meps              : Counts or displays media endpoints.
  [0:255]         : FactoryId (default=all)
  [c|s|v]         : 'c'=count 's'=summary 'v'=verbose (default='s')

No additional help is available.
pots>quit
nb>an
an>help full
traffic           : Generates POTS calls for load testing.
(                 : subcommand...
  states          : displays circuit and call states
  rate            : sets call rate
    (0:84490)     : calls per minute
  query           : displays traffic statistics
)

No additional help is available.
an>quit
nb>sn
sn>help full
treatments        : Displays treatments.
  [0:5]           : PotsTreatmentRegistry::QId (default=all)
  [b|v]           : 'b'=brief 'v'=verbose (default='b')

No additional help is available.
sn>quit
nb>ct
ct>help full
import            : Adds a directory to the code base.
  <str>           : directory name
  <str>           : path within SourcePath configuration parameter

show              : Displays library information.
(                 : what to show...
  dirs            : code directories
  failed          : code files that failed to parse
  stats           : parser statistics
)

type              : Displays the items in a set, separated by commas.
  <str>           : a set of code files or directories

list              : Displays the items in a set, one per line.
  <str>           : a set of code files or directories

count             : Counts the items in a set.
  <str>           : a set of code files or directories

countlines        : Counts the number of lines of code.
  <str>           : a set of code files

scan              : Scans files for lines that contain a string.
  <str>           : a set of code files
  <str>           : target string (in quotes; '$' = wildcard)

assign            : Assigns a set of files or directories to a variable.
  <str>           : variable name
  <str>           : a set of code files or directories

purge             : Deletes a variable.
  <str>           : variable name

sort              : Sorts files by build dependency order.
  <str>           : a set of code files

fileinfo          : Displays information about a code file.
  <str>           : filename (including extension)

trace             : Manage tracepoints for >parse command.
(                 : subcommand...
  insert          : add tracepoint
  (               : action at tracepoint...
    break         : breakpoint (at Debug::noop in Context::SetPos)
    start         : start tracing (preconfigure trace using >set)
    stop          : stop tracing
  )
    <str>         : name of source code file
    (0:999999)    : line number (must contain source code)
  remove          : delete tracepoint
  (               : action at tracepoint...
    break         : breakpoint (at Debug::noop in Context::SetPos)
    start         : start tracing (preconfigure trace using >set)
    stop          : stop tracing
  )
    <str>         : name of source code file
    (0:999999)    : line number (must contain source code)
  clear           : delete all tracepoints
  list            : list tracepoints
)

parse             : Parses code files.
  <str>           : options (enter ">help parse full" for details)
  <str>           : file for #define symbols (.txt in input directory)
  <str>           : a set of code files

check             : Checks if code follows C++ guidelines.
  <str>           : filename for output
  <str>           : a set of code files

explain           : Explains a warning generated by >check.
  (1:148)         : warning number

fix               : Interactively fixes warnings detected by >check.
  (0:148)         : warning number from Wnnn (0 = all warnings)
  (t|f)           : prompt before fixing?
  <str>           : a set of code files

format            : Reformats code files.
  <str>           : a set of code files or directories

export            : Exports library information.
  <str>           : filename for output
  [<str>]         : options (enter ">help export full" for details)

rename            : Renames a C++ item.
  <str>           : name of C++ item (enter ">help rename full" for details)
  <str>           : new name for C++ item

linetypes         : Displays the count of line types in the specified files.
  <str>           : filename for output
  <str>           : a set of code files

coverage          : Supports code coverage.
(                 : subcommand...
  load            : reads the database from InputPath/coverage.db.txt
  query           : displays information about the loaded database
  under           : displays functions invoked by fewer than N tests
    (1:10)        : value of N
  erase           : removes a function from the database
    <str>         : name of function to remove
  update          : updates database with modified functions and rerun tests
)

items             : Displays the C++ items in a file, by position.
  <str>           : filename (including extension)

exp               : Performs an experimental test.

Commands in this increment often take an expression as the last parameter.
An expression contains variables and operators.  Variables can be defined
using the >assign command.  The code library also provides the following
variables, which cannot be modified using the >assign command:
   $dirs: directories that have been added to the library by >import
  $files: all code files (headers and implementations) found in $dirs
   $hdrs: headers in $files
   $cpps: implementations (.c*) in $files
   $subs: headers that declare items which are external to the code base
   $exts: headers whose directories were not included by an >import
          (which will cause >parse to fail>
   $vars: all variables (those above, or user-defined)

An expression is evaluated left to right, but parentheses can be used to
override this.  A variable is a set of directories, files, or C++ code
items.  The following notation is used below:
  D: the name of a directory (from >import) or a set of directories
  F: the name of a specific file or a set of files
  C: the name of a C++ code item or a set of such items
  S: any of the above (D, F, or C)

The current operators are listed below.  What the operator returns is shown
on the left; this becomes the input to commands such as >assign and >type.
The type of parameter(s) that the operator expects are shown on the right:
  S: S1 | S2     set union of S1 and S2 (the '|' is optional)
  S: S1 & S2     set intersection of S1 and S2
  S: S1 - S2     set difference between S1 and S2
  F: f S         the files in S
  D: d S         the directories in S
  F: F fn <str>  files in F with the file name <str>*
  F: F ft <str>  files in F with the file type *.<str>
  F: F ms <str>  files in F with a file name that contains <str>
  F: F in D      files in F whose directory is in D
  F: im F     *  implements: for each item declared in F, add the file
                 that defines it, and vice versa
  F: us F        users: files that #include any in F
  F: ub F        used by: files that any in F #include
  F: as F        affecters: ub F, transitively
  F: ab F        affected by: us F, transitively
  F: ca F        common affecters: (as f1) & (as f2) & ... (as fN)
  F: ns F     *  needers: files that also need F in a build
                 (im ab F, transitively)
  F: nb F     *  needed by: files that F also needs in a build
                 (im as F, transitively)
  C: db S     *  declared by: code items declared within S
  C: ds C     *  declarers: code items that declare the items in C
  C: df C     *  definitions: distinct definitions of the items in C
  C: rb S     *  referenced by: code items referenced within S
  C: rs C     *  referencers: code items that reference the items in C

Here is how related unary operators act on the F parameter:
  lower layers      F parameter      higher layers
       |<----ub/as/nb----|----us/ab/ns---->|

The code must have been parsed before operators marked with an asterisk
can be used.  Parsing occurs automatically when required.

For further details, see the article "A Static Analysis Tool for C++"
at www.codeproject.com.
ct>quit
nb>send cout
  OK.