v1.0.5 January 1998

Increased the number of characters in the name field of the
		nameEntry struct from 34 to 36.  This gives an 8-byte
		alignment to the offset entry, which provides binary
		compatibility of the precompiled database file between
		the IIgs and little-endian 32-bit machines such as
		Linux boxes.

		*** THIS MEANS THAT THE PRECOMPILED DATABASE IS NO LONGER
		    BINARY COMPATIBLE WITH EARLIER VERSIONS.

	Updated descu so that the "Last Updated" line in the describe
		source "header" is updated to reflect the current date
		and time (GMT, if supported).
	Fixed a bug in descu that caused the "header" to be slowly eaten,
		one character at a time.
	The describe database source file is no longer part of this
		archive.  It is available separately from the url,
		above.
	Added a "Known Bugs" section and URLs on where to find the
		online database to this README.  Modified the installation
		instructions a bit.
This commit is contained in:
gdr 1998-01-17 07:20:07 +00:00
parent be853ae490
commit 51b2bbcf92
11 changed files with 95 additions and 1091 deletions

View File

@ -1,4 +1,4 @@
$Id: README,v 1.6 1997/12/22 00:34:51 gdr Exp $
$Id: README,v 1.7 1998/01/17 07:20:06 gdr Exp $
This is the README file for the describe package. This package is
designated as version 1.0.5, and consists of the following utilities:
@ -10,6 +10,11 @@ designated as version 1.0.5, and consists of the following utilities:
descu - the describe source updater
** NOTE ** The describe database itself is now shipped as a
separate file. You can find the most recent version
of the database at the URLs mentioned in the installation
section.
ABOUT DESCRIBE AND DESCC
========================
@ -75,29 +80,79 @@ You can either type "dmake install", or do the following:
rm /usr/local/bin/descc
rm /usr/local/bin/describe
You will also want to do the following, which is NOT done by dmake's
install target:
After you have done this, type the command
rehash
/usr/sbin/descc ./describe.src
so that gsh will be able to locate the new utilities.
Note that the describe database source file (describe.src) included in
this archive is almost certainly out-of-date. The most recent version
of this file can be obtained online at:
Next, you will need a current copy of the describe database. As of
version 1.0.5, the database is no longer included with the describe
sources. Instead, you can get it from one of the following URLs:
ftp://ftp.gno.org/pub/apple2/gs.specific/gno/doc/desc.src.shk
ftp://ftp.gno.org/pub/apple2/gs.specific/gno/doc/desc.db.shk
http://www.gno/org/~gno/describe
http://www.arrowweb.com/sbehrens/describe.htm
If the above url is unreachable, check the GNO FAQ for a new location.
The desc.src.shk file contains the describe database "source" file.
The desc.db.shk file contains a "precompiled" database.
If you downloaded the precompiled database archive, then you can extract
the contained file, "describe.db", and place it directly in /usr/lib.
If you select another location, you will have to set your DESC_DB
environment variable. See the describe(1) man page. If you did
this step, then you can skip extraction and compilation of the database
source.
If you downloaded the database source archive (desc.src.shk), it will
extract to a file called "describe.source". You can place this file
anywhere, but the recommended location is in /usr/lib. Next, issue
the following command:
/usr/sbin/descc /usr/lib/describe.source
This will create the file /usr/lib/describe.db.
You should periodically download a new copy of the database. The
date the database was updated is visible in the first few lines
of the describe.source file.
If you have submissions for the database, the web pages mentioned above
contain directions on how to do the submission.
KNOWN BUGS
==========
The describe.source file must be sorted (keyed on the "Name" field,
case insensitive) when being compiled by descc. Failure to ensure
this will result describe failing to find certain entries, even if
they belong in the database. Using the descu program to update the
database source ensures that the source is properly sorted.
CHANGES
=======
This details changes to the entire distribution.
v1.0.5 December 1997
v1.0.5 January 1998
Increased the number of characters in the name field of the
nameEntry struct from 34 to 36. This gives an 8-byte
alignment to the offset entry, which provides binary
compatibility of the precompiled database file between
the IIgs and little-endian 32-bit machines such as
Linux boxes.
*** THIS MEANS THAT THE PRECOMPILED DATABASE IS NO LONGER
BINARY COMPATIBLE WITH EARLIER VERSIONS.
Updated descu so that the "Last Updated" line in the describe
source "header" is updated to reflect the current date and
time (GMT, if supported).
source "header" is updated to reflect the current date
and time (GMT, if supported).
Fixed a bug in descu that caused the "header" to be slowly eaten,
one character at a time.
The describe database source file is no longer part of this
archive. It is available separately from the url,
above.
Added a "Known Bugs" section and URLs on where to find the
online database to this README. Modified the installation
instructions a bit.
v1.0.4 September 1997
This package is now part of the base GNO distribution.

