| Vince Lehman | d1ee56a | 2015-07-14 17:21:56 -0500 | [diff] [blame] | 1 | Mini-NDN Edit |
| 2 | ============= |
| 3 | |
| 4 | Mini-NDN Edit is a GUI program designed to simplify the creation of Mini-NDN topology |
| 5 | configuration files. Mini-NDN Edit allows the user to build a topology, configure the hosts and |
| 6 | links, and generate a topology file that can be used by Mini-NDN. |
| 7 | |
| 8 |  |
| 9 | |
| 10 | ## Working with topology files |
| 11 | |
| 12 | #### File formats |
| 13 | |
| 14 | There are two file formats used by Mini-NDN edit. |
| 15 | |
| 16 | * ``.mnndn`` files store topology information used by the GUI. Mini-NDN Edit can open and |
| 17 | save ``.mnndn`` files. |
| 18 | |
| 19 | * ``.conf`` files are used by Mini-NDN to create and run topologies. Mini-NDN Edit can generate a |
| 20 | ``.conf`` file from a ``.mnndn`` file. Mini-NDN edit cannot open ``.conf`` files. Please see |
| 21 | [CONFIG-FILE.md](CONFIG.md) for more information on the content and format of ``.conf`` files. |
| 22 | |
| 23 | #### File menu |
| 24 | |
| 25 |  |
| 26 | |
| 27 | * **New** - Erase the current canvas and provide a new empty topology |
| 28 | * **Open** - Open a ``.mnndn`` topology file |
| 29 | * **Save** - Save the current topology as a ``.mnndn`` topology file |
| 30 | * **Generate** - Convert the current topology to a ``.conf`` file runnable by Mini-NDN |
| 31 | * **Run** - Run the current topology in Mini-NDN. The GUI will disappear and Mini-NDN will run on |
| 32 | the command-line. |
| 33 | * **Quit** - Exit Mini-NDN edit |
| 34 | |
| 35 | ## Tools |
| 36 | |
| 37 | ### Cursor tool |
| 38 |  |
| 39 | |
| 40 | The *cursor tool* is used to select and move nodes in the topology. A selected node or link can be |
| 41 | removed from the topology using the ``backspace`` key or by selecting ``edit/cut``. |
| 42 | |
| 43 | ### Host tool |
| 44 |  |
| 45 | |
| Vince Lehman | fbd47c9 | 2015-10-14 16:00:06 -0500 | [diff] [blame^] | 46 | The *host tool* is used to add a host node to the topology. Click on the canvas to create a new host |
| 47 | node at the mouse cursor's position. |
| 48 | |
| 49 | ### Switch tool |
| 50 |  |
| 51 | |
| 52 | The *switch tool* is used to add a switch to the topology. Click on the canvas to create a new |
| 53 | switch at the mouse cursor's position. |
| Vince Lehman | d1ee56a | 2015-07-14 17:21:56 -0500 | [diff] [blame] | 54 | |
| 55 | ### Link tool |
| 56 |  |
| 57 | |
| 58 | The *link tool* is used to connect two nodes with a network link. Click on a node and drag the mouse |
| 59 | cursor to another node to create a link between the two nodes. |
| 60 | |
| 61 | ## Configuration |
| 62 | |
| 63 | #### Editing host information |
| 64 | |
| 65 | To edit a host's information and configuration, right-click on the desired node and select |
| 66 | ``Host Options``. |
| 67 | |
| 68 | The *Host Options* window will include tabs to modify the node's properties as well as the |
| 69 | configuration files for NFD and NLSR on that node. |
| 70 | |
| 71 | *Note: Network, Site, and Router in the NLSR tab are unused in v0.1.0* |
| 72 | |
| 73 |  |
| 74 | |
| 75 | #### Editing link configuration |
| 76 | |
| 77 | To edit a link's configuration, right-click on the desired link and select ``Link Options``. |
| 78 | |
| 79 | The *Link Options* window will allow configuration of the link's bandwidth, delay, and loss rate. |
| 80 | |
| 81 |  |