aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2022-05-16 19:03:50 -0700
committerKaz Kylheku <kaz@kylheku.com>2022-05-16 19:03:50 -0700
commit71bbfa562d0299f443381dce206dd5662ffea744 (patch)
tree7525b34046acba87fb43a0832a746719628dc927
parent46c52e5e2f70749803b2a3906e2da1d6d0b1fdf8 (diff)
downloadpw-71bbfa562d0299f443381dce206dd5662ffea744.tar.gz
pw-71bbfa562d0299f443381dce206dd5662ffea744.tar.bz2
pw-71bbfa562d0299f443381dce206dd5662ffea744.zip
Start release notes, as a man page.
-rw-r--r--Makefile15
-rw-r--r--pw-relnotes.546
-rw-r--r--pw.13
3 files changed, 59 insertions, 5 deletions
diff --git a/Makefile b/Makefile
index 2050b94..001aae1 100644
--- a/Makefile
+++ b/Makefile
@@ -9,10 +9,15 @@ endif
CFLAGS ?= -g -O2 -W -Wall
override CFLAGS += $(NEEDED_CFLAGS) -DCONFIG_PW_VER=\"$(PW_VERSION)\"
DESTDIR ?= /usr/local
-.PHONY: all pw.1
-all: pw pw.1
+.PHONY: all fixver
+all: pw fixver
pw:
clean:; rm -f pw
-install:; install pw $(DESTDIR)/bin/pw; install pw.1 $(DESTDIR)/share/man/man1
-pw.1:; @sed -e '/^\.TH/s/Version [^"]\+/Version $(PW_VERSION)/' pw.1 > pw.tmp
- cmp -s pw.1 pw.tmp && rm pw.tmp || mv pw.tmp pw.1
+install:; install pw $(DESTDIR)/bin/pw; \
+ install pw.1 $(DESTDIR)/share/man/man1 \
+ install pw-relnotes.5 $(DESTDIR)/share/man/man5
+define FIXVER
+sed -e '/^\.TH/s/Version [^"]\+/Version $(PW_VERSION)/' $1 > pw.tmp ;
+cmp -s $1 pw.tmp && rm pw.tmp || mv pw.tmp $1
+endef
+fixver:; @$(call FIXVER,pw.1); $(call FIXVER, pw-relnotes.5)
diff --git a/pw-relnotes.5 b/pw-relnotes.5
new file mode 100644
index 0000000..ff858c3
--- /dev/null
+++ b/pw-relnotes.5
@@ -0,0 +1,46 @@
+.\" Pipe Watch ("pw")
+.\" Copyright 2022 Kaz Kylheku <kaz@kylheku.com>
+.\"
+.\" BSD-2 License
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright notice,
+.\" this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright notice,
+.\" this list of conditions and the following disclaimer in the documentation
+.\" and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.TH PW-RELNOTES 5 "16 May 2022" "Version 1" "Pipe Watch Release Notes"
+
+.SH DESCRIPTION
+This document provides release notes for the
+.I pw
+utility.
+
+.SH CHANGES IN VERSION 2
+
+.IP 1.
+The original
+.B :s
+command for saving settings was renamed to
+.B :sa
+
+.SH AUTHOR
+Kaz Kylheku <kaz@kylheku.com>
+
+.SH COPYRIGHT
+Copyright 2022, BSD2 License.
diff --git a/pw.1 b/pw.1
index c773b1c..bf9bc0c 100644
--- a/pw.1
+++ b/pw.1
@@ -1132,6 +1132,9 @@ It doesn't track insertions or deletions of characters; If 999 changes to 1000,
the rest of the line will be be different, except for characters that are still
the same by coincidence.
+.SH SEE ALSO
+.IR pw-relnotes ( 5 )
+
.SH AUTHOR
Kaz Kylheku <kaz@kylheku.com>