crc/retroforth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add man page for retro-document

Browse source 
FossilOrigin-Name: 72688845f86225df8e1a1082bd568b4029b17c713ed93941131c0dbd0d18ec09
This commit is contained in:
crc 2019-05-10 13:14:17 +00:00
parent 310fca3d65
commit 7d9bcbb7e1
4 changed files with 29 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Makefile
View file

@ -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-muri $(DESTDIR)$(PREFIX)/bin/retro-muri
install -c -m 755 -s bin/retro $(DESTDIR)$(PREFIX)/bin/retro 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 -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-data:
install -m 755 -d -- $(DESTDIR)$(DATADIR) 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-embedimage.1 $(MANDIR)/retro-embedimage.1
install -c -m 644 man/retro-extend.1 $(MANDIR)/retro-extend.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-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-muri.1 $(MANDIR)/retro-muri.1
install -c -m 644 man/retro-unu.1 $(MANDIR)/retro-unu.1 install -c -m 644 man/retro-unu.1 $(MANDIR)/retro-unu.1

4
RELEASE_NOTES.md
View file

@ -26,6 +26,7 @@ July - September window for this release.
- merged BSD, Linux, macOS build instructions - merged BSD, Linux, macOS build instructions
- updated Starting instructions - updated Starting instructions
- added implementation notes on arrays
## Examples ## Examples
@ -36,6 +37,7 @@ July - September window for this release.
- add sqlite3 wrapper - add sqlite3 wrapper
- corrected an issue in mail.forth - corrected an issue in mail.forth
- cleanup publish-examples.forth - cleanup publish-examples.forth
- publish-examples.forth now uses `retro-document` to generate glossaries
## General ## General
@ -48,3 +50,5 @@ July - September window for this release.
## Interfaces ## Interfaces
- retro-compiler: runtime now supports scripting arguments - retro-compiler: runtime now supports scripting arguments
- retro-unix: replaces earlier rre.c
- retro-windows: rre, adapted for windows

4
man/retro-describe.1
View file

@ -1,4 +1,4 @@
.Dd March 2019 .Dd May 2019
.Dt RETRO-DESCRIBE 1 .Dt RETRO-DESCRIBE 1
.Os .Os
.Sh RETRO-DESCRIBE .Sh RETRO-DESCRIBE
@ -13,7 +13,7 @@ sources. It's clean, elegant, tiny, and easy to grasp and adapt
to various uses. to various uses.
.Nm .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 words in the core language and extensions. It will write output
to stdout. to stdout.
.Sh AUTHORS .Sh AUTHORS

20
man/retro-document.1 Normal file
View file

@ -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