home *** CD-ROM | disk | FTP | other *** search
/ ftp.cse.unsw.edu.au / 2014.06.ftp.cse.unsw.edu.au.tar / ftp.cse.unsw.edu.au / pub / doc / slirp / CONFIG < prev    next >
Encoding:
Text File  |  1996-06-26  |  9.8 KB  |  280 lines
  1. Key:
  2.     all options within [] are optional
  3.     usable: refers to where it can be used, ie: "command-line/config-file",
  4.             "telnet", or "anywhere" (which means it can appear in either
  5.             command-line/config-file or telnet).
  6.     command-line: gives the command-line equivalent
  7.     XXX etc.
  8.  
  9.  
  10. redir X [start RDISP] [ADDR][:DISPLAY[.SCREEN]]
  11.     redirect a port for use with X
  12.     
  13.     usable: anywhere
  14.     command-line: -X
  15.     options:
  16.     start RDISP    tell slirp to start looking for free ports starting
  17.             from N.  eg: if N = 2, slirp will try to grab port
  18.             6002 then 6003 etc.  this is useful for sites which
  19.             sometimes run their own X server and you don't want
  20.             to nab their port 6000, which they would naturally expect.
  21.         ADDR        our home ip address, or the address where the x server is
  22.             (if you have a LAN at home to connect more than one machine
  23.             to the net) (default 10.0.2.15 when in ~/.slirprc, the
  24.             source IP address when in command-line)
  25.     DISPLAY        which display to redirect to (default :0)
  26.     SCREEN        which screen to redirect to (default .0)
  27.     Example:
  28.         redir X 10.0.2.15:0.0
  29.     Note:
  30.         this will print the command needed to enter into each shell from
  31.         where you launch your X apps
  32.     See also:
  33.         show X
  34.     
  35. show X
  36.     show the command that needs to be given to your shell for any X port
  37.     that has been redirected (in case you forget).
  38.     
  39.     usable: telnet
  40.     command-line: NONE
  41.     options:
  42.         NONE
  43.     Example:
  44.         show X
  45.     Note:
  46.         this is useful if you forget the command to give to your shell for
  47.         X redirection.
  48.     See also:
  49.         redir X, log start
  50.     
  51. redir [once|time] [udp|tcp] PORT [to] [ADDRESS:]LPORT
  52.     redirect host port to local port using a selected protocol.
  53.     
  54.     usable: anywhere
  55.     command-line: NONE
  56.     Options:
  57.         once    only allow one redirection [TCP only]
  58.     time    allow redirection to time out [UDP only]
  59.     udp    redirect a UDP port
  60.     tcp    redirect a TCP port [default]
  61.         PORT    port to use on host system
  62.     ADDRESS address of your home machine [default 10.0.2.15]
  63.         LPORT   port to redirect host port to on local system
  64.     Example:
  65.         redir tcp 5021 to 21
  66.                 allow users to ftp to your local machine using
  67.                 your host's port 21. (ftp your.hosts.name 5021)
  68.     Note:
  69.         if this command is in your .slirprc file and no address is
  70.         specified, it will assume  that your local IP address is 10.0.2.15.
  71.         If you enter the command from the slirp control telnet IP it will
  72.         use the IP address you are accessing with.
  73.  
  74. baudrate N
  75.     controls the allocation of time to communications across 
  76.     your serial link.  Higher values generally use more of
  77.     the available bandwidth to your modem.  This is _only_
  78.     an internal control value and does _not_ change the physical
  79.     settings for the host port or modem.
  80.     
  81.     usable: anywhere
  82.     command-line: -b
  83.     Options:
  84.         N    change baudrate to N
  85.     Example:
  86.         baudrate 14400
  87.     Note:
  88.         higher numbers generally allow better transfer rates
  89.         for ftp sessions, but interactive sessions could become less
  90.     responsive.  the optimum value is *JUST* when ftp sessions reach
  91.     maximum throughput, but this can be hard to find (especially on
  92.     compressing modems) so you should choose the maximum throughput
  93.     you would expect from your modem.
  94.  
  95. special|control|host addr ADDRESS
  96.     set ip address aliases and others for slirp.
  97.     
  98.     usable: anywhere
  99.     command-line: none
  100.     Options:
  101.         special address     set the network ip alias for slirp
  102.         control address     only allow access to slirp control 
  103.                             address from ADDRESS.
  104.     host address        tell slirp the IP address of the host it's
  105.                         running on.  use this only if slirp can't
  106.                 properly find the host's IP address
  107.     Example:
  108.         special address 10.0.3.0
  109.     Note:
  110.         the ADDRESS for special must end in 0 (zero) and other 
  111.         addresses are classed from this.  The default special
  112.         address is 10.0.2.0 giving the following defined IP's
  113.             10.0.2.0        slirp control telnet IP
  114.             10.0.2.1        slirp exec IP
  115.             10.0.2.2        slirp host alias
  116.         10.0.2.x        add [pty]exec optional address
  117.  
  118. add [pty]exec PROGRAM:[ADDRESS:]PORT
  119.     Set program to execute on host  when local machine attempts
  120.     to connect to ADDRESS at port PORT.
  121.     
  122.     usable: anywhere
  123.     command-line: none
  124.     Options:
  125.         exec    establish binary connection to program
  126.             in the style of inetd.
  127.         ptyexec    establish telnet connection to program
  128.                 using telnetd helper application under a
  129.         pseudo-terminal
  130.         PROGRAM    program to exec
  131.     ADDRESS optional address
  132.     PORT    port
  133.     Example:
  134.         add ptyexec csh:55
  135.                 A telnet connection to the slirp exec IP 
  136.         (default 10.0.2.1) will start and connect you 
  137.         directly to the csh program on the host. 
  138.         (telnet 10.0.2.1 55)
  139.         add exec nntpd:10.0.2.3:119
  140.                 A program that attempts to open port 119 at
  141.                 address 10.0.2.3 will be connected to the 
  142.                 nntpd program.
  143.     Note:
  144.         the use of the ptyexec form requires the slirp.telnetd
  145.         helper application be available on your path.  also note that
  146.     ADDRESS must be of the form SPECIAL_ADDRESS.xx (10.0.2.xx by default)
  147.  
  148. [no]compress
  149.     force startup mode for slirp to SLIP or CSLIP.  This 
  150.     overrides the default automatic mode determination.
  151.     Command:
  152.         nocompress    start in SLIP mode
  153.         compress      start in CSLIP mode
  154.     Options:
  155.         NONE
  156.     Note:
  157.         the default method of operation generally performs
  158.         well.  You should only have to use this command if
  159.         you find that your host and local system are failing
  160.         synchronize the connection type.
  161.  
  162. mtu N
  163.     controls the size of the IP packets sent across the serial
  164.     IP link.  Valid values are <= 1500.
  165.     Options:
  166.         NONE
  167.     Example:
  168.         mtu 1500
  169.                 set the mtu to its largest allowable size.
  170.     Note:
  171.         larger values generally improve the performance of
  172.         graphics web browsers and ftp transfers across the
  173.         serial link, at the expense of interactive performance.
  174.         The default value of 552 seems to be a reasonable 
  175.         compromise for connections at 14400 baud.
  176.  
  177.  
  178. shell PROGRAM
  179.     set program to execute on EXEC IP default telnet port (23).
  180.     It is the same as
  181.         add ptyexec PROGRAM:23
  182.     Options:
  183.         NONE
  184.     Note:
  185.         by default slirp connects /bin/sh to the exec IP telnet
  186.         port.
  187.  
  188. help [COMMAND]
  189.     show a brief list of available commands, or more information on
  190.     the named command
  191.     
  192.     
  193. remove [pty]exec PROGRAM:[ADDRESS/]PORT
  194.     reverse the effect of "add [pty]exec".  see "add [pty]exec" for the
  195.     options etc.
  196.     Note:
  197.         you must enter the options exactly as you entered it in add [pty]exec.
  198.     XXX incomplete
  199.     
  200. echo [on|off]
  201.     turn echo on or off, depending on how your client behaves.  "echo" by
  202.     itself will show whether echo is currently on or off.
  203.  
  204. kill N
  205.     kill the session which has a Socket no. of N.  to find the Socket no. of a particular
  206.     session, use the "stats socket" commands.  see
  207.     "stats" below.
  208.     Note:
  209.         it is recommended you use "close N" instead, as this merely wipes
  210.         out the session, whereas "close N" closes it properly, as a good
  211.         little tcpip-emulator should :)
  212.     
  213.     "kill -1" shouldn't be used, it will kill the first session it finds
  214.         with -1, which usually is the command-line connection.
  215.  
  216. close N
  217.     close the session which has a Socket no. of N.  same as "kill N", but
  218.     closes it session gracefully.  see "kill N"
  219.     
  220.  
  221. stats [ip | socket | tcp | vj | udp | mbuf | tty | alltty | others? ]
  222.     show statistics on the given argument
  223.     Options:
  224.         ip    show ip statistics
  225.     socket  show statistics on the currently active sockets.  use this
  226.                 to find out which sessions to close/kill as it will also
  227.         show the FD of the session
  228.     tcp     show tcp statistics (packets sent/received/etc)
  229.     udp     same as tcp but for udp
  230.     mbuf    show how many mbufs were allocated, are in use, etc.
  231.             if the modem is idle, and there are more than 1 mbufs on
  232.         the used list, it suggests an mbuf leak
  233.  
  234. [pty]exec PROGRAM
  235.     this will execute PROGRAM, and the current command-line session will
  236.     cease to exist, taken over by the PROGRAM. ie: when the program exits,
  237.     you will not get the command-line back, the session will (should) close.
  238.  
  239. socket [PORT,PASSWORD]
  240.     create a Unix-domain socket and listen() for more interfaces to connect.
  241.     This is also needed for restarting.  Give the arguments PORT,PASSWORD if
  242.     you wish to use Internet-domain sockets instead of UNIX-domain sockets.
  243.  
  244. log start
  245.     log all the startup output to the file .slirp_start.
  246.  
  247. add emu SERVICE[:TYPE_OF_SERVICE] [lport:]fport
  248.     Tell slirp to emulate SERVICE when on port lport/fport.
  249.     
  250.     service can be: ftp, ksh, irc, none
  251.     type_of_service can be: throughput, lowdelay
  252.     
  253.     lport can be given if that service needs emulation for, say, servers.
  254.     
  255.     examples:
  256.         if you wish to ftp to somewhere on port 8021, do:
  257.     
  258.     add emu ftp 8021
  259.     
  260.     if your home ftp server is on port 8021, do:
  261.     
  262.     add emu ftp 8021:0
  263.     
  264.     [NOTE: this does NOT mean if you redirect port 8021 for your ftp
  265.     daemon, it refers the the port AT HOME at which ftpd is listening to]
  266.     
  267.     if you telnet somewhere on port 8000, and you wish those packets to
  268.     go on the fastq (ie: so they have a higher priority than, say, ftp
  269.     packets), do:
  270.     
  271.     add emu none:lowdelay 8000
  272.     
  273.     this tells slirp that any packets destined for port 8000 will not
  274.     have any emulation, but it will be set IPTOS_LOWDELAY.
  275.  
  276. dns DNS_IP
  277.     Give this to slirp if you want to use 10.0.2.3 as an alias for DNS,
  278.         AND slirp guesses wrong for the DNS on startup.
  279.  
  280.