home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsa / bootnet / Docs / Commands next >
Encoding:
Text File  |  1995-06-30  |  8.0 KB  |  305 lines
  1. ============================================================================
  2.                            BootNet commands
  3. ============================================================================
  4.  
  5.  
  6. This section gives details of the * Commands provided by the BootNet module.
  7. These commands may help you in managing your network, and seeing how it is
  8. operating. To use the more esoteric commands you will need a more technical
  9. understanding of AUN than is in these files, particularly its use of
  10. Internet addressing. You'll find this information in volume 5 of the
  11. RISC OS 3 Programmer's Reference Manual.
  12.  
  13. The list below summarises the commands:
  14.  
  15. Command                 Summary
  16. -------                 -------
  17. *Configure BootNet      Sets the configured state for whether or not the AUN
  18.                         software is loaded from ROM
  19. *NetMap                 Displays the current AUN map table
  20. *NetProbe               Reports if a remote station is accessible and active
  21. *NetStat                Displays the current status of any network
  22.                         interface(s) configured for AUN
  23. *Networks               Displays the current AUN routing table
  24. *SetStation             Sets a station's number
  25.  
  26.  
  27. Command syntax
  28. ==============
  29.  
  30. Special symbols are used when defining the syntax for commands:
  31.  
  32. * Angle brackets indicate that you must substitute an actual value. For
  33.   example, <filename> means that you must supply an actual filename.
  34.  
  35. * Braces indicate that the item enclosed is optional. For example, [K] shows
  36.   that you may omit the letter 'K'.
  37.  
  38. * A bar indicates an option. For example 0|1 means that you must supply the
  39.   value 0 or 1.
  40.  
  41.  
  42. * Commands
  43. ==========
  44.  
  45.  
  46. *Configure BootNet
  47. ==================
  48.  
  49. Sets the configured state for whether or not the AUN software is loaded from
  50. ROM
  51.  
  52. Syntax
  53. ------
  54. *Configure BootNet On|Off
  55.  
  56. Use
  57. ---
  58. *Configure BootNet sets the configured state for whether or not the AUN
  59. software is to be loaded from a network interface's ROM or from RISC OS.
  60. Drivers are always loaded from the network interface, irrespective of this
  61. configured setting.
  62.  
  63. You should configure this value to 'On' if the station is to be a client
  64. station using an AUN-configured network, and to 'Off' otherwise (i.e. if the
  65. station is to be a gateway station, or to be connected to a
  66. TCP/IP-configured network).
  67.  
  68. The default state is 'Off'.
  69.  
  70. Example
  71. -------
  72. *Configure BootNet On
  73.  
  74. Related commands
  75. ----------------
  76. None
  77.  
  78.  
  79. *NetMap
  80. =======
  81.  
  82. Displays the current AUN map table
  83.  
  84. Syntax
  85. ------
  86. *NetMap [<net_number>]
  87.  
  88. Parameters
  89. ----------
  90. <net_number>    net number for which to display the map
  91.  
  92. Use
  93. ---
  94. *NetMap displays the current AUN map table either for the specified net, or
  95. for all nets if no parameter is specified. The map table shows the net
  96. number of each net, its name, and its Internet address.
  97.  
  98. Each station obtains the information held in the map table from a gateway's
  99. Map file. Since this file is identical for all gateways on a correctly set
  100. up network, the output from this command is the same for all stations, and
  101. only varies when the network's layout is altered.
  102.  
  103. Examples
  104. --------
  105. *NetMap 129
  106. 129     science                 1.3.129.x
  107.  
  108. *NetMap
  109. 1       compsciA                1.1.1.x
  110. 2       compsciA                1.1.2.x
  111. 3       compsciA                1.1.3.x
  112. 128     compsciB                1.2.128.x
  113. 129     science                 1.3.129.x
  114. 4       art                     1.4.4.x
  115. 130     business                1.5.130.x
  116. 131     backbone                1.6.131.x
  117.  
  118. Related commands
  119. ----------------
  120. *Networks
  121.  
  122.  
  123. *NetProbe
  124. =========
  125.  
  126. Reports if a remote station is accessible and active
  127.  
  128. Syntax
  129. ------
  130. *NetProbe <net_number>.<station_number>
  131.  
  132. Parameters
  133. ----------
  134. <net_number>              remote station's net number
  135.  
  136. <station_number>          remote station's station number
  137.  
  138. Use
  139. ---
  140. *NetProbe reports if a remote station is accessible and active, and hence
  141. can be reached from the local station and network. This command does so by
  142. sending a control message to the specified station and awaiting a reply.
  143.  
  144. Examples
  145. --------
  146. *NetProbe 128.135
  147. Station present
  148.  
  149. *NetProbe 128.201
  150. Station not present
  151.  
  152. Related commands
  153. ----------------
  154. None
  155.  
  156.  
  157. *NetStat
  158. ========
  159.  
  160. Displays the current status of any network interface(s) configured
  161. for AUN
  162.  
  163. Syntax
  164. ------
  165. *NetStat [a]
  166.  
  167. Parameters
  168. ----------
  169. a               give all information, rather than simplified version
  170.  
  171. Use
  172. ---
  173. *NetStat displays the current status of any network interface(s)
  174. configured for AUN. The optional parameter a gives extra information,
  175. including traffic counters and full IP addresses. Known network numbers
  176. which are marked with an asterisk ('*') represent nets in a directly
  177. connected Econet network.
  178.  
  179. Example
  180. -------
  181. *NetStat a
  182.  
  183. Native Econet     0.5                   information for native Econet
  184.  
  185. Interface         EconetA               information for first AUN interface
  186.  
  187. AUN Station       4.5
  188.  
  189. Full address      1.4.4.5
  190.  
  191. Interface         Ether2                information for second AUN interface
  192.  
  193. AUN Station       131.5
  194.  
  195. Full address      1.6.131.5
  196.  
  197. Known nets        1     2     3    *4     128   129   130
  198.                   131
  199.                                         information below only given if
  200.                                         optional parameter a supplied
  201.  
  202. TX stats          Data=0, Immediate=2, Imm_Reply=0, Retry=0
  203.                   Error=20, Data_Ack=5, Data_Rej=0, Broadcast=10
  204.                   (local=0, global=5)
  205.  
  206. RX stats          Data=5, Immediate=0, Broadcast=0, Discard=0
  207.                   Retry=0, Error=0, Data_Ack=0, Data_Rej=0
  208.                   Imm_Reply=2, Reply_Rej=0
  209.  
  210. Module status     0140
  211.  
  212. Related commands
  213. ----------------
  214. None
  215.  
  216.  
  217. *Networks
  218. =========
  219.  
  220. Displays the current AUN routing table
  221.  
  222. Syntax
  223. ------
  224. *Networks
  225.  
  226. Use
  227. ---
  228. *Networks displays the current AUN routing table. This shows the names of
  229. any local networks (i.e. those to which the station is directly connected).
  230. It also shows the names of those remote networks that the station knows how
  231. to reach, and the gateway that it will use to do so
  232.  
  233. The AUN routing table alters as gateways start up and shut down, and so the
  234. information returned by this command varies as the state of the network
  235. alters.
  236.  
  237. Examples
  238. --------
  239. *Networks
  240.                                                 a client on the 'backbone'
  241. art             gateway=131.5                   connected to the 'art' net
  242. by backbone        local                        gateway 131.5
  243.  
  244. *Networks
  245.                                                 a gateway between the 'art'
  246. art             local                           net and the 'backbone' net
  247. backbone        local                           (i.e. station 131.5 above)
  248.  
  249. Related commands
  250. ----------------
  251. *NetMap
  252.  
  253.  
  254. *SetStation
  255. ===========
  256.  
  257. Sets a station's number
  258.  
  259. Syntax
  260. ------
  261. *SetStation [<station_number>]
  262.  
  263. Parameters
  264. ----------
  265. <station_number>          a station number in the range 2 - 254
  266.  
  267. Use
  268. ---
  269. *SetStation sets a station's number, storing it in CMOS RAM so it is not
  270. lost when the computer is switched off. If no number is specified then one
  271. is prompted for. If the new station number given is invalid, then the
  272. current station number is preserved.
  273.  
  274. This command is not a part of the supplied software, to prevent users from
  275. altering station numbers. It is instead supplied as a separate program on
  276. the Support disc of the Level 4 FileServer distribution, in the ArthurLib
  277. directory. You can run this program from the desktop by double-clicking on
  278. its icon; a window shows the prompt for the station number.
  279.  
  280. The number is stored in the same location as is used by Econet to store
  281. station numbers. If the station is connected to both an AUN network and a
  282. native Econet, it will accordingly use the same station number for both
  283. types of network. Altering the station number for one network will alter it
  284. for the other.
  285.  
  286. You can find out a station's current station number by typing at a command
  287. line:
  288.  
  289. *Help Station                   if Econet is fitted
  290.  
  291. or:
  292.  
  293. *NetStat                        if AUN is installed
  294.  
  295. Examples
  296. --------
  297. *SetStation 20
  298.  
  299. *SetStation
  300. New station number: 20
  301.  
  302. Related commands
  303. ----------------
  304. *Help Station
  305.