home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / unzip51.zip / ZipRules < prev   
Text File  |  1994-01-23  |  5KB  |  132 lines
  1. Subject: Info-ZIP Rules (No Feelthy ...)
  2.  
  3. In discussions with Mark Adler (and others), I realized we in the Info-ZIP
  4. community have been evolving a set of rules that maybe oughtta be
  5. documented, archived and available to potential contributors.
  6.  
  7. The following appear to meet our requirements.  Please observe these
  8. rules when submitting source, context diffs or other files to Info-ZIP.
  9.  
  10.  
  11. 1 - "NO FEELTHY TABS"
  12.  
  13.     Many editors and e-mail systems either have no capability to use and/or
  14. display the ASCII 9 (TAB) character correctly, or there are variable tab
  15. columns, or other horrors.  (My Maxe-mail offline email editor for one.)
  16.  
  17.     Bottom line:  use spaces, not tabs.
  18.  
  19.     Related utility programs:  Unix, OS/2 and MS-DOS:  expand, unexpand.
  20. MS-DOS:  Buerg's TABS; Toad Hall's TOADSOFT.  And some editors have the
  21. conversion built-in.
  22.  
  23.     Exceptions:  the Unix Makefile.  Some makes seem to require "real"
  24. tabs.  If they need it there, fine.  So don't fiddle the Makefile.
  25.  
  26.  
  27. 2 - "NO FEELTHY CRS"
  28.  
  29.     All source, documentation and other text files shall have Unix style
  30. line endings (LF, Ctrl-J), NOT the MS-DOS CR/LF or Mac CR line endings.
  31.  
  32.     Reason:  "real programmers" in any environment can convert back and
  33. forth between Unix and DOS/Mac style.  MS-DOS Turbo C can use Unix or
  34. MS-DOS line endings (donno about Mac Turbo C).  Buerg's LIST file display
  35. utility for MS-DOS can use Unix or MS-DOS line endings.  Unix utilities
  36. like diff and patch die a horrible death (or produce horrible output) if
  37. target files have CRs.
  38.  
  39.     Related utilities:  flip for Unix, OS/2 and MS-DOS; Unix "tr".
  40.  
  41.     Exceptions:  the zip archive README and zip.doc files, which Mark
  42. Adler wants to leave in MSDOS for "unsophisticated" (read brain-dead) DOS
  43. users.  Also the batch files to compile under MS-DOS (where it requires
  44. the CRs).  [These exceptions may not exist anymore; Jean-loup now handles
  45. such things...]
  46.  
  47.  
  48. 3 - "NO FEELTHY HEX"
  49.  
  50.     We'll use uuencode/uudecode compatible converters to move binary files
  51. through our 7-bit e-mail systems (xxencode on special request; Mark's "ship"
  52. within Info-ZIP).  Uuencoded files, if larger than +/- 32KB, will be broken
  53. into smaller (< 32KB) files (via David M. Read's UUXFER utility).  If Down
  54. Under is involved, files will be broken into under-20KB chunks.
  55.  
  56.     Reason:  to prevent sounds of gagging mailers from resounding
  57. throughout the land.  To be standard with the Uunet side of the world.
  58. To be relatively efficient in the binary->Ascii conversion.  (Yeah, yeah,
  59. I know, there's better conversions out there.  But not as widely known.)
  60.  
  61.     Related utilities:  uuencode, uudecode, uuxfer20, quux, others.
  62. Just make sure they don't leave imbedded or trailing spaces.  (That is,
  63. they should use the "`" character in place of Ascii 32.)  Else mailers 
  64. are prone to truncate or whatever.  Message me if you need one.
  65.  
  66.  
  67. 4 - "NO FEELTHY TARS"
  68.  
  69.     UnZip will be available in .tar.Z (16-bit compressed tar), .zoo (ver-
  70. sion 2.10, available for Unix, OS/2, MS-DOS, VMS, etc.), or .zip format.
  71. (If requesting we e-mail you source, specify desired format.)  Zip source
  72. will only be distributed in .zip archives.
  73.  
  74.     Reason:  for unzip development or use, anyone should have one of the
  75. specified dearchivers.  For zip development or use, you shouldn't be
  76. messing with zip unless you can already unzip.  (This protects the
  77. innocent.)
  78.  
  79.     Related utilities:  Unix:  zoo, tar, compress, gzip, zip, unzip.
  80. MS-DOS: ZOO, PKUNZIP, PAK, TAR, COMPRESS, and others.
  81.  
  82.  
  83. 5 - "NO FEELTHY FANCY_NAMES"
  84.  
  85.     Assume the worst:  that someone on a brain-damaged DOS system has to
  86. work with everything your magic fingers produced.  Keep the file names
  87. unimaginative and within MS-DOS limits (e.g., ordinary A..Z, 1..9, "-$_!"
  88. type characters, in the "filename.ext" 8-dot-3 format).  MacUsers, giggle
  89. all you want, but no spaces.
  90.  
  91.     Reason:  Compatibility with different file systems.  MS-DOS is the
  92. most limited, with the exception of CompuServe (6.3, argh).
  93.  
  94.  
  95. 6 - "NO FEELTHY GRAPHICS"
  96.  
  97.     Do all your editing in a plain-text ASCII editor.  No WordPerfect,
  98. Word, WordStar document mode, or other word processor files, thenkyew.
  99. No desktop publishing.  No TIFFs, no GIFs, no imbedded pictures or dancing
  100. ladies (too bad, Cave Newt).  [Sigh... -CN]
  101.  
  102.     Reason:  Compatibility with different consoles.  My old XT clone is
  103. the most limited!
  104.  
  105.     Related utilities:  vi, ed, EDLIN, Turbo C editor, UED, EASYEDIT, cat
  106. or "COPY CON UNZIP.C"; various word processor -> text conversion utilities.
  107.  
  108.  
  109. 7 - "NO FEELTHY DASHES"
  110.  
  111.     Don't have repeated dashes (starting at the left margin) in any
  112. source code or patches you try to e-mail to me or Info-ZIP.  Instead, be
  113. sure to always prefix them with a space, asterisk, comment, whatever, like
  114. this:
  115. #---------------   or
  116. /*--------------   or even
  117.  ---------------   (just indented)
  118.  
  119.     Reason:  Most "undigestify" utilities (that break down newsletters
  120. into their separate messages) use that "--------" (starting at the left
  121. margin) as the symbol that it's hit the end of a message.  We'd rather not
  122. have your C source file broken up into a dozen separate untitled messages,
  123. thank you.
  124.  
  125.  
  126. *-------------------*
  127.  
  128. David Kirschbaum
  129. former Info-ZIP Coordinator
  130.  
  131. with minor updates by Cave McNewt, 23 Jan 94.
  132.