home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / fs050.zip / FIDOSOUP.DOC < prev    next >
Text File  |  1997-03-03  |  15KB  |  365 lines
  1. <fidosoup.doc V 0.50 04/03/97>
  2. History-what does it do ?
  3. *************************
  4. I've been in Fidonet for a long time, and I am used to the fidonet tools.
  5. There are many of them, and I believe you really can find anything you want.
  6. I personnally love Golded (Hej Odinn!) which is a brilliant fidonet editor.
  7.  
  8. My first internet account was time based, so I quickly looked for the
  9. possibility to have fidonet-like session on internet. I was lucky to find
  10. SOUPER, a pop/smtp client (hello Chin :-) and it's companion, the YARN editor.
  11. Using both of them, I could come close enough to a fido session on the
  12. internet. I didn't like too much the look and feel of yarn, but it's damn
  13. good, and it had several features which I really loved, like the listserver
  14. filter. Moreover all convertors I could find were UUCP convertor made for
  15. industrial size gating, way too big for what I wanted. Most wanted that you
  16. have your own domain also.
  17. The only thing to come close to what I needed was Soup2Sq by Steven Van Loef
  18. but for some reason it wouldn't work on my system.
  19.  
  20. After some time with 2 editors, I decided to take the jump and create my own
  21. gating system. I had toyed with the idea before and produced a soup unit. I
  22. produced a PKT unit as well, and bolted the 2 together. The rest is history
  23. :-)
  24.  
  25. So here it is. the only thing I can tell you is that it works for ME on MY
  26. system. I have no idea what it will do (if anything else than occupy disk
  27. space) on your system. Any use, abuse, storage or direct contemplation of this
  28. program is to your own risk. You've been warned.
  29. I use Warp (what else!). I  know there is a yarn for Dos, so I assume there is
  30. a SOUPER equivalent under dos. This is why I release a Dos version as well as
  31. an os/2 version. However, I have never seen such a product and both versions
  32. have been tested with soup packet created by Souper for os/2 since version
  33. 1.2 -> 1.5. It has also been tested with Vsoup, a souper clone for os/2 using
  34. threads for faster download (0.9 beta to 1.2.7).
  35. Dos version will detect dv, os/2, windows, etc and yield timeslices
  36. accordingly.
  37.  
  38. The default configuration is FidoSoup.cfg, but you can give another name as
  39. argument, which allows for several configurations in the same directory.
  40.  
  41. Note: the usenet format is the same as the BAG format used by UUCP (rnews
  42. format). So it is possible to use FidoSoup for uucp news as well. You have to
  43. provide an AREAS file according to the format
  44.  
  45. <name of file>  name.of.newsgroup un
  46.  
  47. the .MSG extention is implied for the name of the file, so rename if
  48. necessary. Pkt2UUCP will export to rmail and rnews format, so you can actually
  49. use this package with a uucp system.
  50.  
  51.  
  52. IMPORTANT:
  53. **********
  54. CrossPost issue: xposts are frequent in usenet (this is my entry for the
  55. understatement of the year award). I don't CARE. when I find a message in a
  56. newsgroup which is xposted, I generate a message for every single copy. Just
  57. configure your tosser to get rid of the extra junk. Proceding otherwise would
  58. mean that I should read a list of the areas you intend to keep and then sort
  59. it out. Too much trouble for what it's worth :-) I'll xpost up to 30 times a
  60. message by default, less if so configurated. But be carefull: I have no idea
  61. what area YOU want. If a message is crossposted in area a,b,c,d,e,f,g,h,
  62. and i and that you are interested in area i but have limited xpost to 5, only
  63. areas a,b,c,d and e will be generated, which means that you'll get 5 badmail
  64. and not the one you are interested in. There is no way I can avoid this.
  65. For the same reason, ALL copies of netmail are created unless the C toggle is
  66. in the config. And even when it is, I still generate all copies if the program
  67. can't figure out for whom the mail comes.
  68.  
  69. Similarly, all echomail tags are in uppercase in fidonet, whereas most usenet
  70. newsgroups are in lowercase. ALL TAGS ARE CONVERTED TO LOWER CASE. If you
  71. happen to have a usenet group which is named ThIs.is.JUST.to.BOTHER.YoU, just
  72. make a fido/usenet name change from THIS.IS.JUST.TO.BOTHER.YOU to
  73. ThIs.is.JUST.to.BOTHER.YoU. There is no check on the newsgroup rename.
  74.  
  75. Pkt Size issue:
  76. some all-in-one point packages have reported problems when the PKT was bigger
  77. than 100k. You can configure the size of the pkt if that is a problem. default
  78. is 300k. This can also be usefull if for some reason you get a garble mail
  79. packet. Making smaller pkt will save whatever can be. Watch out: the check on
  80. the pkt size is done every message, but I won't start a new package for a
  81. single message. It means that in certain cases, the maximum size will exceed
  82. slightly the one you mentionned. So if your tosser really can't handle more
  83. than 100k pkt, specify 90k as a maximum.
  84. As far as messages are concerned: many fidonet message reader break if you
  85. give them a msg > 64k. I'm not taking any chances, i'm splitting messages at
  86. 60k. I use temp files in the soup dir. Make sure I have room available there
  87. just in case. The maximum size of a message is 1560k and it will be split in
  88. 26 messages of 60 k each.
  89.  
  90. Speed issue:
  91. Soup2Pkt is not blazingly fast. A 1 mega Soup package takes about 2-3 minutes
  92. to process. OS/2 version is significantly faster since I can use bigger
  93. buffers.
  94.  
  95. Limitations:
  96. ************
  97. For those who understand:
  98. All exe will only read usenet, unixbox, mmdf, Binary mail, and Binary
  99. news. The indexed format is not supported, and mmdf not tested.
  100. The software will write in binary mail /binary news formats only, simply
  101. because my souper doesn't support anything else for replies. Alternately,
  102. you can use the uucp format to send, but then you need rmail/rnews.
  103. for the others: that shouldn't bother you.
  104.  
  105. DOS ONLY:
  106. Due to data segment restrictions under dos, there are limitations to
  107. soup2pkt. Chances are that you'll run out of memory on big packets.
  108. It will not be able to handle more than 500 newsgroups at a time (was 50 <
  109. 0.45), and will not be able to handle more than 2000 (was 450 <0.45) msg per
  110. package (DPMI). Since 0.45 the size of those messages no longer matters.
  111.  
  112. =>YOU MUST HAVE A 386
  113. =>You need the Borland DPMI interface ie RTM.EXE and DPMI16BI.OVL
  114.  
  115. See SOUPER/VSoup documentation on how to limit the number of msg, size,
  116. etc., and just swap newsrc, get 50-100 newsgroup, store them somewhere
  117. else and get the next load of newsgroups, etc. It is not as bad as it
  118. sounds since you probably rarely have more than 50-100 newsgroups
  119. anyway. I have tossed successfully with the DPMI version a 2.2 megas
  120. soup packet (Souper's default) containing 977 messages (the daily bread
  121. in some programming echoes) for a total of 45098 lines, so you *do* have
  122. a margin, even under Dos/DPMI.
  123.  
  124. Suggested parameters for the dos box:
  125. SET DOS_HIGH=1;
  126. SET DOS_UMB=1;
  127. SET DPMI_DOS_API=ENABLED;
  128. SET DPMI_MEMORY_LIMIT=32550;
  129. SET VIDEO_MODE_RESTRICTION=CGA;
  130. SET XMS_HANDLES=64;
  131. SET XMS_MEMORY_LIMIT=6000;
  132.  
  133. this will create a dos box with 720k of memory and 6 megas of xms.
  134. I haven't reached the limits of the OS/2 version yet :-), but it
  135. won't process more than 15000 messages per packet. Seemed like
  136. high enough a limit :-)
  137.  
  138. Known Bugs
  139. **********
  140. Pkt2Soup:
  141. - sometimes souper complains about a null message to send. if it
  142.   happens, it's usually at the end of a news packet. I have no
  143.   idea why, since this is not consistent at all. It usually does
  144.   not affect operation at all. fix/workaround: use pkt2uucp.
  145.  
  146. Soup2pkt:
  147. - sometimes some transfert indication somehow find their way into the
  148.   the message. (Long path lines not properly truncated, usually
  149.   binary msg). those are generally right after the header or at
  150.   the end of the message. It doesn't really hinder the reading.
  151.  
  152. Note:
  153. *****
  154. If you want to report a bug please be as explicit as possible. If
  155. you can send me the offensive package and your configuration,
  156. that will help a lot. (I do not promise to correct anything,
  157. specially if it is in the dos version). I have some other ideas /
  158. improvements in the pipeline (amongst those is a more intelligent
  159. character mapping, a version that will work without rmail/rnews,
  160. etc), but I want to get this version out first and get some more
  161. feedback. If I don't get any, chances are that the next versions
  162. (if any) will not be released. If they are, they will be released
  163. on Hobbes and Leo.
  164.  
  165.  
  166. Technical stuff
  167. ****************
  168. This is written using qedit and compiled with Borland Pascal 7.01 (Tm of
  169. Borland) for the Dos version and  Speed Pascal 1.51 for the
  170. os/2 version (and the ae editor on Os/2).
  171.  
  172. I used the FTS-0001 rev 015 for the PKT specs (Copyright Randy Bush -
  173. randy@psg.com) and the Soup 1.2 rev aug 93 specs (Copyright (c) 1992-1993 Rhys
  174. Weatherley- rhys@cs.uq.oz.au). Internet messages comply with RFC822 and
  175. RFC1036. I have also used the FAQ posted in comp.mail.uucp for the Uucp header
  176. structure.
  177.  
  178. Main      :       2924 lines / 85k
  179. soup units:  read: 985 lines / 26k write:  853 lines / 25k
  180. pkt units :  read: 300 lines /  8k write:  757 lines / 22k
  181. uucp unit :                        write:  617 lines / 18k
  182. ulti unit :                        write:  467 lines / 12k
  183.  
  184. Total     :       6436 lines/184k
  185.  
  186.  
  187. I only have 1 source file to produce the 6 different executables, and it's
  188. full of ifdef :-)
  189.  
  190. Source code availability
  191. *************************
  192. source code is not available: it is dull, long and unecessarily
  193. complicated. Get High: write your own !
  194.  
  195. Disclaimer
  196. **********
  197. The only thing I can guarantee is that this program will take up space on
  198. your hard disk. The rest is beyond my control. Use it at your own risks,
  199. i don't wanna hear about it.
  200.  
  201. Registration
  202. ************
  203. This is not free software and it is copyrighted Thunus F. (C) 1996-97.
  204.  
  205. However, you can use it and distribute it free of charge (see below)
  206. providing that all the files are distributed together. You are allowed to
  207. change the archive type to whatever you like best and to add your bbs's
  208. tag in the archive.
  209.  
  210. YOU MAY NOT DISTRIBUTE THIS PROGRAM ON A SHAREWARE/FREEWARE CD-ROM
  211. WITHOUT PREVIOUS WRITTEN PERMISSION FROM THE AUTHOR.
  212.  
  213. REGISTRATION IS MANDATORY FOR ANY USE OTHER THAN PERSONNAL.
  214.  
  215. Installation
  216. ************
  217. This archive should contain the following files:
  218.  
  219. Pkt2uucp.Dos  Executable file for Dos.
  220. Pkt2Soup.Dos  Executable file for Dos.
  221. Soup2Pkt.Dpm  Executable file for Dos Protected Mode (DPMI).
  222. Pkt2uucp.OS2  Executable for OS/2.
  223. Soup2Pkt.OS2  Executable for OS/2.
  224. Pkt2Soup.OS2  Executable for OS/2.
  225. FidoSoup.DOC  This file
  226. History.fs    The long and winding road
  227. FidoSoup.CFG  sample config file
  228. Charset.Map   sample mapping file
  229. PRODUCTS.LST  other software by the same author
  230.  
  231. just tailor the config to your need, i tried to keep it simple:
  232.  
  233. ; Cfg File for FidoSoup 0.50 and up - also valid for dos counterpart
  234. ; pkt2soup and soup2pkt
  235. ; ---------------------
  236. ; mandatory section
  237. ;----------------------
  238. ; YOUR fido adresse  when soup=>pkt, this goes in "to" field
  239. F 1:234/56.7
  240. ; THE GATE fido adresse  when soup=>pkt, this goes in "from" field
  241. G 1:234/56.999
  242. ; default internet adresse :
  243. ; when pkt => soup/uucp  I use this to pick up the domain
  244. I bloke@some.kindof.net
  245. ; outbound PKT directory
  246. O c:\fd\out
  247. ; inbound PKT directory
  248. P C:\FD\IN
  249. ; Soup directory
  250. S D:\tcpip\souper
  251. ; if you use pkt2uucp here is your outbound spool directory:
  252. A c:\spool\myfeed
  253. ; --------------------------------------------------------------------
  254. ; Optional section - can be safely ignored if running a home system
  255. ; --------------------------------------------------------------------
  256. ; ---------------------
  257. ; Keep only MY CC
  258. ; (default is produce all copies. if nothing found for me, back to default)
  259. ; ---------------------
  260. C
  261. ; ---------------------
  262. ; Block mail to
  263. ; ---------------------
  264. B listserv
  265. B archie
  266. ; ---------------------
  267. ; EchoLine
  268. ; ---------------------
  269. E Francois' Gate: 2:270/25.2 <> Club.TeleMatique.org
  270. ; ---------------------
  271. ; log file name - log level
  272. ; ---------------------
  273. ;log level is email redirected   : 1
  274. ;             listserver redirect: 2
  275. ;             echo rename        : 4
  276. ;             normal mail        : 8
  277. ;             newsgroup          : 16
  278. ;             Block              : 32
  279. ; and combination thereof, ie email+ echo rename=5, etc.
  280. ; for automatic treatment with perl:
  281. ;  ! is error
  282. ;  M is mail redirected
  283. ;  L is Listserver
  284. ;  R is echo rename
  285. ;  E is Email not redirected
  286. ;  N is Newsgroup not renamed
  287. ;  B is Block
  288. ;  C is carbon copy (blind or not)
  289. ;  D is debug
  290. D fidosoup.log  61
  291. ; ---------------------
  292. ; Maximum size of PKT (in Ko default is 300):
  293. ; ---------------------
  294. K 150
  295. ; ---------------------
  296. ; Listserver redirection:
  297. ; ---------------------
  298. ;L FidoName            NameInFromField
  299. ;L Karate.lst           karate@ukanaix.cc.ukans.edu
  300. ;L Magazine             announce@webster.ibmlink.ibm.com
  301. ; ---------------------
  302. ; Mapping file
  303. ; ---------------------
  304. M Charset.map
  305. ; ---------------------
  306. ; Newsgroup rename :
  307. ; ---------------------
  308. N FidoEchoName  InternetNewsgroupName
  309. ;N douglas              alt.fan.douglas-adams
  310. ; ---------------------
  311. ; User allowed to use the gate
  312. ; ---------------------
  313. ; internet name       FidoAdress
  314. U User.Name           1:123/45.6
  315. ; ---------------------
  316. ; Maximum # of crosspost allowed
  317. ; ---------------------
  318. X 3
  319. ; set word wrap on (70 is the length it will start to look for a way to wrap.)
  320. W 70
  321.  
  322.  
  323. Charset.map: this is a simple ascii file which contains 2 lines of
  324. maximum 254 char. On the first line is the char expected, and on the second,
  325. at the same position is the remapped char. for example I have
  326. éèêàùûôç
  327. eeeauuoc
  328. that is enough for me.
  329.  
  330.  
  331. Kudos / ACK
  332. ************
  333. - Turbo Pascal is a trademark of Borland International.
  334. - Speed Pascal is (C) SpeedSoft
  335. - IBM is a trademark of International Business Machines Corporation.
  336.  
  337.                   (this line is intentionally left blank)
  338.  
  339. Just in case I left anyone out, here is a global acknowledgement of
  340. copyright:
  341.  
  342. *.*  is a  copyright /  trademark /  service  mark /  trade name  / pet
  343. project / patent of *.*, All rights reserved.
  344.  
  345. Support
  346. ********
  347. No real support for this file but if really necessary,
  348. Support and registration :
  349. on FidoNet 2:270/25.2
  350. on Internet Francois@Club.TeleMatique.org
  351.  
  352. If ((comment > 0) or (happiness > 0)) then
  353.     begin
  354.      NetMail:=NetMail+1;
  355.      Inc(Happiness_programmer);
  356.     end;
  357.   while ((Happiness > 0) && !NMI)
  358.   {
  359.      programming+=;
  360.      shareware++;
  361.   }
  362.  
  363. Drop also a line to give feedback.
  364.  
  365.