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

add arguments to retro(1) man page

Browse source 
FossilOrigin-Name: b3f66347a20e91f11197cc31c50ebaf26e1d5c2d51d7323697ba1ff5a8b62d4b
This commit is contained in:
crc 2019-01-22 18:05:02 +00:00
parent 26bee34006
commit ec276f67d0
2 changed files with 28 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Makefile
View file

@ -2,6 +2,7 @@ PREFIX ?= /usr/local
DATADIR ?= $(PREFIX)/share/RETRO12 DATADIR ?= $(PREFIX)/share/RETRO12
DOCSDIR ?= $(PREFIX)/share/doc/RETRO12 DOCSDIR ?= $(PREFIX)/share/doc/RETRO12
EXAMPLESDIR ?= $(PREFIX)/share/examples/RETRO12 EXAMPLESDIR ?= $(PREFIX)/share/examples/RETRO12
MANDIR ?= $(PREFIX)/man/man1
LIBM ?= -lm LIBM ?= -lm
LIBCURSES ?= -lcurses LIBCURSES ?= -lcurses
@ -19,7 +20,7 @@ clean:
rm -f bin/* rm -f bin/*
find . -name "*.o" -type f -delete find . -name "*.o" -type f -delete
install: build install-data install-docs install-examples install: build install-data install-docs install-examples install-manpages
install -m 755 -d -- $(DESTDIR)$(PREFIX)/bin install -m 755 -d -- $(DESTDIR)$(PREFIX)/bin
install -c -m 755 bin/retro-embedimage $(DESTDIR)$(PREFIX)/bin/retro-embedimage install -c -m 755 bin/retro-embedimage $(DESTDIR)$(PREFIX)/bin/retro-embedimage
install -c -m 755 bin/retro-extend $(DESTDIR)$(PREFIX)/bin/retro-extend install -c -m 755 bin/retro-extend $(DESTDIR)$(PREFIX)/bin/retro-extend
@ -60,6 +61,13 @@ install-examples:
install -m 755 -d -- $(DESTDIR)$(EXAMPLESDIR) install -m 755 -d -- $(DESTDIR)$(EXAMPLESDIR)
cp -fpR example $(DESTDIR)$(EXAMPLESDIR) cp -fpR example $(DESTDIR)$(EXAMPLESDIR)
install-manpages:
install -c -m 644 man/retro.1 $(MANDIR)/retro.1
install -c -m 644 man/retro-ri.1 $(MANDIR)/retro-ri.1
install -c -m 644 man/retro-unu.1 $(MANDIR)/retro-unu.1
install -c -m 644 man/retro-muri.1 $(MANDIR)/retro-muri.1
test: bin/retro test: bin/retro
./bin/retro tests/test-core.forth ./bin/retro tests/test-core.forth

26
man/retro.1
View file

@ -6,15 +6,27 @@
.Nd "a modern, pragmatic forth development system" .Nd "a modern, pragmatic forth development system"
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
[options] .Op Fl h
.Op Fl i
.Op Fl t
.Op Fl f Ar filename
.Op Fl u Ar filename
.Op Ar filename Ar script-args
.Sh DESCRIPTION .Sh DESCRIPTION
RETRO is a modern, pragmatic Forth drawing influences from many RETRO is a modern, pragmatic Forth drawing influences from many sources.
sources. It's clean, elegant, tiny, and easy to grasp and adapt It's clean, elegant, tiny, and easy to grasp and adapt to various uses.
to various uses.
.Nm .Nm
is the main interface for interacting with is the main interface for interacting with Retro. It provides both
Retro. It provides both an interactive and a an interactive and a scripting model.
scripting model. .Sh OPTIONS
.Bl -tag -width -indent
.It Fl h Display a help screen
.It Fl i Start Retro in interactive mode
.It Fl t Run any test blocks in the loaded files
.It Fl f Ar filename Run any code blocks in the specified file
.It Fl u Ar filename Load and use the specified image file rather than the integral one
.It filename script-args Run code blocks in a single file. Pass script-args to the code being run.
.El
.Sh AUTHORS .Sh AUTHORS
.An Charles Childers Aq Mt crc@forthworks.com .An Charles Childers Aq Mt crc@forthworks.com