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.man < prev    next >
Text File  |  1998-04-27  |  20KB  |  661 lines
  1.  
  2.  
  3.  
  4. LZOP(1)                                                   LZOP(1)
  5.  
  6.  
  7. NNNNAAAAMMMMEEEE
  8.        lzop - compress or expand files
  9.  
  10. AAAABBBBSSSSTTTTRRRRAAAACCCCTTTT
  11.        llllzzzzoooopppp is a file compressor very similar to ggggzzzziiiipppp.  llllzzzzoooopppp
  12.        favors speed over compression ratio.
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.        llllzzzzoooopppp [ _c_o_m_m_a_n_d ] [ _o_p_t_i_o_n_s ] [ _f_i_l_e_n_a_m_e ...  ]
  16.  
  17.        llllzzzzoooopppp [----ddddxxxxlllltttthhhhIIIIVVVVLLLL11119999] [----qqqqvvvvccccffffFFFFnnnnNNNNkkkkUUUU] [----oooo _f_i_l_e] [----pppp[_p_a_t_h]]
  18.        [----SSSS _s_u_f_f_i_x] [_f_i_l_e_n_a_m_e ...]
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.        llllzzzzoooopppp reduces the size of the named files. Whenever
  22.        possible, each file is compressed into one with the
  23.        extension ....llllzzzzoooo, while keeping the same ownership modes,
  24.        access and modification times. If no files are specified,
  25.        or if a file name is "-", lzop tries to compress the
  26.        standard input to the standard output. lzop will only
  27.        attempt to compress regular files. In particular, it will
  28.        ignore directories and symbolic links.
  29.  
  30.        If the compressed file name is too long for its file
  31.        system, llllzzzzoooopppp truncates it.
  32.  
  33.        Compressed files can be restored to their original form
  34.        using llllzzzzoooopppp ----dddd.  llllzzzzoooopppp ----dddd takes a list of files on its
  35.        command line and decompresses each file whose name ends
  36.        with ....llllzzzzoooo and which begins with the correct magic number
  37.        to an uncompressed file without the original extension.
  38.        llllzzzzoooopppp ----dddd also recognizes the special extension ....ttttzzzzoooo as
  39.        shorthand for ....ttttaaaarrrr....llllzzzzoooo.  When compressing, lzop uses the
  40.        ....ttttzzzzoooo extension if necessary instead of truncating a file
  41.        with a ....ttttaaaarrrr extension.
  42.  
  43.        llllzzzzoooopppp stores the original file name, mode and time stamp in
  44.        the compressed file. These can be used when decompressing
  45.        the file with the ----dddd option. This is useful when the
  46.        compressed file name was truncated or when the time stamp
  47.        was not preserved after a file transfer.
  48.  
  49.        llllzzzzoooopppp preserves the ownership, mode and time stamp of files
  50.        when compressing. When decompressing lzop restores the
  51.        mode and time stamp if present in the compressed files.
  52.        See the options ----nnnn, ----NNNN, --------nnnnoooo----mmmmooooddddeeee and --------nnnnoooo----ttttiiiimmmmeeee for more
  53.        information.
  54.  
  55.        llllzzzzoooopppp always keeps original files unchanged unless you use
  56.        the option ----UUUU.
  57.  
  58.        llllzzzzoooopppp uses the _L_Z_O _d_a_t_a _c_o_m_p_r_e_s_s_i_o_n _l_i_b_r_a_r_y for compression
  59.        services. The amount of compression obtained depends on
  60.        the size of the input and the distribution of common
  61.  
  62.  
  63.  
  64. 1998-04-27                  lzop 1.00                           1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. LZOP(1)                                                   LZOP(1)
  71.  
  72.  
  73.        substrings.  Typically, text such as source code or
  74.        English is compressed into 40-50% of the original size,
  75.        and large files usually compress much better than small
  76.        ones. Compression and decompression speed is generally
  77.        much faster than that achieved by ggggzzzziiiipppp, but compression
  78.        ratio is worse.
  79.  
  80.        CCCCOOOOMMMMPPPPRRRREEEESSSSSSSSIIIIOOOONNNN LLLLEEEEVVVVEEEELLLLSSSS
  81.  
  82.        lzop offers the following compression levels of the LZO1X
  83.        algorithm:
  84.  
  85.        -3  the default level offers pretty fast compression.
  86.            Note that -2, -3, -4, -5 and -6 are currently all
  87.            equivalent - this may change in a future release.
  88.  
  89.        -1, --fast
  90.            can be even a little bit faster in some cases - but
  91.            most times you won't notice the difference
  92.  
  93.        -7, -8, -9, --best
  94.            these compression levels are mainly intended for
  95.            generating pre-compressed data - especially ----9999 can be
  96.            somewhat slow
  97.  
  98.        Decompression is _v_e_r_y fast for all compression levels.
  99.  
  100. MMMMAAAAIIIINNNN CCCCOOOOMMMMMMMMAAAANNNNDDDD
  101.        If no other command is given then lzop defaults to
  102.        compression.
  103.  
  104.        -#, --fast, --best
  105.            Regulate the speed of compression using the specified
  106.            digit ####, where -1 or --fast indicates the fastest
  107.            compression method (less compression) and -9 or --best
  108.            indicates the slowest compression method (best
  109.            compression). The default compression level is -3.
  110.  
  111.        -d, --decompress, --uncompress
  112.            Decompress. Each file will be placed into same the
  113.            directory as the compressed file.
  114.  
  115.        -x, --extract
  116.            Extract compressed files to the current working
  117.            directory. This is the same as `-dNp'.
  118.  
  119.        -t, --test
  120.            Test. Check the compressed file integrity.
  121.  
  122.        -l, --list
  123.            For each compressed file, list the following fields:
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. 1998-04-27                  lzop 1.00                           2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. LZOP(1)                                                   LZOP(1)
  137.  
  138.  
  139.              method: compression method
  140.              compressed: size of the compressed file
  141.              uncompr.: size of the uncompressed file
  142.              ratio: compression ratio
  143.              uncompressed_name: name of the uncompressed file
  144.  
  145.            In combination with the --verbose option, the
  146.            following fields are also displayed:
  147.  
  148.              date & time: time stamp for the uncompressed file
  149.  
  150.            With --name, the uncompressed name, date and time are
  151.            those stored within the compress file if present.
  152.  
  153.            With --verbose, the size totals and compression ratio
  154.            for all files is also displayed. With --quiet, the
  155.            title and totals lines are not displayed.
  156.  
  157.            Note that lzop defines compression ratio as
  158.            compressed_size / uncompressed_size.
  159.  
  160.        --ls, --ls=_F_L_A_G_S
  161.            List each compressed file in a format similar to
  162.            llllssss ----llllnnnn.
  163.  
  164.            The following flags are currently honoured:
  165.              F  Append a `*' for executable files.
  166.              G  Inhibit display of group information.
  167.              Q  Enclose file names in double quotes.
  168.  
  169.        --info
  170.            For each compressed file, list the internal header
  171.            fields.
  172.  
  173.        -I, --sysinfo
  174.            Display information about the system and quit.
  175.  
  176.        -L, --license
  177.            Display the lzop license and quit.
  178.  
  179.        -h, -H, --help
  180.            Display a help screen and quit.
  181.  
  182.        -V  Version. Display the version number and compilation
  183.            options then quit.
  184.  
  185.        --version
  186.            Version. Display the version number then quit.
  187.  
  188.        Note that ----tttt has priority over ----dddd, ----llll over ----tttt, and so on.
  189.  
  190. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  191.  
  192.  
  193.  
  194.  
  195.  
  196. 1998-04-27                  lzop 1.00                           3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. LZOP(1)                                                   LZOP(1)
  203.  
  204.  
  205.        -c, --stdout, --to-stdout
  206.            Write output on standard output. If there are several
  207.            input files, the output consists of a sequence of
  208.            independently (de)compressed members. To obtain better
  209.            compression, concatenate all input files before
  210.            compressing them.
  211.  
  212.        -o _F_I_L_E, --output=_F_I_L_E
  213.            Write output to the file _F_I_L_E. If there are several
  214.            input files, the output consists of a sequence of
  215.            independently (de)compressed members.
  216.  
  217.        -p, -p_D_I_R, --path=_D_I_R
  218.            Write output files into the directory _D_I_R instead of
  219.            the directory determined by the input file. If _D_I_R is
  220.            omitted, then write to the current working directory.
  221.  
  222.        -f, --force
  223.            Force lzop to
  224.  
  225.             - overwrite existing files
  226.             - compress from stdin even if it seems a terminal
  227.             - compress to stdout even if it seems a terminal
  228.             - allow option -c in combination with -U
  229.  
  230.            Using ----ffff two or more times forces things like
  231.  
  232.             - compress files that already have a .lzo suffix
  233.             - decompress files that do not have a valid suffix
  234.             - try to handle compressed files with unknown header flags
  235.  
  236.            Use with care.
  237.  
  238.        -F, --no-checksum
  239.            Do not store or verify a checksum of the uncompressed
  240.            file when compressing or decompressing.  This speeds
  241.            up the operation of lzop a little bit (especially when
  242.            decompressing), but as unnoticed data corruption can
  243.            happen in case of damaged compressed files the usage
  244.            of this option is not generally recommended.  Also, a
  245.            checksum is always stored when compressing with one of
  246.            the slow compression levels (-7, -8 or -9).
  247.  
  248.        -n, --no-name
  249.            When decompressing, do not restore the original file
  250.            name if present (remove only the lzop suffix from the
  251.            compressed file name). This option is the default
  252.            under UNIX.
  253.  
  254.        -N, --name
  255.            When decompressing, restore the original file name if
  256.            present. This option is useful on systems which have a
  257.            limit on file name length. If the original name saved
  258.            in the compressed file is not suitable for its file
  259.  
  260.  
  261.  
  262. 1998-04-27                  lzop 1.00                           4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. LZOP(1)                                                   LZOP(1)
  269.  
  270.  
  271.            system, a new name is constructed from the original
  272.            one to make it legal.  This option is the default
  273.            under DOS, Windows and OS/2.
  274.  
  275.        --no-mode
  276.            When decompressing, do not restore the original mode
  277.            (permissions) saved in the compressed file.
  278.  
  279.        --no-time
  280.            When decompressing, do not restore the original time
  281.            stamp saved in the compressed file.
  282.  
  283.        -S _._s_u_f, --suffix=_._s_u_f
  284.            Use suffix _._s_u_f instead of _._l_z_o. The suffix must not
  285.            contain multiple dots and special characters like '+'
  286.            or '*', and suffixes other than _._l_z_o should be avoided
  287.            to avoid confusion when files are transferred to other
  288.            systems.
  289.  
  290.        -k, --keep
  291.            Do not delete input files. This is the default.
  292.  
  293.        -U, --unlink, --delete
  294.            Delete input files after succesfull compression or
  295.            decompression. Beware. Use this option to make lzop
  296.            behave like ggggzzzziiiipppp. Note that ----kkkk overrides ----UUUU.
  297.  
  298.        --no-stdin
  299.            Do not try to read standard input. This option is
  300.            necessary in cron jobs (which do not have a
  301.            controlling terminal).  A file name "-" will still
  302.            override this option.
  303.  
  304.        --no-warn
  305.            Suppress all warnings.
  306.  
  307.        --ignore-warn
  308.            Suppress all warnings, and never exit with exit status
  309.            2.
  310.  
  311.        -q, --quiet, --silent
  312.            Suppress all warnings and decrease the verbosity of
  313.            some commands like --------lllliiiisssstttt or --------tttteeeesssstttt.
  314.  
  315.        -v, --verbose
  316.            Verbose. Display the name for each file compressed or
  317.            decompressed. Multiple ----vvvv can be used to increase the
  318.            verbosity of some commands like --------lllliiiisssstttt or --------tttteeeesssstttt.
  319.  
  320.        --  Specifies that this is the end of the options. Any
  321.            file name after -------- will not be interpreted as an
  322.            option even if it starts with a hyphen.
  323.  
  324.  
  325.  
  326.  
  327.  
  328. 1998-04-27                  lzop 1.00                           5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. LZOP(1)                                                   LZOP(1)
  335.  
  336.  
  337. OOOOTTTTHHHHEEEERRRR OOOOPPPPTTTTIIIIOOOONNNNSSSS
  338.        --no-color
  339.            Do not use any color escape sequences.
  340.  
  341.        --mono
  342.            Assume a mono ANSI terminal. This is the default under
  343.            UNIX.
  344.  
  345.        --color
  346.            Assume a color ANSI terminal or try full-screen
  347.            access. This is the default under DOS and in a Linux
  348.            virtual console.
  349.  
  350.        --intro
  351.            Try to display that nice intro sequence then quit.
  352.            Needs full-screen access.
  353.  
  354.        --filter=_N_U_M_B_E_R
  355.            Rarely useful.  Preprocess data with a special
  356.            "multimedia" filter before compressing in order to
  357.            improve compression ratio.  _N_U_M_B_E_R must be a decimal
  358.            number from 1 to 16, inclusive.  Using a filter slows
  359.            down both compression and decompression quite a bit,
  360.            and the compression ratio usually doesn't improve much
  361.            either...  More effective filters may be added in the
  362.            future, though.
  363.  
  364.            You can try --filter=1 with data like 8-bit sound
  365.            samples, --filter=2 with 16-bit samples or depth-16
  366.            images, etc.
  367.  
  368.            Un-filtering during decompression is handled
  369.            automatically.
  370.  
  371.        -C, --checksum
  372.            Deprecated. Only for compatibility with old versions
  373.            as lzop now uses a checksum by default. This option
  374.            may get removed in a future release.
  375.  
  376. AAAADDDDVVVVAAAANNNNCCCCEEEEDDDD UUUUSSSSAAAAGGGGEEEE
  377.        lzop allows you to deal with your files in many flexible
  378.        ways. Here are some usage examples:
  379.  
  380.        ssssiiiinnnngggglllleeee ffffiiiilllleeee mmmmooooddddeeee:::: individually (de)compress each file
  381.  
  382.          create
  383.            lzop a.c             -> create a.c.lzo
  384.            lzop a.c b.c         -> create a.c.lzo & b.c.lzo
  385.            lzop -U a.c b.c      -> create a.c.lzo & b.c.lzo and delete a.c & b.c
  386.            lzop *.c
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. 1998-04-27                  lzop 1.00                           6
  395.  
  396.  
  397.  
  398.  
  399.  
  400. LZOP(1)                                                   LZOP(1)
  401.  
  402.  
  403.          extract
  404.            lzop -d a.c.lzo      -> restore a.c
  405.            lzop -df a.c.lzo     -> restore a.c, overwrite if already exists
  406.            lzop -d *.lzo
  407.  
  408.          list
  409.            lzop -l a.c.lzo
  410.            lzop -l *.lzo
  411.            lzop -lv *.lzo       -> be verbose
  412.  
  413.          test
  414.            lzop -t a.c.lzo
  415.            lzop -tq *.lzo       -> be quiet
  416.  
  417.  
  418.        ppppiiiippppeeee mmmmooooddddeeee:::: (de)compress from stdin to stdout
  419.  
  420.          create
  421.            lzop < a.c > y.lzo
  422.            cat a.c | lzop > y.lzo
  423.            tar -cf - *.c | lzop > y.tar.lzo     -> create a compressed tar file
  424.  
  425.          extract
  426.            lzop -d < y.lzo > a.c
  427.            lzop -d < y.tar.lzo | tar -xvf -     -> extract a tar file
  428.            lzop -d < y.tar.lzo | tar -tvf -     -> list a tar file
  429.  
  430.          list
  431.            lzop -l < y.lzo
  432.            cat y.lzo | lzop -l
  433.  
  434.          test
  435.            lzop -t < y.lzo
  436.            cat y.lzo | lzop -t
  437.  
  438.  
  439.        ssssttttddddoooouuuutttt mmmmooooddddeeee:::: (de)compress to stdout
  440.  
  441.          create
  442.            lzop -c a.c > y.lzo
  443.  
  444.          extract
  445.            lzop -dc y.lzo > a.c
  446.            lzop -dc y.tar.lzo | tar -tvf -      -> list a tar file
  447.  
  448.  
  449.        aaaarrrrcccchhhhiiiivvvveeee mmmmooooddddeeee:::: compress/extract multiple files into a
  450.         single archive file
  451.  
  452.          create
  453.            lzop a.c b.c -o sources.lzo          -> create an archive
  454.            lzop -c *.c > sources.lzo            -> another way to create an archive
  455.            lzop -c *.h >> sources.lzo           -> add files to archive
  456.  
  457.  
  458.  
  459.  
  460. 1998-04-27                  lzop 1.00                           7
  461.  
  462.  
  463.  
  464.  
  465.  
  466. LZOP(1)                                                   LZOP(1)
  467.  
  468.  
  469.          extract
  470.            lzop -dN sources.lzo
  471.            lzop -x ../src/sources.lzo           -> extract to current directory
  472.            lzop -x -p/tmp < ../src/sources.lzo  -> extract to /tmp directory
  473.  
  474.          list
  475.            lzop -lNv sources.lzo
  476.  
  477.          test
  478.            lzop -t sources.lzo
  479.            lzop -tvv sources.lzo                -> be very verbose
  480.  
  481.  
  482.        If you wish to create a single archive file with multiple
  483.        members so that members can later be extracted
  484.        independently, you should prefer a full-featured archiver
  485.        such as tar or zip. The latest version of GNU tar supports
  486.        the --------uuuusssseeee----ccccoooommmmpppprrrreeeessssssss----pppprrrrooooggggrrrraaaammmm====llllzzzzoooopppp option to invoke lzop
  487.        transparently.  lzop is designed as a complement to tar,
  488.        not as a replacement.
  489.  
  490. EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  491.        The environment variable LLLLZZZZOOOOPPPP can hold a set of default
  492.        options for lzop. These options are interpreted first and
  493.        can be overwritten by explicit command line parameters.
  494.        For example:
  495.  
  496.            for sh/ksh/zsh:    LZOP="-1v --name"; export LZOP
  497.            for csh/tcsh:      setenv LZOP "-1v --name"
  498.            for DOS:           set LZOP=-1v --name
  499.  
  500.        On Vax/VMS, the name of the environment variable is
  501.        LZOP_OPT, to avoid a conflict with the symbol set for
  502.        invocation of the program.
  503.  
  504.        Note that not all options are valid in the environment
  505.        variable - lzop will tell you.
  506.  
  507. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  508.        ggggzzzziiiipppp(1), ttttaaaarrrr(1), bbbbzzzziiiipppp2222(1)
  509.  
  510.        Precompiled binaries for some platforms should be
  511.        available from the lzop home page soon.
  512.  
  513.            see http://wildsau.idv.uni-linz.ac.at/mfx/lzop.html
  514.  
  515.        lzop uses the LZO data compression library for compression
  516.        services.
  517.  
  518.            see http://wildsau.idv.uni-linz.ac.at/mfx/lzo.html
  519.  
  520.  
  521. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  522.        Exit status is normally 0; if an error occurs, exit status
  523.  
  524.  
  525.  
  526. 1998-04-27                  lzop 1.00                           8
  527.  
  528.  
  529.  
  530.  
  531.  
  532. LZOP(1)                                                   LZOP(1)
  533.  
  534.  
  535.        is 1. If a warning occurs, exit status is 2.
  536.  
  537.        llllzzzzoooopppp''''ssss diagnostics are intended to be self-explanatory.
  538.  
  539. BBBBUUUUGGGGSSSS
  540.        Please report all bugs immediately to the author.
  541.  
  542. AAAAUUUUTTTTHHHHOOOORRRR
  543.        markus.oberhumer@jk.uni-linz.ac.at
  544.  
  545. CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  546.        lzop and the LZO library are Copyright (C) 1996, 1997,
  547.        1998 by Markus Franz Xaver Johannes Oberhumer.
  548.  
  549.        lzop and the LZO library are distributed under the terms
  550.        of the GNU General Public License (GPL).
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592. 1998-04-27                  lzop 1.00                           9
  593.  
  594.  
  595.  
  596.  
  597.  
  598. LZOP(1)                                                   LZOP(1)
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658. 1998-04-27                  lzop 1.00                          10
  659.  
  660.  
  661.