home *** CD-ROM | disk | FTP | other *** search
/ Freelog 2 / Freelog002.iso / Linux / Slackware / contrib / slirp.README < prev    next >
Text File  |  1999-02-08  |  6KB  |  147 lines
  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. Where VERSION is the version of Slirp you are unpacking.  This will unpack
  22. the Slirp package into a directory called slirp-VERSION.
  23.  
  24. To compile Slirp type the following commands at your shell prompt:
  25.  
  26. cd slirp-VERSION/src
  27. ./configure
  28. make
  29.  
  30. Note: if you do not intend to use PPP you can give ./configure the flag
  31. "--disable-ppp".  This will make a somewhat smaller executable.
  32.  
  33. That's all there is to it.  If the compilation failed, read "Getting Help"
  34. below for information on how to get help.
  35.  
  36. You should be left with a file called "slirp", this is the Slirp executable.
  37. After compilation, you can type:
  38.  
  39. strip slirp
  40.  
  41. to make the Slirp executable smaller, but this will also remove any
  42. debugging information from the executable.
  43.  
  44. Here are some common ./configure/compiler/pre-processor/etc. problems and
  45. suggestions for fixing them: 
  46.  
  47. * "configure: error: can not run test program while cross compiling" (or
  48. similar errors about cross compiling).  This almost always happens due to an
  49. error in the setup of the compiler.  Look in the file config.log for clues
  50. as to why it failed, or send it to your sysadmin for help.
  51.  
  52. * "gcc: xxxxxxx.p: No such file or directory.": This can be completely
  53. ignored when running the pre-processor, and can probably be ignored in the
  54. actual compilation.  The .p files only contain the function prototypes.
  55.  
  56. * "gcc: warning: no previous prototype for XXX'": Again, you can ignore
  57. this.
  58.  
  59. * "RUN_MAKE_AGAIN: not found ... *** Error code 1": This is normal.  As
  60. suggested, simply run "make" again.
  61.  
  62.  
  63. Running and Quitting Slirp
  64. ==========================
  65.  
  66. Once you have compiled Slirp you can delete everything except the file
  67. called "slirp", this is the Slirp executable.  I suggest you also keep all
  68. the files in the "docs" directory, this is where all the documentation is
  69. kept.  Copy the Slirp executable somewhere in your home directory (E.g.:
  70. ~/bin) then to run Slirp, you simply type:
  71.  
  72. ~/bin/slirp
  73.  
  74. (or whatever the full path to "slirp" is).  That's it.  Now you activate
  75. your SLIP/PPP software, and start your applications.
  76.  
  77. All you have to remember is this: Once you run Slirp, your shell account now
  78. looks exactly like a SLIP/PPP account (with some limitations of course).
  79. Any documentation that you have telling you how to connect to a SLIP/PPP
  80. account is completely valid for Slirp as well.
  81.  
  82. To quit Slirp you simply kill your SLIP/PPP software and type five 0's
  83. (zeroes), with a 1 second gap between each zero.  Slirp will then exit and
  84. you will be back at your shell prompt.
  85.  
  86. You can also "disconnect" Slirp by typing five 1's (one's), with a 1 second
  87. gap between each.  This will disconnect Slirp from your shell's terminal and
  88. put Slirp in the background.  Later, you can type "slirp -l 0" to
  89. "reconnect" Slirp again.  Please read Section 10, "Load-balancing" and
  90. Section 11, "Link-resumption" of the Slirp manual for more information.
  91.  
  92.  
  93. Files in the Slirp package
  94. ==========================
  95.  
  96. Here are the list of files you'll find within the slirp package:
  97.  
  98. COPYRIGHT       Conditions of the Copyright on Slirp.  Please read this.
  99. ChangeLog       Descriptions of changes made to slirp from version to
  100.         version.  Also details all contributors, and their
  101.         contributions.
  102. README          This file.
  103. docs/CONFIG     List of configuration options (probably out of date)
  104. docs/alt.dcom.slip-emulators.FAQ
  105.                 This is the FAQ (Frequently Asked Questions) from the
  106.                 newsgroup alt.dcom.slip-emulators.
  107. docs/slirp.doc  The Slirp manual.
  108. src/*           The source code to Slirp.
  109.  
  110. Getting Help
  111. ============
  112.  
  113. There are several sources of help.  First, read the Slirp manual called
  114. slirp.doc in the "docs" directory of the Slirp package, especially Section
  115. 13, "Troubleshooting" and Section 14, "Answers to Frequently Asked Questions
  116. (FAQs)".
  117.  
  118. If that fails, try the Slirp Home Page at:
  119.  
  120. http://blitzen.canberra.edu.au/slirp
  121.  
  122. There are lots of neat links there to other pages which have specific
  123. configuration information.
  124.  
  125. There is also a Newsgroup dedicated to SLIP-emulators called
  126. alt.dcom.slip-emulators.  You will find lots of discussion about Slirp and
  127. other "SLIP-emulators".  The FAQ (Frequently Asked Questions) for
  128. alt.dcom.slip-emulators is included in the "docs" directory, I would suggest
  129. reading this as well.
  130.  
  131. If all else fails, send me e-mail to danjo@blitzen.canberra.edu.au with the
  132. following information:
  133.  
  134. * Output of the command "uname -a" on the remote system;
  135. * Operating System name and version you run on your PC;
  136. * Version of Slirp you are using (IMPORTANT!!!);
  137. * If you managed to get Slirp running, run Slirp as "slirp -S" then try
  138.   whatever failed.  When you exit Slirp, you should have a file called
  139.   "slirp_stats".  Send me this file; and
  140. * Anything else you consider relevant.
  141.  
  142. *PLEASE* include all the above information.  If you do not, I may simply
  143. press "d".  I can't guarantee a response, but I will try my best.
  144.  
  145.  
  146. Dan ...
  147.