lzip-go

lzip-go is an implementation of the lzip compressed format written in pure Go.

This package supports reading and writing of lzip compressed streams.

Usage

To install this package:

go get -u github.com/sorairolake/lzip-go

Example

Please see example_test.go.

Documentation

See the documentation for more details.

Command-line utility

This package includes a simple command-line utility for reading and writing of lzip format compressed files.

Installation

From source

go install github.com/sorairolake/lzip-go/cmd/glzip@latest

From binaries

The release page contains pre-built binaries for Linux, macOS, Windows and others.

How to build

To build the command-line utility:

just build-cmd

To build a man page:

just build-man

The man page is generated in docs/man/man1. Note that Asciidoctor is required when building the man page.

Usage

Please see glzip(1).

Minimum Go version

This package requires the minimum version of Go 1.22.

Changelog

Please see CHANGELOG.adoc.

Contributing

Please see CONTRIBUTING.adoc.

Acknowledgment

The API of this package is based on the compress/gzip package.

This package uses the github.com/ulikunitz/xz/lzma package to encode and decode LZMA streams.

License

Copyright © 2024 Shun Sakai (see AUTHORS.adoc)

This package is distributed under the terms of either the Apache License 2.0 or the MIT License.

This project is compliant with version 3.2 of the REUSE Specification. See copyright notices of individual files for more details on copyright and licensing information.