From ec276f67d00e03cd5a8905c8db074359d5cf4717 Mon Sep 17 00:00:00 2001 From: crc Date: Tue, 22 Jan 2019 18:05:02 +0000 Subject: [PATCH] add arguments to retro(1) man page FossilOrigin-Name: b3f66347a20e91f11197cc31c50ebaf26e1d5c2d51d7323697ba1ff5a8b62d4b --- Makefile | 10 +++++++++- man/retro.1 | 26 +++++++++++++++++++------- 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index 83c9691..a886d8e 100644 --- a/Makefile +++ b/Makefile @@ -2,6 +2,7 @@ PREFIX ?= /usr/local DATADIR ?= $(PREFIX)/share/RETRO12 DOCSDIR ?= $(PREFIX)/share/doc/RETRO12 EXAMPLESDIR ?= $(PREFIX)/share/examples/RETRO12 +MANDIR ?= $(PREFIX)/man/man1 LIBM ?= -lm LIBCURSES ?= -lcurses @@ -19,7 +20,7 @@ clean: rm -f bin/* 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 -c -m 755 bin/retro-embedimage $(DESTDIR)$(PREFIX)/bin/retro-embedimage install -c -m 755 bin/retro-extend $(DESTDIR)$(PREFIX)/bin/retro-extend @@ -60,6 +61,13 @@ install-examples: install -m 755 -d -- $(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 ./bin/retro tests/test-core.forth diff --git a/man/retro.1 b/man/retro.1 index 5b0cecd..4d4ebcd 100644 --- a/man/retro.1 +++ b/man/retro.1 @@ -6,15 +6,27 @@ .Nd "a modern, pragmatic forth development system" .Sh SYNOPSIS .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 -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. +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 the main interface for interacting with -Retro. It provides both an interactive and a -scripting model. +is the main interface for interacting with Retro. It provides both +an interactive and a 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 .An Charles Childers Aq Mt crc@forthworks.com