.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "STREAMZIP 1" .TH STREAMZIP 1 "2022-02-17" "perl v5.32.1" "Perl Programmers Reference Guide" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" streamzip \- create a zip file from stdin .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& producer | streamzip [opts] | consumer \& producer | streamzip [opts] \-zipfile=output.zip .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This program will read data from stdin, compress it into a zip container and, by default, write a \fIstreamed\fR zip file to stdout. No temporary files are created. .PP The zip container written to stdout is, by necessity, written in streaming format. Most programs that read Zip files can cope with a streamed zip file, but if interoperability is important, and your workflow allows you to write the zip file directly to disk you can create a non-streamed zip file using the \f(CW\*(C`zipfile\*(C'\fR option. .SS "\s-1OPTIONS\s0" .IX Subsection "OPTIONS" .IP "\-zip64" 5 .IX Item "-zip64" Create a Zip64\-compliant zip container. Use this option if the input is greater than 4Gig. .Sp Default is disabled. .IP "\-zipfile=F" 5 .IX Item "-zipfile=F" Write zip container to the filename F. .Sp Use the \f(CW\*(C`Stream\*(C'\fR option to enable the creation of a streamed zip file. .IP "\-member\-name=M" 5 .IX Item "-member-name=M" This option is used to name the \*(L"file\*(R" in the zip container. .Sp Default is '\-'. .IP "\-stream" 5 .IX Item "-stream" Ignored when writing to stdout. .Sp If the \f(CW\*(C`zipfile\*(C'\fR option is specified, including this option will trigger the creation of a streamed zip file. .Sp Default: Always enabled when writing to stdout, otherwise disabled. .IP "\-method=M" 5 .IX Item "-method=M" Compress using method \*(L"M\*(R". .Sp Valid method names are .Sp .Vb 4 \& * store Store without compression \& * deflate Use Deflate compression [Deflault] \& * bzip2 Use Bzip2 compression \& * lzma Use LZMA compression .Ve .Sp Note that Lzma compress needs IO::Compress::Lzma to be installed. .Sp Default is deflate. .IP "\-version" 5 .IX Item "-version" Display version number [$VERSION] .IP "\-help" 5 .IX Item "-help" Display help .SS "When to use a Streamed Zip File" .IX Subsection "When to use a Streamed Zip File" A Zip file created with streaming mode enabled allows you to create a zip file in situations where you cannot seek backwards/forwards in the file. .PP A good examples is when you are serving dynamic content from a Web Server straight into a socket without needing to create a temporary zip file in the filesystsm. .PP Similarly if your workfow uses a Linux pipelined commands. .SH "SUPPORT" .IX Header "SUPPORT" General feedback/questions/bug reports should be sent to (preferred) or . .SH "AUTHOR" .IX Header "AUTHOR" Paul Marquess \fIpmqs@cpan.org\fR. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2019 Paul Marquess. All rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.