source documentation for initgui.tcl

Bug found by:
Submitted by:
Requested by:
Reviewed by:
Approved by:
Obtained from:

diff --git a/initgui.tcl b/initgui.tcl
index f665e96d5eec9efda002d95c909469c3c9e99764..04a6b909e395371673a740c7076ce183fca49e26 100755 (executable)
--- a/initgui.tcl
+++ b/initgui.tcl
@@ -33,11 +33,74 @@
 # and Technology through the research contract #IP-2003-143.
 #
 
+#****h* imunes/initgui.tcl
+# NAME
+#    initgui.tcl
+# FUNCTION
+#    Initialize GUI. Not included in imunes when opearting in batch mode.
+#****
+
 
 #
 # GUI-related global variables
 #
 
+#****v* initgui.tcl/global variables
+# NAME
+#    global variables
+# FUNCTION
+#    GUI-related global varibles
+# 
+#    * newlink -- helps when creating a new link. If there is no
+#      link currently created, this value is set to an empty string.
+#    * selectbox -- the value of the box representing all the selected items
+#    * selected -- containes the list of node_id's of all selected nodes.
+#    * newCanves -- 
+#
+#    * animatephase -- starting dashoffset. With this value the effect of 
+#      rotating line around selected itme is achived. 
+#    * undolevel -- control variable for undo.
+#    * redolevel -- control variable for redo.
+#    * undolog -- control variable for saving all the past configurations.
+#    * changed -- control variable for indicating that there something changed 
+#      in active configuration.
+#    * badentry -- control variable indicating that there has been a bad entry
+#      in the text box.
+#    * cursorstate -- control variable for animating cursor.
+#    * clock_seconds -- control variable for animating cursor.
+#    * oper_mode -- control variable reresenting operating mode, possible 
+#      values are edit and exec.
+#    * grid -- control variable representing grid distance. All new 
+#      elements on the 
+#      canvas are snaped to grid. Default value is 24.
+#    * sizex -- X size of the canvas.
+#    * sizey -- Y size of the canvas.
+#    * curcanvas -- the value of the current canvas.
+#    * autorearrange_enabled -- control variable indicating is 
+#      autorearrange enabled.
+#
+#    * defLinkColor -- defines the default link color, default link color is set
+#      to red.
+#    * defLinkWidth -- defines the width of the link, default is 2.
+#    * defEthBandwidth -- defines the ethernet bandwidth, default is set to 
+#      100000000.
+#    * defSerBandwidth -- defines the serail link bandwidth, default is 2048000.
+#    * defSerDelay -- defines the serail link delay, default is 2500.
+#    * showIfNames -- control variable for showing interface names, default is 1
+#    * showIfIPaddrs -- control variable for showing interface IPv4 addresses, 
+#      default is 1 (addresses are visible).
+#    * showIfIPv6addrs -- control variable for showing interface IPv4 
+#      addresses, default is 1 (addresses are visible).
+#    * showNodeLabels -- control variable for showing node labels, default is 1.
+#    * showLinkLabels -- control variable for showing link labels, default is 1.
+#
+#    * supp_router_models -- supproted router models, currently xorp quagga 
+#      and static.
+#    * def_router_model -- default router model, set to quagga.
+#****
+
+
+    
 set newlink ""
 set selectbox ""
 set selected ""