From de6fdf888d87f1d24e9c9bbe9f4efdc819039c67 Mon Sep 17 00:00:00 2001 From: Christian Krause Date: Fri, 7 Aug 2015 10:13:12 +0200 Subject: [PATCH 1/4] move sources to src --- common.c => src/common.c | 0 cpu.c => src/cpu.c | 0 endian.c => src/endian.c | 0 list.c => src/list.c | 0 pixz.c => src/pixz.c | 0 pixz.h => src/pixz.h | 0 read.c => src/read.c | 0 write.c => src/write.c | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename common.c => src/common.c (100%) rename cpu.c => src/cpu.c (100%) rename endian.c => src/endian.c (100%) rename list.c => src/list.c (100%) rename pixz.c => src/pixz.c (100%) rename pixz.h => src/pixz.h (100%) rename read.c => src/read.c (100%) rename write.c => src/write.c (100%) diff --git a/common.c b/src/common.c similarity index 100% rename from common.c rename to src/common.c diff --git a/cpu.c b/src/cpu.c similarity index 100% rename from cpu.c rename to src/cpu.c diff --git a/endian.c b/src/endian.c similarity index 100% rename from endian.c rename to src/endian.c diff --git a/list.c b/src/list.c similarity index 100% rename from list.c rename to src/list.c diff --git a/pixz.c b/src/pixz.c similarity index 100% rename from pixz.c rename to src/pixz.c diff --git a/pixz.h b/src/pixz.h similarity index 100% rename from pixz.h rename to src/pixz.h diff --git a/read.c b/src/read.c similarity index 100% rename from read.c rename to src/read.c diff --git a/write.c b/src/write.c similarity index 100% rename from write.c rename to src/write.c From bc9a3b8d5ab9cb81bb9c7205cbe24fbd41a5f64c Mon Sep 17 00:00:00 2001 From: Christian Krause Date: Fri, 7 Aug 2015 11:33:37 +0200 Subject: [PATCH 2/4] complete autotools build - `__APPLE__` vs `__OS2__` - does this actually work? Would some please test on apple and give feedback? - pthread via `AX_PTHREAD` - version via `PACKAGE_VERSION` in `config.h` - large file support via `AC_SYS_LARGEFILE` --- .gitignore | 45 +++- Makefile | 56 ----- Makefile.am | 5 + autogen.sh | 3 + configure.ac | 50 ++++ m4/ax_pthread.m4 | 332 +++++++++++++++++++++++++ src/Makefile.am | 23 ++ src/endian.c | 2 +- pixz.1.asciidoc => src/pixz.1.asciidoc | 0 src/pixz.c | 6 +- 10 files changed, 457 insertions(+), 65 deletions(-) delete mode 100644 Makefile create mode 100644 Makefile.am create mode 100755 autogen.sh create mode 100644 configure.ac create mode 100644 m4/ax_pthread.m4 create mode 100644 src/Makefile.am rename pixz.1.asciidoc => src/pixz.1.asciidoc (100%) diff --git a/.gitignore b/.gitignore index d988a49..1c07a37 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,40 @@ -pixz -pixz.1 -dist -pixz-*.tgz +# created by autoscan -*.o +/autom4te.cache +/autoscan.log +/configure.scan + +# created by autoreconf -fi (includes autoconf, automake, libtool) + +Makefile.in +/aclocal.m4 +/autom4te.cache +/compile +/config.guess +/config.h.in* +/config.sub +/configure +/depcomp +/install-sh +/ltmain.sh +/missing + +# created by configure -libs -tars +Makefile +/config.h +/config.log +/config.status +/libtool +/stamp-h1 +.deps + +# created by make + +*.la +*.lo +*.o +.libs +pixz +pixz.1 +*.tar.* diff --git a/Makefile b/Makefile deleted file mode 100644 index 3b27690..0000000 --- a/Makefile +++ /dev/null @@ -1,56 +0,0 @@ -VERSION = 1.0.2 -DISTNAME = pixz-$(VERSION) -TARBALL = $(DISTNAME).tgz - -ifneq ($(shell gcc -v 2>&1 | grep 'Apple Inc'),) - APPLE=1 -endif - -OPT = -g -O0 -MYCFLAGS = $(patsubst %,-I%/include,$(LIBPREFIX)) $(OPT) -std=gnu99 \ - -Wall -Wno-unknown-pragmas -DPIXZ_VERSION='"$(VERSION)"' -MYLDFLAGS = $(patsubst %,-L%/lib,$(LIBPREFIX)) $(OPT) -Wall - -THREADS = -lpthread -LIBADD = $(THREADS) -lm -llzma -larchive - -CC = gcc -COMPILE = $(CC) $(MYCFLAGS) $(CFLAGS) -c -o -LD = $(CC) $(MYLDFLAGS) $(LDFLAGS) -o - -ifdef APPLE -ifeq ($(CC),gcc) - MYLDFLAGS += -search_paths_first -endif -endif - -PROGS = pixz -MANPAGE = pixz.1 -COMMON = common.o endian.o cpu.o read.o write.o list.o - -all: $(PROGS) - -%.o: %.c pixz.h - $(COMPILE) $@ $< - -$(PROGS): %: %.o $(COMMON) - $(LD) $@ $^ $(LIBADD) - -clean: - rm -rf *.o $(PROGS) $(MANPAGE) $(TARBALL) dist - -$(MANPAGE): pixz.1.asciidoc - a2x -a manversion=$(VERSION) -f manpage $< - -dist: - rm -rf dist - mkdir -p dist - git archive --prefix=$(DISTNAME)/ --format=tar HEAD | tar -x -C dist - -$(TARBALL): $(MANPAGE) dist - cp pixz.1 dist/$(DISTNAME)/ - tar -czf $(TARBALL) -C dist $(DISTNAME) - -tarball: $(TARBALL) - -.PHONY: all clean tarball dist diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..67f4286 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,5 @@ +ACLOCAL_AMFLAGS = -I m4 + +SUBDIRS = src + +EXTRA_DIST = LICENSE m4 NEWS README test.sh TODO diff --git a/autogen.sh b/autogen.sh new file mode 100755 index 0000000..e7b8536 --- /dev/null +++ b/autogen.sh @@ -0,0 +1,3 @@ +#!/bin/sh + +autoreconf -fi diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..df556d8 --- /dev/null +++ b/configure.ac @@ -0,0 +1,50 @@ +# -*- Autoconf -*- +# Process this file with autoconf to produce a configure script. + +AC_PREREQ([2.69]) +AC_INIT([pixz], [1.0.2], [https://github.com/vasi/pixz/issues]) +AC_CONFIG_MACRO_DIRS([m4]) +AC_CONFIG_SRCDIR([src/pixz.c]) +AC_CONFIG_HEADERS([config.h]) + +# Automake invocation. +AM_INIT_AUTOMAKE([foreign]) + +# Checks for programs. +AC_PROG_CC_STDC +AC_CHECK_PROG(A2X, a2x, a2x, []) +if test "x$A2X" = x ; then + AC_MSG_ERROR([AsciiDoc not found.]) +fi + +# Checks for libraries. +AC_CHECK_LIB([m], [ceil]) +AX_PTHREAD +PKG_CHECK_MODULES(LIBARCHIVE, libarchive) +PKG_CHECK_MODULES(LZMA, liblzma) + +# Checks for header files. +AC_CHECK_HEADERS([stdint.h stdlib.h string.h unistd.h]) + +# Checks for typedefs, structures, and compiler characteristics. +AC_CHECK_HEADER_STDBOOL +AC_TYPE_OFF_T +AC_TYPE_SIZE_T +AC_TYPE_SSIZE_T +AC_TYPE_UINT16_T +AC_TYPE_UINT32_T +AC_TYPE_UINT64_T +AC_TYPE_UINT8_T + +# Checks for operating system services or capabilities. +AC_SYS_LARGEFILE + +# Checks for library functions. +AC_FUNC_MALLOC +AC_FUNC_REALLOC +AC_FUNC_STRTOD +AC_CHECK_FUNCS([memchr memmove memset strtol]) + +AC_CONFIG_FILES([Makefile + src/Makefile]) +AC_OUTPUT diff --git a/m4/ax_pthread.m4 b/m4/ax_pthread.m4 new file mode 100644 index 0000000..d383ad5 --- /dev/null +++ b/m4/ax_pthread.m4 @@ -0,0 +1,332 @@ +# =========================================================================== +# http://www.gnu.org/software/autoconf-archive/ax_pthread.html +# =========================================================================== +# +# SYNOPSIS +# +# AX_PTHREAD([ACTION-IF-FOUND[, ACTION-IF-NOT-FOUND]]) +# +# DESCRIPTION +# +# This macro figures out how to build C programs using POSIX threads. It +# sets the PTHREAD_LIBS output variable to the threads library and linker +# flags, and the PTHREAD_CFLAGS output variable to any special C compiler +# flags that are needed. (The user can also force certain compiler +# flags/libs to be tested by setting these environment variables.) +# +# Also sets PTHREAD_CC to any special C compiler that is needed for +# multi-threaded programs (defaults to the value of CC otherwise). (This +# is necessary on AIX to use the special cc_r compiler alias.) +# +# NOTE: You are assumed to not only compile your program with these flags, +# but also link it with them as well. e.g. you should link with +# $PTHREAD_CC $CFLAGS $PTHREAD_CFLAGS $LDFLAGS ... $PTHREAD_LIBS $LIBS +# +# If you are only building threads programs, you may wish to use these +# variables in your default LIBS, CFLAGS, and CC: +# +# LIBS="$PTHREAD_LIBS $LIBS" +# CFLAGS="$CFLAGS $PTHREAD_CFLAGS" +# CC="$PTHREAD_CC" +# +# In addition, if the PTHREAD_CREATE_JOINABLE thread-attribute constant +# has a nonstandard name, defines PTHREAD_CREATE_JOINABLE to that name +# (e.g. PTHREAD_CREATE_UNDETACHED on AIX). +# +# Also HAVE_PTHREAD_PRIO_INHERIT is defined if pthread is found and the +# PTHREAD_PRIO_INHERIT symbol is defined when compiling with +# PTHREAD_CFLAGS. +# +# ACTION-IF-FOUND is a list of shell commands to run if a threads library +# is found, and ACTION-IF-NOT-FOUND is a list of commands to run it if it +# is not found. If ACTION-IF-FOUND is not specified, the default action +# will define HAVE_PTHREAD. +# +# Please let the authors know if this macro fails on any platform, or if +# you have any other suggestions or comments. This macro was based on work +# by SGJ on autoconf scripts for FFTW (http://www.fftw.org/) (with help +# from M. Frigo), as well as ac_pthread and hb_pthread macros posted by +# Alejandro Forero Cuervo to the autoconf macro repository. We are also +# grateful for the helpful feedback of numerous users. +# +# Updated for Autoconf 2.68 by Daniel Richard G. +# +# LICENSE +# +# Copyright (c) 2008 Steven G. Johnson +# Copyright (c) 2011 Daniel Richard G. +# +# This program is free software: you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General +# Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with this program. If not, see . +# +# As a special exception, the respective Autoconf Macro's copyright owner +# gives unlimited permission to copy, distribute and modify the configure +# scripts that are the output of Autoconf when processing the Macro. You +# need not follow the terms of the GNU General Public License when using +# or distributing such scripts, even though portions of the text of the +# Macro appear in them. The GNU General Public License (GPL) does govern +# all other use of the material that constitutes the Autoconf Macro. +# +# This special exception to the GPL applies to versions of the Autoconf +# Macro released by the Autoconf Archive. When you make and distribute a +# modified version of the Autoconf Macro, you may extend this special +# exception to the GPL to apply to your modified version as well. + +#serial 21 + +AU_ALIAS([ACX_PTHREAD], [AX_PTHREAD]) +AC_DEFUN([AX_PTHREAD], [ +AC_REQUIRE([AC_CANONICAL_HOST]) +AC_LANG_PUSH([C]) +ax_pthread_ok=no + +# We used to check for pthread.h first, but this fails if pthread.h +# requires special compiler flags (e.g. on True64 or Sequent). +# It gets checked for in the link test anyway. + +# First of all, check if the user has set any of the PTHREAD_LIBS, +# etcetera environment variables, and if threads linking works using +# them: +if test x"$PTHREAD_LIBS$PTHREAD_CFLAGS" != x; then + save_CFLAGS="$CFLAGS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + save_LIBS="$LIBS" + LIBS="$PTHREAD_LIBS $LIBS" + AC_MSG_CHECKING([for pthread_join in LIBS=$PTHREAD_LIBS with CFLAGS=$PTHREAD_CFLAGS]) + AC_TRY_LINK_FUNC([pthread_join], [ax_pthread_ok=yes]) + AC_MSG_RESULT([$ax_pthread_ok]) + if test x"$ax_pthread_ok" = xno; then + PTHREAD_LIBS="" + PTHREAD_CFLAGS="" + fi + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" +fi + +# We must check for the threads library under a number of different +# names; the ordering is very important because some systems +# (e.g. DEC) have both -lpthread and -lpthreads, where one of the +# libraries is broken (non-POSIX). + +# Create a list of thread flags to try. Items starting with a "-" are +# C compiler flags, and other items are library names, except for "none" +# which indicates that we try without any flags at all, and "pthread-config" +# which is a program returning the flags for the Pth emulation library. + +ax_pthread_flags="pthreads none -Kthread -kthread lthread -pthread -pthreads -mthreads pthread --thread-safe -mt pthread-config" + +# The ordering *is* (sometimes) important. Some notes on the +# individual items follow: + +# pthreads: AIX (must check this before -lpthread) +# none: in case threads are in libc; should be tried before -Kthread and +# other compiler flags to prevent continual compiler warnings +# -Kthread: Sequent (threads in libc, but -Kthread needed for pthread.h) +# -kthread: FreeBSD kernel threads (preferred to -pthread since SMP-able) +# lthread: LinuxThreads port on FreeBSD (also preferred to -pthread) +# -pthread: Linux/gcc (kernel threads), BSD/gcc (userland threads) +# -pthreads: Solaris/gcc +# -mthreads: Mingw32/gcc, Lynx/gcc +# -mt: Sun Workshop C (may only link SunOS threads [-lthread], but it +# doesn't hurt to check since this sometimes defines pthreads too; +# also defines -D_REENTRANT) +# ... -mt is also the pthreads flag for HP/aCC +# pthread: Linux, etcetera +# --thread-safe: KAI C++ +# pthread-config: use pthread-config program (for GNU Pth library) + +case ${host_os} in + solaris*) + + # On Solaris (at least, for some versions), libc contains stubbed + # (non-functional) versions of the pthreads routines, so link-based + # tests will erroneously succeed. (We need to link with -pthreads/-mt/ + # -lpthread.) (The stubs are missing pthread_cleanup_push, or rather + # a function called by this macro, so we could check for that, but + # who knows whether they'll stub that too in a future libc.) So, + # we'll just look for -pthreads and -lpthread first: + + ax_pthread_flags="-pthreads pthread -mt -pthread $ax_pthread_flags" + ;; + + darwin*) + ax_pthread_flags="-pthread $ax_pthread_flags" + ;; +esac + +# Clang doesn't consider unrecognized options an error unless we specify +# -Werror. We throw in some extra Clang-specific options to ensure that +# this doesn't happen for GCC, which also accepts -Werror. + +AC_MSG_CHECKING([if compiler needs -Werror to reject unknown flags]) +save_CFLAGS="$CFLAGS" +ax_pthread_extra_flags="-Werror" +CFLAGS="$CFLAGS $ax_pthread_extra_flags -Wunknown-warning-option -Wsizeof-array-argument" +AC_COMPILE_IFELSE([AC_LANG_PROGRAM([int foo(void);],[foo()])], + [AC_MSG_RESULT([yes])], + [ax_pthread_extra_flags= + AC_MSG_RESULT([no])]) +CFLAGS="$save_CFLAGS" + +if test x"$ax_pthread_ok" = xno; then +for flag in $ax_pthread_flags; do + + case $flag in + none) + AC_MSG_CHECKING([whether pthreads work without any flags]) + ;; + + -*) + AC_MSG_CHECKING([whether pthreads work with $flag]) + PTHREAD_CFLAGS="$flag" + ;; + + pthread-config) + AC_CHECK_PROG([ax_pthread_config], [pthread-config], [yes], [no]) + if test x"$ax_pthread_config" = xno; then continue; fi + PTHREAD_CFLAGS="`pthread-config --cflags`" + PTHREAD_LIBS="`pthread-config --ldflags` `pthread-config --libs`" + ;; + + *) + AC_MSG_CHECKING([for the pthreads library -l$flag]) + PTHREAD_LIBS="-l$flag" + ;; + esac + + save_LIBS="$LIBS" + save_CFLAGS="$CFLAGS" + LIBS="$PTHREAD_LIBS $LIBS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS $ax_pthread_extra_flags" + + # Check for various functions. We must include pthread.h, + # since some functions may be macros. (On the Sequent, we + # need a special flag -Kthread to make this header compile.) + # We check for pthread_join because it is in -lpthread on IRIX + # while pthread_create is in libc. We check for pthread_attr_init + # due to DEC craziness with -lpthreads. We check for + # pthread_cleanup_push because it is one of the few pthread + # functions on Solaris that doesn't have a non-functional libc stub. + # We try pthread_create on general principles. + AC_LINK_IFELSE([AC_LANG_PROGRAM([#include + static void routine(void *a) { a = 0; } + static void *start_routine(void *a) { return a; }], + [pthread_t th; pthread_attr_t attr; + pthread_create(&th, 0, start_routine, 0); + pthread_join(th, 0); + pthread_attr_init(&attr); + pthread_cleanup_push(routine, 0); + pthread_cleanup_pop(0) /* ; */])], + [ax_pthread_ok=yes], + []) + + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" + + AC_MSG_RESULT([$ax_pthread_ok]) + if test "x$ax_pthread_ok" = xyes; then + break; + fi + + PTHREAD_LIBS="" + PTHREAD_CFLAGS="" +done +fi + +# Various other checks: +if test "x$ax_pthread_ok" = xyes; then + save_LIBS="$LIBS" + LIBS="$PTHREAD_LIBS $LIBS" + save_CFLAGS="$CFLAGS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + + # Detect AIX lossage: JOINABLE attribute is called UNDETACHED. + AC_MSG_CHECKING([for joinable pthread attribute]) + attr_name=unknown + for attr in PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_UNDETACHED; do + AC_LINK_IFELSE([AC_LANG_PROGRAM([#include ], + [int attr = $attr; return attr /* ; */])], + [attr_name=$attr; break], + []) + done + AC_MSG_RESULT([$attr_name]) + if test "$attr_name" != PTHREAD_CREATE_JOINABLE; then + AC_DEFINE_UNQUOTED([PTHREAD_CREATE_JOINABLE], [$attr_name], + [Define to necessary symbol if this constant + uses a non-standard name on your system.]) + fi + + AC_MSG_CHECKING([if more special flags are required for pthreads]) + flag=no + case ${host_os} in + aix* | freebsd* | darwin*) flag="-D_THREAD_SAFE";; + osf* | hpux*) flag="-D_REENTRANT";; + solaris*) + if test "$GCC" = "yes"; then + flag="-D_REENTRANT" + else + # TODO: What about Clang on Solaris? + flag="-mt -D_REENTRANT" + fi + ;; + esac + AC_MSG_RESULT([$flag]) + if test "x$flag" != xno; then + PTHREAD_CFLAGS="$flag $PTHREAD_CFLAGS" + fi + + AC_CACHE_CHECK([for PTHREAD_PRIO_INHERIT], + [ax_cv_PTHREAD_PRIO_INHERIT], [ + AC_LINK_IFELSE([AC_LANG_PROGRAM([[#include ]], + [[int i = PTHREAD_PRIO_INHERIT;]])], + [ax_cv_PTHREAD_PRIO_INHERIT=yes], + [ax_cv_PTHREAD_PRIO_INHERIT=no]) + ]) + AS_IF([test "x$ax_cv_PTHREAD_PRIO_INHERIT" = "xyes"], + [AC_DEFINE([HAVE_PTHREAD_PRIO_INHERIT], [1], [Have PTHREAD_PRIO_INHERIT.])]) + + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" + + # More AIX lossage: compile with *_r variant + if test "x$GCC" != xyes; then + case $host_os in + aix*) + AS_CASE(["x/$CC"], + [x*/c89|x*/c89_128|x*/c99|x*/c99_128|x*/cc|x*/cc128|x*/xlc|x*/xlc_v6|x*/xlc128|x*/xlc128_v6], + [#handle absolute path differently from PATH based program lookup + AS_CASE(["x$CC"], + [x/*], + [AS_IF([AS_EXECUTABLE_P([${CC}_r])],[PTHREAD_CC="${CC}_r"])], + [AC_CHECK_PROGS([PTHREAD_CC],[${CC}_r],[$CC])])]) + ;; + esac + fi +fi + +test -n "$PTHREAD_CC" || PTHREAD_CC="$CC" + +AC_SUBST([PTHREAD_LIBS]) +AC_SUBST([PTHREAD_CFLAGS]) +AC_SUBST([PTHREAD_CC]) + +# Finally, execute ACTION-IF-FOUND/ACTION-IF-NOT-FOUND: +if test x"$ax_pthread_ok" = xyes; then + ifelse([$1],,[AC_DEFINE([HAVE_PTHREAD],[1],[Define if you have POSIX threads libraries and header files.])],[$1]) + : +else + ax_pthread_ok=no + $2 +fi +AC_LANG_POP +])dnl AX_PTHREAD diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..03cb0b7 --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,23 @@ +bin_PROGRAMS = pixz + +pixz_CC = $(PTHREAD_CC) +pixz_CFLAGS = $(PTHREAD_CFLAGS) -Wall -Wno-unknown-pragmas +pixz_CPPFLAGS = $(LIBARCHIVE_CPPFLAGS) $(LZMA_CPPFLAGS) +pixz_LDADD = -lm $(LIBARCHIVE_LIBS) $(LZMA_LIBS) $(PTHREAD_LIBS) + +pixz_SOURCES = \ + common.c \ + cpu.c \ + endian.c \ + list.c \ + pixz.c \ + pixz.h \ + read.c \ + write.c + +pixz.1: pixz.1.asciidoc + $(A2X) -a manversion=$(PACKAGE_VERSION) -f manpage pixz.1.asciidoc + +man_MANS = pixz.1 + +EXTRA_DIST = pixz.1.asciidoc diff --git a/src/endian.c b/src/endian.c index 2490364..e620631 100644 --- a/src/endian.c +++ b/src/endian.c @@ -1,4 +1,4 @@ -#ifdef __APPLE__ +#ifdef __OS2__ #include diff --git a/pixz.1.asciidoc b/src/pixz.1.asciidoc similarity index 100% rename from pixz.1.asciidoc rename to src/pixz.1.asciidoc diff --git a/src/pixz.c b/src/pixz.c index a9295e5..6777946 100644 --- a/src/pixz.c +++ b/src/pixz.c @@ -1,3 +1,7 @@ +#if HAVE_CONFIG_H +# include +#endif + #include "pixz.h" #include #include @@ -47,7 +51,7 @@ static void usage(const char *msg) { "(C) 2009-2012 Dave Vasilevsky \n" "https://github.com/vasi/pixz\n" "You may use this software under the FreeBSD License\n", - PIXZ_VERSION); + PACKAGE_VERSION); exit(2); } From 378ee786d688645c8b2d052af9592ec14bf9106d Mon Sep 17 00:00:00 2001 From: Christian Krause Date: Fri, 7 Aug 2015 11:39:22 +0200 Subject: [PATCH 3/4] update TODO because autoconf is done --- TODO | 1 - 1 file changed, 1 deletion(-) diff --git a/TODO b/TODO index 40ca5b1..002c7ef 100644 --- a/TODO +++ b/TODO @@ -5,7 +5,6 @@ CLEANUP * error handling * signal handling * globals - * autoconf * optimized settings * memory limit * cpu number From 00bad4eed55a52a8318e4002289b4c45b600916d Mon Sep 17 00:00:00 2001 From: Christian Krause Date: Fri, 7 Aug 2015 12:15:22 +0200 Subject: [PATCH 4/4] updates README --- README | 80 ------------------------ README.md | 182 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 182 insertions(+), 80 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 5639865..0000000 --- a/README +++ /dev/null @@ -1,80 +0,0 @@ -Pixz (pronounced 'pixie') is a parallel, indexing version of XZ - -Repository: https://github.com/vasi/pixz -Downloads: https://sourceforge.net/projects/pixz/files/ - - -The existing XZ Utils ( http://tukaani.org/xz/ ) provide great compression in the .xz file format, but they have two significant problems: - -* They are single-threaded, while most users nowadays have multi-core computers. -* The .xz files they produce are just one big block of compressed data, rather than a collection of smaller blocks. This makes random access to the original data impossible. - - -With pixz, both these problems are solved. The most useful commands: - -$ pixz foo.tar foo.tpxz # Compress and index a tarball, multi-core -$ pixz -l foo.tpxz # Very quickly list the contents of the compressed tarball -$ pixz -d foo.tpxz foo.tar # Decompress it, multi-core -$ pixz -x dir/file < foo.tpxz | tar x # Very quickly extract a file, multi-core. - # Also verifies that contents match index. - -$ tar -Ipixz -cf foo.tpxz foo # Create a tarball using pixz for multi-core compression - -$ pixz bar bar.xz # Compress a non-tarball, multi-core -$ pixz -d bar.xz bar # Decompress it, multi-core - - -Specifying input and output: - -$ pixz < foo.tar > foo.tpxz # Same as 'pixz foo.tar foo.tpxz' -$ pixz -i foo.tar -o foo.tpxz # Ditto. These both work for -x, -d and -l too, eg: - -$ pixz -x -i foo.tpxz -o foo.tar file1 file2 ... # Extract the files from foo.tpxz into foo.tar - -$ pixz foo.tar # Compress it to foo.tpxz, removing the original -$ pixz -d foo.tpxz # Extract it to foo.tar, removing the original - - -Other flags: - -$ pixz -1 foo.tar # Faster, worse compression -$ pixz -9 foo.tar # Better, slower compression -$ pixz -p 2 foo.tar # Cap the number of threads at 2 - -$ pixz -t foo.tar # Compress but don't treat it as a tarball (don't index it) -$ pixz -d -t foo.tpxz # Decompress foo, don't check that contents match index -$ pixz -l -t foo.tpxz # List the xz blocks instead of files - -For even more tuning flags, check the manual page. - - -Compare to: - plzip - * About equally complex, efficient - * lzip format seems less-used - * Version 1 is theoretically indexable...I think - ChopZip - * Python, much simpler - * More flexible, supports arbitrary compression programs - * Uses streams instead of blocks, not indexable - * Splits input and then combines output, much higher disk usage - pxz - * Simpler code - * Uses OpenMP instead of pthreads - * Uses streams instead of blocks, not indexable - * Uses temp files and doesn't combine them until the whole file is compressed, high disk/memory usage - -Comparable tools for other compression algorithms: - pbzip2 - * Not indexable - * Appears slow - * bzip2 algorithm is non-ideal - pigz - * Not indexable - dictzip, idzip - * Not parallel - - -Requirements: - * libarchive 2.8 or later - * liblzma 4.999.9-beta-212 or later (from the xz distribution) diff --git a/README.md b/README.md new file mode 100644 index 0000000..336db5c --- /dev/null +++ b/README.md @@ -0,0 +1,182 @@ +pixz +==== + +Pixz (pronounced *pixie*) is a parallel, indexing version of `xz`. + +Repository: https://github.com/vasi/pixz + +Downloads: https://github.com/vasi/pixz/releases + +pixz vs xz +---------- + +The existing [XZ Utils](http://tukaani.org/xz/) provide great compression in the `.xz` file format, +but they have two significant problems: + +- they are single-threaded, while most users nowadays have multi-core computers +- the `.xz` files they produce are just one big block of compressed data, rather than a collection + of smaller blocks which makes random access to the original data impossible + +With pixz, both these problems are solved. + +Building pixz +------------- + +General help about the building process's configuration step can be acquired via: + +``` +./configure --help +``` + +### Dependencies + +- pthreads +- liblzma 4.999.9-beta-212 or later (from the xz distribution) +- libarchive 2.8 or later +- AsciiDoc to generate the man page + +### Build from Release Tarball + +``` +./configure +make +make install +``` + +You many need `sudo` permissions to run `make install`. + +### Build from GitHub + +``` +git clone https://github.com/vasi/pixz.git +cd pixz +./autogen.sh +./configure +make +make install +``` + +You many need `sudo` permissions to run `make install`. + +Usage +----- + +### Single Files + +Compress a single file (no tarball, just compression), multi-core: + + pixz bar bar.xz + +Decompress it, multi-core: + + pixz -d bar.xz bar + +### Tarballs + +Compress and index a tarball, multi-core: + + pixz foo.tar foo.tpxz + +Very quickly list the contents of the compressed tarball: + + pixz -l foo.tpxz + +Decompress the tarball, multi-core: + + pixz -d foo.tpxz foo.tar + +Very quickly extract a single file, multi-core, also verifies that contents match index: + + pixz -x dir/file < foo.tpxz | tar x + +Create a tarball using pixz for multi-core compression: + + tar -Ipixz -cf foo.tpxz foo/ + +### Specifying Input and Output + +These are the same (also work for `-x`, `-d` and `-l` as well): + + pixz foo.tar foo.tpxz + pixz < foo.tar > foo.tpxz + pixz -i foo.tar -o foo.tpxz + +Extract the files from `foo.tpxz` into `foo.tar`: + + pixz -x -i foo.tpxz -o foo.tar file1 file2 ... + +Compress to `foo.tpxz`, removing the original: + + pixz foo.tar + +Extract to `foo.tar`, removing the original: + + pixz -d foo.tpxz + +### Other Flags + +Faster, worse compression: + + pixz -1 foo.tar + +Better, slower compression: + + pixz -9 foo.tar + +Use exactly 2 threads: + + pixz -p 2 foo.tar + +Compress, but do not treat it as a tarball, i.e. do not index it: + + pixz -t foo.tar + +Decompress, but do not check that contents match index: + + pixz -d -t foo.tpxz + +List the xz blocks instead of files: + + pixz -l -t foo.tpxz + +For even more tuning flags, check the manual page: + + man pixz + +Comparison to other Tools +------------------------- + +### plzip + +- about equally complex and efficient +- lzip format seems less-used +- version 1 is theoretically indexable, I think + +### ChopZip + +- written in Python, much simpler +- more flexible, supports arbitrary compression programs +- uses streams instead of blocks, not indexable +- splits input and then combines output, much higher disk usage + +### pxz + +- simpler code +- uses OpenMP instead of pthreads +- uses streams instead of blocks, not indexable +- uses temporary files and does not combine them until the whole file is compressed, high disk and + memory usage + +### pbzip2 + +- not indexable +- appears slow +- bzip2 algorithm is non-ideal + +### pigz + +- not indexable + +### dictzip, idzip + +- not parallel