rstplib/README

   1
   2
   3 The Rapid Spanning Tree Library project contains a  full  implementation
   4 of 802.1s as an library  with API.  There is two  processes,  using this
   5 library: 'bridge' & 'mngr'. First simulates RSTP bridge behavior, second
   6 is dedicated to link/unlink 'bridges' into virtual RSTP domain (VRSTPD).
   7 Both 'bridge' & 'mngr' has its own simple CLI like language of commands;
   8 these  commands  allow  to manage the VRSTPD.  There are  tools to trace
   9 state machine transitions and get traps about drastic changes.
  10
  11 Purpose: studying, debugging, development.
  12
  13 The library may be used in real bridges/routers while bounding to a real
  14 system depending environment.
  15
  16 To run:
  17 1. In one shell run 'mngr'
  18 ./mngr
  19 You will get prompt of 'mngr'; type '?' and get full help of
  20 'mngr' commands.
  21
  22 2. In another shell run bridge instance.
  23 ./bridge
  24 You will get prompt of 'bridge'; type '?' and get full help
  25 of bridge management commands.
  26
  27 3. You may (and should) run a number of bridge instances, each in its
  28 separate shell (this way you will be able manage them).
  29
  30 For example, if there were two bridge instances, you may see examples
  31 of the dialog in files mngr.txt, B5055.txt and B5056.txt.
  32
  33 Note: prompt both of 'mngr' and of 'bridge' instance contains time stamp,
  34 while all these process run onto the same computer, these time stamps
  35 are synchronized.
  36
  37