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