home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / Linux / Divers / lzop-1.00.tar.gz / lzop-1.00.tar / lzop-1.00 / doc / lzop.txt < prev    next >
Text File  |  1998-04-27  |  15KB  |  410 lines
  1. NAME
  2.     lzop - compress or expand files
  3.  
  4. ABSTRACT
  5.     lzop is a file compressor very similar to gzip. lzop favors
  6.     speed over compression ratio.
  7.  
  8. SYNOPSIS
  9.     lzop [ *command* ] [ *options* ] [ *filename* ... ]
  10.  
  11.     lzop [-dxlthIVL19] [-qvcfFnNkU] [-o *file*] [-p[*path*]] [-S
  12.     *suffix*] [*filename* ...]
  13.  
  14. DESCRIPTION
  15.     lzop reduces the size of the named files. Whenever possible,
  16.     each file is compressed into one with the extension .lzo, while
  17.     keeping the same ownership modes, access and modification times.
  18.     If no files are specified, or if a file name is "-", lzop tries
  19.     to compress the standard input to the standard output. lzop will
  20.     only attempt to compress regular files. In particular, it will
  21.     ignore directories and symbolic links.
  22.  
  23.     If the compressed file name is too long for its file system,
  24.     lzop truncates it.
  25.  
  26.     Compressed files can be restored to their original form using
  27.     lzop -d. lzop -d takes a list of files on its command line and
  28.     decompresses each file whose name ends with .lzo and which
  29.     begins with the correct magic number to an uncompressed file
  30.     without the original extension. lzop -d also recognizes the
  31.     special extension .tzo as shorthand for .tar.lzo. When
  32.     compressing, lzop uses the .tzo extension if necessary instead
  33.     of truncating a file with a .tar extension.
  34.  
  35.     lzop stores the original file name, mode and time stamp in the
  36.     compressed file. These can be used when decompressing the file
  37.     with the -d option. This is useful when the compressed file name
  38.     was truncated or when the time stamp was not preserved after a
  39.     file transfer.
  40.  
  41.     lzop preserves the ownership, mode and time stamp of files when
  42.     compressing. When decompressing lzop restores the mode and time
  43.     stamp if present in the compressed files. See the options -n, -
  44.     N, --no-mode and --no-time for more information.
  45.  
  46.     lzop always keeps original files unchanged unless you use the
  47.     option -U.
  48.  
  49.     lzop uses the *LZO data compression library* for compression
  50.     services. The amount of compression obtained depends on the size
  51.     of the input and the distribution of common substrings.
  52.     Typically, text such as source code or English is compressed
  53.     into 40-50% of the original size, and large files usually
  54.     compress much better than small ones. Compression and
  55.     decompression speed is generally much faster than that achieved
  56.     by gzip, but compression ratio is worse.
  57.  
  58.   COMPRESSION LEVELS
  59.  
  60.     lzop offers the following compression levels of the LZO1X
  61.     algorithm:
  62.  
  63.     -3  the default level offers pretty fast compression. Note that -2,
  64.         -3, -4, -5 and -6 are currently all equivalent - this may
  65.         change in a future release.
  66.  
  67.     -1, --fast
  68.         can be even a little bit faster in some cases - but most
  69.         times you won't notice the difference
  70.  
  71.     -7, -8, -9, --best
  72.         these compression levels are mainly intended for generating
  73.         pre-compressed data - especially -9 can be somewhat slow
  74.  
  75.     Decompression is *very* fast for all compression levels.
  76.  
  77. MAIN COMMAND
  78.     If no other command is given then lzop defaults to compression.
  79.  
  80.     -#, --fast, --best
  81.         Regulate the speed of compression using the specified digit
  82.         #, where -1 or --fast indicates the fastest compression
  83.         method (less compression) and -9 or --best indicates the
  84.         slowest compression method (best compression). The default
  85.         compression level is -3.
  86.  
  87.     -d, --decompress, --uncompress
  88.         Decompress. Each file will be placed into same the directory
  89.         as the compressed file.
  90.  
  91.     -x, --extract
  92.         Extract compressed files to the current working directory.
  93.         This is the same as `-dNp'.
  94.  
  95.     -t, --test
  96.         Test. Check the compressed file integrity.
  97.  
  98.     -l, --list
  99.         For each compressed file, list the following fields:
  100.  
  101.           method: compression method
  102.           compressed: size of the compressed file
  103.           uncompr.: size of the uncompressed file
  104.           ratio: compression ratio
  105.           uncompressed_name: name of the uncompressed file
  106.  
  107.         In combination with the --verbose option, the following
  108.         fields are also displayed:
  109.  
  110.           date & time: time stamp for the uncompressed file
  111.  
  112.         With --name, the uncompressed name, date and time are those
  113.         stored within the compress file if present.
  114.  
  115.         With --verbose, the size totals and compression ratio for
  116.         all files is also displayed. With --quiet, the title and
  117.         totals lines are not displayed.
  118.  
  119.         Note that lzop defines compression ratio as compressed_size
  120.         / uncompressed_size.
  121.  
  122.     --ls, --ls=*FLAGS*
  123.         List each compressed file in a format similar to ls -ln.
  124.  
  125.         The following flags are currently honoured: F Append a `*'
  126.         for executable files. G Inhibit display of group
  127.         information. Q Enclose file names in double quotes.
  128.  
  129.     --info
  130.         For each compressed file, list the internal header fields.
  131.  
  132.     -I, --sysinfo
  133.         Display information about the system and quit.
  134.  
  135.     -L, --license
  136.         Display the lzop license and quit.
  137.  
  138.     -h, -H, --help
  139.         Display a help screen and quit.
  140.  
  141.     -V  Version. Display the version number and compilation options then
  142.         quit.
  143.  
  144.     --version
  145.         Version. Display the version number then quit.
  146.  
  147.     Note that -t has priority over -d, -l over -t, and so on.
  148.  
  149. OPTIONS
  150.     -c, --stdout, --to-stdout
  151.         Write output on standard output. If there are several input
  152.         files, the output consists of a sequence of independently
  153.         (de)compressed members. To obtain better compression,
  154.         concatenate all input files before compressing them.
  155.  
  156.     -o *FILE*, --output=*FILE*
  157.         Write output to the file *FILE*. If there are several input
  158.         files, the output consists of a sequence of independently
  159.         (de)compressed members.
  160.  
  161.     -p, -p*DIR*, --path=*DIR*
  162.         Write output files into the directory *DIR* instead of the
  163.         directory determined by the input file. If *DIR* is omitted,
  164.         then write to the current working directory.
  165.  
  166.     -f, --force
  167.         Force lzop to
  168.  
  169.          - overwrite existing files
  170.          - compress from stdin even if it seems a terminal
  171.          - compress to stdout even if it seems a terminal
  172.          - allow option -c in combination with -U
  173.  
  174.         Using -f two or more times forces things like
  175.  
  176.          - compress files that already have a .lzo suffix
  177.          - decompress files that do not have a valid suffix
  178.          - try to handle compressed files with unknown header flags
  179.  
  180.         Use with care.
  181.  
  182.     -F, --no-checksum
  183.         Do not store or verify a checksum of the uncompressed file
  184.         when compressing or decompressing. This speeds up the
  185.         operation of lzop a little bit (especially when
  186.         decompressing), but as unnoticed data corruption can happen
  187.         in case of damaged compressed files the usage of this option
  188.         is not generally recommended. Also, a checksum is always
  189.         stored when compressing with one of the slow compression
  190.         levels (-7, -8 or -9).
  191.  
  192.     -n, --no-name
  193.         When decompressing, do not restore the original file name if
  194.         present (remove only the lzop suffix from the compressed
  195.         file name). This option is the default under UNIX.
  196.  
  197.     -N, --name
  198.         When decompressing, restore the original file name if
  199.         present. This option is useful on systems which have a limit
  200.         on file name length. If the original name saved in the
  201.         compressed file is not suitable for its file system, a new
  202.         name is constructed from the original one to make it legal.
  203.         This option is the default under DOS, Windows and OS/2.
  204.  
  205.     --no-mode
  206.         When decompressing, do not restore the original mode
  207.         (permissions) saved in the compressed file.
  208.  
  209.     --no-time
  210.         When decompressing, do not restore the original time stamp
  211.         saved in the compressed file.
  212.  
  213.     -S *.suf*, --suffix=*.suf*
  214.         Use suffix *.suf* instead of *.lzo*. The suffix must not
  215.         contain multiple dots and special characters like '+' or
  216.         '*', and suffixes other than *.lzo* should be avoided to
  217.         avoid confusion when files are transferred to other systems.
  218.  
  219.     -k, --keep
  220.         Do not delete input files. This is the default.
  221.  
  222.     -U, --unlink, --delete
  223.         Delete input files after succesfull compression or
  224.         decompression. Beware. Use this option to make lzop behave
  225.         like gzip. Note that -k overrides -U.
  226.  
  227.     --no-stdin
  228.         Do not try to read standard input. This option is necessary
  229.         in cron jobs (which do not have a controlling terminal). A
  230.         file name "-" will still override this option.
  231.  
  232.     --no-warn
  233.         Suppress all warnings.
  234.  
  235.     --ignore-warn
  236.         Suppress all warnings, and never exit with exit status 2.
  237.  
  238.     -q, --quiet, --silent
  239.         Suppress all warnings and decrease the verbosity of some
  240.         commands like --list or --test.
  241.  
  242.     -v, --verbose
  243.         Verbose. Display the name for each file compressed or
  244.         decompressed. Multiple -v can be used to increase the
  245.         verbosity of some commands like --list or --test.
  246.  
  247.     --  Specifies that this is the end of the options. Any file name
  248.         after -- will not be interpreted as an option even if it
  249.         starts with a hyphen.
  250.  
  251. OTHER OPTIONS
  252.     --no-color
  253.         Do not use any color escape sequences.
  254.  
  255.     --mono
  256.         Assume a mono ANSI terminal. This is the default under UNIX.
  257.  
  258.     --color
  259.         Assume a color ANSI terminal or try full-screen access. This
  260.         is the default under DOS and in a Linux virtual console.
  261.  
  262.     --intro
  263.         Try to display that nice intro sequence then quit. Needs
  264.         full-screen access.
  265.  
  266.     --filter=*NUMBER*
  267.         Rarely useful. Preprocess data with a special "multimedia"
  268.         filter before compressing in order to improve compression
  269.         ratio. *NUMBER* must be a decimal number from 1 to 16,
  270.         inclusive. Using a filter slows down both compression and
  271.         decompression quite a bit, and the compression ratio usually
  272.         doesn't improve much either... More effective filters may be
  273.         added in the future, though.
  274.  
  275.         You can try --filter=1 with data like 8-bit sound samples, -
  276.         -filter=2 with 16-bit samples or depth-16 images, etc.
  277.  
  278.         Un-filtering during decompression is handled automatically.
  279.  
  280.     -C, --checksum
  281.         Deprecated. Only for compatibility with old versions as lzop
  282.         now uses a checksum by default. This option may get removed
  283.         in a future release.
  284.  
  285. ADVANCED USAGE
  286.     lzop allows you to deal with your files in many flexible ways.
  287.     Here are some usage examples:
  288.  
  289.     single file mode: individually (de)compress each file
  290.       create
  291.         lzop a.c             -> create a.c.lzo
  292.         lzop a.c b.c         -> create a.c.lzo & b.c.lzo
  293.         lzop -U a.c b.c      -> create a.c.lzo & b.c.lzo and delete a.c & b.c
  294.         lzop *.c
  295.  
  296.       extract
  297.         lzop -d a.c.lzo      -> restore a.c
  298.         lzop -df a.c.lzo     -> restore a.c, overwrite if already exists
  299.         lzop -d *.lzo
  300.  
  301.       list
  302.         lzop -l a.c.lzo
  303.         lzop -l *.lzo
  304.         lzop -lv *.lzo       -> be verbose
  305.  
  306.       test
  307.         lzop -t a.c.lzo
  308.         lzop -tq *.lzo       -> be quiet
  309.  
  310.     pipe mode: (de)compress from stdin to stdout
  311.       create
  312.         lzop < a.c > y.lzo
  313.         cat a.c | lzop > y.lzo
  314.         tar -cf - *.c | lzop > y.tar.lzo     -> create a compressed tar file
  315.  
  316.       extract
  317.         lzop -d < y.lzo > a.c
  318.         lzop -d < y.tar.lzo | tar -xvf -     -> extract a tar file
  319.         lzop -d < y.tar.lzo | tar -tvf -     -> list a tar file
  320.  
  321.       list
  322.         lzop -l < y.lzo
  323.         cat y.lzo | lzop -l
  324.  
  325.       test
  326.         lzop -t < y.lzo
  327.         cat y.lzo | lzop -t
  328.  
  329.     stdout mode: (de)compress to stdout
  330.       create
  331.         lzop -c a.c > y.lzo
  332.  
  333.       extract
  334.         lzop -dc y.lzo > a.c
  335.         lzop -dc y.tar.lzo | tar -tvf -      -> list a tar file
  336.  
  337.     archive mode: compress/extract multiple files into a single archive file
  338.       create
  339.         lzop a.c b.c -o sources.lzo          -> create an archive
  340.         lzop -c *.c > sources.lzo            -> another way to create an archive
  341.         lzop -c *.h >> sources.lzo           -> add files to archive
  342.  
  343.       extract
  344.         lzop -dN sources.lzo
  345.         lzop -x ../src/sources.lzo           -> extract to current directory
  346.         lzop -x -p/tmp < ../src/sources.lzo  -> extract to /tmp directory
  347.  
  348.       list
  349.         lzop -lNv sources.lzo
  350.  
  351.       test
  352.         lzop -t sources.lzo
  353.         lzop -tvv sources.lzo                -> be very verbose
  354.  
  355.     If you wish to create a single archive file with multiple
  356.     members so that members can later be extracted independently,
  357.     you should prefer a full-featured archiver such as tar or zip.
  358.     The latest version of GNU tar supports the --use-compress-
  359.     program=lzop option to invoke lzop transparently. lzop is
  360.     designed as a complement to tar, not as a replacement.
  361.  
  362. ENVIRONMENT
  363.     The environment variable LZOP can hold a set of default options
  364.     for lzop. These options are interpreted first and can be
  365.     overwritten by explicit command line parameters. For example:
  366.  
  367.         for sh/ksh/zsh:    LZOP="-1v --name"; export LZOP
  368.         for csh/tcsh:      setenv LZOP "-1v --name"
  369.         for DOS:           set LZOP=-1v --name
  370.  
  371.     On Vax/VMS, the name of the environment variable is LZOP_OPT, to
  372.     avoid a conflict with the symbol set for invocation of the
  373.     program.
  374.  
  375.     Note that not all options are valid in the environment variable
  376.     - lzop will tell you.
  377.  
  378. SEE ALSO
  379.     gzip(1), tar(1), bzip2(1)
  380.  
  381.     Precompiled binaries for some platforms should be available from
  382.     the lzop home page soon.
  383.  
  384.         see http://wildsau.idv.uni-linz.ac.at/mfx/lzop.html
  385.  
  386.     lzop uses the LZO data compression library for compression
  387.     services.
  388.  
  389.         see http://wildsau.idv.uni-linz.ac.at/mfx/lzo.html
  390.  
  391. DIAGNOSTICS
  392.     Exit status is normally 0; if an error occurs, exit status is 1.
  393.     If a warning occurs, exit status is 2.
  394.  
  395.     lzop's diagnostics are intended to be self-explanatory.
  396.  
  397. BUGS
  398.     Please report all bugs immediately to the author.
  399.  
  400. AUTHOR
  401.     markus.oberhumer@jk.uni-linz.ac.at
  402.  
  403. COPYRIGHT
  404.     lzop and the LZO library are Copyright (C) 1996, 1997, 1998 by
  405.     Markus Franz Xaver Johannes Oberhumer.
  406.  
  407.     lzop and the LZO library are distributed under the terms of the
  408.     GNU General Public License (GPL).
  409.  
  410.