components/archiver/bzip2/manpages/libbz2.3

   1 .TH libbz2 3 "8 Oct 1999"
   2 .SH NAME
   3 libbz2 \- library for block-sorting data compression
   4 .SH SYNOPSIS
   5 .LP
   6 .B cc
   7 .RI "[ " "flag " \|.\|.\|. ] " "file \|.\|.\|."
   8 .B \-lbz2
   9 .RI "[ " "library" " \|.\|.\|. ]"
  10 .sp 1n
  11 .nf
  12 .ft 3
  13 #include <stdio.h>
  14 #include <bzlib.h>
  15 .ft
  16 .fi
  17 .SH DESCRIPTION
  18 Interfaces in this library provide the ability to compress (and
  19 decompress) files using the Burrows-Wheeler blocksorting text compression
  20 algorithm, and  Huffman  coding. It is provided along with the
  21 .BR bzip2(1)
  22 utility.
  23 See
  24 .BR bzip2(1)
  25 for more information.
  26 .LP
  27 The source distribution of bzip2 contains a description of how to
  28 use this library in HTML form.
  29 .LP
  30 For additional information on shared object interfaces,  see
  31 .BR intro(3).
  32 .SH INTERFACES
  33 .nf
  34 BZ2_bzCompressInit
  35 BZ2_bzCompress
  36 BZ2_bzCompressEnd
  37 BZ2_bzDecompressInit
  38 BZ2_bzDecompress
  39 BZ2_bzDecompressEnd
  40 BZ2_bzReadOpen
  41 BZ2_bzReadClose
  42 BZ2_bzReadGetUnused
  43 BZ2_bzRead
  44 BZ2_bzWriteOpen
  45 BZ2_bzWrite
  46 BZ2_bzWriteClose
  47 BZ2_bzBuffToBuffCompress
  48 BZ2_bzBuffToBuffDecompress
  49 BZ2_bzlibVersion
  50 BZ2_bzopen
  51 BZ2_bzdopen
  52 BZ2_bzread
  53 BZ2_bzwrite
  54 BZ2_bzflush
  55 BZ2_bzclose
  56 .fi
  57 .SH FILES
  58 .PD 0
  59 .TP 20
  60 /usr/lib/libbz2.so.1
  61 shared object
  62 .TP
  63 /usr/lib/64/libbz2.so.1
  64 64-bit shared object
  65 .PD
  66 .SH "SEE ALSO"
  67 bzip2(1), intro(3)
  68 .SH AUTHOR
  69 Julian Seward, jseward@acm.org.
  70
  71 http://sourceware.cygnus.com/bzip2
  72 http://www.muraroa.demon.co.uk
  73
  74 The ideas embodied in bzip2 are due to (at least) the fol-
  75 lowing people: Michael Burrows and David Wheeler (for  the
  76 block  sorting  transformation), David Wheeler (again, for
  77 the Huffman coder), Peter Fenwick (for the structured cod-
  78 ing model in the original bzip, and many refinements), and
  79 Alistair Moffat, Radford Neal  and  Ian  Witten  (for  the
  80 arithmetic  coder  in  the  original  bzip).   I  am  much
  81 indebted for their help, support and advice.  See the man-
  82 ual  in the source distribution for pointers to sources of
  83 documentation.  Christian von Roques encouraged me to look
  84 for  faster sorting algorithms, so as to speed up compres-
  85 sion.  Bela Lubkin encouraged me to improve the worst-case
  86 compression performance.  Many people sent patches, helped
  87 with portability problems, lent machines, gave advice  and
  88 were generally helpful.