View File

@ -2,17 +2,20 @@
* Header file for the describe package. This file is
* used by describe(1), descc(8), and descu(8).
*
* $Id: desc.h,v 1.5 1997/12/22 00:34:52 gdr Exp $
* $Id: desc.h,v 1.6 1998/01/17 07:20:06 gdr Exp $
*/
/* Keep these utilities in lockstep. */
/*
* Keep these utilities in lockstep. Don't forget to change the version
* number in the *.rez files and in the manual pages.
*/
#define _VERSION_ "v1.0.5"
#define QUOTE_CHAR '#'
#define DATABASE "/usr/lib/describe.db"
#define FIELD_LEN 9
#define NAME_LEN 34
#define NAME_LEN 36
#define MAX_LINE_LENGTH 81
#define FIELD_COUNT 7 /* number of fields below, not including comments */

View File

@ -1,5 +1,5 @@
.\"
.\" $Id: descc.8,v 1.5 1997/10/30 04:19:10 gdr Exp $
.\" $Id: descc.8,v 1.6 1998/01/17 07:20:07 gdr Exp $
.\"
.TH DESCC 8 "22 September 1997" GNO "System Administration"
.SH NAME
@ -13,7 +13,7 @@ descc \- the describe(1) source compiler
.SH DESCRIPTION
This manual page documents
.BR descc
version 1.0.4.
version 1.0.5.
.LP
.BR descc
compiles the describe source file
@ -55,7 +55,7 @@ a complete record:
.nf
Name: describe
Version: 1.0.4
Version: 1.0.5
Shell: GNO, ORCA/Shell
Author: James Brookes
Contact: jamesb@ecst.csuchico.edu
@ -82,7 +82,7 @@ in the following format:
2 bytes: Short Int, number of \fBName Entries\fR
Name Entries
34 bytes: NULL-terminated string; name of the utility.
36 bytes: NULL-terminated string; name of the utility.
4 bytes: Long Int, offset of the \fBrecord\fR in file.
Records

View File

@ -1,7 +1,9 @@
/* */
/* descc - compile info file into describe database file */
/* */
/* $Id: descc.c,v 1.5 1997/09/24 06:34:58 gdr Exp $ */
/* $Id: descc.c,v 1.6 1998/01/17 07:20:07 gdr Exp $ */
/* */
/* v1.0.5 and later - see the README file for a list of changes. */
/* */
/* v1.0.4 - Changed location of database. Describe is now */
/* part of the base GNO distribution. Version numbers */
@ -36,7 +38,7 @@
/* */
/* Name Entries */
/* */
/* 34 bytes: Null-terminated string; name of utility */
/* 36 bytes: Null-terminated string; name of utility */
/* 4 bytes: Long Int, offset of record in file. */
/* */
/* Records */

View File

