home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / usenet / compsrcs / misc / volume02 / bencode.man < prev    next >
Encoding:
Internet Message Format  |  1991-08-27  |  2.6 KB
  1. From mipos3!intelca!oliveb!ames!necntc!ncoast!allbery Sat Feb  6 16:04:13 PST 1988
  2. Article 281 of comp.sources.misc:
  3. Path: td2cad!mipos3!intelca!oliveb!ames!necntc!ncoast!allbery
  4. From: wilber@gauss.UUCP (Bob Wilber)
  5. Newsgroups: comp.sources.misc
  6. Subject: v02i027: man page for bencode/bdecode
  7. Message-ID: <7153@ncoast.UUCP>
  8. Date: 30 Jan 88 21:34:36 GMT
  9. Sender: allbery@ncoast.UUCP
  10. Lines: 63
  11. Approved: allbery@ncoast.UUCP
  12. X-Archive: comp.sources.misc/8801/26
  13. Comp.sources.misc: Volume 2, Issue 27
  14. Submitted-By: Bob Wilber <wilber@gauss.UUCP>
  15. Archive-Name: bencode-man
  16.  
  17. Comp.sources.misc: Volume 2, Issue 27
  18. Submitted-By: Bob Wilber <wilber@gauss.UUCP>
  19. Archive-Name: bencode-man
  20.  
  21. I just snarfed bencode/bdecode off comp.sources.misc.  Here's a man page
  22. I wrote that you might want to add to the shar file.  (Use nroff -man.)
  23.  
  24. Bob Wilber   wilber@research.att.com  or ihnp4!gauss!wilber or
  25.              wilber%btl@csnet
  26.  
  27. ----------------- Cut Here ---------------------------------------------------
  28. #! /bin/sh
  29. # "sh" this file to produce the file "bencode.1"
  30. sed 's/^X//' << \_END_ > bencode.1
  31. X.TH BENCODE 1 "9 January 1988"
  32. X.UC 4
  33. X.SH NAME
  34. Xbencode, bdecode \- encode a binary file into printable ASCII; decode it back
  35. Xinto binary.
  36. X.SH SYNOPSIS
  37. X.B /usr/local/bin/bencode [source]
  38. X.br
  39. X.B /usr/local/bin/bdecode [source]
  40. X.SH DESCRIPTION
  41. X.I Bencode
  42. Xis used to a encode a binary file into printable ASCII, and
  43. X.I bdecode
  44. Xis used to decode an encoded file back into binary.
  45. XThese functions are typically used to package a binary file for mailing.
  46. X.PP
  47. X.I Bencode
  48. Xtakes the named source file (the default is standard input) and
  49. Xproduces an encoded version on the standard output.
  50. XThe encoding uses only the ASCII characters ``A'' \- ``Z'', ``a'' \- ``z'', ``0''
  51. X\- ``9'', ``+'', and ``-''.
  52. XThe ASCII characters blank, newline, and ``/'' also appear in the
  53. Xencoded file, but do not represent encoded bits.
  54. XThe encoded file is terminated with
  55. Xa byte count and cyclic redundancy check for detecting corrupted files.
  56. X.PP
  57. X.I Bdecode
  58. Xreads a file encoded by bencode (the default is standard input), strips off
  59. Xany leading and trailing lines added by mailers,
  60. Xand writes the decoded version to standard output.
  61. X.PP
  62. XThese functions are similar to
  63. X.I uuencode
  64. Xand
  65. X.I uudecode,
  66. Xbut are more robust because of the CRC check and because
  67. Xthey don't send characters like ``^'' and ``\\'', which are likely to get
  68. Xmangled if the file should happen to pass through a
  69. Xnon-ASCII machine.
  70. X.PP
  71. X.SH SEE\ ALSO
  72. Xuuencode(1)
  73. X.SH AUTHORS
  74. XKen Lalonde and Reg Quinton
  75. X.SH BUGS
  76. XThe file is expanded by 35% (3 bytes become 4 plus control information)
  77. Xcausing it to take longer to transmit.
  78. _END_
  79. exit 0
  80.  
  81.  
  82.