From 7d9bcbb7e15a20411bd58e38a252736e13a1ed98 Mon Sep 17 00:00:00 2001 From: crc Date: Fri, 10 May 2019 13:14:17 +0000 Subject: [PATCH] add man page for retro-document FossilOrigin-Name: 72688845f86225df8e1a1082bd568b4029b17c713ed93941131c0dbd0d18ec09 --- Makefile | 3 +++ RELEASE_NOTES.md | 4 ++++ man/retro-describe.1 | 4 ++-- man/retro-document.1 | 20 ++++++++++++++++++++ 4 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 man/retro-document.1 diff --git a/Makefile b/Makefile index a14efbd..5842f84 100644 --- a/Makefile +++ b/Makefile @@ -40,6 +40,8 @@ install-strip: build install-data install-docs install-examples install -c -m 755 -s bin/retro-muri $(DESTDIR)$(PREFIX)/bin/retro-muri install -c -m 755 -s bin/retro $(DESTDIR)$(PREFIX)/bin/retro install -c -m 755 -s bin/retro-unu $(DESTDIR)$(PREFIX)/bin/retro-unu + install -c -m 755 bin/retro-describe $(DESTDIR)$(PREFIX)/bin/retro-describe + install -c -m 755 bin/retro-document $(DESTDIR)$(PREFIX)/bin/retro-document install-data: install -m 755 -d -- $(DESTDIR)$(DATADIR) @@ -64,6 +66,7 @@ install-manpages: install -c -m 644 man/retro-embedimage.1 $(MANDIR)/retro-embedimage.1 install -c -m 644 man/retro-extend.1 $(MANDIR)/retro-extend.1 install -c -m 644 man/retro-describe.1 $(MANDIR)/retro-describe.1 + install -c -m 644 man/retro-document.1 $(MANDIR)/retro-document.1 install -c -m 644 man/retro-muri.1 $(MANDIR)/retro-muri.1 install -c -m 644 man/retro-unu.1 $(MANDIR)/retro-unu.1 diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index b5b8d85..8e085de 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -26,6 +26,7 @@ July - September window for this release. - merged BSD, Linux, macOS build instructions - updated Starting instructions +- added implementation notes on arrays ## Examples @@ -36,6 +37,7 @@ July - September window for this release. - add sqlite3 wrapper - corrected an issue in mail.forth - cleanup publish-examples.forth +- publish-examples.forth now uses `retro-document` to generate glossaries ## General @@ -48,3 +50,5 @@ July - September window for this release. ## Interfaces - retro-compiler: runtime now supports scripting arguments +- retro-unix: replaces earlier rre.c +- retro-windows: rre, adapted for windows diff --git a/man/retro-describe.1 b/man/retro-describe.1 index 9940682..73a816d 100644 --- a/man/retro-describe.1 +++ b/man/retro-describe.1 @@ -1,4 +1,4 @@ -.Dd March 2019 +.Dd May 2019 .Dt RETRO-DESCRIBE 1 .Os .Sh RETRO-DESCRIBE @@ -13,7 +13,7 @@ sources. It's clean, elegant, tiny, and easy to grasp and adapt to various uses. .Nm -is a tool for looking the description and stack comments for +is a tool for looking up the description and stack comments for words in the core language and extensions. It will write output to stdout. .Sh AUTHORS diff --git a/man/retro-document.1 b/man/retro-document.1 new file mode 100644 index 0000000..d330cc2 --- /dev/null +++ b/man/retro-document.1 @@ -0,0 +1,20 @@ +.Dd May 2019 +.Dt RETRO-DOCUMENT 1 +.Os +.Sh RETRO-DOCUMENT +.Nm retro-document +.Nd "a modern, pragmatic forth development system" +.Sh SYNOPSIS +.Nm +filename +.Sh DESCRIPTION +RETRO is a modern, pragmatic Forth drawing influences from many +sources. It's clean, elegant, tiny, and easy to grasp and adapt +to various uses. + +.Nm +is a tool for generating a listing of the descriptions and stack +comments for all standard word used in a source file. It will +write output to stdout. +.Sh AUTHORS +.An Charles Childers Aq Mt crc@forthworks.com