"SfR Fresh" - the SfR Freeware/Shareware Archive

Member "slirp-1.0.16/README.NEXT" of archive slirp-1.0.16.tar.gz:


As a special service "SfR Fresh" has tried to format the requested source page into HTML format using source code syntax highlighting with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field.
    1 **********************************************************************
    2 ***** PLEAESE READ THIS WHOLE FILE BEFORE CONTINUING ANY FURTHER *****
    3 **********************************************************************
    4 
    5 
    6 What is Slirp?
    7 ==============
    8 
    9 Slirp is a TCP/IP emulator which turns an ordinary shell account into a
   10 (C)SLIP/PPP account.  This allows shell users to use all the funky Internet
   11 applications like Netscape, Mosaic, CUSeeMe, etc.
   12 
   13 
   14 Unpacking and Compiling Slirp
   15 =============================
   16 
   17 To unpack Slirp type the following command at your shell prompt:
   18 
   19 gzip -dc slirp-VERSION.tar.gz | tar xvf -
   20 
   21 Of course, if you have the latest GNU tar...
   22 
   23 tar xfvz slirp-VERSION.tar.gz
   24 
   25 Where VERSION is the version of Slirp you are unpacking.  This will unpack
   26 the Slirp package into a directory called slirp-VERSION.
   27 
   28 To compile Slirp type the following commands at your shell prompt:
   29 
   30 cd slirp-VERSION/src
   31 ./configure
   32 make
   33 
   34 Notes:
   35 
   36     if you do not intend to use PPP you can give ./configure the flag
   37     "--disable-ppp".  This will make a somewhat smaller executable.
   38 
   39     if you wish to disable the MS type DNS transfer for PPP, or enable
   40     MS DCC functionality, you will need to edit the created Makefile and
   41     add/remove the options.
   42     By default USE_MS_DNS is enabled, MS_DCC is disabled.
   43 
   44 
   45 That's all there is to it.  If the compilation failed, read "Getting Help"
   46 below for information on how to get help.
   47 
   48 You should be left with a file called "slirp", this is the Slirp executable.
   49 After compilation, you can type:
   50 
   51 strip slirp
   52 
   53 to make the Slirp executable smaller, but this will also remove any
   54 debugging information from the executable.
   55 
   56 Here are some common ./configure/compiler/pre-processor/etc. problems and
   57 suggestions for fixing them:
   58 
   59 * "configure: error: can not run test program while cross compiling" (or
   60 similar errors about cross compiling).  This almost always happens due to an
   61 error in the setup of the compiler.  Look in the file config.log for clues
   62 as to why it failed, or send it to your sysadmin for help.
   63 
   64 * "gcc: xxxxxxx.p: No such file or directory.": This can be completely
   65 ignored when running the pre-processor, and can probably be ignored in the
   66 actual compilation.  The .p files only contain the function prototypes.
   67 
   68 * "gcc: warning: no previous prototype for XXX'": Again, you can ignore
   69 this.
   70 
   71 * "RUN_MAKE_AGAIN: not found ... *** Error code 1": This is normal.  As
   72 suggested, simply run "make" again.
   73 
   74 
   75 Running and Quitting Slirp
   76 ==========================
   77 
   78 Once you have compiled Slirp you can delete everything except the file
   79 called "slirp", this is the Slirp executable.  I suggest you also keep all
   80 the files in the "docs" directory, this is where all the documentation is
   81 kept.  Copy the Slirp executable somewhere in your home directory (E.g.:
   82 ~/bin) then to run Slirp, you simply type:
   83 
   84 ~/bin/slirp
   85 or ~/bin/slirp -P (for PPP operation)
   86 
   87 (or whatever the full path to "slirp" is).  That's it.  Now you activate
   88 your SLIP/PPP software, and start your applications.
   89 
   90 All you have to remember is this: Once you run Slirp, your shell account now
   91 looks exactly like a SLIP/PPP account (with some limitations of course).
   92 Any documentation that you have telling you how to connect to a SLIP/PPP
   93 account is completely valid for Slirp as well.
   94 
   95 To quit Slirp you simply kill your SLIP/PPP software and type five 0's
   96 (zeroes), with a 1 second gap between each zero.  Slirp will then exit and
   97 you will be back at your shell prompt.
   98 
   99 You can also "disconnect" Slirp by typing five 1's (one's), with a 1 second
  100 gap between each.  This will disconnect Slirp from your shell's terminal and
  101 put Slirp in the background.  Later, you can type "slirp -l 0" to
  102 "reconnect" Slirp again.  Please read Section 10, "Load-balancing" and
  103 Section 11, "Link-resumption" of the Slirp manual for more information.
  104 
  105 Slirp has lots of options available, so while this will mostly get you
  106 up and running in the first instance, reading the manual is worthwhile.
  107 
  108 
  109 Files in the Slirp package
  110 ==========================
  111 
  112 Here are the list of files you'll find within the slirp package:
  113 
  114 COPYRIGHT       Conditions of the Copyright on Slirp.  Please read this.
  115 ChangeLog       Descriptions of changes made to slirp from version to
  116 		version.  Also details all contributors, and their
  117 		contributions.
  118 IMPORTANT       Information about who's the latest maintainer.
  119 		(Hint, it's not Danny)
  120 README          What was this file.
  121 README.NEXT     This file.  Really!
  122 docs/CONFIG     List of configuration options (probably out of date)
  123 docs/alt.dcom.slip-emulators.FAQ
  124                 This is the FAQ (Frequently Asked Questions) from the
  125                 newsgroup alt.dcom.slip-emulators.
  126 docs/slirp.doc  The Slirp manual.
  127 src/*           The source code to Slirp.
  128 
  129 Getting Help
  130 ============
  131 
  132 There are several sources of help.  First, read the Slirp manual called
  133 slirp.doc in the "docs" directory of the Slirp package, especially Section
  134 13, "Troubleshooting" and Section 14, "Answers to Frequently Asked Questions
  135 (FAQs)".
  136 
  137 There is also a Newsgroup dedicated to SLIP-emulators called
  138 alt.dcom.slip-emulators.  You will find lots of discussion about Slirp and
  139 other "SLIP-emulators".  The FAQ (Frequently Asked Questions) for
  140 alt.dcom.slip-emulators is included in the "docs" directory, I would suggest
  141 reading this as well.
  142 
  143 The Slirp website (http://slirp.sourceforge.net) has some information
  144 too.  Go there!
  145 
  146 A mailing list for Slirp development is hosted by SourceForge.
  147 If you are intrested in pitching in, go ahead and subscribe.
  148 
  149 If all else fails, send Kelly, the new maintainer, an e-mail
  150 with the following information:
  151 
  152 * Output of the command "uname -a" on the remote system;
  153 * Operating System name and version you run on your PC;
  154   * If it's Linux, the name of which distribution you are running and
  155     which version.
  156 * What compiler and which version you're compiling with.
  157   HINT:  If it's not GCC, then I will be tempted to have you switch to it and
  158     try it again.  Seriously, GCC is much better!
  159 * Version of Slirp you are using (IMPORTANT!!!);
  160   HINT:  If it's a 1.0g or less, you really need to upgrade first.  This is
  161     what I'll say first -- Upgrade and try it again.
  162 * If you managed to get Slirp running, run Slirp as "slirp -S" then try
  163   whatever failed.  When you exit Slirp, you should have a file called
  164   "slirp_stats".  Send me this file; and
  165 * Anything else you consider relevant.
  166 
  167 Don't send me core dumps.  I can't handle 'em, and they may be for an different
  168 system than what I have!!!
  169 
  170 *PLEASE* include all the above information.  If you do not, I may simply
  171 press "d".  I can't guarantee a response, but I will try my best.
  172 
  173 Kelly Price and the Slirp Development team.
  174 (Thanks go out to Dan, the previous developer.)