From 490f652974171aeed24f859eb5ecf850dcb42f1c Mon Sep 17 00:00:00 2001 From: Sam Russell Date: Mon, 15 Oct 2018 22:20:10 +1300 Subject: [PATCH] Add man pages for zstdgrep and zstdless --- build/cmake/programs/CMakeLists.txt | 8 ++++++++ programs/Makefile | 16 +++++++++++++++- programs/zstdgrep.1 | 23 +++++++++++++++++++++++ programs/zstdgrep.1.md | 26 ++++++++++++++++++++++++++ programs/zstdless.1 | 14 ++++++++++++++ programs/zstdless.1.md | 16 ++++++++++++++++ 6 files changed, 102 insertions(+), 1 deletion(-) create mode 100644 programs/zstdgrep.1 create mode 100644 programs/zstdgrep.1.md create mode 100644 programs/zstdless.1 create mode 100644 programs/zstdless.1.md diff --git a/build/cmake/programs/CMakeLists.txt b/build/cmake/programs/CMakeLists.txt index 221c24811..7c01b4c5b 100644 --- a/build/cmake/programs/CMakeLists.txt +++ b/build/cmake/programs/CMakeLists.txt @@ -43,6 +43,12 @@ IF (UNIX) ADD_CUSTOM_TARGET(zstd.1 ALL ${CMAKE_COMMAND} -E copy ${PROGRAMS_DIR}/zstd.1 . COMMENT "Copying manpage zstd.1") + ADD_CUSTOM_TARGET(zstdgrep.1 ALL + ${CMAKE_COMMAND} -E copy ${PROGRAMS_DIR}/zstdgrep.1 . + COMMENT "Copying manpage zstdgrep.1") + ADD_CUSTOM_TARGET(zstdless.1 ALL + ${CMAKE_COMMAND} -E copy ${PROGRAMS_DIR}/zstdless.1 . + COMMENT "Copying manpage zstdless.1") ADD_CUSTOM_TARGET(zstdcat.1 ALL ${CMAKE_COMMAND} -E create_symlink zstd.1 zstdcat.1 DEPENDS zstd.1 COMMENT "Creating zstdcat.1 symlink") ADD_CUSTOM_TARGET(unzstd.1 ALL ${CMAKE_COMMAND} -E create_symlink zstd.1 unzstd.1 DEPENDS zstd.1 COMMENT "Creating unzstd.1 symlink") @@ -55,6 +61,8 @@ IF (UNIX) INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/zstd.1 DESTINATION "${MAN_INSTALL_DIR}") INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/zstdcat.1 DESTINATION "${MAN_INSTALL_DIR}") INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/unzstd.1 DESTINATION "${MAN_INSTALL_DIR}") + INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/zstdgrep.1 DESTINATION "${MAN_INSTALL_DIR}") + INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/zstdless.1 DESTINATION "${MAN_INSTALL_DIR}") ADD_EXECUTABLE(zstd-frugal ${PROGRAMS_DIR}/zstdcli.c ${PROGRAMS_DIR}/fileio.c) TARGET_LINK_LIBRARIES(zstd-frugal libzstd_static) diff --git a/programs/Makefile b/programs/Makefile index ac17caee8..32dbc67ef 100644 --- a/programs/Makefile +++ b/programs/Makefile @@ -249,16 +249,26 @@ MD2ROFF_FLAGS = --roff --warnings --manual="User Commands" --organization="zstd zstd.1: zstd.1.md ../lib/zstd.h cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ +zstdgrep.1: zstdgrep.1.md ../lib/zstd.h + cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ + +zstdless.1: zstdless.1.md ../lib/zstd.h + cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ + .PHONY: man -man: zstd.1 +man: zstd.1 zstdgrep.1 zstdless.1 .PHONY: clean-man clean-man: rm zstd.1 + rm zstdgrep.1 + rm zstdless.1 .PHONY: preview-man preview-man: clean-man man man ./zstd.1 + man ./zstdgrep.1 + man ./zstdless.1 #----------------------------------------------------------------------------- # make install is validated only for Linux, macOS, BSD, Hurd and Solaris targets @@ -332,6 +342,8 @@ install: zstd @$(INSTALL_MAN) zstd.1 $(DESTDIR)$(MAN1DIR)/zstd.1 @ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/zstdcat.1 @ln -sf zstd.1 $(DESTDIR)$(MAN1DIR)/unzstd.1 + @$(INSTALL_MAN) zstdgrep.1 $(DESTDIR)$(MAN1DIR)/zstdgrep.1 + @$(INSTALL_MAN) zstdless.1 $(DESTDIR)$(MAN1DIR)/zstdless.1 @echo zstd installation completed .PHONY: uninstall @@ -341,6 +353,8 @@ uninstall: @$(RM) $(DESTDIR)$(BINDIR)/zstdcat @$(RM) $(DESTDIR)$(BINDIR)/unzstd @$(RM) $(DESTDIR)$(BINDIR)/zstd + @$(RM) $(DESTDIR)$(MAN1DIR)/zstdless.1 + @$(RM) $(DESTDIR)$(MAN1DIR)/zstdgrep.1 @$(RM) $(DESTDIR)$(MAN1DIR)/zstdcat.1 @$(RM) $(DESTDIR)$(MAN1DIR)/unzstd.1 @$(RM) $(DESTDIR)$(MAN1DIR)/zstd.1 diff --git a/programs/zstdgrep.1 b/programs/zstdgrep.1 new file mode 100644 index 000000000..3db9f1cce --- /dev/null +++ b/programs/zstdgrep.1 @@ -0,0 +1,23 @@ +. +.TH "ZSTDGREP" "1" "October 2018" "zstd 1.3.7" "User Commands" +. +.SH "NAME" +\fBzstdgrep\fR \- print lines matching a pattern in zstandard\-compressed files +. +.SH "SYNOPSIS" +\fBzgrep\fR [\fIgrep\-flags\fR] [\-\-] \fIpattern\fR [\fIfiles\fR \.\.\.] +. +.SH "DESCRIPTION" +\fBzgrep\fR runs \fBgrep (1)\fR on files or stdin, if no files argument is given, after decompressing them with \fBzstdcat (1)\fR\. +. +.P +The grep\-flags and pattern arguments are passed on to \fBgrep (1)\fR\. If an \fB\-e\fR flag is found in the \fBgrep\-flags\fR, \fBzgrep\fR will not look for a pattern argument\. +. +.SH "EXIT STATUS" +In case of missing arguments or missing pattern, 1 will be returned, otherwise 0\. +. +.SH "SEE ALSO" +\fBzstd (1)\fR +. +.SH "AUTHORS" +Thomas Klausner \fIwiz@NetBSD\.org\fR diff --git a/programs/zstdgrep.1.md b/programs/zstdgrep.1.md new file mode 100644 index 000000000..0ddb0c066 --- /dev/null +++ b/programs/zstdgrep.1.md @@ -0,0 +1,26 @@ +zstdgrep(1) -- print lines matching a pattern in zstandard-compressed files +============================================================================ + +SYNOPSIS +-------- + +`zgrep` [*grep-flags*] [--] _pattern_ [_files_ ...] + + +DESCRIPTION +----------- +`zgrep` runs `grep (1)` on files or stdin, if no files argument is given, after decompressing them with `zstdcat (1)`. + +The grep-flags and pattern arguments are passed on to `grep (1)`. If an `-e` flag is found in the `grep-flags`, `zgrep` will not look for a pattern argument. + +EXIT STATUS +----------- +In case of missing arguments or missing pattern, 1 will be returned, otherwise 0. + +SEE ALSO +-------- +`zstd (1)` + +AUTHORS +------- +Thomas Klausner diff --git a/programs/zstdless.1 b/programs/zstdless.1 new file mode 100644 index 000000000..bb7c31fef --- /dev/null +++ b/programs/zstdless.1 @@ -0,0 +1,14 @@ +. +.TH "ZSTDLESS" "1" "October 2018" "zstd 1.3.7" "User Commands" +. +.SH "NAME" +\fBzstdless\fR \- view zstandard\-compressed files +. +.SH "SYNOPSIS" +\fBzless\fR [\fIflags\fR] [\fIfile\fR \.\.\.] +. +.SH "DESCRIPTION" +\fBzstdless\fR runs \fBless (1)\fR on files or stdin, if no files argument is given, after decompressing them with \fBzstdcat (1)\fR\. +. +.SH "SEE ALSO" +\fBzstd (1)\fR diff --git a/programs/zstdless.1.md b/programs/zstdless.1.md new file mode 100644 index 000000000..8b9a647d0 --- /dev/null +++ b/programs/zstdless.1.md @@ -0,0 +1,16 @@ +zstdless(1) -- view zstandard-compressed files +============================================================================ + +SYNOPSIS +-------- + +`zless` [*flags*] [_file_ ...] + + +DESCRIPTION +----------- +`zstdless` runs `less (1)` on files or stdin, if no files argument is given, after decompressing them with `zstdcat (1)`. + +SEE ALSO +-------- +`zstd (1)`