@ -1,7 +1,7 @@
/*
* Resources for version and comment
*
* $Id: descc.rez,v 1.1 1997/09/24 06:34:58 gdr Exp $
* $Id: descc.rez,v 1.2 1998/01/17 07:20:07 gdr Exp $
*/
#include "Types.rez"
@ -14,7 +14,7 @@
* Version
*/
resource rVersion (1, purgeable3) {
{ 1, 0, 4, /* Version 1.0.4 */
{ 1, 0, 5, /* Version 1.0.5 */
release, /* development|alpha|beta|final|release */
0 }, /* non-final release number */
verUS, /* Country */

View File

@ -1,5 +1,5 @@
.\"
.\" $Id: describe.1,v 1.5 1997/10/30 04:19:10 gdr Exp $
.\" $Id: describe.1,v 1.6 1998/01/17 07:20:07 gdr Exp $
.\"
.TH DESCRIBE 1 "22 September 1997" GNO "Commands and Applications"
.SH NAME
@ -13,7 +13,7 @@ describe \- show information about a program
.SH DESCRIPTION
This manual page documents
.BR describe
version 1.0.4.
version 1.0.5.
.LP
.BR describe
will show current information about

View File

@ -1,7 +1,7 @@
/*
* Resources for version and comment
*
* $Id: describe.rez,v 1.1 1997/09/24 06:34:58 gdr Exp $
* $Id: describe.rez,v 1.2 1998/01/17 07:20:07 gdr Exp $
*/
#include "Types.rez"
@ -14,7 +14,7 @@
* Version
*/
resource rVersion (1, purgeable3) {
{ 1, 0, 4, /* Version 1.0.4 */
{ 1, 0, 5, /* Version 1.0.5 */
release, /* development|alpha|beta|final|release */
0 }, /* non-final release number */
verUS, /* Country */
@ -26,7 +26,7 @@ resource rVersion (1, purgeable3) {
* Comment
*/
resource rComment (1, purgeable3) {
PROG " v1.0.4\n"
PROG " v1.0.5\n"
DESC " (GNO) \n"
AUTHOR
};

File diff suppressed because it is too large Load Diff

View File

@ -1,5 +1,5 @@
.\"
.\" $Id: descu.8,v 1.5 1997/12/22 00:34:52 gdr Exp $
.\" $Id: descu.8,v 1.6 1998/01/17 07:20:07 gdr Exp $
.\"
.TH DESCU 8 "22 September 1997" GNO "System Administration"
.SH NAME
@ -20,7 +20,7 @@ descu \- the describe(1) source updater
.SH DESCRIPTION
This manual page documents
.BR descu
version 1.0.4.
version 1.0.5.
.LP
.BR descu
updates the describe source file

View File

@ -11,7 +11,7 @@
* Copyright 1995-1997 by Devin Reade for James Brookes' describe(1) utility.
* See the included README file and man page for details.
*
* $Id: descu.c,v 1.6 1997/12/22 00:34:52 gdr Exp $
* $Id: descu.c,v 1.7 1998/01/17 07:20:07 gdr Exp $
*/
#include <sys/types.h>
@ -565,7 +565,7 @@ int main(int argc, char **argv) {
p++;
}
time(&t);
fprintf(outfp,"%s%s %s%s", header, revisionMagic,
fprintf(outfp,"%s%s %s%s\n", header, revisionMagic,
asctime(gmtime(&t)), p);
} else {
fprintf(outfp,"%s\n", header);

View File

@ -1,7 +1,7 @@
/*
* Resources for version and comment
*
* $Id: descu.rez,v 1.1 1997/09/24 06:34:59 gdr Exp $
* $Id: descu.rez,v 1.2 1998/01/17 07:20:07 gdr Exp $
*/
#include "Types.rez"
@ -14,7 +14,7 @@
* Version
*/
resource rVersion (1, purgeable3) {
{ 1, 0, 4, /* Version 1.0.4 */
{ 1, 0, 5, /* Version 1.0.5 */
release, /* development|alpha|beta|final|release */
0 }, /* non-final release number */
verUS, /* Country */
@ -26,7 +26,7 @@ resource rVersion (1, purgeable3) {
* Comment
*/
resource rComment (1, purgeable3) {
PROG " v1.0.4\n"
PROG " v1.0.5\n"
DESC " (GNO) \n"
AUTHOR
};