summaryrefslogtreecommitdiffstats
path: root/programs
diff options
context:
space:
mode:
authorYann Collet <yann.collet.73@gmail.com>2014-04-15 14:47:48 (GMT)
committerYann Collet <yann.collet.73@gmail.com>2014-04-15 14:47:48 (GMT)
commit5b91330ce272fe39ea3b88b197e943be6a1bc490 (patch)
tree6d7731a149db2251b38b2966d6fbc18f5ec4d927 /programs
parent374d6ac35cf784481d60634e9b8e6ca8be7c9302 (diff)
downloadlz4-5b91330ce272fe39ea3b88b197e943be6a1bc490.zip
lz4-5b91330ce272fe39ea3b88b197e943be6a1bc490.tar.gz
lz4-5b91330ce272fe39ea3b88b197e943be6a1bc490.tar.bz2
Added lz4c & lz4cat man pages
Diffstat (limited to 'programs')
-rw-r--r--programs/Makefile4
-rw-r--r--programs/lz4c.133
-rw-r--r--programs/lz4cat.134
3 files changed, 71 insertions, 0 deletions
diff --git a/programs/Makefile b/programs/Makefile
index fc42ac0..a1814b6 100644
--- a/programs/Makefile
+++ b/programs/Makefile
@@ -85,11 +85,15 @@ clean:
ifneq (,$(filter $(shell uname),Linux Darwin))
install: lz4 lz4c
+ @echo Installing binaries
@install -d -m 755 $(DESTDIR)$(BINDIR)/ $(DESTDIR)$(MANDIR)/
@install -m 755 lz4 $(DESTDIR)$(BINDIR)/lz4
@ln -sf lz4 $(DESTDIR)$(BINDIR)/lz4cat
@install -m 755 lz4c $(DESTDIR)$(BINDIR)/lz4c
+ @echo Installing man pages
@install -m 644 lz4.1 $(DESTDIR)$(MANDIR)/lz4.1
+ @install -m 644 lz4c.1 $(DESTDIR)$(MANDIR)/lz4c.1
+ @install -m 644 lz4cat.1 $(DESTDIR)$(MANDIR)/lz4cat.1
@echo lz4 installation completed
uninstall:
diff --git a/programs/lz4c.1 b/programs/lz4c.1
new file mode 100644
index 0000000..fed6c8b
--- /dev/null
+++ b/programs/lz4c.1
@@ -0,0 +1,33 @@
+\"
+\" lz4c.1: This is a manual page for 'lz4c' program. This file is part of the
+\" lz4 <https://code.google.com/p/lz4/> project.
+\"
+
+\" No hyphenation
+.hy 0
+.nr HY 0
+
+.TH lz4c "1" "2014-04-15" "lz4c" "User Commands"
+.SH NAME
+\fBlz4\fR - Extremely fast compression algorithm
+
+.SH SYNOPSIS
+.TP 5
+\fBlz4c\fR [\fBOPTIONS\fR] [-|INPUT-FILE] <OUTPUT-FILE>
+
+.SH DESCRIPTION
+.PP
+\fBlz4c\fR is the legacy version of \fBlz4\fR.
+As such, it supports older supplementary legacy commands.
+\fBlz4c\fR is now deprecated.
+It is recommended to use \fBlz4\fR instead whenever possible.
+
+To get a list of commands specific to lz4c, do :
+lz4c -h
+
+
+.SH BUGS
+Report bugs at:- https://code.google.com/p/lz4/
+
+.SH AUTHOR
+Yann Collet \ No newline at end of file
diff --git a/programs/lz4cat.1 b/programs/lz4cat.1
new file mode 100644
index 0000000..fb33fd5
--- /dev/null
+++ b/programs/lz4cat.1
@@ -0,0 +1,34 @@
+\"
+\" lz4cat.1: This is a manual page for 'lz4cat' program. This file is part of
+\" the lz4 <https://code.google.com/p/lz4/> project.
+\"
+
+\" No hyphenation
+.hy 0
+.nr HY 0
+
+.TH lz4cat "1" "2014-04-15" "lz4cat" "User Commands"
+.SH NAME
+\fBlz4cat\fR - Extremely fast compression algorithm
+
+.SH SYNOPSIS
+.TP 5
+\fBlz4cat\fR [\fBOPTIONS\fR] [-|INPUT-FILE] <OUTPUT-FILE>
+
+.SH DESCRIPTION
+.PP
+\fBlz4\fR is an extremely fast lossless compression algorithm.
+
+\fBlz4cat\fR is an utility based on \fBlz4\fR.
+
+\fBlz4cat\fR is equivalent to \fBlz4 -cd\fR,
+which forces decompression and redirect its output to the console.
+
+All other options are the same as \fBlz4\fR ones (man lz4).
+
+
+.SH BUGS
+Report bugs at:- https://code.google.com/p/lz4/
+
+.SH AUTHOR
+Yann Collet \ No newline at end of file