mirror of
https://github.com/GnoConsortium/gno.git
synced 2024-06-03 04:29:35 +00:00
Added documentation, make 'help' explicitly a gsh script.
This commit is contained in:
parent
e7015008c4
commit
0a72bc2794
21
usr.bin/help/Makefile
Normal file
21
usr.bin/help/Makefile
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
#
|
||||||
|
# $Id: Makefile,v 1.1 1997/10/30 03:51:55 gdr Exp $
|
||||||
|
#
|
||||||
|
|
||||||
|
PROG = help
|
||||||
|
|
||||||
|
.INCLUDE: /src/gno/paths.mk
|
||||||
|
.INCLUDE: /src/gno/binconst.mk
|
||||||
|
|
||||||
|
BINDIR = /usr/bin
|
||||||
|
MANDIR = /usr/man
|
||||||
|
RELBIN = $(RELEASE_DIR)$(BINDIR)
|
||||||
|
RELMAN = $(RELEASE_DIR)$(MANDIR)
|
||||||
|
|
||||||
|
build: $(PROG)
|
||||||
|
|
||||||
|
$(PROG): help.gsh $(PROG).r
|
||||||
|
$(INSTALL) -m755 help.gsh $@
|
||||||
|
$(CATREZ) -d $@ $(PROG).r
|
||||||
|
|
||||||
|
.INCLUDE: /src/gno/binrelease.mk
|
49
usr.bin/help/help.1
Normal file
49
usr.bin/help/help.1
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
.\"
|
||||||
|
.\" $Id: help.1,v 1.1 1997/10/30 03:51:56 gdr Exp $
|
||||||
|
.\"
|
||||||
|
.TH HELP 1 "19 October 1997" GNO "Commands and Applications"
|
||||||
|
.SH NAME
|
||||||
|
.BR help
|
||||||
|
\- print ORCA help file
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.BR help
|
||||||
|
.I program_name
|
||||||
|
.SH DESCRIPTION
|
||||||
|
The ORCA/Shell expects all of its utilities to be in the
|
||||||
|
directory specified by GS/OS prefix
|
||||||
|
.BR 17 .
|
||||||
|
The brief descriptions
|
||||||
|
for these utilities (and for built-in commands) are kept in the
|
||||||
|
directory
|
||||||
|
.BR 17/help ,
|
||||||
|
and are printed, under the ORCA/Shell, by the built-in command
|
||||||
|
.BR help .
|
||||||
|
.LP
|
||||||
|
Because this shell built-in is not available under GNO, the
|
||||||
|
.BR help
|
||||||
|
program is used to access these description files. It is invoked in
|
||||||
|
the same manner as under ORCA/Shell, but also provides pagination.
|
||||||
|
.SH BUGS
|
||||||
|
The GNO implementation of
|
||||||
|
.BR help
|
||||||
|
will only accept one
|
||||||
|
.IR program_name .
|
||||||
|
.LP
|
||||||
|
.BR help
|
||||||
|
is currently implemented as a very dumb
|
||||||
|
.BR gsh (1)
|
||||||
|
script. When
|
||||||
|
.BR sh (1)
|
||||||
|
becomes available,
|
||||||
|
.BR help
|
||||||
|
should be updated to accept multiple file names, recognise the
|
||||||
|
.BR PAGER
|
||||||
|
environment variable, and give cleaner diagnostics when
|
||||||
|
.IR program_name
|
||||||
|
does not have a description file in
|
||||||
|
.BR 17/help .
|
||||||
|
.SH HISTORY
|
||||||
|
The
|
||||||
|
.BR help
|
||||||
|
program appeared in GNO v1.0 as an emulation of the ORCA/Shell built-in
|
||||||
|
command.
|
9
usr.bin/help/help.desc
Normal file
9
usr.bin/help/help.desc
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
Name: help
|
||||||
|
Version: 1.1 (19 Oct 97)
|
||||||
|
Shell: GNO
|
||||||
|
Author: Devin Reade.
|
||||||
|
Contact: gdr@eddore.myrias.com
|
||||||
|
Where: /usr/bin
|
||||||
|
FTP: ground.isca.uiowa.edu apple2.caltech.edu trenco.myrias.com
|
||||||
|
|
||||||
|
Prints out the help file for an ORCA utility, with pagination.
|
|
@ -1,6 +1,6 @@
|
||||||
#! /bin/gsh
|
#! /bin/gsh
|
||||||
#
|
#
|
||||||
# $Id: help,v 1.1 1997/08/02 20:49:21 gdr Exp $
|
# $Id: help.gsh,v 1.1 1997/10/30 03:51:56 gdr Exp $
|
||||||
#
|
#
|
||||||
# When it becomes available, /bin/sh should be used for this and
|
# When it becomes available, /bin/sh should be used for this and
|
||||||
# it should be made a bit "smarter", such as using $PAGER if it is
|
# it should be made a bit "smarter", such as using $PAGER if it is
|
16
usr.bin/help/help.rez
Normal file
16
usr.bin/help/help.rez
Normal file
|
@ -0,0 +1,16 @@
|
||||||
|
/*
|
||||||
|
* $Id: help.rez,v 1.1 1997/10/30 03:51:56 gdr Exp $
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "Types.Rez"
|
||||||
|
|
||||||
|
resource rVersion (0x1, purgeable3, nocrossbank) {
|
||||||
|
|
||||||
|
{ 1, 1, 0, /* version 1.1.0 */
|
||||||
|
release, /* development|alpha|beta|final|release */
|
||||||
|
0 /* non-final release number */
|
||||||
|
},
|
||||||
|
verUS,
|
||||||
|
"help",
|
||||||
|
"Print the help file for an ORCA utility"
|
||||||
|
};
|
Loading…
Reference in New Issue
Block a user