usr.sbin/srtconfig/srtconfig.1

   1 .\" $NetBSD: srtconfig.1,v 1.2 2006/12/29 10:39:11 wiz Exp $
   2 .\" This file is in the public domain.
   3 .Dd August 21, 2000
   4 .Dt SRTCONFIG 1
   5 .Os
   6 .Sh NAME
   7 .Nm srtconfig
   8 .Nd configure srt interfaces
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Ar srtX
  12 .Nm
  13 .Ar srtX
  14 .Ar N
  15 .Nm
  16 .Ar srtX
  17 del
  18 .Ar N
  19 .Nm
  20 .Ar srtX
  21 add
  22 .Ar srcaddr
  23 .Ar mask
  24 .Ar dstif
  25 .Ar dstaddr
  26 .Nm
  27 .Ar srtX
  28 set
  29 .Ar N
  30 .Ar srcaddr
  31 .Ar mask
  32 .Ar dstif
  33 .Ar dstaddr
  34 .Sh DESCRIPTION
  35 .Nm
  36 configures, or queries the configuration of,
  37 .Xr srt 4
  38 interfaces.
  39 An
  40 .Xr srt 4
  41 interface parcels packets out to other interfaces based on their source
  42 addresses (the normal routing mechanisms handle routing decisions based
  43 on destination addresses).
  44 An interface may have any number of routing choices; they are
  45 examined in order until one matching the packet is found.  The
  46 packet is sent to the corresponding interface.
  47 (Any interface, even another
  48 .Nm srt
  49 interface, may be specified; if the configurations collaborate to cause
  50 a packet to loop forever, the system will lock up or crash.)
  51 .Pp
  52 When run with only one argument,
  53 .Nm
  54 prints the settings for the specified interface.
  55 .Pp
  56 When run with two arguments,
  57 .Nm
  58 prints the settings for the routing choice whose number is given as the
  59 second argument.
  60 .Pp
  61 The form with
  62 .Sq del
  63 deletes a routing choice, identified by its number.
  64 Other choices with higher numbers, if any, will be renumbered
  65 accordingly.
  66 .Pp
  67 The
  68 .Sq add
  69 form adds a choice; the other arguments describe it, and are documented
  70 below.
  71 The new choice is added at the end of the list.
  72 .Pp
  73 The
  74 .Sq set
  75 form replaces an existing choice, given its number.
  76 The other arguments describe the new choice which is to replace
  77 whatever currently exists at the given number
  78 .Ar N .
  79 .Pp
  80 A choice is described by four pieces of information: a source address
  81 and mask, which are used to determine which choice an outgoing packet
  82 uses, a destination interface, and a destination address for the new
  83 interface.
  84 The source address and mask are specified like any Internet
  85 addresses (for convenience, the mask may instead be specified as a
  86 .Sq /
  87 followed by a small integer, CIDR-style; note that in this case the
  88 mask must still be a separate argument; it cannot be appended to the
  89 end of the source address argument).
  90 .Pp
  91 Each srt interface also has ordinary source and destination addresses
  92 which are set with
  93 .Xr ifconfig 8
  94 like any other interface; these should not be confused with any of the
  95 above.
  96 .Sh AUTHORS
  97 .An der Mouse
  98 .Aq mouse@rodents.montreal.qc.ca