Lucee Function Reference
Function COMPRESS
Compress given source to different formats.
Example
compress(string format,string source,string target,[boolean includeBaseFolder,[string mode]]):boolean
Arguments
The arguments for this function are set. You can not use other arguments except the following ones.
| Name | Type | Required | Default Value | Description |
|---|---|---|---|---|
| format | string | Yes | Format to compress (bzip,gzip,tar,tbz (tar bzip),tgz (tar gzip) and zip) | |
| source | string | Yes | source file or directory to compress | |
| target | string | Yes | name of the target compressed file | |
| includeBaseFolder | boolean | No | true | take the folder or only content of folder |
| mode | string | No | 777 | mode of the values |