Mail Archives: djgpp/1994/06/30/15:16:16
We (the Linux world) have been using the following form to accompany
software uploaded to ftp sites. It has proven to be quite useful. The
file is (I think I've got the path right):
sunsite.unc.edu:/pub/Linux/docs/lsm-template
Linux Software Map Entry Template Release: 20MAY94
=============================================================================
Synopsis:
The LSM is a directory of information about each of the software packages
available via FTP for the Linux operating system. It is meant to be a public
information resource. All entries have been entered by volunteers all over
the world via email using the template below. New versions will appear
first on sunsite.unc.edu and will be announced in the newsgroup
comp.os.linux.announce . Discussions pertaining to the LSM will be held in
the newsgroup comp.os.linux.help . Any questions or comments can be entered in
comp.os.linux.help or sent to me directly at jeffk AT msen DOT com .
Instructions:
Any new packages or updates to old entries should be entered in the template
below and sent to jeffk AT msen DOT com (Jeff Kopmanis). Each release of the
LSM will have the current template as part of the package. Any changes to
the template will be made and released there.
*PLEASE* use the entry template below when submitting information. It has
been designed so that all you have to do is fill in the blanks and send it
in as is. Your entry will be read into the database directly from your
email response with little if any hand manipulation.
DO NOT RENAME FIELDS. DO NOT REMOVE THE BEGIN OR END MARKERS. Please
take a few minutes to review the field lengths listed below. Any text
beyond these lengths will be TRUNCATED.
Complete as many fields as possible. As of the 05SEP93 version, you don't
need to keep blank fields around, but I strongly encourage developers to
complete all the fields, as its more descriptive. Make any corrections
that are necessary. The initial data came from a variety of sources,
and is not at all assumed to be correct.
Once you have completed the documentation as best as possible, upload your
package and a completed LSM template to sunsite.unc.edu:/pub/Linux/Incoming
The sunsite admin will get the LSM's to me. If this is inconvenient, you
may also email the modified version of this file to: jeffk AT msen DOT com
Thank you VERY much for your time and enthusiasm. Your contribution will
help to ensure that the Linux Software Map will continue to be a trusted
Linux resource.
-Jeff. :) (jeffk AT msen DOT com) (Jeffrey J. Kopmanis)
=============================================================================
As of the 20MAY94 version....
=============================================================================
Expanded Numbers of Fields
--------------------------
You are allowed to have unlimited numbers of the
Desc, Site/Path/File/Filesize, Required, Comment, RelFiles and CopyPolicy
fields. YOU MUST NUMBER each of them (ie. Desc1, Desc2, Desc3...) for now.
I'm working to make the program able to read in arbitrary numbers, but the
code just isn't there.
"HyperText" file locations
--------------------------
For each Site/Path/File combination that is completely filled in, a reference
is generated that should be readable and comprehended by the WWW, WAIS and
some gopher servers to automatically download the particular file for you.
I think this could be a really neat addition, and I'd like to get your
feedback to how it works.
Relaxed formatting
------------------
The formatting of the entries is continually being relaxed. A field name
must have AT LEAST one blank after its name. Everything after the equals
sign (=) is trimmed of excess spaces and inserted into the data field. No
column positioning is required.
=============================================================================
DESCRIPTIONS of fields used in the LSM template
DO NOT FILL IN THIS PART...THAT IS BELOW THESE FIELD DEFINITIONS!!
=============================================================================
Field:len Description
----------- -----------------------------------------------------------------
Title:40 The name of the package. example: "Emacs text editor"
Version:25 The version number or designation.
Desc1:80 5 lines of text describing the package's function or purpose.
Desc2:80 The more descriptive you are the more useful the entry will be.
Desc3:80
Desc4:80
Desc5:80
Author:65 Who wrote the package originally, or, the person who ported it.
AuthorEmail:40 The author's email address, if known.
Maintainer:65 Who currently maintains the code.
MaintEmail:40 The maintainer's email address, if known.
Site1:30 FTP address of the primary site where this package is distributed.
Path1:50 The path at Site1 where the package is located.
File1:40 The filename in Path1 at Site1 where the package is located.
FileSize1:size The size of the package. You may use K and MB after a number.
Site2/Path2/File2/FileSize2 (same as first one)
Site3/Path3/File3/FileSize3 (same as first one)
Site4/Path4/File4/FileSize4 (same as first one)
Required1:80 Required hardware or software needed to run this package. Please
Required2:80 be as specific as possible, for this information is VERY
Required3:80 important.
Required4:80
CopyPolicy1:80 The copyright policy of this package.
CopyPolicy2:80
Keywords:80 Keywords to use in searching for this package.
Comment1:80 Put any pertenant information that doesn't fit in the above
Comment2:80 fields or categories here. The more you tell us, the better.
Comment3:80
Comment4:80
RelFiles1:80 List any related files that come with the package here.
RelFiles2:80
RelFiles3:80
Entered:12 The date you filled out this template. Ex: 05SEP93
EnteredBy:30 Take credit for your work!
CheckedEmail:40 Your email address (if you wish it to be in the LSM)
=============================================================================
NOTE: The example file below contains ALL AVAILABLE fields. You may delete
any fields you do not use. BE SURE TO RETAIN THE BEGIN2 and END keywords...
they are VERY important!
-------------------------------- cut here ------------------------------------
Begin2
Title =
Version =
Desc1 =
Desc2 =
Desc3 =
Desc4 =
Desc5 =
Author =
AuthorEmail =
Maintainer =
MaintEmail =
Site1 =
Path1 =
File1 =
FileSize1 =
Site2 =
Path2 =
File2 =
FileSize2 =
Site3 =
Path3 =
File3 =
FileSize3 =
Site4 =
Path4 =
File4 =
FileSize4 =
Required1 =
Required2 =
Required3 =
Required4 =
CopyPolicy1 =
CopyPolicy2 =
Keywords =
Comment1 =
Comment2 =
Comment3 =
Comment4 =
RelFiles1 =
RelFiles2 =
RelFiles3 =
Entered =
EnteredBy =
CheckedEmail =
End
--
J. Alan Eldridge (alane AT wozzle DOT linet DOT org)
- Raw text -