home *** CD-ROM | disk | FTP | other *** search
/ Collection of Internet / Collection of Internet.iso / msdos / ka9q / docs / ka9qnos.nr < prev    next >
Encoding:
Text File  |  1991-06-02  |  138.3 KB  |  3,573 lines

  1. .ds RF May 28, 1991
  2. .TL
  3. NET User Reference Manual (NOS Version)
  4. .AU
  5. Phil Karn, KA9Q
  6. .nr LL 6.5i
  7. .NH 1
  8. The NET.EXE Program
  9. .LP
  10. The MS-DOS executable file \fBnet.exe\fP provides Internet (TCP/IP),
  11. NET/ROM and AX.25
  12. facilities.  Because it has an internal multitasking operating system,
  13. \fBnet.exe\fP can act simultaneously as a client, a server and a packet switch
  14. for all three sets of protocols. That is, while a local user accesses remote
  15. services, the system can also provide those same services to remote users
  16. while also switching IP, NET/ROM and AX.25 packets and frames between other
  17. client and server nodes.
  18. .LP
  19. The keyboard and display is used by the local operator to control both host
  20. and gateway level functions, for which a number of commands are provided.
  21. .NH 2
  22. Installation
  23. .LP
  24. \fBNet.exe\fP uses the following directory structure:
  25. .DS
  26. /spool
  27. /spool/help
  28. /spool/mail
  29. /spool/mqueue
  30. /spool/rqueue
  31. /spool/news
  32. .DE
  33. .LP
  34.  
  35. By default, the /spool directory is placed in the root directory of the
  36. current drive. However, a subdirectory may be specified with the 
  37. \fB-d\fP command-line option described below. If a subdirectory is
  38. given, the
  39. \fBalias, autoexec.net, dialer, domain.txt\fP and \fBftpusers\fP
  40. configuration files must also be located there.
  41. .LP
  42. The "/spool" directory and its sub-directories are used by the bbs,
  43. SMTP and NNTP services.
  44. The \fBareas, forward.bbs, history, mail.log, rewrite\fP and \fBsignatur\fP
  45. configuration files are located here.
  46. .LP
  47. The \fBalias, forward.bbs\fP and \fBrewrite\fP files are described in the
  48. document "maildoc", which should be found at the same location as this file.
  49. .NH 2
  50. net [-b] [-s <sockets>] [-d <directory>] [<startup file>]
  51. .NH 3
  52. -b
  53. .LP
  54. The \fB-b\fP option specifies the use of BIOS for console output;
  55. the default is to write directly to the video display buffer. Use
  56. this option if you are running under a windowing package and have
  57. trouble with output "bleeding through" on top of other windows.
  58. .NH 3
  59. -s
  60. .LP
  61. The \fB-s\fP option specifies the size of the
  62. \fIsocket\fP array to be allocated within \fBnet.exe\fP. This limits the number
  63. of network connections that may exist simultaneously.
  64. The default is 40.
  65. .NH 3
  66. -d
  67. .LP
  68. The \fB-d\fP option allows the user to specify a directory for the
  69. configuration and spool files; it defaults to the root directory of the system.
  70. .NH 3
  71. Startup file
  72. .LP
  73. After all command-line options, the name of a startup file may be specified.
  74. If no startup file is specified, \fBnet.exe\fP attempts to open a file named
  75. \fBautoexec.net\fP in the configuration directory of the current drive.
  76. If the file exists,
  77. it is read and executed as though its contents were typed on the
  78. console as commands.
  79. (See the \fBCommands\fP chapter.)
  80. This feature is useful for attaching communication
  81. interfaces, configuring network addresses, and starting the various services.
  82. .NH 1
  83. Console modes
  84. .LP
  85. The console may be in one of two modes: \fIcommand mode\fP and
  86. \fIconverse mode\fP.
  87. In \fIcommand mode\fP, the prompt \fBnet>\fP is displayed and any of the
  88. commands described in the \fBCommands\fP chapter may be entered.
  89. In \fIconverse mode\fP,
  90. keyboard input is processed according to the \fIcurrent session\fP.
  91. .LP
  92. Sessions come in many types, including \fITelnet, FTP, AX25,
  93. NETROM, Ping, More, Hopcheck\fP and \fITip\fP.
  94. In a Telnet, AX25, NETROM, or Tip session, keyboard input is sent to the
  95. remote system and any output from the remote system is displayed on the
  96. console.  In a FTP session, keyboard input is first examined to see if
  97. it is a known local command; if so it is executed locally.  If not, it
  98. is "passed through" to the remote FTP server.
  99. (See the \fBFTP Subcommands\fP chapter).
  100. In a Ping session the user may test the path to a
  101. remote site, and in a More session, the user may examine a local
  102. file. A Hopcheck session is used to trace the path taken by packets
  103. to reach a specified destination. A Tip session provides a "dumb terminal"
  104. service that bypasses all network protocols.
  105. .LP
  106. The keyboard also has \fIcooked\fP and \fIraw\fP states.
  107. In \fIcooked\fP state, input
  108. is line-at-a-time; the user may use the line editing characters ^U, ^R
  109. and backspace to erase the line, redisplay the line and erase the last
  110. character, respectively.  Hitting either return or line feed passes the
  111. complete line up to the application.
  112. In \fIraw\fP state, each character is
  113. immediately passed to the application as it is typed.
  114. .LP
  115. The keyboard is always in \fIcooked\fP state in command mode.
  116. It is also \fIcooked\fP in converse mode on an AX25, FTP or NET/ROM session.
  117. In a Telnet session it depends on
  118. whether the remote end has issued (and the local end has accepted) the
  119. Telnet WILL ECHO option (see the \fBecho\fP command).
  120. .LP
  121. On the IBM-PC, the user may escape back to \fIcommand mode\fP
  122. by hitting the F10 key.
  123. On other systems, the user must enter the \fIescape\fP character,
  124. which is by default control-] (hex 1d, ASCII GS).
  125. (Note that this is distinct from the ASCII character of the same name).
  126. The \fIescape\fP character can be changed (see the \fBescape\fP command).
  127. .LP
  128. In the IBM PC version, each session (including the command "session")
  129. has its own screen.
  130. When a new session is created,
  131. the command display is saved in memory and the screen is cleared.
  132. When the command escape key (usually F10) is hit,
  133. the current session screen is saved and the command screen is restored.
  134. When a session is resumed,
  135. its screen is restored exactly as it appeared when it was last current.
  136. .NH 1
  137. Commands
  138. .LP
  139. This chapter describes the commands recognized in command mode,
  140. or within a startup file such as \fBautoexec.net\fP.
  141. These are given in the following notation:
  142. .DS
  143. command
  144. command literal_parameter
  145. command subcommand <parameter>
  146. command [<optional_parameter>]
  147. command a | b
  148. .DE
  149. .LP
  150. Many commands take subcommands or parameters, which may be optional or
  151. required. In general, if a required subcommand or parameter is omitted,
  152. an error message will summarize the available subcommands or required
  153. parameters.  (Giving a '?' in place of the subcommand will also generate the
  154. message.  This is useful when the command word alone is a valid command.) If
  155. a command takes an optional value parameter, issuing the command without the
  156. parameter generally displays the current value of the variable. (Exceptions
  157. to this rule are noted in the individual command descriptions.)
  158. .LP
  159. Two or more parameters separated by vertical bar(s) denote a choice between
  160. the specified values.  Optional parameters are shown enclosed in [brackets],
  161. and a parameter enclosed in <angle brackets> should be replaced with an
  162. actual value or string.  For example, the notation \fB<hostid>\fP denotes an
  163. actual host or gateway, which may be specified in one of two ways:
  164. as a numeric IP address in dotted decimal notation (eg. 44.0.0.1), or
  165. as a symbolic name listed in the file \fBdomain.txt\fP.
  166. .LP
  167. All commands and many subcommands may be abbreviated. You only need
  168. type enough of a command's name to distinguish it from others that
  169. begin with the same series of letters. Parameters, however, must be
  170. typed in full.
  171. .LP
  172. Certain FTP subcommands (eg. \fBput, get, dir\fP, etc) are recognized
  173. only in converse mode with the appropriate FTP session; they are not
  174. recognized in command mode.
  175. (See the \fBFTP Subcommands\fP chapter.)
  176. .LP
  177. Note that certain commands may have been configured out of a given
  178. copy of \fBnet.exe\fP to save disk and memory.
  179. If a command has been configured out, it will not appear in the list
  180. produced by the "?" command, nor will it be recognized by the command
  181. interpreter.
  182. .NH 2
  183. <CR>
  184. .LP
  185. Entering a carriage return (empty line) while in command mode puts you in
  186. converse mode with the current session. If there is no current session,
  187. \fBnet.exe\fP remains in command mode.
  188. .NH 2
  189. !
  190. .LP
  191. An alias for the \fBshell\fP command.
  192. .NH 2
  193. #
  194. .LP
  195. Commands starting with the hash mark (#) are ignored. This is mainly useful
  196. for comments in the \fBautoexec.net\fP file.
  197. .NH 2
  198. abort [<session #>]
  199. .LP
  200. Abort a FTP \fBget, put\fP or \fBdir\fP operation in progress. If issued without
  201. an argument, the current session is aborted. (This command works only
  202. on FTP sessions.) When receiving a file, \fBabort\fP
  203. simply resets the data connection; the next incoming data packet will generate
  204. a TCP RST (reset) response to clear the remote server.  When
  205. sending a file, \fBabort\fP sends a premature end-of-file. Note that in both
  206. cases \fBabort\fP will leave a partial copy of the file on the destination
  207. machine, which must be removed manually if it is unwanted.
  208. .NH 2
  209. arp
  210. .LP
  211. Display the Address Resolution Protocol table that maps IP addresses
  212. to their subnet (link) addresses on subnetworks capable of broadcasting.
  213. For each IP address entry the subnet type (eg. Ethernet, AX.25), subnet
  214. address and time to expiration is shown. If the link address is currently
  215. unknown, the number of IP datagrams awaiting resolution is also shown.
  216. .NH 3
  217. arp add <hostid> ethernet | ax25 <ethernet address> | <ax25_address>
  218. .LP
  219. Add a permanent entry to the table. It will not time out
  220. as will an automatically-created entry, but must be removed with the
  221. \fBarp drop\fP command.
  222. .NH 3
  223. arp publish <hostid> ethernet | ax25 <ethernet address> | <ax25_address>
  224. .LP
  225. This command is similar to the \fBarp add\fP command, but
  226. system will also respond to any ARP request it sees on the network that seeks
  227. the specified address.  \fIUse this feature with great care.\fP
  228. .NH 3
  229. arp drop <hostid> ax25 | ethernet
  230. .LP
  231. Remove the specified entry from the ARP table.
  232. .NH 3
  233. arp flush
  234. .LP
  235. Drop all automatically-created entries in the ARP table. Permanent
  236. entries are not affected.
  237. .NH 2
  238. asystat
  239. .LP
  240. Display statistics on attached asynchronous communications interfaces
  241. (8250 or 16550A), if any. The display for each port consists of three
  242. lines. The first line gives the port label and the configuration flags;
  243. these indicate whether the port is a 16550A chip, the \fItrigger character\fP
  244. if any,
  245. whether CTS flow control is enabled,
  246. whether RLSD (carrier detect) line control is enabled,
  247. and the speed in bits per second.
  248. (Receiving the \fItrigger character\fP causes the driver
  249. to signal upper layer software that data is ready;
  250. it is automatically set to the appropriate frame end
  251. character for SLIP, PPP and NRS lines.)
  252. .LP
  253. The second line of the status display shows receiver (RX) event counts: the
  254. total number of receive interrupts, received characters, receiver overruns
  255. (lost characters) and the receiver \fIhigh water mark\fP.
  256. The high water mark is
  257. the maximum number of characters ever read from the device during a single
  258. interrupt. This is useful for monitoring system interrupt latency margins as
  259. it shows how close the port hardware has come to overflowing due to the
  260. inability of the CPU to respond to a receiver interrupt in time. 8250 chips
  261. have no FIFO, so the high water mark cannot go higher than 2 before overruns
  262. occur. The 16550A chip, however, has a 16-byte receive FIFO which the
  263. software programs to interrupt the CPU when the FIFO is one-quarter full.
  264. The high water mark should typically be 4 or 5 when a 16550A is used; higher
  265. values indicate that the CPU has at least once been slow to respond
  266. to a receiver interrupt.
  267. .LP
  268. When the 16550A is used, a count of FIFO timeouts is also displayed on the
  269. RX status line. These are generated automatically by the 16550A when three
  270. character intervals go by with more than 0 but less than 4 characters in the
  271. FIFO. Since the characters that make up a SLIP or NRS frame are normally
  272. sent at full line speed,
  273. this count will usually be a lower bound on the number of frames received
  274. on the port, as only the last fragment of a frame generally results
  275. in a timeout (and then only when the frame is not a multiple of 4 bytes
  276. long.)
  277. .LP
  278. Finally, the software fifo overruns and high water mark are displayed.
  279. These indicate whether the <bufsize> parameter on the attach command
  280. needs to be adjusted (see the \fBAttach Commands\fP chapter).
  281. .LP
  282. The third line shows transmit (TX) statistics,
  283. including a total count of transmit interrupts, transmitted characters,
  284. the length of the transmit queue in bytes,
  285. the number of status interrupts,
  286. and the number of THRE timeouts.
  287. The status interrupt count will be zero
  288. unless CTS flow control or RLSD line control has been enabled.
  289. The THRE timeout is a stopgap measure to catch lost transmit interrupts,
  290. which seem to happen when there is a lot of activity
  291. (ideally, this will be zero).
  292. .NH 2
  293. attach <hw type> ...
  294. .LP
  295. Configure and attach a hardware interface to the system.
  296. Detailed instructions for each driver are in the \fBAttach Commands\fP chapter.
  297. An easy way to obtain a summary of the parameters required for a given device
  298. is to issue a partial attach command (eg. \fBattach packet\fP).
  299. This produces a usage message giving the complete command format.
  300. .NH 2
  301. ax25 ...
  302. .LP
  303. These commands are used to control the AX.25 amateur radio link level
  304. protocol.
  305. .NH 3
  306. ax25 blimit [<count>]
  307. .LP
  308. Display or set the AX25 retransmission backoff limit. Normally each
  309. successive AX25 retransmission is delayed by twice the value of the
  310. previous interval; this is called \fIbinary exponential backoff\fP.
  311. When the backoff reaches the blimit setting it is held at that value,
  312. which defaults to 30.
  313. To prevent the possibility of "congestive collapse" on a loaded channel,
  314. blimit should be set at least as high as the number of stations sharing
  315. the channel.
  316. Note that this is applicable only on actual AX25 connections; UI frames
  317. will never be retransmitted by the AX25 layer.
  318. .NH 3
  319. ax25 dest
  320. .LP
  321. Display the AX25 destination monitoring database. Each callsign seen in
  322. the destination field of
  323. an AX25 frame is displayed (most recent first), along with the time
  324. since it was last referenced. The time since the same callsign was last
  325. seen in the source field of an AX25 frame on the same interface is also
  326. shown. If the callsign has never been seen in the source field of
  327. a frame, then this field is left blank. (This indicates that the
  328. destination is either a multicast address or a "hidden station".)
  329. .NH 3
  330. ax25 digipeat [on | off]
  331. .LP
  332. Display or set the digipeater enable flag.
  333. .NH 3
  334. ax25 flush
  335. .LP
  336. Clear the AX.25 "heard" list (see \fBax25 heard\fP).
  337. .NH 3
  338. ax25 heard
  339. .LP
  340. Display the AX.25 "heard" list. For each interface that is configured to
  341. use AX.25, a list of all callsigns heard through that interface is
  342. shown, along with a count of the number of packets heard from each station
  343. and the interval, in hr:min:sec format, since each station was last heard.
  344. The list is sorted in most-recently-heard order.
  345. The local station is included in the listing; the packet count reflects
  346. the number of packets transmitted. This count will be correct whether
  347. or not the modem monitors its own transmissions.
  348. .NH 3
  349. ax25 irtt [<milliseconds>]
  350. .LP
  351. Display or set the initial value of smoothed round trip time to be used
  352. when a new AX25 connection is created. The value is in milliseconds.
  353. The actual round trip time will be learned by measurement once the
  354. connection has been established.
  355. .NH 3
  356. ax25 kick <axcb>
  357. .LP
  358. Force a retransmission on the specified AX.25 control block.
  359. .NH 3
  360. ax25 maxframe [<count>]
  361. .LP
  362. Establish the maximum number of frames that will be allowed to remain
  363. unacknowledged at one time on new AX.25 connections. This number cannot
  364. be greater than 7.
  365. .NH 3
  366. ax25 mycall [<call>]
  367. .LP
  368. Display or set the local AX.25 address.  The standard format is used
  369. (eg. KA9Q-0 or WB6RQN-5).
  370. This command must be given before any \fBattach\fP commands
  371. using AX.25 mode are given.
  372. .NH 3
  373. ax25 paclen [<size>]
  374. .LP
  375. Limit the size of I-fields on new AX.25 connections.  If IP
  376. datagrams or fragments larger than this are transmitted, they will be
  377. transparently fragmented at the AX.25 level, sent as a series of I
  378. frames, and reassembled back into a complete IP datagram or fragment at
  379. the other end of the link. To have any effect on IP datagrams,
  380. this parameter should be less than or equal to
  381. the MTU of the associated interface.
  382. .NH 3
  383. ax25 pthresh [<size>]
  384. .LP
  385. Display or set the poll threshold to be used for new AX.25 Version 2
  386. connections.  The poll threshold controls retransmission behavior as
  387. follows. If the oldest unacknowledged I-frame size is less than the poll
  388. threshold, it will be sent with the poll (P) bit set if a timeout occurs.
  389. If the oldest unacked I-frame size is equal to or greater than the
  390. threshold, then a RR or RNR frame, as appropriate, with the poll bit set
  391. will be sent if a timeout occurs.
  392. .LP
  393. The idea behind the poll threshold is that the extra time needed to send a
  394. "small" I-frame instead of a supervisory frame when polling after a timeout
  395. is small, and since there's a good chance the I-frame will have to be sent
  396. anyway (i.e., if it were lost previously) then you might as well send it as
  397. the poll. But if the I-frame is large, send a supervisory (RR/RNR) poll
  398. instead to determine first if retransmitting the oldest unacknowledged
  399. I-frame is necessary; the timeout might have been caused by a lost
  400. acknowledgement.  This is obviously a tradeoff, so experiment with the
  401. poll threshold setting. The default is 128 bytes, one half the default
  402. value of \fBpaclen\fP.
  403. .NH 3
  404. ax25 reset <axcb>
  405. .LP
  406. Delete the AX.25 connection control block at the specified address.
  407. .NH 3
  408. ax25 retry [<count>]
  409. .LP
  410. Limit the number of successive unsuccessful retransmission attempts on
  411. new AX.25 connections. If this limit is exceeded, link re-establishment
  412. is attempted. If this fails \fBretry\fP times, then the connection
  413. is abandoned and all queued data is deleted. A value of 0 means "infinity";
  414. the retry limit is disabled.
  415. retry 
  416. .NH 3
  417. ax25 route
  418. .LP
  419. Display the AX.25 routing table that
  420. specifies the digipeaters to be used in reaching a given station.
  421. .NH 4
  422. ax25 route add <target> [digis ... ]
  423. .LP
  424. Add an entry to the AX.25 routing table.  An automatic \fBax25
  425. route add\fP is executed if digipeaters are specified in an AX25 \fBconnect\fP
  426. command, or if a connection is received from a remote station via
  427. digipeaters. Such automatic routing table entries won't override locally
  428. created entries, however.
  429. .NH 4
  430. ax25 route drop <target>
  431. .LP
  432. Drop an entry from the AX.25 routing table.
  433. .NH 3
  434. ax25 status [<axcb>]
  435. .LP
  436. Without an argument, display a one-line summary of each AX.25 control block.
  437. If the address of a particular control block is specified, the contents of
  438. that control block are dumped in more detail. Note that the send queue units
  439. are frames, while the receive queue units are bytes.
  440. .NH 3
  441. ax25 t3 [<milliseconds>]
  442. .LP
  443. Display or set the AX.25 idle "keep alive" timer. Value is in milliseconds.
  444. .NH 3
  445. ax25 version [1 | 2]
  446. .LP
  447. Display or set the version of the AX.25 protocol to attempt to use on
  448. new connections. The default is 1 (the version
  449. that does not use the poll/final bits).
  450. .NH 3
  451. ax25 window [<size>]
  452. .LP
  453. Set the number of bytes that can be pending on an AX.25 receive queue
  454. beyond which I frames will be answered with RNR (Receiver Not Ready)
  455. responses.  This presently applies only to suspended interactive AX.25
  456. sessions, since incoming I-frames containing network (IP, NET/ROM) packets
  457. are always processed immediately and are not placed on the receive queue.
  458. However, when an AX.25 connection carries both interactive
  459. and network packet traffic, an RNR generated because of
  460. backlogged interactive traffic will also stop network
  461. packet traffic from being sent.
  462. .NH 2
  463. BOOTP
  464. .LP
  465. The bootp client and server are added to KA9Q to provide automatic
  466. configuration capabilities.  With this suite of extensions, a KA9Q host
  467. can automatically configure its IP address, subnet mask, broadcast
  468. address, host name, the default gateway, the name servers, and default
  469. boot file.  This simplifies host configuration.
  470. .LP
  471. The bootp server supports dynamic IP address assignment.  If a bootp
  472. request is made by a host to the server, and the server doesn't have a
  473. static record for the PC making the request, an IP address may be
  474. assigned from a list of dynamic addresses.  This simplifies server
  475. configuration, so that machines don't require prior IP address
  476. assignment.  This is useful in environments such as university
  477. dormitories, where network service is provided, and the computers
  478. configurations change frequently.  When the server list of free
  479. addresses reaches a minimum threshold, it will begin attempts to
  480. reclaim the address.
  481. .LP
  482. The bootp client and server code are written according to RFC 951 and
  483. 1048.
  484. .NH 3
  485. bootp  [<net_name>] [silent] [noisy]
  486. .LP
  487. Send a request to a bootp server, and wait for a reply.  On receipt
  488. of the server reply, the information is used to configure the host.  If
  489. a reply is not received, the command will time out. Without arguments,
  490. \fBbootp\fP sends a request to the first interface in the interface list.
  491. .LP
  492. This command requires that there exist a routing entry for the
  493. IP broadcast address
  494. 255.255.255.255 pointing to the appropriate interface. If the
  495. interface uses ARP, there must also be an ARP entry that maps that address
  496. to the appropriate link level broadcast address.
  497. For example, if you have an Ethernet interface named "ethernet", use the
  498. following commands before the \fBbootp\fP command:
  499. .IP
  500. route add 255.255.255.255 ethernet
  501. .sp
  502. arp add 255.255.255.255 ether ff:ff:ff:ff:ff:ff
  503. .LP
  504. The following \fBbootp\fP subcommands are available:
  505. .NH 4
  506. bootp <net_name>
  507. .LP
  508. Send a request over the specified network.
  509. .NH 4
  510. bootp silent
  511. .LP
  512. Set bootp so that it will not print the configuration.
  513. .NH 4
  514. bootp noisy
  515. .LP
  516. Set bootp so that it will print the configuration.
  517. .NH 3
  518. bootpd [start] [stop] [dns] [dynip] [host] [rmhost] [homedir] [defaultfile] [logfile] [logscreen]
  519. .LP
  520. This command starts and stops the bootp server, and sets the
  521. configuration for the information it will provide in replies.  If the
  522. file \fBbootptab\fP exists, it will read the file for configuration
  523. information.  On receipt of a request, if \fBbootptab\fP has been changed,
  524. the server will reread the file for the changed configuration.
  525. The following subcommands are available:
  526. .NH 4
  527. bootpd start
  528. .LP
  529. Start the bootp server, reading from the file bootptab
  530. for configuration information.
  531. .NH 4
  532. bootpd stop
  533. .LP
  534. Stop the bootp server.
  535. .NH 4
  536. bootpd dns
  537. .LP
  538. Print the address of the domain name servers supplied in replies.
  539. .NH 4
  540. bootpd dns <IP addr of domain name server>...
  541. .LP
  542. Set the addresses.
  543. .NH 4
  544. bootpd dynip
  545. .LP
  546. Print the range and use of the dynamic IP address.
  547. .NH 4
  548. bootpd dynip <net_name> <IP address> <IP address>
  549. .LP
  550. Set the range of IP address to be used for network
  551. netname.  These address will be supplied to hosts that
  552. are not found in the static record.
  553. .NH 4
  554. bootpd dynip <netname> off
  555. .LP
  556. Turn off dynamic ip for network interface netname.
  557. .NH 4
  558. bootpd host
  559. .LP
  560. Print the information in the static host table.
  561. .NH 4
  562. bootpd host <hostname>  ethernet|ax25 <ethernet addr>|<ax25 addr> <ip addr> [boot file]
  563. .LP
  564. Add a host to the host table.  The LANSTAR packet
  565. drivers provide an Ethernet interface to upper layer
  566. applications, so configure a LANSTAR network as an
  567. Ethernet.
  568. .NH 4
  569. bootpd rmhost <hostname>
  570. .LP
  571. Remove host <hostname> from the static host tables.
  572. .NH 4
  573. bootpd homedir
  574. .LP
  575. Print the default directory for the bootp file name
  576. used when the bootp file is not specified in the static
  577. host record, and when dynamic addresses are supplied.
  578. Default is the null string.
  579. .NH 4
  580. bootpd homedir <directory name>
  581. .LP
  582. Set the default directory.
  583. .NH 4
  584. bootpd defaultfile
  585. .LP
  586. Print the default file for the bootp file name used
  587. when the bootp file is not specified in the static host
  588. record, and when dynamic addresses are supplied.
  589. Default is the null string.
  590. .NH 4
  591. bootpd defaultfile <filename>
  592. .LP
  593. Set the default file.
  594. .NH 4
  595. bootpd logfile
  596. .LP
  597. Print the status of logging to a log file.
  598. .NH 4
  599. bootpd logfile <filename | default> on|off
  600. .LP
  601. Sets the file for logging to <filename> or the default,
  602. bootplog.  Turn logging to that file on or off.
  603. .NH 4
  604. bootpd logscreen
  605. .LP
  606. Print the status of logging to the screen.
  607. .NH 4
  608. bootpd logscreen on|off
  609. .LP
  610. Turn logging to the screen on or off.
  611. .NH 2
  612. cd [<dirname>]
  613. .LP
  614. Change the current working directory, and display the new setting.
  615. Without an argument, \fBcd\fP simply displays the current directory
  616. without change.
  617. The \fBpwd\fP command is an alias for \fBcd\fP.
  618. .NH 2
  619. close [<session>]
  620. .LP
  621. Close the specified session; without an argument, close the current session.
  622. On an AX.25 session, this command initiates a disconnect.  On a FTP or
  623. Telnet session, this command sends a FIN (i.e., initiates a close) on the
  624. session's TCP connection.  This is an alternative to asking the remote
  625. server to initiate a close (\fBQUIT\fP to FTP, or the logout command appropriate
  626. for the remote system in the case of Telnet).  When either FTP or Telnet
  627. sees the incoming half of a TCP connection close, it automatically responds
  628. by closing the outgoing half of the connection.  Close is more graceful than
  629. the \fBreset\fP command, in that it is less likely to leave the remote TCP in a
  630. "half-open" state.
  631. .NH 2
  632. connect <iface> <callsign> [<digipeater> ... ]
  633. .LP
  634. Initiate a "vanilla" AX.25 session to the specified call sign using the
  635. specified interface. Data sent on this session goes out in
  636. conventional AX.25 packets with no upper layer protocol.  The de-facto
  637. presentation standard format is used, in that each packet holds one line
  638. of text, terminated by a carriage return.  A single AX.25 connection may
  639. be used for terminal-to-terminal, IP and NET/ROM traffic.
  640. The three types of data are automatically separated by their
  641. AX.25 Level 3 Protocol IDs.
  642. .LP
  643. Up to 7 optional digipeaters may be given; note that the word \fBvia\fP is NOT
  644. needed. If digipeaters are specified, they are automatically added to the
  645. AX25 routing table as though the \fBax25 route add\fP command had been given
  646. before issuing the \fBconnect\fP command.
  647. .NH 2
  648. delete <filename>
  649. .LP
  650. Delete a \fBfilename\fP in the current working directory.
  651. .NH 2
  652. detach <iface>
  653. .LP
  654. Detach a previously attached interface from the system. All IP routing
  655. table entries referring to this interface are deleted, and forwarding
  656. references by any other interface to this interface are removed.
  657. .NH 2
  658. dialer <iface> <seconds> <hostid> <pings> <dialer-file>
  659. .LP
  660. Setup an autodialer session for the interface.
  661. Whenever the interface is idle for the interval in <seconds>,
  662. the autodialer will ping the <hostid>.
  663. If there is no answer after <pings> attempts,
  664. the autodialer will execute the special commands contained in the <dialer-file>.
  665. .LP
  666. If the interval in <seconds> is zero,
  667. a previous dialer command process will be removed.
  668. If the number of <pings> is zero,
  669. the <dialer-file> will be executed without pinging the <hostid>.
  670. .LP
  671. The file may have any valid name,
  672. and must be located in the configuration directory
  673. (see the \fBInstallion\fP section).
  674. The commands in the file are described in the \fBDialer Subcommands\fP chapter.
  675. .NH 2
  676. dir [<dirname>]
  677. .LP
  678. List the contents of the specified directory on the console. If no argument
  679. is given, the current directory is listed. Note that this command works
  680. by first listing the directory into a temporary file, and then creating
  681. a \fBmore\fP session to display it. After this completes, the temporary
  682. file is deleted.
  683. .NH 2
  684. disconnect [<session #>]
  685. .LP
  686. An alias for the \fBclose\fP command (for the benefit of AX.25 users).
  687. .NH 2
  688. domain ...
  689. .LP
  690. These commands control the operation of the Internet
  691. Domain Name Service (DNS).
  692. .NH 3
  693. domain addserver <hostid>
  694. .LP
  695. Add one or more domain name server(s) to the list of name servers.
  696. .NH 3
  697. domain dropserver <hostid>
  698. .LP
  699. Remove one or more domain name server(s) from the list of name servers.
  700. .NH 3
  701. domain listservers
  702. .LP
  703. List the currently configured domain name servers, along with statistics
  704. on how many queries and replies have been exchanged with each one,
  705. response times, etc.
  706. .NH 3
  707. domain query <hostid>
  708. .LP
  709. Send a query to a domain server asking for all resource records
  710. associated with this <hostid>, and list the records.
  711. .NH 3
  712. domain retry [<count>]
  713. .LP
  714. Display or set the number of attempts to reach each server on the list
  715. during one call to the resolver.
  716. If this count is exceeded,
  717. a failure indication is returned.
  718. If set to 0, the list will cycle forever;
  719. this may be useful for unattended operation.
  720. The default is 3.
  721. .NH 3
  722. domain suffix [<domain suffix>]
  723. .LP
  724. Display or specify the default domain name suffix to be appended to
  725. a host name when it contains no periods. For example, if the suffix is
  726. set to \fBampr.org\fP and the user enters \fBtelnet ka9q\fP, the domain
  727. resolver will attempt to find \fBka9q.ampr.org\fP. If the host name being
  728. sought contains one or more periods, however, the default suffix is NOT
  729. applied (eg. \fBtelnet foo.bar\fP would NOT be turned into
  730. \fBfoo.bar.ampr.org\fP).
  731. .NH 3
  732. domain trace [on | off]
  733. .LP
  734. Display or set the flag controlling the tracing of domain server
  735. requests and responses. Trace messages will be seen only if a domain name
  736. being sought is not found in the local cache file, \fBdomain.txt\fP.
  737. .NH 3
  738. domain cache ...
  739. .LP
  740. These commands are used for the use of the resource record file \fBdomain.txt\fP,
  741. and the local memory cache.
  742. .NH 4
  743. domain cache clean [on | off]
  744. .LP
  745. Display or set the flag controlling the removal of resource records
  746. from the \fBdomain.txt\fP file whose time-to-live has reached zero.
  747. .LP
  748. When clean is off (the default), expired records will be retained;
  749. if no replacement can be obtained from another domain name server,
  750. these records will continue to be used.
  751. .LP
  752. When clean is on, expired records will be removed from the file
  753. whenever any new record is added to the file.
  754. .NH 4
  755. domain cache list
  756. .LP
  757. List the current contents of the local memory cache.
  758. .NH 4
  759. domain cache size [<count>]
  760. .LP
  761. Display or set the nominal maximum size of the local memory cache.
  762. The default is 20.
  763. .LP
  764. (Note: The cache may be temporarily larger when waiting for new records
  765. to be written to the \fBdomain.txt\fP file.)
  766. .NH 4
  767. domain cache wait [<seconds>]
  768. .LP
  769. Display or set the interval in seconds to wait for additional activity
  770. before updating the \fBdomain.txt\fP file.  The default is 300 seconds
  771. (5 minutes).
  772. .NH 2
  773. echo [accept | refuse]
  774. .LP
  775. Display or set the flag controlling client Telnet's response to a
  776. remote WILL ECHO offer.
  777. .LP
  778. The Telnet presentation protocol specifies that in the absence of a negotiated
  779. agreement to the contrary, neither end echoes data received from the other.
  780. In this mode, a Telnet client session echoes keyboard input locally and nothing
  781. is actually sent until a carriage return is typed. Local line editing is also
  782. performed: backspace deletes the last character typed, while control-U deletes
  783. the entire line.
  784. .LP
  785. When communicating from keyboard to keyboard the standard local echo mode is
  786. used, so the setting of this parameter has no effect. However, many
  787. timesharing systems (eg. UNIX) prefer to do their own echoing of typed input.
  788. (This makes screen editors work right, among other things). Such systems send
  789. a Telnet WILL ECHO offer immediately upon receiving an incoming Telnet
  790. connection request. If \fBecho accept\fP is in effect, a client Telnet
  791. session will
  792. automatically return a DO ECHO response. In this mode, local echoing and
  793. editing is turned off and each key stroke is sent immediately (subject to the
  794. congestion control algorithms in TCP).  While this mode is just fine across an
  795. Ethernet, it is clearly inefficient and painful across slow paths like packet
  796. radio channels. Specifying \fBecho refuse\fP causes an incoming WILL ECHO
  797. offer to be answered with a DONT ECHO; the client Telnet session remains
  798. in the local echo mode.  Sessions already in the remote echo mode are
  799. unaffected. (Note: Berkeley Unix has a bug in that it will still echo input
  800. even after the client has refused the WILL ECHO offer. To get around this
  801. problem, enter the \fBstty -echo\fP command to the shell once you have
  802. logged in.)
  803. .NH 2
  804. eol [unix | standard]
  805. .LP
  806. Display or set Telnet's end-of-line behavior when in remote echo mode.
  807. In standard mode, each key is sent as-is. In unix mode, carriage returns
  808. are translated to line feeds.  This command is not necessary with all UNIX
  809. systems; use it only when you find that a particular system responds to
  810. line feeds but not carriage returns.  Only SunOS release 3.2 seems to
  811. exhibit this behavior; later releases are fixed.
  812. .NH 2
  813. escape [<char>]
  814. .LP
  815. Display or set the current command-mode escape character in hex.
  816. (This command is not provided on the IBM-PC; on the PC, the escape char is
  817. always F10.)
  818. .NH 2
  819. etherstat
  820. .LP
  821. Display 3-Com Ethernet controller statistics (if configured).
  822. .NH 2
  823. exit
  824. .LP
  825. Exit the \fBnet.exe\fP program and return to MS-DOS.
  826. .NH 2
  827. finger <user@hostid> [<user@hostid> ...]
  828. .LP
  829. Issue a network finger request for user \fBuser\fP at host \fBhostid\fP. This
  830. creates a client session which may be interrupted, resumed, reset, etc,
  831. just like a Telnet client session.
  832. .NH 2
  833. ftp <hostid>
  834. .LP
  835. Open an FTP control channel to the specified remote host and enter converse
  836. mode on the new session.  Responses from the remote server are displayed
  837. directly on the screen. See the \fBFTP Subcommands\fP chapter for descriptions
  838. of the commands available in a FTP session.
  839. .NH 2
  840. help
  841. .LP
  842. Display a brief summary of top-level commands.
  843. .NH 2
  844. hop ...
  845. .LP
  846. These commands are used to test the connectivity of the network.
  847. .NH 3
  848. hop check <hostid>
  849. .LP
  850. Initiate a \fIhopcheck\fP session to the specified host. This uses a series
  851. of UDP "probe" packets with increasing IP TTL fields to determine the
  852. sequence of gateways in the path to the specified destination. This
  853. function is patterned after the UNIX \fItraceroute\fP facility.
  854. .LP
  855. ICMP message tracing should be turned off before this command is
  856. executed (see the \fBicmp trace\fP command).
  857. .NH 3
  858. hop maxttl [<hops>]
  859. .LP
  860. Display or set the maximum TTL value to be used in hop check sessions.
  861. This effectively bounds the radius of the search.
  862. .NH 3
  863. hop maxwait [<seconds>]
  864. .LP
  865. Display or set the maximum interval that a hopcheck session
  866. will wait for responses at each stage of the trace. The default is 5 seconds.
  867. .NH 3
  868. hop queries [<count>]
  869. .LP
  870. Display or set the number of UDP probes that will be sent at each stage
  871. of the trace. The default is 3.
  872. .NH 3
  873. hop trace [on | off]
  874. .LP
  875. Display or set the flag that controls the display of additional information
  876. during a hop check session.
  877. .NH 2
  878. hostname [<name>]
  879. .LP
  880. Display or set the local host's name. By convention this should be the same
  881. as the host's primary domain name. This string
  882. is used only in the greeting messages
  883. of the various network servers;
  884. note that it does NOT set the system's IP address.
  885. .LP
  886. If <name> is the same as an <iface> (see the \fBAttach commands\fP chapter),
  887. this command will search for a CNAME domain resource record
  888. which corresponds to the IP address of the <iface>.
  889. .NH 2
  890. hs
  891. .LP
  892. Display statistics about the HS high speed HDLC driver (if configured
  893. and active).
  894. .NH 2
  895. icmp ...
  896. .LP
  897. These commands are used for the Internet Control Message Protocol service.
  898. .NH 3
  899. icmp echo [on | off]
  900. .LP
  901. Display or set the flag controlling
  902. the asynchronous display of ICMP Echo Reply packets.
  903. This flag must be on for one-shot pings to work (see the \fBping\fP command.)
  904. .NH 3
  905. icmp status
  906. .LP
  907. Display statistics about the
  908. Internet Control Message Protocol (ICMP), including the number of ICMP
  909. messages of each type sent or received. 
  910. .NH 3
  911. icmp trace [on | off]
  912. .LP
  913. Display or set the flag controlling
  914. the display of ICMP error messages. These informational
  915. messages are generated by Internet routers in response to routing,
  916. protocol or congestion problems. This option should be turned
  917. off before using the \fBhop check\fP facility because it
  918. relies on ICMP Time Exceeded messages, and the asynchronous
  919. display of these messages will be mingled with \fBhop check\fP command output.
  920. .NH 2
  921. ifconfig
  922. .LP
  923. Display a list of interfaces, with a short status for each.
  924. .NH 3
  925. ifconfig <iface>
  926. .LP
  927. Display an extended status of the interface.
  928. .NH 3
  929. ifconfig <iface> broadcast <address>
  930. .LP
  931. Set the broadcast address for the interface.
  932. The <address> takes the form of an IP address
  933. with 1's in the host part of the address.
  934. This is related to the \fBnetmask\fP sub-command.
  935. See also the \fBarp\fP command.
  936. .NH 3
  937. ifconfig <iface> encapsulation <name>
  938. .LP
  939. Not fully implemented.
  940. .NH 3
  941. ifconfig <iface> forward <forward-iface>
  942. .LP
  943. Set a forwarding interface for multiple channel interfaces.
  944. To remove the forward, set <forward-iface> to <iface>.
  945. .NH 3
  946. ifconfig <iface> ipaddress <hostid>
  947. .LP
  948. Set the IP address for this interface.
  949. It is standard Internet practice that each interface has its own address.
  950. For hosts with only one interface, the interface address is usually the
  951. same as the host address.
  952. See also the \fBhostname\fP and \fBip address\fP commands.
  953. .NH 3
  954. ifconfig <iface> linkaddress <hardware-dependant>
  955. .LP
  956. Set the hardware dependant address for this interface.
  957. .NH 3
  958. ifconfig <iface> mtu <mtu>
  959. .LP
  960. Set the MTU for this interface.
  961. See the \fBSetting ... MTU, MSS and Window\fP chapter for more information.
  962. .NH 3
  963. ifconfig <iface> netmask <address>
  964. .LP
  965. Set the sub-net mask for this interface.
  966. The <address> takes the form of an IP address
  967. with 1's in the network and subnet parts of the address,
  968. and 0's in the host part of the address.
  969. This is related to the \fBbroadcast\fP sub-command.
  970. See also the \fBroute\fP command.
  971. .NH 3
  972. ifconfig <iface> rxbuf <?>
  973. .LP
  974. Not yet implemented.
  975. .NH 2
  976. ip ...
  977. .LP
  978. These commands configure the Internet Protocol (IP) service.
  979. .NH 3
  980. ip address [<hostid>]
  981. .LP
  982. Display or set the default local IP address. This command must be given before
  983. an \fBattach\fP command if it is to be used as the default IP address for
  984. the interface.
  985. .NH 3
  986. ip rtimer [<seconds>]
  987. .LP
  988. Display or set the IP reassembly timeout. The default is 30 seconds.
  989. .NH 3
  990. ip status
  991. .LP
  992. Display Internet Protocol (IP) statistics, such as total packet counts
  993. and error counters of various types.
  994. .NH 3
  995. ip ttl [<hops>]
  996. .LP
  997. Display or set the time-to-live value placed in each outgoing IP datagram.
  998. This limits the number of switch hops the datagram will be allowed to
  999. take. The idea is to bound the lifetime of the packet should it become caught
  1000. in a routing loop, so make the value slightly larger than the number of
  1001. hops across the network you expect to transit packets.
  1002. The default is set at compilation time to the official recommended value
  1003. for the Internet.
  1004. .NH 2
  1005. isat [on | off]
  1006. .LP
  1007. Display or set the AT flag.
  1008. Currently, there is no sure-fire way to determine the type of clock-chip
  1009. being used.  If an AT type clock is in use, this command will allow
  1010. measurement of time in milliseconds, rather than clock ticks
  1011. (55 milliseconds per clock tick).
  1012. .NH 3
  1013. kick [<session>]
  1014. .LP
  1015. Kick all sockets associated with a session;
  1016. if no argument is given, kick the current session.
  1017. Performs the same function as the \fBax25 kick\fP and \fBtcp kick\fP commands,
  1018. but is easier to type.
  1019. .NH 2
  1020. log [stop | <filename>]
  1021. .LP
  1022. Display or set the \fBfilename\fP for logging server sessions. If
  1023. \fBstop\fP is given as the argument, logging is terminated
  1024. (the servers themselves are unaffected).
  1025. If a file name is given as an argument, server session log
  1026. entries will be appended to it.
  1027. .NH 2
  1028. mbox
  1029. .LP
  1030. Display the status of the mailbox server system (if configured).
  1031. .NH 2
  1032. memory ...
  1033. .LP
  1034. These commands are used to display memory allocation statistics.
  1035. .NH 3
  1036. memory free
  1037. .LP
  1038. Display the storage allocator free list. Each entry consists of a
  1039. starting address, in hex, and a size, in decimal bytes.
  1040. .NH 3
  1041. memory ibuffs
  1042. .LP
  1043. Display or set the number of buffers on the interrupt buffer pool.
  1044. The default is 5.
  1045. .NH 3
  1046. memory ibufsize
  1047. .LP
  1048. Display or set the size of each buffer on the interrupt buffer pool.
  1049. Since the interrupt buffer pool consists of fixed-size buffers, the
  1050. value chosen must be large enough to satisfy the needs of the most
  1051. demanding driver. The default is 2048.
  1052. .NH 3
  1053. memory sizes
  1054. .LP
  1055. Display a histogram of storage allocator request sizes. Each histogram
  1056. bin is a binary order of magnitude (i.e., a factor of 2).
  1057. .NH 3
  1058. memory status
  1059. .LP
  1060. Display a summary of storage allocator statistics. The first line
  1061. shows the base address of the heap, its total size, the amount of heap
  1062. memory available in bytes and as a percentage of the total heap size,
  1063. and the amount of memory left over (i.e., not placed on the heap at startup)
  1064. and therefore available for \fBshell\fP subcommands.
  1065. .LP
  1066. The second line shows the total number of calls to allocate and free blocks
  1067. of memory, the difference of these two values (i.e., the number of allocated
  1068. blocks outstanding), the number of allocation requests that were denied
  1069. due to lack of memory, and the number of calls to free() that attempted to
  1070. free garbage
  1071. (eg. by freeing the same block twice or freeing a garbled pointer).
  1072. .LP
  1073. The third line shows the number of calls to malloc and free that occurred
  1074. with interrupts off. In normal situations these values should be zero.
  1075. The fourth line shows statistics for the special pool of fixed-size buffers
  1076. used to satisfy requests for memory at interrupt time. The variables
  1077. shown are the number of buffers currently in the pool, their size, and
  1078. the number of requests that failed due to exhaustion of the pool.
  1079. .NH 2
  1080. mkdir <dirname>
  1081. .LP
  1082. Create a sub-directory in the current working directory.
  1083. .NH 2
  1084. mode <iface> [vc | datagram]
  1085. .LP
  1086. Control the default transmission mode on the specified AX.25 interface. 
  1087. In \fBdatagram\fP mode, IP packets are encapsulated in AX.25 UI frames and
  1088. transmitted without any other link level mechanisms, such as connections
  1089. or acknowledgements. 
  1090. .LP
  1091. In \fBvc\fP (virtual circuit) mode, IP packets are encapsulated in AX.25 I
  1092. frames and are acknowledged at the link level according to the AX.25
  1093. protocol.  Link level connections are opened if necessary.
  1094. .LP
  1095. In both modes, ARP is used to map IP to AX.25 addresses.  The defaults
  1096. can be overridden with the type-of-service (TOS) bits in the IP header. 
  1097. Turning on the "reliability" bit causes I frames to be used, while
  1098. turning on the "low delay" bit uses UI frames.  (The effect of turning
  1099. on both bits is undefined and subject to change).
  1100. .LP
  1101. In both modes, IP-level fragmentation is done if the datagram is larger
  1102. than the interface  MTU.  In virtual circuit mode, however, the resulting
  1103. datagram (or fragments) is further fragmented at the AX.25 layer if it
  1104. (or they) are still larger than the AX.25 \fBpaclen\fP parameter. In AX.25
  1105. fragmentation, datagrams are broken into several I frames and reassembled
  1106. at the receiving end before being passed to IP. This is preferable to
  1107. IP fragmentation whenever possible because of decreased overhead (the IP
  1108. header isn't repeated in each fragment) and increased robustness (a
  1109. lost fragment is immediately retransmitted by the link layer).
  1110. .NH 2
  1111. more <file> [<file> ...]
  1112. .LP
  1113. Display the specified file(s) a screen at a time. To proceed to the next
  1114. screen, press the space bar; to cancel the display, hit the 'q' key.
  1115. The \fBmore\fP command creates a session that you can suspend and resume
  1116. just like any other session.
  1117. .NH 2
  1118. param <iface> [<param> [value]] ...
  1119. .LP
  1120. Invoke a device-specific control routine.  The following parameter names
  1121. are recognized by the parameter command, but not all are supported by
  1122. each device type. Most commands deal only with half-duplex packet
  1123. radio interfaces.
  1124. .DS 
  1125. TxDelay - transmit keyup delay
  1126. Persist - P-persistence setting
  1127. SlotTime - persistence slot time setting
  1128. txTail - transmit done holdup delay
  1129. FullDup - enable/disable full duplex
  1130. Hardware - hardware specific command
  1131. TxMute - experimental transmit mute command
  1132. DTR - control Data Terminal Ready (DTR) signal to modem
  1133. RTS - control Request to Send (RTS) signal to modem
  1134. Speed - set line speed
  1135. EndDelay
  1136. Group
  1137. Idle
  1138. Min
  1139. MaxKey
  1140. Wait
  1141. Down - drop modem control lines
  1142. Up - raise modem control lines
  1143. Return - return a KISS TNC to command mode
  1144. .DE
  1145.  
  1146. Depending on the interface, some parameters can be read back by
  1147. omitting a new value. This is not possible with KISS TNCs as there
  1148. are no KISS commands for reading back previously sent parameters.
  1149. .LP
  1150. On a KISS TNC interface, the \fBparam\fP command generates and sends control
  1151. packets to the TNC.  Data bytes are treated as decimal.  For example,
  1152. \fBparam ax0 txdelay 255 \fP will set the keyup timer (type field = 1)
  1153. on the KISS TNC configured as ax0 to 2.55 seconds (255 x .01 sec).  On
  1154. all \fBasy\fP interfaces (slip, kiss/ax25, nrs, ppp)
  1155. the \fBparam <iface> speed\fP command allows the baud rate to be
  1156. read or set.
  1157. .LP
  1158. The implementation of this command for the various interface drivers is
  1159. incomplete and subject to change. 
  1160. .NH 2
  1161. ping <hostid> [<length> [<seconds> [<incflag>]]]
  1162. .LP
  1163. Ping (send ICMP Echo Request packets to) the specified host. By default
  1164. the data field contains only a small timestamp to aid in determining
  1165. round trip time; if the optional \fBlength\fP argument is given,
  1166. the appropriate number of data bytes (consisting of hex 55) are added to the
  1167. ping packets.
  1168. .LP
  1169. If interval is specified, pings will be repeated indefinitely
  1170. at the specified number of seconds;
  1171. otherwise a single, "one shot" ping is done.
  1172. Responses to one-shot pings appear asynchronously on the command screen,
  1173. while repeated pings create a session that may be suspended and resumed.
  1174. Pinging continues until the session is manually reset.
  1175. .LP
  1176. The \fBincflag\fP option causes a repeated ping to increment the
  1177. target IP address for each ping; it is an experimental feature for searching
  1178. blocks of IP addresses for active hosts.
  1179. .NH 2
  1180. ppp ...
  1181. .LP
  1182. These commands are used to configure Point to Point Protocol interfaces.
  1183. .LP
  1184. This implementation of PPP is designed to be as complete as possible.
  1185. Because of this, the number of options can be rather daunting.
  1186. However, a typical PPP configuration might include the following commands:
  1187. .DS
  1188. attach asy 0x3f8 4 ppp pp0 4096 1500 9600
  1189. dial pp0 30 <hostid> 3 dialer.pp0
  1190. #
  1191. ppp pp0 lcp local accm 0
  1192. ppp pp0 lcp local compress address on
  1193. ppp pp0 lcp local compress protocol on
  1194. ppp pp0 lcp local magic on
  1195. ppp pp0 lcp open active
  1196. #
  1197. ppp pp0 ipcp local compress tcp 16 1
  1198. ppp pp0 ipcp open active
  1199. #
  1200. route add default pp0
  1201. .DE
  1202. .NH 3
  1203. ppp <iface>
  1204. .LP
  1205. Display the status of the PPP interface.
  1206. .NH 3
  1207. ppp <iface> lcp ...
  1208. .LP
  1209. These commands are used for the LCP [Link Control Protocol]
  1210. configuration.
  1211. .NH 4
  1212. ppp <iface> lcp close
  1213. .LP
  1214. Shutdown the PPP interface.
  1215. .NH 4
  1216. ppp <iface> lcp local ...
  1217. .LP
  1218. These commands control the configuration of the local side of the link.
  1219. If an option is specified, the parameters will be used
  1220. as the initial values in configuration requests.
  1221. If not specified, that option will not be requested.
  1222. .LP
  1223. For each of these options,
  1224. the \fBallow\fP parameter will permit the remote
  1225. to include that option in its response,
  1226. even when the option is not included in the request.
  1227. By default, all options are allowed.
  1228. .NH 5
  1229. ppp <iface> lcp local accm [ <bitmap> | allow [on | off] ]
  1230. .LP
  1231. Display or set the Async Control Character Map.
  1232. The default is 0xffffffff.
  1233. .NH 5
  1234. ppp <iface> lcp local authenticate [ pap | none | allow [on | off] ]
  1235. .LP
  1236. Display or set the authentication protocol.
  1237. The default is \fBnone\fP.
  1238. .NH 5
  1239. ppp <iface> lcp local compress address/control [ on | off | allow [on | off] ]
  1240. .LP
  1241. Display or set the option to compress the address and control fields of
  1242. the PPP HLDC-like header.
  1243. This is generally desirable for slow asynchronous links,
  1244. and undesirable for fast or synchronous links.
  1245. The default is off.
  1246. .NH 5
  1247. ppp <iface> lcp local compress protocol [ on | off | allow [on | off] ]
  1248. .LP
  1249. Display or set the option to compress the protocol field of
  1250. the PPP HLDC-like header.
  1251. This is generally desirable for slow asynchronous links,
  1252. and undesirable for fast or synchronous links.
  1253. The default is off.
  1254. .NH 5
  1255. ppp <iface> lcp local magic [ on | off | <value> | allow [on | off] ]
  1256. .LP
  1257. Display or set the initial Magic Number.
  1258. The default is off (zero).
  1259. .NH 5
  1260. ppp <iface> lcp local mru [ <size> | allow [on | off] ]
  1261. .LP
  1262. Display or set the Maximum Receive Unit.
  1263. The default is 1500.
  1264. .NH 5
  1265. ppp <iface> lcp local default
  1266. .LP
  1267. Reset the options to their default values.
  1268. .NH 4
  1269. ppp <iface> lcp open active | passive
  1270. .LP
  1271. Wait for the physical layer to come up.
  1272. If \fBactive\fP, initiate configuration negotiation.
  1273. If \fBpassive\fP, wait for configuration negotiation from the remote.
  1274. .NH 4
  1275. ppp <iface> lcp remote ...
  1276. .LP
  1277. These commands control the configuration of the remote side of the link.
  1278. The options are identical to those of the local side.
  1279. If an option is specified, the parameters will be used
  1280. in responses to the remote's configuration requests.
  1281. If not specified, that option will be accepted if it is allowed.
  1282. .LP
  1283. For each of these options,
  1284. the \fBallow\fP parameter will permit the remote
  1285. to specify that option in its request.
  1286. By default, all options are allowed.
  1287. .NH 4
  1288. ppp <iface> lcp timeout [<seconds>]
  1289. .LP
  1290. Display or set the interval to wait between configuration
  1291. or termination attempts.
  1292. The default is 3 seconds.
  1293. .NH 4
  1294. ppp <iface> lcp try ...
  1295. .LP
  1296. These commands are used for the various counters.
  1297. .NH 5
  1298. ppp <iface> lcp try configure [<count>]
  1299. .LP
  1300. Display or set the number of configuration requests sent.
  1301. The default is 10.
  1302. .NH 5
  1303. ppp <iface> lcp try failure [<count>]
  1304. .LP
  1305. Display or set the number of bad configuration requests allowed from the remote.
  1306. The default is 5.
  1307. .NH 5
  1308. ppp <iface> lcp try terminate [<count>]
  1309. .LP
  1310. Display or set the number of termination requests sent before shutdown.
  1311. The default is 2.
  1312. .NH 3
  1313. ppp <iface> ipcp ...
  1314. .LP
  1315. These commands are used for the IPCP [Internet Protocol Control Protocol]
  1316. configuration.
  1317. .LP
  1318. The \fBclose, open, timeout\fP and \fBtry\fP sub-commands
  1319. are identical to the LCP (described above).
  1320. .NH 4
  1321. ppp <iface> ipcp local ...
  1322. .LP
  1323. These commands control the configuration of the local side of the link.
  1324. If an option is specified, the parameters will be used
  1325. as the initial values in configuration requests.
  1326. If not specified, that option will not be requested.
  1327. .LP
  1328. For each of these options,
  1329. the \fBallow\fP parameter will permit the remote
  1330. to include that option in its response,
  1331. even when the option is not included in the request.
  1332. By default, all options are allowed.
  1333. .NH 5
  1334. ppp <iface> ipcp local address [ <hostid> | allow [on | off] ]
  1335. .LP
  1336. Display or set the local address for negotiation purposes.
  1337. If an address of 0 is specified,
  1338. the other side of the link will supply the address.
  1339. By default, no addresses are negotiated.
  1340. .NH 5
  1341. ppp <iface> ipcp local compress [ tcp <slots> [<flag>] | none | allow [on | off] ]
  1342. .LP
  1343. Display or set the compression protocol.
  1344. The default is \fBnone\fP.
  1345. .LP
  1346. The \fBtcp\fP <slots> specifies the number of "conversation" slots,
  1347. which must be 1 to 255.
  1348. (This may be limited at compilation time to a smaller number.)
  1349. A good choice is in the range 4 to 16.
  1350. .LP
  1351. The \fBtcp\fP <flag> is 0 (don't compress the slot number)
  1352. or 1 (OK to compress the slot number).
  1353. KA9Q can handle compressed slot numbers, so the default is 1.
  1354. .NH 4
  1355. ppp <iface> ipcp remote ...
  1356. .LP
  1357. These commands control the configuration of the remote side of the link.
  1358. The options are identical to those of the local side.
  1359. If an option is specified, the parameters will be used
  1360. in responses to the remote's configuration requests.
  1361. If not specified, that option will be accepted if it is allowed.
  1362. .LP
  1363. For each of these options,
  1364. the \fBallow\fP parameter will permit the remote
  1365. to specify that option in its request.
  1366. By default, all options are allowed.
  1367. .NH 3
  1368. ppp <iface> pap ...
  1369. .LP
  1370. These commands are used for the PAP [Password Authentication Protocol]
  1371. configuration.
  1372. .LP
  1373. The \fBtimeout\fP and \fBtry\fP sub-commands
  1374. are identical to the LCP (described above).
  1375. However, the terminate counter is unused.
  1376. .NH 4
  1377. ppp <iface> pap user [ <username> [<password>] ]
  1378. .LP
  1379. Display or set the username (the password may be set, but not displayed).
  1380. When the username is specified, but no password is supplied,
  1381. the \fBftpusers\fP file is searched for the password.
  1382. When a username/password is unknown or rejected,
  1383. a session will appear at the console to prompt for a new username/password.
  1384. .NH 3
  1385. ppp <iface> trace [<flags>]
  1386. .LP
  1387. Display or set the flags that control the logging of information
  1388. during PPP link configuration.
  1389. .LP
  1390. The flag value is 0 for none, 1 for basic, and 2 for general.
  1391. Values greater than 2 are usually not compiled,
  1392. and are described in the appropriate source files where they are defined.
  1393. .NH 2
  1394. ps
  1395. .LP
  1396. Display all current processes in the system. The fields are as follows:
  1397. .LP
  1398. \fBPID\fP - Process ID (the address of the process descriptor).
  1399. .LP
  1400. \fBSP\fP - The current value of the process stack pointer.
  1401. .LP
  1402. \fBstksize\fP - The size of the stack allocated to the process.
  1403. .LP
  1404. \fBmaxstk\fP - The apparent peak stack utilization of this process. This is
  1405. done in a somewhat heuristic fashion, so the numbers should be treated
  1406. as approximate. If this number reaches or exceeds the stksize figure,
  1407. the system is almost certain to crash; the \fBnet.exe\fP program
  1408. should be recompiled to give the process a larger allocation when it is started.
  1409. .LP
  1410. \fBevent\fP - The event this task is waiting for, if it is not runnable.
  1411. .LP
  1412. \fBfl\fP - Process status flags. There are three: I (Interrupts enabled),
  1413. W (Waiting for event) and S (Suspended). The I
  1414. flag is set whenever a task has executed a pwait() call (wait for
  1415. event) without first disabling hardware interrupts. Only tasks that
  1416. wait for hardware interrupt events will turn off this flag; this is
  1417. done to avoid critical sections and missed interrupts. The W flag
  1418. indicates that the process is waiting for an event; the \fBevent\fP
  1419. column will be non-blank. Note that although there may be several
  1420. runnable processes at any time (shown in the \fBps\fP listing as those
  1421. without the W flag and with blank event fields) only one
  1422. process is actually running at any one instant (The Refrigerator
  1423. Light Effect says that the \fBps\fP command is always the one running
  1424. when this display is generated.)
  1425. .NH 2
  1426. pwd [<dirname>]
  1427. .LP
  1428. An alias for the \fBcd\fP command.
  1429. .NH 2
  1430. record [off | <filename>]
  1431. .LP
  1432. Append to \fBfilename\fP all data received on the current
  1433. session.  Data sent on the current session is also written into the file
  1434. except for Telnet sessions in remote echo mode.  The command \fBrecord
  1435. off\fP stops recording and closes the file.
  1436. .NH 2
  1437. remote [-p <port>] [-k <key>] [-a <kickaddr>] <hostid> exit | reset | kick
  1438. .LP
  1439. Send a UDP packet to the specified host commanding it
  1440. to exit the \fBnet.exe\fP program, reset the processor,
  1441. or force a retransmission on TCP connections.  For this
  1442. command to be accepted, the remote system must be running the \fBremote\fP
  1443. server and the port number specified in the \fBremote\fP command must match
  1444. the port number given when the server was started on the remote system.
  1445. If the port numbers do not match, or if the remote server is not running
  1446. on the target system, the command packet is ignored.  Even if the
  1447. command is accepted there is no acknowledgement.
  1448. .LP
  1449. The \fBkick\fP command forces a retransmission timeout on all
  1450. TCP connections that the remote node may have with the local node.
  1451. If a connection is idle, a current ACK packet (without data) is sent.
  1452. If the -a option is used, connections to the specified host are
  1453. kicked instead. No key is required for the kick subcommand.
  1454. .LP
  1455. The \fBexit\fP and \fBreset\fP subcommands are mainly useful for
  1456. restarting the \fBnet.exe\fP program on a remote
  1457. unattended system after the configuration file has been updated.  The
  1458. remote system should invoke the \fBnet.exe\fP program automatically upon booting,
  1459. preferably in an infinite loop.  For example, under MS-DOS the boot disk
  1460. should contain the following in \fBautoexec.net\fP:
  1461. .DS
  1462. .ft CW
  1463. :loop
  1464. net
  1465. goto :loop
  1466. .ft P
  1467. .DE
  1468. .LP
  1469. .NH 2
  1470. remote -s <key>
  1471. .LP
  1472. The \fBexit\fP and \fBreset\fP subcommands of remote require a password.
  1473. The password is set
  1474. on a given system with the \fB-s\fP option, and it is specified in a command
  1475. to a remote system with the \fB-k\fP option. If no password is set with the
  1476. \fB-s\fP option, then the \fBexit\fP and \fBreset\fP subcommands are disabled.
  1477. .LP
  1478. Note that \fBremote\fP is an experimental feature in NOS; it is \fInot\fP
  1479. yet supported by any other TCP/IP implementation.
  1480. .NH 2
  1481. rename <oldfilename> <newfilename>
  1482. .LP
  1483. Rename \fBoldfilename\fP to \fBnewfilename\fP.
  1484. .NH 2
  1485. reset [<session>]
  1486. .LP
  1487. Reset the specified session; if no argument is given, reset the current
  1488. session.  This command should be used with caution since it does not
  1489. reliably inform the remote end that the connection no longer exists.  (In
  1490. TCP a reset (RST) message will be automatically generated should the remote
  1491. TCP send anything after a local reset has been done.  In AX.25 the DM
  1492. message performs a similar role.  Both are used to get rid of a lingering
  1493. half-open connection after a remote system has crashed.)
  1494. .NH 2
  1495. rip ...
  1496. .LP
  1497. These commands are used for the RIP service.
  1498. .NH 3
  1499. rip accept <gateway>
  1500. .LP
  1501. Remove the specified gateway from the RIP filter table, allowing future
  1502. broadcasts from that gateway to be accepted.
  1503. .NH 3
  1504. rip add <hostid> <seconds> [<flags>]
  1505. .LP
  1506. Add an entry to the RIP broadcast table. The IP routing table will be sent
  1507. to \fBhostid\fP every interval seconds. If
  1508. \fBflags\fP is specified as 1, then "split horizon" processing will
  1509. be performed
  1510. for this destination. That is, any IP routing table entries pointing to the
  1511. interface that will be used to send this update will be removed from the
  1512. update.  If split horizon processing is not specified, then all routing
  1513. table entries except those marked "private" will be sent in each update.
  1514. (Private entries are never sent in RIP packets).
  1515. .LP
  1516. Triggered updates are always done. That is, any change in the routing table
  1517. that causes a previously reachable destination to become unreachable will
  1518. trigger an update that advertises the destination with metric 15, defined to
  1519. mean "infinity".
  1520. .LP
  1521. Note that for RIP packets to be sent properly to a broadcast address, there
  1522. must exist correct IP routing and ARP table entries that will first steer
  1523. the broadcast to the correct interface and then place the correct link-level
  1524. broadcast address in the link-level destination field. If a standard IP
  1525. broadcast address convention is used (eg. 128.96.0.0 or 128.96.255.255)
  1526. then chances are you already have the necessary IP routing table entry, but
  1527. unusual subnet or cluster-addressed networks may require special attention.
  1528. However, an \fBarp add\fP command will be required to translate this address to
  1529. the appropriate link level broadcast address.  For example,
  1530. .sp
  1531. .DS I 0
  1532. .ft CW
  1533. arp add 128.96.0.0 ethernet ff:ff:ff:ff:ff:ff
  1534. .ft P
  1535. .DE
  1536. .sp
  1537. for an Ethernet network, and
  1538. .sp
  1539. .DS I 0
  1540. .ft CW
  1541. arp add 44.255.255.255 ax25 qst-0
  1542. .ft P
  1543. .DE
  1544. .sp
  1545. for an AX25 packet radio channel.
  1546. .NH 3
  1547. rip drop <dest>
  1548. .LP
  1549. Remove an entry from the RIP broadcast table.
  1550. .NH 3
  1551. rip merge [on | off]
  1552. .LP
  1553. This flag controls an experimental feature for consolidating redundant
  1554. entries in the IP routing table. When rip merging is enabled, the table is
  1555. scanned after processing each RIP update. An entry is considered redundant
  1556. if the target(s) it covers would be routed identically by a less "specific"
  1557. entry already in the table. That is, the target address(es) specified
  1558. by the entry in question must also match the target addresses of the
  1559. less specific entry and the two entries must have the same interface
  1560. and gateway fields. For example, if the routing table contains
  1561. .sp
  1562. .DS I 0
  1563. .ft CW
  1564. Dest            Len Interface    Gateway          Metric  P Timer  Use
  1565. 1.2.3.4         32  ethernet0    128.96.1.2       1       0 0      0
  1566. 1.2.3           24  ethernet0    128.96.1.2       1       0 0      0
  1567. .ft
  1568. .DE
  1569. .sp
  1570. then the first entry would be deleted as redundant since packets sent to
  1571. 1.2.3.4 will still be routed correctly by the second entry. Note that the
  1572. relative metrics of the entries are ignored.
  1573. .NH 3
  1574. rip refuse <gateway>
  1575. .LP
  1576. Refuse to accept RIP updates from the specified gateway by adding the
  1577. gateway to the RIP filter table. It may be later removed with the \fBrip
  1578. accept\fP command.
  1579. .NH 3
  1580. rip request <gateway>
  1581. .LP
  1582. Send a RIP Request packet to the specified gateway, causing it to reply
  1583. with a RIP Response packet containing its routing table.
  1584. .NH 3
  1585. rip status
  1586. .LP
  1587. Display RIP status, including a count of the number of packets sent
  1588. and received, the number of requests and responses, the number of
  1589. unknown RIP packet types, and the number of refused RIP updates from hosts
  1590. in the filter table. A list of the addresses and intervals
  1591. to which periodic RIP updates are being sent is also shown, along with
  1592. the contents of the filter table.
  1593. .NH 3
  1594. rip trace [0 | 1 | 2]
  1595. .LP
  1596. This variable controls the tracing of incoming and outgoing RIP packets.
  1597. Setting it to 0 disables all RIP tracing. A value of 1 causes changes
  1598. in the routing table to be displayed, while packets that cause no changes
  1599. cause no output. Setting the variable to 2 produces maximum output,
  1600. including tracing of RIP packets that cause no change in the routing table.
  1601. .NH 2
  1602. rmdir <dirname>
  1603. .LP
  1604. Remove a sub-directory from the current working directory.
  1605. .NH 2
  1606. route
  1607. .LP
  1608. With no arguments, \fBroute\fP displays the IP routing table.
  1609. .NH 3
  1610. route add <dest_hostid>[/bits] | default <iface> [<gateway_hostid> [<metric>]]
  1611. .LP
  1612. This command adds an entry to the routing table. It requires at least two
  1613. more arguments, the hostid of the target destination and the name of
  1614. the interface to which its packets should be sent.  If the destination is
  1615. not local, the gateway's hostid should also be specified. (If the interface
  1616. is a point-to-point link, then \fBgateway_hostid\fP may be omitted even if the
  1617. target is non-local because this field is only used to determine the
  1618. gateway's link level address, if any.  If the destination is directly
  1619. reachable, \fBgateway_hostid\fP is also unnecessary since the destination
  1620. address is used to determine the interface link address).
  1621. .LP
  1622. The optional \fB/bits\fP suffix to the destination host id specifies how
  1623. many leading bits in the host id are to be considered significant in the
  1624. routing comparisons.  If not specified, 32 bits (i.e., full significance) is
  1625. assumed.  With this option, a single routing table entry may refer to
  1626. many hosts all sharing a common bit string prefix in their IP addresses. 
  1627. For example, ARPA Class A, B and C networks would use suffixes of /8,
  1628. /16 and /24 respectively; the command
  1629. .DS I 0
  1630. .ft CW
  1631. route add 44/8 sl0 44.64.0.2
  1632. .ft P
  1633. .DE
  1634. .LP
  1635. causes any IP addresses beginning with "44" in the first 8 bits to be
  1636. routed to 44.64.0.2; the remaining 24 bits are "don't-cares".
  1637. .LP
  1638. When an IP address to be routed matches more than one entry in the routing
  1639. table, the entry with largest \fBbits\fP parameter (i.e., the "best" match)
  1640. is used. This allows individual hosts or blocks of hosts to be exceptions
  1641. to a more general rule for a larger block of hosts.
  1642. .LP
  1643. The special destination \fBdefault\fP is used to route datagrams to
  1644. addresses not matched by any other entries
  1645. in the routing table; it is equivalent to specifying a
  1646. \fB/bits\fP suffix of /0 to any destination hostid.  Care must be taken with
  1647. default entries since two nodes with default entries pointing at each
  1648. other will route packets to unknown addresses back and forth in a loop
  1649. until their time-to-live (TTL) fields expire.  (Routing loops for
  1650. specific addresses can also be created, but this is less likely to occur
  1651. accidentally). The best way to use default routes is to pick one node
  1652. in your network that has the "best" connections to the world outside
  1653. your network. Create a spanning tree with that node as the root and have
  1654. each node install a default route pointing in the direction of that node,
  1655. \fIwith the exception of the root node.\fP
  1656. .LP
  1657. Here are some examples of the \fBroute\fP command:
  1658. .DS I 0
  1659. .ft CW
  1660. # Route datagrams to IP address 44.0.0.3 to SLIP line #0.
  1661. # No gateway is needed because SLIP is point-to point.
  1662. route add 44.0.0.3 sl0 
  1663.  
  1664. # Route all default traffic to the gateway on the local Ethernet
  1665. # with IP address 44.0.0.1
  1666. route add default ec0 44.0.0.1
  1667.  
  1668. # The local Ethernet has an ARPA Class-C address assignment;
  1669. # route all IP addresses beginning with 192.4.8 to it
  1670. route add 192.4.8/24 ec0
  1671.  
  1672. # The station with IP address 44.0.0.10 is on the local AX.25 channel
  1673. route add 44.0.0.10 ax0
  1674. .ft P
  1675. .DE
  1676. .NH 3
  1677. route addprivate <dest hostid>[/bits] | default <iface> [<gateway hostid> [<metric>]]
  1678. .LP
  1679. This command is identical to \fBroute add\fP except that it also marks the new
  1680. entry as private; it will never be included in outgoing RIP updates.
  1681. .NH 3
  1682. route drop <dest hostid>
  1683. .LP
  1684. \fBroute drop\fP deletes an entry from the table. If a packet arrives for the
  1685. deleted address and a default route is in effect, it will be used.
  1686. .NH 2
  1687. session [<session #>]
  1688. .LP
  1689. Without arguments, displays the list of current sessions, including
  1690. session number, remote TCP or AX.25 address and the associated socket
  1691. index.  An asterisk (*) is shown next to the current
  1692. session; entering a blank line at this point puts you in converse mode with
  1693. that session.  Entering a session number as an argument to the \fBsession\fP
  1694. command will put you in \fIconverse\fP mode with that session.  If the Telnet
  1695. server is enabled, the user is notified of an incoming request and a
  1696. session number is automatically assigned.  The user may then select the
  1697. session normally to converse with the remote user as though the session
  1698. had been locally initiated. 
  1699. .NH 2
  1700. shell
  1701. .LP
  1702. Suspends \fBnet.exe\fP and executes a sub-shell
  1703. ("command processor" under MS-DOS).
  1704. When the sub-shell exits, \fBnet.exe\fP resumes
  1705. (under MS-DOS, enter the \fBexit\fP command).
  1706. Background activity (FTP servers, etc) is also suspended
  1707. while the subshell executes. Note that this will fail unless there is
  1708. sufficient unused memory for the sub-shell and whatever command the user
  1709. tries to run.
  1710. .NH 2
  1711. smtp ...
  1712. .LP
  1713. These commands control the operation of the Simple Mail Transfer Protocol
  1714. (that is, mail).
  1715. .NH 3
  1716. smtp gateway [<hostid>]
  1717. .LP
  1718. Displays or sets the host to be used as a "smart" mail relay. Any mail sent
  1719. to a host not in the host table will instead be sent to the gateway for
  1720. forwarding.
  1721. .NH 3
  1722. smtp kick
  1723. .LP
  1724. Run through the outgoing mail queue and attempt to deliver any pending mail.
  1725. This command allows the user to "kick" the mail system manually.
  1726. Normally, this command is periodically invoked by a timer
  1727. whenever \fBnet.exe\fP is running.
  1728. .NH 3
  1729. smtp maxclients [<count>]
  1730. .LP
  1731. Displays or sets the maximum number of simultaneous outgoing SMTP sessions
  1732. that will be allowed. The default is 10; reduce it if network congestion
  1733. is a problem.
  1734. .NH 3
  1735. smtp timer [<seconds>]
  1736. .LP
  1737. Displays or sets the interval between "kicks" (scans) of the outbound
  1738. mail queue. For example, \fBsmtp timer 600\fP will cause the system to check
  1739. for outgoing mail every 10 minutes and attempt to deliver anything it finds,
  1740. subject of course to the \fBsmtp maxclients\fP limit. Setting a value of zero
  1741. disables
  1742. queue scanning altogether, note that this is the default!  This value is
  1743. recommended for stand alone IP gateways that never handle mail, since it
  1744. saves wear and tear on the floppy disk drive.
  1745. .NH 3
  1746. smtp trace [<value>]
  1747. .LP
  1748. Displays or sets the trace flag in the SMTP client, allowing you to
  1749. watch SMTP's conversations as it delivers mail.  Zero (the default)
  1750. disables tracing.
  1751. .NH 2
  1752. socket [<socket #>]
  1753. .LP
  1754. Without an argument, displays all active sockets, giving their index
  1755. and type, the address of the associated protocol control block and the
  1756. and owner process ID and name. If the index to an active socket is
  1757. supplied, the status display for the appropriate protocol is called.
  1758. For example, if the socket refers to a TCP connection, the display will
  1759. be that given by the \fBtcp status\fP command with the protocol control
  1760. block address.
  1761. .NH 2
  1762. start ax25 | discard | echo | ftp | netrom | remote | smtp | telnet | ttylink
  1763. .LP
  1764. Start the specified Internet server, allowing remote connection requests.
  1765. .NH 2
  1766. stop ax25 | discard | echo | ftp | netrom | remote | smtp | telnet | ttylink
  1767. .LP
  1768. Stop the specified Internet server, rejecting any further remote connect
  1769. requests. Existing connections are allowed to complete normally.
  1770. .NH 2
  1771. tcp ...
  1772. .LP
  1773. These commands are used for the Transmission Control Protocol service.
  1774. .NH 3
  1775. tcp irtt [<milliseconds>]
  1776. .LP
  1777. Display or set the initial round trip time estimate, in milliseconds, to be
  1778. used for new TCP connections until they can measure and adapt to the
  1779. actual value.  The default is 5000 milliseconds (5 seconds).
  1780. Increasing this when operating
  1781. over slow channels will avoid the flurry of retransmissions that would
  1782. otherwise occur as the smoothed estimate settles down at the correct
  1783. value. Note that this command should be given before servers are started in
  1784. order for it to have effect on incoming connections.
  1785. .LP
  1786. TCP also caches measured round trip times and mean
  1787. deviations (MDEV) for current and recent destinations. Whenever a new
  1788. TCP connection is opened, the system first looks in this cache. If the
  1789. destination is found, the cached IRTT and MDEV values are used. If not,
  1790. the default IRTT value mentioned above is used, along with a MDEV of 0.
  1791. This feature is fully automatic, and it can improve performance greatly
  1792. when a series of connections are opened and closed to a given destination
  1793. (eg. a series of FTP file transfers or directory listings).
  1794. .NH 3
  1795. tcp kick <tcb_addr>
  1796. .LP
  1797. If there is unacknowledged
  1798. data on the send queue of the specified TCB, this command forces
  1799. an immediate retransmission. 
  1800. .NH 3
  1801. tcp mss [<size>]
  1802. .LP
  1803. Display or set the TCP Maximum Segment Size in bytes that will be sent on all
  1804. outgoing TCP connect request (SYN segments).  This tells the remote end the
  1805. size of the largest segment (packet) it may send. Changing MSS affects
  1806. only future connections; existing connections are unaffected.
  1807. .NH 3
  1808. tcp reset <tcb_addr>
  1809. .LP
  1810. Deletes the TCP control block at the specified address.
  1811. .NH 3
  1812. tcp rtt <tcb_addr> <rtt> <mdev>
  1813. .LP
  1814. Replaces the automatically computed round trip time and mean deviation
  1815. values in the specified TCB
  1816. with new values in milliseconds.  This command is useful to speed up
  1817. recovery from a series of lost packets since it provides a manual bypass
  1818. around the normal backoff retransmission timing mechanisms. 
  1819. .NH 3
  1820. tcp status [<tcb_addr>]
  1821. .LP
  1822. Without arguments, displays several TCP-level statistics, plus a summary of
  1823. all existing TCP connections, including TCB address, send and receive queue
  1824. sizes, local and remote sockets, and connection state. If \fBtcb_addr\fP is
  1825. specified, a more detailed dump of the specified TCB is generated, including
  1826. send and receive sequence numbers and timer information.
  1827. .NH 3
  1828. tcp window [<size>]
  1829. .LP
  1830. Displays or sets the default receive window size in bytes to be used by TCP
  1831. when creating new connections. Existing connections are unaffected.
  1832. .NH 2
  1833. telnet <hostid>
  1834. .LP
  1835. Creates a Telnet session to the specified host and enters converse mode.
  1836. .NH 2
  1837. tip <iface>
  1838. .LP
  1839. Creates a \fBtip\fP session that
  1840. connects to the specified interface in "dumb terminal" mode.
  1841. The interface must have already been attached with the \fBattach\fP command.
  1842. Any packet
  1843. traffic (IP datagrams, etc) routed to the interface while this session
  1844. exists will be discarded.
  1845. To close a \fBtip\fP session, use the \fBreset\fP command. It
  1846. will then revert to normal \fBslip, nrs\fP or \fBkiss\fP mode operation.
  1847. .LP
  1848. This feature is primarily useful for manually establishing SLIP connections.
  1849. At present, only the built-in "com" ports can be used with this command.
  1850. .NH 2
  1851. trace [<iface> [off | <btio> [<tracefile>]]]
  1852. .LP
  1853. Controls packet tracing by the interface drivers. Specific bits enable
  1854. tracing of the various interfaces and the amount of information produced.
  1855. Tracing is controlled on a per-interface basis; without arguments, \fBtrace\fP
  1856. gives a list of all defined interfaces and their tracing status.
  1857. Output can be limited to a single interface by specifying it, and the
  1858. control flags can be change by specifying them as well. The flags are
  1859. given as a hexadecimal number which is interpreted as follows:
  1860. .DS I 0
  1861. .ft CW
  1862.     O - Enable tracing of output packets if 1, disable if 0
  1863.     I - Enable tracing of input packets if 1, disable if 0
  1864.     T - Controls type of tracing:
  1865.     0 - Protocol headers are decoded, but data is not displayed
  1866.     1 - Protocol headers are decoded, and data (but not the
  1867.         headers themselves) are displayed as ASCII characters,
  1868.         64 characters/line. Unprintable characters are displayed
  1869.         as periods.
  1870.     2 - Protocol headers are decoded, and the entire packet
  1871.         (headers AND data) is also displayed in hexadecimal
  1872.         and ASCII, 16 characters per line.
  1873.     B - Broadcast filter flag. If set, only packets specifically addressed
  1874.     to this node will be traced; broadcast packets will not be displayed.
  1875. .ft
  1876. .DE
  1877. If \fBtracefile\fP is not specified, tracing will be to the console.
  1878. .NH 2
  1879. udp status
  1880. .LP
  1881. Displays the status of all UDP receive queues.
  1882. .NH 2
  1883. upload [<filename>]
  1884. .LP
  1885. Opens \fBfilename\fP and sends it on the current session as though it were
  1886. typed on the terminal.
  1887. .NH 2
  1888. watch
  1889. .LP
  1890. Displays the current software stopwatch values, with min and max readings
  1891. for each. This facility allows a programmer to measure the execution time
  1892. of critical sections of code with microsecond resolution.
  1893. This command is supported only on the IBM PC, and the meaning of each
  1894. stopwatch value depends on where the calls have been inserted for test
  1895. purposes; the distribution copy of \fBnet.exe\fP usually has no stopwatch calls.
  1896. .NH 2
  1897. ?
  1898. .LP
  1899. Same as the \fBhelp\fP command.
  1900. .NH 1
  1901. Attach Commands
  1902. .LP
  1903. This chapter details the attach commands for the various hardware interface
  1904. drivers. Not all of these drivers may be configured into every \fBnet.exe\fP
  1905. binary; a list of the available types may be obtained by entering the
  1906. command \fBattach ?\fP.
  1907. .LP
  1908. Some parameters are accepted by several drivers. They are:
  1909. .NH 3
  1910. <bufsize>
  1911. .LP
  1912. For asynchronous devices (eg. COM ports operating in SLIP or NRS mode)
  1913. this parameter specifies the size of the receiver's ring buffer.
  1914. It should be large enough to hold incoming data at full line speed for
  1915. the longest time that the system may be busy in MS-DOS or the BIOS doing
  1916. a slow I/O operation (eg. to a floppy disk). A kilobyte is usually more
  1917. than sufficient.
  1918. .LP
  1919. For synchronous devices (eg. the \fBscc, hs, pc100, hapn\fP
  1920. and \fBdrsi\fP interfaces operating in HDLC mode),
  1921. the bufsize parameter specifies the largest packet
  1922. that may be received on the interface.  This should be set by mutual
  1923. agreement among stations sharing the channel. For standard AX.25 with a
  1924. maximum I-frame data size of 256 bytes, a value of 325 should provide an
  1925. adequate safety margin. On higher speed channels (eg. 56kb/s) larger
  1926. values (eg. 2K bytes) will provide much better performance and allow
  1927. full-sized Ethernet packets to be carried without fragmentation.
  1928. .NH 3
  1929. <ioaddr>
  1930. .LP
  1931. The base address of the interface's control registers, in hex.
  1932. .NH 3
  1933. <vector>
  1934. .LP
  1935. The interface's hardware interrupt (IRQ) vector, in hex.
  1936. .NH 3
  1937. <iface>
  1938. .LP
  1939. The name (an arbitrary character string)
  1940. to be assigned to this interface. It is used to refer to the
  1941. interface in \fBifconfig\fP and \fBroute\fP commands and in \fBtrace\fP output.
  1942. .NH 3
  1943. <mtu>
  1944. .LP
  1945. The Maximum Transmission Unit size, in bytes.  Datagrams
  1946. larger than this limit will be fragmented at the IP layer into smaller
  1947. pieces. For AX.25 UI frames, this limits the size of the information field.
  1948. For AX.25 I frames, however, the \fBax25 paclen\fP parameter is also
  1949. relevant.  If
  1950. the datagram or fragment is still larger than \fBpaclen\fP, it is also
  1951. fragmented at the AX.25 level (as opposed to the IP level) before
  1952. transmission.  (See the \fBax25 paclen\fP command for further information).
  1953. .NH 3
  1954. <speed>
  1955. .LP
  1956. The speed in bits per second (eg. 2400).
  1957. .NH 2
  1958. attach 3c500 <ioaddr> <vector> arpa <iface> <qlen> <mtu> [<ip_addr>]
  1959. .LP
  1960. Attach a 3Com 3C501 Ethernet interface.  \fBqlen\fP is the maximum allowable
  1961. transmit queue length.  If the \fBip_addr\fP parameter is not given, the value
  1962. associated with a prior \fBip address\fP command will be used.
  1963. .LP
  1964. The use of this driver is not recommended; use the packet driver interface
  1965. with the loadable 3C501 packet driver instead.
  1966. .NH 2
  1967. attach asy <ioaddr> <vector> ax25 | nrs | ppp | slip <iface> <bufsize> <mtu>
  1968. <speed> [<crv>]
  1969. .LP
  1970. Attach a standard PC "com port" (asynchronous serial port),
  1971. using the National 8250 or 16550A chip.
  1972. Standard values on the IBM PC and clones for \fBioaddr\fP and \fBvector\fP
  1973. are 0x3f8 and 4 for COM1,
  1974. and 0x2f8 and 3 for COM2.
  1975. If the port uses a 16550A chip, it will be detected
  1976. automatically and the FIFOs enabled.
  1977. .NH 3
  1978. ax25
  1979. .LP
  1980. Similar to \fBslip\fP, except that an AX.25 header and a KISS TNC
  1981. control header are added to the front of the datagram before SLIP
  1982. encoding.  Either UI (connectionless) or I (connection-oriented) AX.25
  1983. frames can be used; see the \fBmode\fP command for details. 
  1984. .NH 3
  1985. nrs
  1986. .LP
  1987. Use the NET/ROM asynchronous framing technique for communication with
  1988. a local NET/ROM TNC.
  1989. .NH 3
  1990. ppp
  1991. .LP
  1992. Point-to-Point-Protocol.
  1993. Encapsulates datagrams in an HDLC-like frame.
  1994. This is a new Internet standard for point-to-point communication,
  1995. compatible with CCITT standards.
  1996. .NH 3
  1997. slip
  1998. .LP
  1999. Serial Line Internet Protocol.
  2000. Encapsulates IP datagrams directly in SLIP frames without a link
  2001. header. This is for operation on point-to-point lines and is compatible
  2002. with 4.2BSD UNIX SLIP.
  2003. .NH 3
  2004. <crv>
  2005. .LP
  2006. The optional flags are a string of characters "crv":
  2007. \fBc\fP enables RTS/CTS detection,
  2008. \fBr\fP enables RLSD (Carrier Detect) physical line sensing,
  2009. \fBv\fP enables Van Jacobson TCP/IP Header Compression,
  2010. and is valid only for SLIP.
  2011. .NH 2
  2012. attach drsi <ioaddr> <vector> ax25 <iface> <bufsize> <mtu> <ch_a_speed>
  2013. <ch_b_speed>
  2014. .LP
  2015. N6TTO driver for the Digital Radio Systems PCPA 8530 card.
  2016. Since there are two channels on the board, two interfaces are attached.
  2017. They will be named \fBiface\fP with 'a' and 'b' appended.
  2018. \fBbufsize\fP is the receiver buffer size in bytes;
  2019. it must be larger than the largest frame to be received.
  2020. \fBch_a_speed\fP and \fBch_b_speed\fP are the speeds, in bits/sec,
  2021. for the A and B channels, respectively.
  2022. .NH 2
  2023. attach eagle <ioaddr> <vector> ax25 <iface> <bufsize> <mtu> <speed>
  2024. .LP
  2025. WA3CVG/NG6Q driver for the Eagle Computer card (Zilog 8530).
  2026. .NH 2
  2027. attach hapn <ioaddr> <vector> ax25 <iface> <bufsize> <mtu> csma | full
  2028. .LP
  2029. KE3Z driver for the Hamilton Amateur Packet Network adapter (Intel 8273).
  2030. The \fBcsma | full\fP parameter specifies whether the port should operate in
  2031. carrier sense multiple access (CSMA) mode or in full duplex.
  2032. .NH 2
  2033. attach hs <ioaddr> <vector> ax25 <iface> <bufsize> <mtu> <keyup_delay> <p>
  2034. .LP
  2035. Attach a DRSI PCPA or Eagle Computer interface card
  2036. using a special "high speed" 8530 driver.
  2037. This driver uses busy-wait loops to send and receive
  2038. each byte instead of interrupts, making it usable with high speed modems
  2039. (such as the WA4DSY 56kb/s modem) on slow systems.
  2040. This does have the side effect of "freezing"
  2041. the system whenever the modem transmitter or receiver is active.
  2042. This driver can operate only in CSMA mode, and it is recommended that
  2043. no other interfaces requiring small interrupt latencies be attached to
  2044. the same machine.
  2045. .LP
  2046. The \fBkeyup_delay\fP parameter specifies the transmitter keyup delay in
  2047. milliseconds. The \fBp\fP value specifies the transmitter persistence
  2048. value in the range 1-255; the corresponding slot time is fixed at one
  2049. hardware clock tick, about 55 ms on the PC.
  2050. .LP
  2051. As with the other 8530 drivers, this driver actually attaches two interfaces,
  2052. one for each 8530 channel.
  2053. .NH 2
  2054. attach packet <intvec> <iface> <txqlen> <mtu>
  2055. .LP
  2056. Attach a separate software "packet driver" meeting the
  2057. FTP Software, Inc, Software Packet Driver specification.
  2058. The driver must have already been installed as a TSR
  2059. (e.g., by invocation in autoexec.bat).
  2060. Packet drivers in the Ethernet, ARCNET,
  2061. SLIP, SLFP, and KISS/AX25 classes are supported.
  2062. .LP
  2063. \fBintvec\fP is the software interrupt vector used for communication to the
  2064. packet driver, and \fBtxqlen\fP is the maximum number of packets that will
  2065. be allowed on the transmit queue.
  2066. .NH 2
  2067. attach pc100 <ioaddr> <vector> ax25 <iface> <bufsize> <speed>
  2068. .LP
  2069. Driver for the PACCOMM PC-100 (Zilog 8530) card.
  2070. Only AX.25 operation is supported.
  2071. .NH 2
  2072. attach scc <devices> init <addr> <spacing> <Aoff> <Boff> <Dataoff> <intack>
  2073. <vec> [p|r]<clock> [<hdwe>] [<param>]
  2074. .LP
  2075. PE1CHL driver to initialize a generic SCC (8530) interface board
  2076. prior to actually attaching it. The parameters are as follows:
  2077. .NH 3
  2078. <devices>
  2079. .LP
  2080. The number of SCC chips to support.
  2081. .NH 3
  2082. <addr>
  2083. .LP
  2084. The base address of the first SCC chip (hex).
  2085. .NH 3
  2086. <spacing>
  2087. .LP
  2088. The spacing between the SCC chip base addresses.
  2089. .NH 3
  2090. <Aoff>
  2091. .LP
  2092. The offset from a chip's base address to its channel A control register.
  2093. .NH 3
  2094. <Boff>
  2095. .LP
  2096. The offset from a chip's base address to its channel B control register.
  2097. .NH 3
  2098. <Dataoff>
  2099. .LP
  2100. The offset from each channel's control register to its data register.
  2101. .NH 3
  2102. <intack>
  2103. .LP
  2104. The address of the INTACK/Read Vector port. If none,
  2105. specify 0 to read from RR3A/RR2B.
  2106. .NH 3
  2107. <vec>
  2108. .LP
  2109. The CPU interrupt vector for all connected SCCs.
  2110. .NH 3
  2111. <clock>
  2112. .LP
  2113. The clock frequency (PCLK/RTxC) of all SCCs in hertz.
  2114. Prefix with 'p' for PCLK, 'r' for RTxC clock (for baudrate gen).
  2115. .NH 3
  2116. <hdwe>
  2117. .LP
  2118. Optional hardware type. The following values are currently supported:
  2119. 1 - Eagle card, 2 - PACCOMM PC-100, 4 - PRIMUS-PC card (DG9BL), 8 - DRSI
  2120. PCPA card.
  2121. .NH 3
  2122. <param>
  2123. .LP
  2124. Optional extra parameter. At present, this is used only with the PC-100
  2125. and PRIMUS-PC cards to set the modem mode. The value 0x22 is used with
  2126. the PC-100 and 0x2 is used with the PRIMUS-PC card.
  2127. .LP  
  2128. The \fBattach scc ... init\fP command must be given
  2129. before the interfaces are actually attached with the following command.
  2130. .NH 2
  2131. attach scc <chan> slip | kiss | nrs | ax25 <iface> <mtu> <speed> <bufsize> [<call>]
  2132. .LP
  2133. Attach an initialized SCC port to the system. The parameters are as follows:
  2134. .NH 3
  2135. <chan>
  2136. .LP
  2137. The SCC channel number to attach, 0 or 1 for the first chip's A or B port,
  2138. 2 or 3 for the second chip's A or B port, etc.
  2139. .NH 3
  2140. slip | kiss | nrs | ax25
  2141. .LP
  2142. The operating mode of the interface. \fBslip, kiss\fP
  2143. and \fBnrs\fP all operate the
  2144. port hardware in asynchronous mode; \fBslip\fP
  2145. is Internet-standard serial line
  2146. IP mode, \fBkiss\fP generates SLIP frames containing KISS TNC commands and
  2147. AX.25 packets and \fBnrs\fP uses NET/ROM local serial link framing conventions
  2148. to carry NET/ROM packets. Selecting \fBax25\fP mode puts the interface into
  2149. synchronous HDLC mode that is suitable for direct connection to a half duplex
  2150. radio modem.
  2151. .NH 3
  2152. <speed>
  2153. .LP
  2154. The interface speed in bits per second (eg. 1200).
  2155. Prefix with 'd' when an external divider
  2156. is available to generate the TX clock. When the clock source is PCLK,
  2157. this can be a /32 divider between TRxC and RTxC. When the clock is at RTxC,
  2158. the TX rate must be supplied at TRxC. This is needed only for full duplex
  2159. synchronous operation. When this arg is given as 'ext', the transmit and
  2160. receive clocks are external, and the internal baud rate generator (BRG)
  2161. and digital phase locked loop (DPLL) are not used.
  2162. .NH 2
  2163. Attach Examples
  2164. .LP
  2165. Here are some examples of the attach command:
  2166. .LP
  2167. .DS I 0
  2168. .ft CW
  2169. # Attach a 3Com Ethernet controller using the standard 3Com address and
  2170. # vector (i.e., as it comes out of the box) to use ARPA-standard encapsulation.
  2171. # The receive queue is limited to 5 packets, and outgoing packets larger
  2172. # than 1500 bytes will be fragmented
  2173. attach 3c500 0x300 3 arpa ec0 5 1500
  2174.  
  2175. # Attach the PC asynch card normally known as "com1" (the first controller)
  2176. # to operate in point-to-point slip mode at 9600 baud, calling it "sl0".
  2177. # A 1024 byte receiver ring buffer is allocated. Outgoing packets larger
  2178. # than 256 bytes are fragmented.
  2179. attach asy 0x3f8 4 slip sl0 1024 256 9600
  2180.  
  2181. # Attach the secondary PC asynch card ("com2") to operate in AX.25 mode
  2182. # with an MTU of 576 bytes at 9600 baud with a KISS TNC, calling it "ax0".
  2183. # By default, IP datagrams are sent in UI frames
  2184. attach asy 0x2f8 3 ax25 ax0 1024 576 9600
  2185.  
  2186. # Attach the packet driver loaded at interrupt 0x7e
  2187. # The packet driver is for an Ethernet interface
  2188. attach packet 0x7e ethernet 8 1500
  2189. .ft P
  2190. .DE
  2191. .LP
  2192. .NH 1
  2193. FTP Subcommands
  2194. .LP
  2195. During converse mode with an FTP server, everything typed on the console is
  2196. first examined to see if it is a locally-known command. If not, the line is
  2197. passed intact to the remote server on the control channel. If it is one of
  2198. the following commands, however, it is executed locally. (Note that this
  2199. generally involves other commands being sent to the remote server on the
  2200. control channel.)
  2201. .NH 2
  2202. dir [<file> | <directory> [<local file>]]
  2203. .LP
  2204. Without arguments,
  2205. \fBdir\fP requests that a full directory listing of the remote
  2206. server's current directory be sent to the terminal.  If one argument is
  2207. given, this is passed along in the LIST command; this can be a specific
  2208. file or subdirectory that is meaningful to the remote file system. If two
  2209. arguments are given, the second is taken as the local file into which the
  2210. directory listing should be put (instead of being sent to the console).
  2211. The PORT command is used before the LIST command is sent.
  2212. .NH 2
  2213. get <remote file> [<local file>]
  2214. .LP
  2215. Asks the remote server to send the file specified in the first argument.
  2216. The second argument, if given, will be the name of the file on the local
  2217. machine; otherwise it will have the same name as on the remote machine.
  2218. The PORT and RETR commands are sent on the control channel.
  2219. .NH 2
  2220. hash
  2221. .LP
  2222. A synonym for the \fBverbose 3\fP command.
  2223. .NH 2
  2224. ls [<file> | <directory> [<local file>]]
  2225. .LP
  2226. \fBls\fP is identical to the \fBdir\fP command except that the "NLST"
  2227. command is
  2228. sent to the server instead of the "LIST" command. This results in an
  2229. abbreviated directory listing, i.e., one showing only the file names
  2230. themselves without any other information.
  2231. .NH 2
  2232. mget <file> [<file> ...]
  2233. .LP
  2234. Fetch a collection of files from the server. File names may include
  2235. wild card characters; they will be interpreted and expanded into a
  2236. list of files by the remote
  2237. system using the NLST command. The files will have the same name on
  2238. the local system that they had on the server.
  2239. .NH 2
  2240. mkdir <remote directory>
  2241. .LP
  2242. Creates a directory on the remote machine.
  2243. .NH 2
  2244. mput <file> [<file> ...]
  2245. .LP
  2246. Send a collection of files to the server. File names may include
  2247. wild card characters; they will be expanded locally into a list
  2248. of files to be sent. The files will have the same name on the
  2249. server as on the local system.
  2250. .NH 2
  2251. put <local file> [<remote file>]
  2252. .LP
  2253. Asks the remote server to accept data, creating the file named in the
  2254. first argument. The second argument, if given, will be the name of the file
  2255. on the remote machine; otherwise it will have the same name as on the local
  2256. machine.  The PORT and STOR commands are sent on the control channel.
  2257. .NH 2
  2258. rmdir <remote directory>
  2259. .LP
  2260. Deletes a directory on the remote machine.
  2261. .NH 2
  2262. type [a | i | l <bytesize>]
  2263. .LP
  2264. Tells both the local client and remote server the type of file that is
  2265. to be transferred.  The default is 'a', which means ASCII (i.e., a text
  2266. file).  Type 'i' means \fIimage\fP, i.e., binary.  In ASCII mode, files are
  2267. sent as varying length lines of text in ASCII separated by cr/lf
  2268. sequences; in IMAGE mode, files are sent exactly as they appear in the
  2269. file system.  ASCII mode should be used whenever transferring text
  2270. between dissimilar systems (eg. UNIX and MS-DOS) because of their
  2271. different end-of-line and/or end-of-file conventions.  When exchanging
  2272. text files between machines of the same type, either mode will work but
  2273. IMAGE mode is usually faster.  Naturally, when exchanging raw
  2274. binary files (executables, compressed archives, etc) IMAGE mode must be
  2275. used.  Type 'l' (logical byte size) is used when exchanging binary files
  2276. with remote servers having oddball word sizes (eg. DECSYSTEM-10s and 20s).
  2277. Locally it works exactly like IMAGE, except that it notifies the
  2278. remote system how large the byte size is. \fBbytesize\fP is typically 8.
  2279. The type command sets the local transfer mode and generates the TYPE
  2280. command on the control channel. 
  2281. .NH 2
  2282. verbose [0 | 1 | 2 | 3]
  2283. .LP
  2284. Set or display the level of message output in file transfers.
  2285. \fBVerbose 0\fP gives the least output, and \fBverbose 3\fP the most,
  2286. as follows:
  2287. .DS I 0
  2288. 0 - Display error messages only.
  2289. 1 - Display error messages plus a one-line summary after each transfer
  2290.     giving the name of the file, its size, and the transfer time and rate.
  2291. 2 - Display error and summary messages plus the progress messages generated
  2292.     by the remote FTP server. (This setting is the default.)
  2293. 3 - Display all messages. In addition, a "hash mark" (#) is displayed for
  2294.     every 1,000 bytes sent or received.
  2295. .DE
  2296. If a command is sent to the
  2297. remote server because it is not recognized locally, the response
  2298. is always displayed, regardless of the setting of \fBverbose\fP.
  2299. This is necessary for commands like \fBpwd\fP (display working directory),
  2300. which would
  2301. otherwise produce no message at all if \fBverbose\fP were set to 0 or 1.
  2302. .NH 1
  2303. Dialer Subcommands
  2304. .LP
  2305. Each dialer command may (should) have a different dialer file.
  2306. The file resides in the configuration directory,
  2307. as specified in the \fBInstallation\fP section (see chapter 1).
  2308. A typical dialer file might be:
  2309. .DS
  2310. # Set the speed, and toggle DTR to ensure modem is in command mode.
  2311. control down
  2312. wait 3000
  2313. speed 2400
  2314. control up
  2315. wait 3000
  2316. # Dial, and wait for connection
  2317. send "atdt555-1212\\r"
  2318. wait 45000 "CONNECT " speed
  2319. wait 2000
  2320. # PAD specific initialization
  2321. send "\\r"
  2322. wait 15000 "Terminal ="
  2323. send "ppp\\r"
  2324. wait 10000 "\\r\\n"
  2325. .DE
  2326. .NH 3
  2327. control down | up
  2328. .LP
  2329. Control \fBasy\fP interface.
  2330. The \fBdown\fP option drops DTR and RTS.
  2331. The \fBup\fP option asserts DTR and RTS.
  2332. .NH 3
  2333. send "string"
  2334. .LP
  2335. This dialer command will write the specified string to the interface.
  2336. The string quote marks are required,
  2337. and the string may not contain embedded control characters.
  2338. However, the standard C string escape sequences are recognized
  2339. (\\0 should not be used).
  2340. .NH 3
  2341. speed [ 9600 | 4800 | 2400 | 1200 | 300 ]
  2342. .LP
  2343. This dialer command will set the speed of the interface to one of the
  2344. available speeds.
  2345. If the speed is missing,
  2346. the speed will be displayed in the dialer session window.
  2347. .NH 3
  2348. wait <milliseconds> [ "test string" ] [ speed ]
  2349. .LP
  2350. If only the time is specified,
  2351. the dialer pauses for the desired number of milliseconds.
  2352. .LP
  2353. Otherwise, the dialer reads until the test string is detected on the interface.
  2354. If the string is not detected within the desired time,
  2355. the autodialer will reset.
  2356. The string quote marks are required,
  2357. and the string may not contain embedded control characters.
  2358. However, the standard C string escape sequences are recognized
  2359. (\\0 should not be used).
  2360. .LP
  2361. Finally, if the \fIspeed\fP parameter is specified,
  2362. the dialer will continue to read characters until a non-digit is detected.
  2363. The string read is converted to an integer,
  2364. and used to set the interface speed.
  2365. If the trailing non-digit is not detected within the desired time,
  2366. or the integer value is not a valid speed,
  2367. the autodialer will reset.
  2368. The \fIspeed\fP feature is useful for reading back the CONNECT <speed>
  2369. message generated by Hayes-compatible modems.
  2370. .NH 1
  2371. The /ftpusers File
  2372. .LP
  2373. Since MS-DOS is a single-user operating system (some might say it is
  2374. a glorified bootstrap loader), it provides
  2375. no access control; all files can be read, written or deleted by the
  2376. local user.  It is usually undesirable to give such open access to a
  2377. system to remote network users.  \fBNet.exe\fP therefore provides its own
  2378. access control mechanisms.
  2379. .LP
  2380. The file \fB/ftpusers\fP controls remote FTP and mailbox access.
  2381. The FTP default
  2382. is \fIno\fP access; if this file does not exist, the FTP server will be
  2383. unusable.  A remote user must first "log in" to the system with the USER
  2384. and PASS commands, giving a valid name and password listed in \fB/ftpusers\fP,
  2385. before he or she can transfer files. 
  2386. .LP
  2387. Each entry in \fB/ftpusers\fP consists of a single line of the form
  2388. .DS I 0
  2389. .ft CW
  2390. username password /path permissions
  2391. .ft P
  2392. .DE
  2393. .LP
  2394. There must be exactly four fields, and there must be exactly one space
  2395. between each field.  Comments may be added after the last field. 
  2396. Comment lines begin with '#' in column one. 
  2397. .LP
  2398. \fBusername\fP is the user's login name.
  2399. .LP
  2400. \fBpassword\fP is the required password.  Note that this is in
  2401. plain text; therefore it is not a good idea to give general read
  2402. permission to the root directory.  A password of '*' (a single asterisk)
  2403. means that any password is acceptable. 
  2404. .LP
  2405. \fB/path\fP is the allowable prefix on accessible files.  Before any
  2406. file or directory operation, the current directory and the user-
  2407. specified file name are joined to form an absolute path name in
  2408. "canonical" form (i.e., a full path name starting at the root, with "./"
  2409. and "../" references, as well as redundant /'s, recognized and removed). 
  2410. The result MUST begin with the allowable path prefix; if not, the
  2411. operation is denied.  This field must always begin with a
  2412. "/", i.e., at the root directory. 
  2413. .LP
  2414. \fBpermissions\fP is a decimal number granting permission for read,
  2415. create and write operations.  If the low order bit (0x1) is set, the
  2416. user is allowed to read a file subject to the path name prefix
  2417. restriction.  If the next bit (0x2) is set, the user is allowed to
  2418. create a new file if it does not overwrite an existing file.  If the
  2419. third bit (0x4) is set, the user is allowed to write a file even if it
  2420. overwrites an existing file, and in addition he may delete files.  Again,
  2421. all operations are allowed subject to the path name prefix restrictions. 
  2422. Permissions may be combined by adding bits, for example, 0x3 (= 0x2 + 0x1)
  2423. means that the user is given read and create permission, but not
  2424. overwrite/delete permission.
  2425. .LP
  2426. For example, suppose \fB/ftpusers\fP on machine
  2427. pc.ka9q.ampr.org contains the line
  2428. .DS I 0
  2429. .ft CW
  2430. friendly test /testdir 7
  2431. .ft P
  2432. .DE
  2433. .LP
  2434. A session using this account would look like this:
  2435. .DS I 0
  2436. .ft CW
  2437. net> ftp pc.ka9q.ampr.org
  2438. Resolving pc.ka9q.ampr.org... Trying 128.96.160.1...
  2439. FTP session 1 connected to pc.ka9q.ampr.org
  2440. 220 pc.ka9q.ampr.org FTP version 900418 ready at Mon May 7 16:27:18 1990
  2441. Enter user name: friendly
  2442. 331 Enter PASS command
  2443. Password: test [not echoed]
  2444. 230 Logged in
  2445. ftp>
  2446. .ft P
  2447. .DE
  2448. .LP
  2449. The user now has read, write, overwrite and delete privileges for any file
  2450. under /testdir; he may not access any other files.
  2451. .LP
  2452. Here are some more sample entries in \fB/ftpusers\fP:
  2453. .DS I 0
  2454. .ft CW
  2455. karn foobar / 7         # User "karn" with password "foobar" may read,
  2456.                         # write, overwrite and delete any file on the
  2457.                         # system.
  2458.  
  2459. guest bletch /g/bogus 3 # User "guest" with password "bletch" may read
  2460.                         # any file under /g/bogus and its subdirectories,
  2461.                         # and may create a new file as long as it does
  2462.                         # not overwrite an existing file. He may NOT
  2463.                         # delete any files.
  2464.  
  2465. anonymous * /public 1   # User "anonymous" (any password) may read files
  2466.                         # under /public and its subdirectories; he may
  2467.                         # not create, overwrite or delete any files.
  2468. .ft
  2469. .DE
  2470. .LP
  2471. This last entry is the standard convention for keeping a repository of
  2472. public files; in particular, the username "anonymous" is an established
  2473. ARPA convention. 
  2474. .NH 1
  2475. The \fBdomain.txt\fP File
  2476. .LP
  2477. \fBNet.exe\fP translates domain names (eg. "pc.ka9q.ampr.org") to IP addresses
  2478. (eg. 128.96.160.3) through the use of an Internet Domain Name resolver and
  2479. a local "cache" file, \fBdomain.txt\fP.
  2480. Whenever the user specifies a domain name,
  2481. the local cache is searched for the desired entry.
  2482. If it is present, it is used;
  2483. if not, and if domain name server(s) have been configured,
  2484. a query is sent over the network to the current server.
  2485. If the server responds,
  2486. the answer is added to the \fBdomain.txt\fP file for future use.
  2487. If the server does not respond, any additional servers on the list are
  2488. tried in a round-robin fashion until one responds,
  2489. or the retry limit is reached (see the \fBdomain retry\fP command).
  2490. If \fBdomain.txt\fP does not contain the
  2491. desired entry and there are no configured domain name servers,
  2492. then the request immediately fails.
  2493. .LP
  2494. If a domain name server is available, and if all references to host-ids in
  2495. your /\fBautoexec.net\fP file are in IP address format, then it is
  2496. possible to start with a completely empty \fBdomain.txt\fP file
  2497. and have \fBnet.exe\fP build it for you.
  2498. However, you may wish to add your own entries to \fBdomain.txt\fP,
  2499. either because you prefer to use symbolic domain names in your
  2500. /\fBautoexec.net\fP file
  2501. or you don't have access to a domain server and you need to create entries
  2502. for all of the hosts you may wish to access.
  2503. .LP
  2504. Each entry takes one line,
  2505. and the fields are separated by any combination of tabs or spaces.
  2506. For example:
  2507. .DS I 0
  2508. pc.ka9q.ampr.org.    IN    A    128.96.160.3
  2509. .DE
  2510. \fBIN\fP is the \fIclass\fP of the record.
  2511. It means \fIInternet\fP, and it will be found in all entries.
  2512. \fBA\fP is the \fItype\fP of the record, and it means that this is
  2513. an \fIaddress\fP record.
  2514. Domain name \fBpc.ka9q.ampr.org\fP therefore has Internet
  2515. address 128.96.160.3.
  2516. .LP
  2517. Another possible entry is the \fBCNAME\fP (Canonical Name) record.
  2518. For example:
  2519. .DS I 0
  2520. ka9q.ampr.org.        IN    CNAME    pc.ka9q.ampr.org.
  2521. .DE
  2522. This says that domain name "ka9q.ampr.org" is actually an alias for the
  2523. system with (primary, or \fIcanonical\fP) domain name "pc.ka9q.ampr.org."
  2524. When a domain name having a \fBCNAME\fP
  2525. record is given to \fBnet.exe\fP, the system
  2526. automatically follows the reference to the canonical name and returns the
  2527. IP address associated with that entry.
  2528. .LP
  2529. Entries added automatically by \fBnet.exe\fP will have an additional field between
  2530. the domain name and the class (\fBIN\fP) field.  For example:
  2531. .DS I 0
  2532. pc.ka9q.ampr.org.    3600    IN    A    128.96.160.3
  2533. .DE
  2534. This is the \fItime-to-live\fP value, in seconds, associated with the record
  2535. received from the server. Clients (such as \fBnet.exe\fP) caching these records are
  2536. supposed to delete them after the time-to-live interval has expired,
  2537. allowing for the possibility that the information in the record may become
  2538. out of date.
  2539. .LP
  2540. This implementation of \fBnet.exe\fP will decrement the TTL to zero, but will not
  2541. delete the record unless the "clean" flag is on
  2542. (see the \fBdomain cache clean\fP command).
  2543. When a remote server is not available, the old entry will be used.
  2544. .LP
  2545. When the \fITTL\fP value is missing (as in the examples above),
  2546. the record will never expire, and must be managed by hand.
  2547. Since \fBdomain.txt\fP is a plain text file,
  2548. it may be easily edited by the user to add, change or delete records.
  2549. .LP
  2550. Additional types of records include MX (mail exchanger),
  2551. NS (name server) and SOA (start of
  2552. authority) may appear in \fBdomain.txt\fP from remote server responses. Only
  2553. MX is currently used by \fBnet.exe\fP (in the mailbox). The others
  2554. are retained for future development
  2555. (such as the incorporation of a smarter resolver or a full-blown
  2556. domain name server).
  2557. .NH 1
  2558. Setting Bufsize, Paclen, Maxframe, MTU, MSS and Window
  2559. .LP
  2560. Many \fBnet.exe\fP users are confused by these parameters and do not know how to
  2561. set them properly. This chapter will first review these parameters and
  2562. then discuss how to choose values for them. Special emphasis is given to
  2563. avoiding interoperability problems that may appear when communicating
  2564. with non-\fBnet.exe\fP implementations of AX.25.
  2565. .NH 2
  2566. Hardware Parameters
  2567. .LP
  2568. .NH 3
  2569. Bufsize
  2570. .LP
  2571. This parameter is required by most of \fBnet.exe\fP's built-in HDLC drivers
  2572. (eg. those for the DRSI PCPA and the Paccomm PC-100). It specifies the size
  2573. of the buffer to be allocated for each receiver port. HDLC frames
  2574. larger than this value cannot be received.
  2575. .LP
  2576. There is no default \fBbufsize\fP; it must be specified in the \fBattach\fP
  2577. command for the interface.
  2578. .NH 2
  2579. AX25 Parameters
  2580. .NH 3
  2581. Paclen
  2582. .LP
  2583. Paclen limits the size of the data field in an AX.25 I-frame. This
  2584. value does \fInot\fP include the AX.25 protocol header (source,
  2585. destination and digipeater addresses).
  2586. .LP
  2587. Since unconnected-mode (datagram) AX.25 uses UI frames, this parameter
  2588. has no effect in unconnected mode.
  2589. .LP
  2590. The default value of \fBpaclen\fP is 256 bytes.
  2591. .NH 3
  2592. Maxframe
  2593. .LP
  2594. This parameter controls the number of I-frames that \fBnet.exe\fP may send
  2595. on an AX.25 connection before it must stop and wait for an acknowledgement.
  2596. Since the AX.25/LAPB sequence number field is 3 bits wide, this number
  2597. cannot be larger than 7.
  2598. .LP
  2599. Since unconnected-mode (datagram) AX.25 uses UI frames that do not have
  2600. sequence numbers, this parameter does \fInot\fP apply to unconnected
  2601. mode.
  2602. .LP
  2603. The default value of \fBmaxframe\fP in \fBnet.exe\fP is 1.
  2604. .NH 2
  2605. IP and TCP Parameters
  2606. .NH 3
  2607. MTU
  2608. .LP
  2609. The MTU (Maximum Transmission Unit) is an interface parameter that
  2610. limits the size of the largest IP
  2611. datagram that it may handle.  IP datagrams routed to
  2612. an interface that are larger than its MTU are each split into two or more
  2613. \fIfragments\fP.
  2614. Each fragment has its own IP header and is handled by the network
  2615. as if it were a distinct IP datagram, but when it arrives at
  2616. the destination it is held by the IP layer until all of the other fragments
  2617. belonging to the original datagram have arrived. Then they are reassembled
  2618. back into the complete, original IP datagram. 
  2619. The minimum acceptable interface MTU is 28
  2620. bytes: 20 bytes for the IP (fragment) header, plus 8 bytes of data.
  2621. .LP
  2622. There is no default MTU in \fBnet.exe\fP; it must be explicitly specified for
  2623. each interface as part of the \fBattach\fP command.
  2624. .NH 3
  2625. MSS
  2626. .LP
  2627. MSS (Maximum Segment Size) is a TCP-level parameter that limits the
  2628. amount of data that the \fIremote\fP TCP will send in a single TCP
  2629. packet. MSS values are exchanged in the SYN (connection request)
  2630. packets that open a TCP connection. In the \fBnet.exe\fP implementation of TCP,
  2631. the MSS actually used by TCP is further reduced in order to avoid
  2632. fragmentation at the local IP interface. That is, the local TCP asks IP
  2633. for the MTU of the interface that will be used to reach the
  2634. destination. It then subtracts 40 from the MTU value to allow for the
  2635. overhead of the TCP and IP headers. If the result is less than the MSS
  2636. received from the remote TCP, it is used instead.
  2637. .LP
  2638. The default value of \fBMSS\fP is 512 bytes.
  2639. .NH 3
  2640. Window
  2641. .LP
  2642. This is a TCP-level parameter that controls how much data the local TCP
  2643. will allow the remote TCP to send before it must stop and wait for an
  2644. acknowledgement. The actual window value used by TCP when deciding how
  2645. much more data to send is referred to as the \fIeffective window\fP.
  2646. This is the smaller of two values: the window advertised by the remote
  2647. TCP minus the unacknowledged data in flight, and the \fIcongestion
  2648. window\fP, an automatically computed time-varying estimate of how much
  2649. data the network can handle.
  2650. .LP
  2651. The default value of \fBWindow\fP is 2048 bytes.
  2652. .NH 2
  2653. Discussion
  2654. .LP
  2655. .NH 3
  2656. IP Fragmentation vs AX.25 Segmentation
  2657. .LP
  2658. IP-level fragmentation often makes it possible to interconnect two
  2659. dissimilar networks, but it is best avoided whenever possible.
  2660. One reason is that when a single IP fragment is lost, all other fragments
  2661. belonging to the same datagram are effectively also lost and
  2662. the entire datagram must be retransmitted by the source.
  2663. Even without loss, fragments require the allocation of temporary buffer
  2664. memory at the destination, and it is never easy
  2665. to decide how long to wait for missing fragments before
  2666. giving up and discarding those that have already arrived.
  2667. A reassembly timer controls this process.
  2668. In \fBnet.exe\fP it is (re)initialized with the \fBip rtimer\fP parameter
  2669. (default 30 seconds) whenever progress is made in reassembling a datagram
  2670. (i.e., a new fragment is received).
  2671. It is not necessary that all of the fragments belonging to a datagram
  2672. arrive within a single timeout interval, only that the interval between
  2673. fragments be less than the timeout.
  2674. .LP
  2675. Most subnetworks that carry IP have MTUs of 576 bytes or more, so
  2676. interconnecting them with subnetworks having smaller values can result in
  2677. considerable fragmentation. For this reason, IP implementors working with
  2678. links or subnets having unusually small packet size limits are encouraged
  2679. to use
  2680. \fItransparent fragmentation\fP,
  2681. that is, to devise schemes to break up large IP
  2682. datagrams into a sequence of link or subnet frames that are immediately
  2683. reassembled on the other end of the link or subnet into the original, whole IP
  2684. datagram without the use of IP-level fragmentation. Such a
  2685. scheme is provided in AX.25 Version 2.1.  It can break
  2686. a large IP or NET/ROM datagram into a series of \fBpaclen\fP-sized
  2687. AX.25 segments (not to be confused with TCP segments),
  2688. one per AX.25 I-frame, for transmission and reassemble them into
  2689. a single datagram at the other end of the link before handing it up to the
  2690. IP or NET/ROM module.  Unfortunately, the segmentation procedure is a new
  2691. feature in AX.25 and is not yet widely implemented;
  2692. in fact, \fBnet.exe\fP is so far
  2693. the only known implementation. This creates some interoperability problems
  2694. between \fBnet.exe\fP and non-\fBnet.exe\fP nodes, in particular, standard
  2695. NET/ROM nodes being used to carry IP datagrams. This problem is discussed
  2696. further in the section on setting the MTU.
  2697. .NH 3
  2698. Setting paclen and bufsize
  2699. .LP
  2700. The more data you put into an AX.25 I frame, the smaller the AX.25
  2701. headers are in relation to the total frame size. In other words, by
  2702. increasing \fBpaclen\fP, you lower the AX.25 protocol overhead. Also, large
  2703. data packets reduce the overhead of keying up a transmitter, and this
  2704. can be an important factor with higher speed modems. On the other hand,
  2705. large frames make bigger targets for noise and interference. Each link
  2706. has an optimum value of \fBpaclen\fP that is best discovered by experiment.
  2707. .LP
  2708. Another thing to remember when setting \fBpaclen\fP is that the AX.25 version
  2709. 2.0 specification limits it to 256 bytes. Although \fBnet.exe\fP can handle
  2710. much larger values, some other AX.25 implementations (including
  2711. digipeaters) cannot and this
  2712. may cause interoperability problems. Even \fBnet.exe\fP may have trouble with
  2713. certain KISS TNCs because of fixed-size buffers. The original KISS TNC
  2714. code for the TNC-2 by K3MC can handle frames limited in size only by
  2715. the RAM in the TNC, but some other KISS TNCs cannot.
  2716. .LP
  2717. \fBNet.exe\fP's built-in HDLC drivers (SCC, PC-100, DRSI, etc) allocate receive
  2718. buffers according to the maximum expected frame size, so it is
  2719. important that these devices be configured with the correct
  2720. \fBbufsize\fP. To do this, you must know the size of the largest
  2721. possible frame that can be received. The \fBpaclen\fP parameter
  2722. controls only the size of the data field in an I-frame and not the
  2723. total size of the frame as it appears on the air. The AX.25 spec allows
  2724. up to 8 digipeaters, so the largest possible frame is (\fBpaclen\fP + 72)
  2725. bytes. So you should make \fBbufsize\fP at least this large.
  2726. .LP
  2727. Another important consideration is that the more recent versions of NOS
  2728. improve interrupt response by maintaining a special pool of buffers for use
  2729. by the receive routines.  These buffers are configured by the
  2730. \fBmemory nibufs\fP and \fPmemory ibufsize\fP commands.
  2731. \fBibufsize\fP defaults to 2048 bytes. The setting of \fBibufsize\fP
  2732. limits \fBbufsize\fP; in fact, attempting to set a larger value may
  2733. cause the driver not to work at all. This situation can be detected by
  2734. running the \fBmemory status\fP command and looking for a non-zero count
  2735. of \fBIbuffail\fP events, although these events can also occur
  2736. occasionally during normal operation.
  2737. .LP
  2738. One of the drawbacks of AX.25 that there is no way for one station to tell
  2739. another how large a packet it is willing to accept.  This requires the
  2740. stations sharing a channel to agree beforehand on a maximum packet size.
  2741. TCP is different, as we shall see.
  2742. .NH 3
  2743. Setting Maxframe
  2744. .LP
  2745. For best performance on a half-duplex radio channel, \fBmaxframe\fP should
  2746. always be set to 1. The reasons are explained in the paper \fILink Level
  2747. Protocols Revisited\fP by Brian Lloyd and Phil Karn, which appeared in the
  2748. proceedings of the ARRL 5th Computer Networking Conference in 1986.
  2749. .NH 3
  2750. Setting MTU
  2751. .LP
  2752. TCP/IP header overhead considerations similar to those of the AX.25 layer
  2753. when setting \fBpaclen\fP apply when choosing an MTU.  However, certain
  2754. subnetwork types supported by \fBnet.exe\fP have well-established MTUs, and
  2755. these should
  2756. always be used unless you know what you're doing: 1500 bytes for Ethernet,
  2757. and 508 bytes for ARCNET.
  2758. The MTU for PPP is automatically negotiated, and defaults to 1500.
  2759. Other subnet types, including SLIP and AX.25, are
  2760. not as well standardized.
  2761. .LP
  2762. SLIP has no official MTU, but the most common
  2763. implementation (for BSD UNIX) uses an MTU of 1006 bytes.  Although
  2764. \fBnet.exe\fP has no hard wired limit on the size of a received SLIP frame,
  2765. this is not true for other systems.
  2766. Interoperability problems may therefore result if larger MTUs are used in
  2767. \fBnet.exe\fP.
  2768. .LP
  2769. Choosing an MTU for an AX.25 interface is more complex. When the interface
  2770. operates in datagram (UI-frame) mode, the \fBpaclen\fP parameter does not
  2771. apply. The MTU effectively becomes the \fBpaclen\fP of the link.  However,
  2772. as mentioned earlier, large packets sent on AX.25 \fIconnections\fP are
  2773. automatically segmented into I-frames no larger than \fBpaclen\fP bytes.
  2774. Unfortunately, as also mentioned earlier, \fBnet.exe\fP is so far the only known
  2775. implementation of the new AX.25 segmentation procedure. This is fine as long
  2776. as all of the NET/ROM nodes along a path are running \fBnet.exe\fP, but since the main
  2777. reason \fBnet.exe\fP supports NET/ROM is to allow use of existing NET/ROM networks,
  2778. this is unlikely.
  2779. .LP
  2780. So it is usually important to avoid AX.25 segmentation when running IP over
  2781. NET/ROM.  The way to do this is to make sure that packets larger
  2782. than \fBpaclen\fP are never handed to AX.25.  A NET/ROM transport header is
  2783. 5 bytes long and a NET/ROM network header takes 15 bytes, so 20 bytes must
  2784. be added to the size of an IP datagram when figuring the size of the AX.25
  2785. I-frame data field. If \fBpaclen\fP is 256, this leaves 236 bytes for the IP
  2786. datagram. This is the default MTU of the \fBnetrom\fP pseudo-interface, so
  2787. as long as \fBpaclen\fP is at least 256 bytes, AX.25 segmentation can't
  2788. happen. But if smaller values of \fBpaclen\fP are used, the \fBnetrom\fP MTU
  2789. must also be reduced with the \fBifconfig\fP command.
  2790. .LP
  2791. On the other hand, if you're running IP directly on top of AX.25, chances
  2792. are all of the nodes are running \fBnet.exe\fP and support AX.25 segmentation.
  2793. In this case there is no reason not to use a larger MTU and let
  2794. AX.25 segmentation do its thing. If you choose
  2795. an MTU on the order of 1000-1500 bytes, you can largely avoid IP-level
  2796. fragmentation and reduce TCP/IP-level header overhead on file transfers
  2797. to a very low level.
  2798. And you are still free to pick whatever \fBpaclen\fP value is
  2799. appropriate for the link.
  2800. .NH 3
  2801. Setting MSS
  2802. .LP
  2803. The setting of this TCP-level parameter is somewhat less critical than the
  2804. IP and AX.25 level parameters already discussed, mainly because it is
  2805. automatically lowered according to the MTU of the local interface when a
  2806. connection is created. Although this is, strictly speaking, a protocol
  2807. layering violation (TCP is not supposed to have any knowledge of the
  2808. workings of lower layers) this technique does work well in practice.
  2809. However, it can be fooled; for example, if a routing change occurs after the
  2810. connection has been opened and the new local interface has a smaller MTU
  2811. than the previous one, IP fragmentation may occur in the local system.
  2812. .LP
  2813. The only drawback to setting a large MSS is that it might cause avoidable
  2814. fragmentation at some other point within the network path if it includes a
  2815. "bottleneck" subnet with an MTU smaller than that of the local interface.
  2816. (Unfortunately, there is presently no way to know when this is the case.
  2817. There is ongoing work within the Internet Engineering Task Force on a "MTU
  2818. Discovery" procedure to determine the largest datagram that may be sent over
  2819. a given path without fragmentation, but it is not yet complete.)
  2820. Also, since the MSS you specify is sent to the remote system, and not all
  2821. other TCPs do the MSS-lowering procedure yet, this might cause the remote
  2822. system to generate IP fragments unnecessarily.
  2823. .LP
  2824. On the other hand, a too-small MSS can result in a considerable performance
  2825. loss, especially when operating over fast LANs and networks that can handle
  2826. larger packets. So the best value for MSS is probably 40 less than the
  2827. largest MTU on your system, with the 40-byte margin allowing for the TCP and
  2828. IP headers. For example, if you have a SLIP interface with a 1006 byte MTU
  2829. and an Ethernet interface with a 1500 byte MTU, set MSS to 1460 bytes. This
  2830. allows you to receive maximum-sized Ethernet packets, assuming the path to
  2831. your system does not have any bottleneck subnets with smaller MTUs.
  2832. .NH 3
  2833. Setting Window
  2834. .LP
  2835. A sliding window protocol like TCP cannot transfer more than one window's
  2836. worth of data per round trip time interval. So this TCP-level parameter
  2837. controls the ability of the remote TCP to keep a long "pipe" full. That is,
  2838. when operating over a path with many hops, offering a large TCP window will
  2839. help keep all those hops busy when you're receiving data. On the other hand,
  2840. offering too large a window can congest the network if it cannot buffer all
  2841. that data. Fortunately, new algorithms for dynamic controlling the
  2842. effective TCP flow control window have been developed over the past few
  2843. years and are now widely deployed.
  2844. \fBNet.exe\fP includes them, and you can watch them
  2845. in action with the \fBtcp status <tcb>\fP or \fBsocket <sockno>\fP commands.
  2846. Look at the \fBcwind\fP (congestion window) value.
  2847. .LP
  2848. In most cases it is safe to set the TCP window to a small integer
  2849. multiple of the MSS (eg. 4 times), or larger if necessary to fully utilize a
  2850. high bandwidth*delay product path. One thing to keep in mind, however, is
  2851. that advertising a certain TCP window value declares that the system has
  2852. that much buffer space available for incoming data.
  2853. \fBNet.exe\fP does not actually preallocate this space;
  2854. it keeps it in a common pool and may well "overbook" it,
  2855. exploiting the fact that many TCP connections are idle for long periods
  2856. and gambling that most applications will read incoming data from an active
  2857. connection as soon as it arrives, thereby quickly freeing the buffer memory.
  2858. However, it is possible to run \fBnet.exe\fP out of memory if excessive TCP window
  2859. sizes are advertised and either the applications go to sleep indefinitely
  2860. (eg. suspended Telnet sessions) or a lot of out-of-sequence data arrives.
  2861. It is wise to keep an eye on the amount of available memory and to decrease
  2862. the TCP window size (or limit the number of simultaneous connections) if it
  2863. gets too low.
  2864. .LP
  2865. Depending on the channel access method and link level protocol, the use
  2866. of a window setting that exceeds the MSS may cause an increase in channel
  2867. collisions. In particular, collisions between data packets and returning
  2868. acknowledgements during a bulk file transfer
  2869. may become common. Although this is, strictly speaking,
  2870. not TCP's fault, it is possible to work around the problem at the TCP level
  2871. by decreasing the window so that the protocol operates in stop-and-wait mode.
  2872. This is done by making the window value equal to the MSS.
  2873. .NH 2
  2874. Summary
  2875. .LP
  2876. In most cases, the default values provided by \fBnet.exe\fP for each of these
  2877. parameters
  2878. will work correctly and give reasonable performance. Only in special
  2879. circumstances such as operation over a very poor link or experimentation
  2880. with high speed modems should it be necessary to change them.
  2881. .NH 1
  2882. Mail Forwarding
  2883. .NH 2
  2884. Intended audience
  2885. .LP
  2886. This section is
  2887. intended for the NOS system operator desiring to
  2888. enable the forwarding of mail to other systems. They are NOT intended
  2889. as a user guide for the mail capabilities of NOS.
  2890. .NH 2
  2891. Background
  2892. .LP
  2893. This section of the NOS docs deals with the intricacies of mail
  2894. forwarding. You should read and understand this documentation
  2895. thoroughly before attempting to forward mail through your NOS box to
  2896. the AX.25 BBS world, otherwise you might grossly misconfigure your
  2897. system and be the unhappy recipient of flames from BBS sysops.
  2898. .LP
  2899. This section does NOT deal with the minutae of the mailbox and its
  2900. various commands; it assumes that you understand concepts such as user
  2901. areas (both public and private) and how to list and send mail. If you
  2902. need help with these, please look elsewhere in the NOS docs.
  2903. .LP
  2904. Apart from the usual domain.txt and other files necessary for ordinary
  2905. functionality of NOS, three files are important in the mail forwarding
  2906. process. These are: /spool/forward.bbs, /alias and /spool/rewrite.
  2907. The contents of these will now be addressed individually.
  2908. .NH 2
  2909. /spool/forward.bbs
  2910. .LP
  2911. This file describes the actions taken by NOS in forwarding to AX.25
  2912. BBSes. The file contains a series of forwarding records, each record
  2913. being separated by a line containing two or more hyphens. The template
  2914. for a forwarding record is:
  2915.  
  2916. .nf
  2917. BBS callsign
  2918. Connection route
  2919. Connection commands                <zero or more lines>
  2920. List of areas to be forwarded      <one per line>
  2921. ------------                       <end of record>
  2922. .fi
  2923. .NH 2
  2924. BBS callsign
  2925. .LP
  2926. This is simply the ordinary call of the remote BBS. A typical (but not
  2927. random!) entry might be simply the line:
  2928.  
  2929. sm0rgv
  2930.  
  2931. The callsign may be followed, on the same line, by a comma separated
  2932. list of valid intervals when forwarding is to take place. Each valid
  2933. interval is a four digit number: the first two digits are the
  2934. beginning hour of the valid interval, the last two digits are the
  2935. final hour of the valid interval. For example, if the first line of a
  2936. forwarding record looks like:
  2937.  
  2938. sm0rgv 0006,1414
  2939.  
  2940. then forwarding to sm0rgv will take place only during hours numbered
  2941. 00, 01, 02, 03, 04, 05, 06 and 14. Ticks of the mbox timer outside of
  2942. these times will not cause mail to be forwarded to sm0rgv. The default
  2943. interval for forwarding is 0023.
  2944. .NH 2
  2945. Connection route
  2946. .LP
  2947. This is the method by which communication is to be established with
  2948. the remote BBS. The first token on the line is the type of protocol to
  2949. be used. This is one of ax25, netrom or tcp. Following this is
  2950. whatever further information the chosen protocol requires to make the
  2951. connection. An example connection route for a simple ax25 connection
  2952. on interface ax0 is:
  2953.  
  2954. ax25 ax0 g3dlh
  2955.  
  2956. .NH 2
  2957. Connection commands
  2958. .LP
  2959. Connection commands may, optionally, follow the connection route.
  2960. These take the form of a full stop (period), followed by the command
  2961. which will be transmitted once the connection defined in the first
  2962. line of the connection route is established.
  2963.  
  2964. For example, suppose that we wish to establish a netrom connection
  2965. with sm0rgv-2, through the netrom node #sth67. Then the connection
  2966. route and connection command portion of the record would look like:
  2967.  
  2968. .nf
  2969. netrom #sth67
  2970.  .c sm0rgv-2     [ Please note that the full stop would be placed at
  2971.                    the beginning of the line; I have placed it here
  2972.                    indented by one column simply so that gateways
  2973.                    which handle this message do not complain at
  2974.                    having a line beginning with a full stop; this
  2975.                    convention is followed throughout this documentation]
  2976. .fi
  2977. .LP
  2978. If the station is reached through digipeating, then the digipeater
  2979. callsigns should be in the ax25 route to the destination callsign.
  2980. That is, if you wish to forward traffic to w0ljf, using k2na as a
  2981. digipeater, then you should have the line:
  2982.  
  2983. ax25 route add w0ljf k2na
  2984.  
  2985. in your autoexec file.
  2986.  
  2987. .NH 2
  2988. List of areas to be forwarded
  2989. .LP
  2990. This is a list, one per line, of entries in the /spool/mail directory
  2991. which will be forwarded to the remote BBS. An entry of the form:
  2992.  
  2993. callsign
  2994.  
  2995. will cause the file /spool/mail/callsign.txt to be scanned for unread
  2996. messages. Any such messages are sent to the remote BBS and deleted
  2997. from the file.
  2998.  
  2999. One can also forward user areas using this mechanism. To do this,
  3000. simply place a line containing the name of the area in the record. So,
  3001. to forward amsat bulletins to the BBS, one would have a line:
  3002.  
  3003. amsat
  3004.  
  3005. This will search the /spool/mail/amsat.txt file; any messages
  3006. contained therein which have not been forwarded to the BBS in question
  3007. will be forwarded. They will NOT be deleted. The determining factor as
  3008. to whether or not entries are deleted is that if the filename is
  3009. present in the /spool/areas file, then there is NO deletion, otherwise
  3010. there is.
  3011.  
  3012. Please note that ONLY FILES IN /spool/mail are checked. In particular,
  3013. the outbound SMTP mail queue is NOT checked.
  3014. .NH 2
  3015. Changing the recipient address
  3016. .LP
  3017. Normally, NOS uses the information in the To: header line to determine
  3018. the parameters used by the "S" command during BBS forwarding. As the
  3019. To: header is unchanged by all /alias and /spool/rewrite machinations,
  3020. the mail will be sent to the BBS addressed precisely as the originator
  3021. of the message typed it. Occasionally, one might want to change this
  3022. behaviour. In this case, a line of the form:
  3023.  
  3024. area  new_address
  3025.  
  3026. in the list of areas to be forwarded will replace the originally typed
  3027. destination with the string new_address instead.
  3028. .NH
  3029. /alias
  3030. .LP
  3031. The alias file is used to map LOCAL names to other names, which may be
  3032. either local or remote; additionally, from a single input message, the
  3033. alias file permits one to produce multiple output messages. Thus,
  3034. typical uses for the /alias file are: converting one local name to
  3035. another, converting a local name to a remote name, and exploding a
  3036. mail message so that it is passed on to several recipients.
  3037.  
  3038. The format of a record in the alias file is very simple:
  3039.  
  3040. .nf
  3041. aliasname    recipient1 recipient2 recipient3
  3042. <tab> or <SP>    recipient4 ... recipientN
  3043.  
  3044. .fi
  3045. .LP
  3046. There is no separation between records in the /alias file other than a newline.
  3047.  
  3048. The aliasname is a local username; that is, it does not contain an "@"
  3049. symbol. When the alias file is processed, if the destination of the
  3050. message matches precisely the aliasname, then the mail is redirected
  3051. to ALL of the alieased recipients.
  3052.  
  3053. Scanning of the /alias file is performed by the SMTP server. The SMTP
  3054. timer (which controls the SMTP client) is kicked whenever the mailbox
  3055. or SMTP server queues something for delivery by SMTP. Mail transport
  3056. within a single NOS system is performed through the SMTP client/server
  3057. mechanism. The result of these facts is that as soon as a piece of
  3058. mail is entered to the mailbox, the SMTP client is kicked and attempts
  3059. to deliver the mail (which has already been scanned by the rewrite
  3060. mechanism \(em see below). If the mail is local to the NOS system
  3061. (i.e. no "@" sign in the address), then the /alias file will be
  3062. scanned and the name mappings take place.
  3063.  
  3064. A few lines in the /alias file might look something like:
  3065.  
  3066. .nf
  3067. bdale    bdale@n3eua
  3068. local    fred@k0yum bdale@n3eua bill@ai0c.co.usa.na
  3069.     n5op@n5op jim@k0jtz n0esg@n0esg
  3070. g4bki    g4bki@gb7bil._2712.gbr.eu
  3071.  
  3072. .fi
  3073. .LP
  3074. The system must know how to deliver traffic to each of the individual
  3075. addresses in the style in which they are entered in the /alias file.
  3076. If the system does not know how to deliver one of the new addresses,
  3077. then it will send it to the SMTP gateway station defined by the 'smtp
  3078. gateway' command.
  3079.  
  3080. Note that it is reasonable, and sometimes desireable, to have alias
  3081. records of the form:
  3082.  
  3083. area    area dest1 dest2 ...
  3084.  
  3085. As the /alias file is scanned only once (see below), this does not
  3086. result in an infinite recursion.
  3087. .NH
  3088. /spool/rewrite
  3089. .LP
  3090.  
  3091. The rewrite file is used to perform a one-to-one mapping between
  3092. destination addresses as received by NOS and destination addresses as
  3093. actually used by NOS. Each record within the rewrite file comprises a
  3094. single line, containing either two or three entries separated by
  3095. spaces. The first field is the template field; if a destination
  3096. address matches the template, it is replaced by the second field. The
  3097. third field, which is optional, is the single letter "r", which, if
  3098. present, tells NOS to rescan the rewrite file, using the new
  3099. destination address to attempt to match against the templates.
  3100.  
  3101. A template may contain asterisks. These stand for a match of any
  3102. number of characters (including zero). In the second field, the
  3103. character "$", followed by a single digit in the range 1 to 9,
  3104. represents the string that matched the respective asterisk in the
  3105. template. By way of example, suppose that there is a line in the
  3106. rewrite file which looks like:
  3107.  
  3108. *@* $1%$2@g1emm.ampr.org
  3109.  
  3110. Then, any traffic reaching the system through the mailbox or the SMTP
  3111. server, but which is supposed to go to a remote system, will be
  3112. redirected to go through g1emm.ampr.org. Suppose that a user logs on,
  3113. and sends a message to n0gbe@nq0i. Then the rewrite file attempts to
  3114. match "n0gbe@nq0i" against the entry *@*. It matches, and assignes $1
  3115. the value n0gbe, and $2 the value nq0i. The mail file as written to
  3116. the disk will no longer be to n0gbe@nq0i, but, rather, to
  3117. n0gbe%nq0i@g1emm.ampr.org. [The nomenclature
  3118. station1%station2@station3 means the final destination is
  3119. station1@station2, and this traffic is to be routed through the
  3120. gateway station3.]
  3121.  
  3122. As soon as a template match is found, the conversion is performed and
  3123. scanning is stopped, unless the third "r" field is present, in which
  3124. case scanning restarts from the top of the file.
  3125.  
  3126. N.B. It is a good idea to have a line of the form:
  3127.  
  3128. *@*.ampr.org $1@$2.ampr.org
  3129.  
  3130. at the beginning of your rewrite file. This will cause all amprnet
  3131. traffic to be caught early in the rewrite scan, and no further
  3132. scanning (and, hence, no unexpected substitutions) will take place.
  3133. .NH 2
  3134. Scanning procedure
  3135. .LP
  3136. The two files which are used to determine the disposition of traffic
  3137. are scanned under slightly different circumstances. Note that neither
  3138. the /alias nor the /spool/rewrite scan makes any actual changes to the
  3139. contents of the traffic. In particular, the To: field remains exactly
  3140. as it was first entered into the system.
  3141.  
  3142. There are four possible entry routes for traffic into the system:
  3143. SMTP, through the mailbox by a user, through the mailbox by a BBS, and
  3144. via an external program (like BM) or creation of the files manually.
  3145. NOS determines if a piece of traffic was entered into the system by a
  3146. BBS by looking for a BBS system ID (like the "[NET-H$]" block issued
  3147. by NOS) on the incoming connection prior to messages being uploaded.
  3148. .NH 2
  3149. Traffic received by SMTP server
  3150. .LP
  3151. 1. The rewrite file is scanned and any changes applied (unless the
  3152. traffic was recieved through the local mailbox; in that case, this
  3153. step does not occur);
  3154. .br
  3155. 2. If the traffic appears to be local then the alias file is scanned
  3156. and any changes or explosions applied.
  3157. .br
  3158. 3. Any copies local to the system are delivered; copies for remote
  3159. delivery are placed in the SMTP queue.
  3160. .NH 2
  3161. Traffic received by mailbox from user
  3162. .LP
  3163. 1. The rewrite file is scanned and any changes applied;
  3164. .br
  3165. 2. The traffic is passed to the SMTP client.
  3166. .NH 2
  3167. Traffic received by mailbox from BBS
  3168. .LP
  3169. 1. The rewrite file is scanned and any changes applied;
  3170. .br
  3171. 2. The traffic is passed to the SMTP client.
  3172. .NH 2
  3173. Traffic entered by external mechanism
  3174. .LP
  3175. 1. No scanning occurs;
  3176. .br
  3177. 2. The traffic is passed to the SMTP client.
  3178. .NH 2
  3179. Headers
  3180. .LP
  3181. Appropriate RFC-822 headers are added to all incoming traffic. Traffic
  3182. entering through the mailbox recieves a full complement of RFC-822
  3183. headers; traffic coming through the SMTP server has only a "Received:"
  3184. header applied. On forwarding to a BBS, if an item of traffic contains
  3185. BBS R: headers, the RFC-822 header is converted to an appropriate R:
  3186. line at the time that NOS forwards the message. (This change only
  3187. occurs for BBS forwarding; forwarding by SMTP retains the RFC-822
  3188. headers.)
  3189. .NH 2
  3190. Bulletin Identifiers (BIDs)
  3191. .LP
  3192. The AX.25 BBS system has evolved a reasonably efficient way of
  3193. reducing overhead when forwarding bulletins. When a bulletin is
  3194. originated on a BBS, it is given a unique bulletin identifier (BID).
  3195. This BID should (theoretically) travel with the bulletin, and should
  3196. never be changed during the distribution of the bulletin. Each system
  3197. keeps track of all received BIDs. If a forwarding station wishes to
  3198. forward a bulletin to a BBS, then the receiving station checks its
  3199. local list of known BIDs and informs the transmitting station if it
  3200. already posesses the bulletin in question. The NOS mailbox conforms to
  3201. this protocol. Received BIDs are stored in the file /spool/history,
  3202. and are encoded in the Message-ID: header line of the message by NOS.
  3203. Messages forwarded from areas listed in the /areas file will have
  3204. their BID (re)generated from the Message-ID: line. Note that ALL
  3205. messages from public areas are forwarded with a BID, whether or not
  3206. the message was produced with the "SB" command. Like other BBSes, NOS
  3207. will inform a transmitting station not to transmit a bulletin if it is
  3208. one that NOS already has locally; likewise, it understands similar
  3209. messages from other stations to which it tries to forward.
  3210.  
  3211. Note that the BID mechanism is not a part of the SMTP world. If you
  3212. are forwarding bulletins through SMTP, there is no mechanism by which
  3213. the receiving station can reject the attempted delivery of a bulletin,
  3214. even if it already exists on the recipient system. (Note that a
  3215. possible workaround is to deliver bulletins to TCP/IP stations using
  3216. TCP instead of SMTP. Alternatively, one could use NNTP, as NNTP
  3217. commands utilise the Message-ID: line, from which the BID is derived.)
  3218. The BID is preserved no matter which mechanism is used to deliver the
  3219. bulletin.
  3220.  
  3221. .NH 2
  3222. Traffic in practice
  3223. .LP
  3224. Now, the big question is, how does one set up these various files to
  3225. perform intelligent manipulation of mail? A number of examples follow.
  3226. Note that, often, there is more than one way to accomplish an
  3227. objective. The following are merely examples (and not necessarily the
  3228. most efficient method possible for any given case). The format used
  3229. will be:
  3230.  
  3231. typed destination -> intended destination
  3232.  
  3233. followed by the necessary entries in the alias (/alias), rewrite
  3234. (/spool/rewrite) and forwarding (/spool/forward.bbs) files.
  3235.  
  3236. .NH 2
  3237. Using familiar names \(em SMTP destination
  3238. .LP
  3239. .nf
  3240. bdale -> bdale@n3eua.ampr.org
  3241.  
  3242. alias:
  3243. bdale    bdale@n3eua.ampr.org
  3244.  
  3245. rewrite:
  3246. forward:
  3247.  
  3248. .NH 2
  3249. Exploding local mail
  3250. .LP
  3251. .nf
  3252. sysops -> nq0i, n5op@n5op.ampr.org
  3253.  
  3254. alias:
  3255. sysops    nq0i n5op@n5op@ampr.org
  3256.  
  3257. rewrite:
  3258. forward:
  3259.  
  3260. .NH 2
  3261. Using familiar names \(em BBS forwarding
  3262. .LP
  3263. .nf
  3264. g4bki -> g4bki@gb7bil._2712.gbr.eu, to be forwarded by ai0c
  3265.  
  3266. alias:
  3267. rewrite:
  3268. forward:
  3269. ai0c
  3270. ax25 ax1 ai0c
  3271. g4bki g4bki@gb7bil._2712.gbr.eu
  3272. ai0c
  3273.  
  3274. .NH 2
  3275. Handling incoming bulletins by subject
  3276. .LP
  3277. .nf
  3278. tcpip@* -> nq0i, tcpip, bdale@n3eua.ampr.org, ai0c@ai0c [a BBS]
  3279.  
  3280. alias:
  3281. tcpip    nq0i tcpip bdale@n3eua.ampr.org ai0c
  3282.  
  3283. rewrite:
  3284. tcpip@* tcpip
  3285.  
  3286. forward:
  3287. ai0c
  3288. ax25 ai0c
  3289. ai0c
  3290.  
  3291. .fi
  3292. Let's walk through the above example. An incoming item comes in
  3293. addressed to TCPIP@ALLUS. A scan is made through the rewrite file, and
  3294. a match is found. The item is redirected to tcpip. The alias file is
  3295. scanned; a total of four copies of the item exist after this, three in
  3296. local areas tcpip, nq0i and ai0c, and one on the SMTP queue (for
  3297. bdale@n3eua.ampr.org). When the mailbox timer next ticks, the mail in
  3298. the local ai0c area will be forwarded on the ax1 interface to ai0c.
  3299.  
  3300. .NH 2
  3301. Routing based on Hierarchical addressing
  3302.  
  3303. .LP
  3304. .nf
  3305. Wyoming -> KE7VS (SMTP)
  3306. Nebraska -> AG0N (BBS over the NETROM, NETROM ID WNBBS)
  3307. Europe -> W0LJF (BBS over AX.25)
  3308.  
  3309. alias:
  3310. rewrite:
  3311. *.noam            $1.na r
  3312. *.us              $1.usa.na r
  3313. *.usa             $1.usa.na r
  3314.  
  3315. *.ne              $1.ne.usa.na r
  3316. *.wy              $1.wy.usa.na r
  3317.  
  3318. *@*.*.wy.usa.na   $1%$2.$3.wy.usa.na@ke7vs
  3319. *@*.wy.usa.na     $1%$2.wy.usa.na@ke7vs
  3320.  
  3321. *.ne.usa.na     ag0n
  3322.  
  3323. *.eu            w0ljf
  3324.  
  3325. forward:
  3326. ag0n
  3327. netrom ax0 wnbbs
  3328. ag0n
  3329. ----------
  3330. w0ljf
  3331. ax25 ax1 w0ljf
  3332. w0ljf
  3333. ----------
  3334.  
  3335. .fi
  3336. Why is the example rewrite file apparently so complicated? This is to
  3337. handle poorly constructed hierarchical addresses in a reasonable way.
  3338. A full U.S. hierarchical address has the form:
  3339. callsign@BBS.#localid.state.usa.na. Many states have no #localid
  3340. field. In the example rewrite file above, the first three lines
  3341. convert non-standard, but frequently used, U.S. designators to the
  3342. more standard format. It is common for users not to use a full
  3343. hierarchical address if the destination is relatively local. For
  3344. eample, a user might easily use only .wy instead of the full
  3345. .wy.usa.na if he is geographically close to Wyoming. The second
  3346. grouping of two lines handles this problem. Note the third, "r", field
  3347. in all the entries so far.
  3348.  
  3349. The remainder of the file handles properly formatted hierarchical
  3350. addresses. The two Wyoming entries handle the cases with and without a
  3351. #localid field. Differentiation between these cases is not necessary
  3352. for BBS forwarding.
  3353. .NH 2
  3354. General bulletin handling
  3355. .LP
  3356. The details of bulletin handling will vary somewhat from place to
  3357. place, as there are several distinct styles of bulletin handling
  3358. currently in use in the AX.25 BBS world. In general, it is necessary
  3359. to arrange one's system so that it accepts bulletins from BBSes,
  3360. forwards them to one or more stations, and also handles intelligently
  3361. bulletins input by users into NOS.
  3362.  
  3363. Suppose that we sish to handle bulletins @JUNK. We are to deposit them
  3364. locally in the junk area, and also forward to BBS g4bki. We also know
  3365. that we generally receive @JUNK bulletins from g4amj, a local BBS
  3366. which handles much bulletin traffic.
  3367. .nf
  3368. alias:
  3369. rewrite:
  3370. *@junk   junk
  3371.  
  3372. forward:
  3373. g4bki
  3374. ax25 ax1 g4bki
  3375. g4bki
  3376. junk
  3377. ----------
  3378. g4amj
  3379. ax25 ax1 g4amj
  3380. g4amj
  3381. junk
  3382. ----------
  3383.  
  3384. .fi
  3385. All incoming @JUNK traffic is written to the junk area (which should
  3386. be an explicit entry in the /spool/areas file). Each tick of the
  3387. mailbox timer, NOS scans the junk area for traffic not forwarded to
  3388. g4bki or g4amj and attempts to deliver unforwarded bulletins. Usually,
  3389. g4amj will respond with a "Have it" message and the bulletin will not
  3390. be forwarded. Any bulletins @JUNK deposited locally by users will
  3391. automatically be sent to both g4bki and g4amj.
  3392. .NH
  3393. Questions and Answers
  3394. .LP
  3395. Q. Under what circumstances does NOS request reverse forwarding from a BBS?
  3396.  
  3397. A. NOS requests a reverse forward after completing any forwards of its
  3398. own to the BBS. If no traffic was queued for a given BBS, then no
  3399. connection is attempted, so no reverse forward request is issued.
  3400.  
  3401. Q. What kinds of message types does the NOS mbox support?
  3402.  
  3403. A. Basically, NOS supports all two letter commands starting with an
  3404. "S". If the mailbox has not received an SID banner (the "[NET-H$]")
  3405. from a connected station, then an SF command will send a followup to
  3406. the address specified on the command line. The SR command will send a
  3407. reply to the current message. One can also issue the command "SR
  3408. <number>", where <number> is the number of the message to which you
  3409. want to generate a reply. All other variations cause an
  3410. X-BBS-Msg-Type: header to be added to the message. When a message with
  3411. such a line is forwarded to a BBS, it is sent to the BBS with the
  3412. appropriate message type as the second letter in the "S" command to
  3413. the BBS.
  3414.  
  3415. If NOS has received a valid SID, then ALL S commands are handled by
  3416. the X-BBS-Msg-Type: mechanism outlined above.
  3417. .bp
  3418. .NH
  3419. Logic map of the mailbox
  3420.  
  3421. .LP
  3422. .nf
  3423. ============== AX.25 === NET/ROM === Ethernet === Loopback =================
  3424.        |                   |                   |                   |
  3425.        |                   |                   |                   |
  3426. +--------------+    +--------------+    +--------------+    +--------------+
  3427. |              |    |              |    |              |    |              |
  3428. |   Mailbox    |    | SMTP client  |    | SMTP server  |    | BBS Forward  |
  3429. |              |    |              |    |              |    |              |
  3430. +--------------+    +--------------+    +--------------+    +--------------+
  3431.        |                   ^                   |                   ^
  3432.        |                   |                   |                   |
  3433.        v                   |                   v                   |
  3434. +--------------+    +--------------+    +--------------+    +--------------+
  3435. |              |    |              |    |              |    |              |
  3436. | Add RFC822   |    | Use MX or A  |    | Add Received |    | Add own R:   |
  3437. | header suite |    | type records |    | line         |  +>| line         |
  3438. |              |    |              |    |              |  | |              |
  3439. +--------------+    +--------------+    +--------------+  | +--------------+
  3440.        |                   ^                   |          |        ^
  3441.        |                   |                   |          |        |
  3442.        v                   |                   v          |        |
  3443. +--------------+    +--------------+    +--------------+  | +--------------+
  3444. |              |    |              |    |              |  | |              |
  3445. | Get Rewrite  |    | Use optional |    | Apply Rewrite|  | | Strip RFC822 |
  3446. | file address |    | SMTP gateway |    | file address |  | | header suite |
  3447. |              |    |              |    |              |  | |              |
  3448. +--------------+    +--------------+    +--------------+  | +--------------+
  3449.        |                   ^                   |          |        ^
  3450.        |                   |                   |          |        | Yes
  3451.        v                   |                   v          |        |
  3452. +--------------+           |            +--------------+  | +--------------+
  3453. |              |   No      |            |              |  | |              |
  3454. | Local addr?  |-------+   |            | Alias file   |  +-| Any R: lines?|
  3455. |              |       |   |            |              | No |              |
  3456. +--------------+       |   |            +--------------+    +--------------+
  3457.        |               |   |                |  |  |                ^
  3458.        | Yes           |   |                |  |  |                |
  3459.        v               |   |                v  v  v                |
  3460. +--------------+       v   |            +--------------+    +--------------+
  3461. |              |    +--------------+    |              |    |              |
  3462. | Apply Rewrite|    |              | No | Local        |Yes | /spool/mail/ |
  3463. | file address |--->| SMTP queue   |<---| address?     |--->| directory    |
  3464. |              |    |              |    |              |    |              |
  3465. +--------------+    +--------------+    +--------------+    +--------------+
  3466. .fi
  3467. .NH 1
  3468. Credits
  3469. .LP
  3470. Several people have contributed to this manual. I would particularly
  3471. like to thank Bill Simpson and Michael Westerhof, KA9WSB,
  3472. for their significant editorial contributions to this document.
  3473. Deborah Swanberg wrote the original BOOTP documentation,.
  3474. and G4AMJ/NQ0I and SM0RGV contributed the section on mail forwarding.
  3475. .LP
  3476. Although I am the primary author of this software package, many others have
  3477. contributed substantial additions and refinements.
  3478. Here is a partial list; additions and corrections are welcome.
  3479. See the individual source code files for additional authorship details.
  3480. .NH 2
  3481. ARCNET
  3482. .LP
  3483. Written by Russ Nelson of Clarkson University.
  3484. .NH 2
  3485. Autodialer
  3486. .LP
  3487. Bill Simpson substantially rewrote my original version and created
  3488. a much improved control file format.
  3489. .NH 2
  3490. Bootstrap Protocol (BOOTP)
  3491. .LP
  3492. Written by Deborah Swanberg of the University of Michigan.
  3493. .NH 2
  3494. Domain resolver
  3495. .LP
  3496. Bill Simpson substantially extended my original version, adding record
  3497. caching and automatic expiration.
  3498. .NH 2
  3499. DRSI driver
  3500. .LP
  3501. Written by Stu Phillips, N6TTO.
  3502. .NH 2
  3503. Eagle 8530 board driver
  3504. .LP
  3505. Written by Art Goldman, WA3CVG, and Richard Bisbey, NG6Q.
  3506. .NH 2
  3507. HAPN 8273 HDLC board driver
  3508. .LP
  3509. Written by Jon Bloom, KE3Z, with fixes by John Tanner, VK2ZXQ.
  3510. .NH 2
  3511. Hop Check utility
  3512. .LP
  3513. Written by Katie Stevens of UC Davis; enhancements by Bill Simpson.
  3514. .NH 2
  3515. Mailbox server & SMTP
  3516. .LP
  3517. My original, primitive SMTP server was
  3518. vastly enhanced and expanded by Bdale Garbee, N3EUA and Dave Trulli,
  3519. NN2Z. Anders Klemets, SM0RGV, wrote the first "mailbox" specifically
  3520. for AX.25; he then expanded it into a full-blown bulletin board system
  3521. and integrated it with the SMTP facilities.
  3522. .NH 2
  3523. NET/ROM
  3524. .LP
  3525. The original NET/ROM code was done by Dan Frank, W9NK. It was ported
  3526. to the NOS platform by Anders Klemets, SM0RGV.
  3527. .NH 2
  3528. Netnews Transfer Protocol (NNTP)
  3529. .LP
  3530. Written by Anders Klements, SM0RGV, with help from Bernie Roehl and
  3531. Gerard Van Der Grinten, PA0GRI.
  3532. .NH 2
  3533. Packet Drivers
  3534. .LP
  3535. Although not really part of this package, the Clarkson Packet Driver
  3536. Collection by Russ Nelson of Clarkson University has enormously enhanced
  3537. the utility of this package by allowing it to use virtually every PC
  3538. Ethernet controller board on the market.
  3539. .NH 2
  3540. PI 8530 DMA HDLC driver
  3541. .LP
  3542. Written by Dave Perry, VE3IFB.
  3543. .NH 2
  3544. Post Office Protocol (POP)
  3545. .LP
  3546. Originally authored by Mike Stockett, WA7DYX. Updates and modifications
  3547. by Allen Gwinn, N5CKP, Gerard Van Der Grinten, PA0GRI, and Mark Edwards,
  3548. WA6SMN.
  3549. .NH 2
  3550. Point to Point Protocol (PPP)
  3551. .LP
  3552. Written by Katie Stevens of UC Davis, based on the original
  3553. implementation by Drew Perkins of CMU. Updated by Bill Simpson and
  3554. Glenn McGregor of the University of Michigan.
  3555. .NH 2
  3556. Routing Information Protocol (RIP)
  3557. .LP
  3558. Original (pre-NOS) version written by Al Broscious N3FCT.
  3559. .NH 2
  3560. SCC - Generic 8530 driver
  3561. .LP
  3562. Originally written for the old "NET" code
  3563. by Rob Janssen, PE1CHL. Ported to NOS by Ken Mitchum, KY3B.
  3564. .NH 2
  3565. Socket-level stream compression
  3566. .LP
  3567. Written by Anders Klemets, SM0RGV
  3568. .NH 2
  3569. TCP/IP Header Compression
  3570. .LP
  3571. Adapted from Van Jacobson's original BSD UNIX implementation by
  3572. Katie Stevens of UC Davis. Updated by Bill Simpson.
  3573.