Hobbes Just Improves
Upload Policy for OS/2

Upload Policy for the Hobbes OS/2 Archive at New Mexico State University

Last modified: 07/27/1998 - Finally put in an example of a good .txt, other fun changes


Object

The purpose of this document is to clarify what should and should not be uploaded to the Hobbes OS/2 Archive (henceforth identified as "Hobbes") and provide guidelines for the user. If the user has any questions regarding the archiver's decision regarding a file, he/she should first refer to this file before asking any questions. Any question asked which is answered by this file will likely result in a response indicating such.

This document is not all-encompassing, nor is it the "last straw," so to speak. It merely provides guidelines; exceptions to these guidelines are made for extenuating circumstances. Every effort will be made to list such circumstances in this file, though there will definitely be ommissions.

Preferred Format

Because we are trying to keep the archive standardized, we prefer that all submissions be made in the same format. This format is a single file in ZIP format, preferrably with 8 or fewer characters in the filename (not including extension), with the filename in all lowercase letters. All filenames will be converted to lowercase before they are archived.

The following exceptions are in effect:

The file must be accompanied by a description file. The name for this file is to be the same as the upload but with a TXT extension. The TXT file must be based on the /pub/incoming file template, preferrably the latest version (i.e. you should redownload it every time you want to upload a file). The template has the following information: (a (R) indicates that this field is mandatory)

If any of the required information is missing, the archive will not be processed until a corrected TXT file is uploaded. Additionally, if the proposed directory is inappropriate and the archiver can not easily see where it should go, the file will not be processed until the TXT file is replaced. Please also note that the only multi-line field is the long description. Please refrain from making OS/requirements/etc. too spammy, and PLEASE try to keep the other fields on a single line. Use a text editor which doesn't force you to word-wrap, if necessary; the OS/2 System Editor (E.EXE) does this just fine. If you keep the fields on one line, I'll be MUCH happier, as it will be easier for me to process the file.

Please note that the only field with multiple lines is the long description. PLEASE try to keep the other fields on a single line; use a text editor which doesn't force you to word-wrap. OS/2 System Editor (E.EXE) does the job nicely. (This makes things a lot easier on me, as then I can simply cut-and-paste the text into the database.)

Since many people still haven't figured out what I mean, here is an example of what I consider to be a good .txt file.

                          Upload Information Template for Hobbes.nmsu.edu
                          ===============================================

        Archive Filename: xxxxx12.zip
       Short Description: xxxxx - Web utility
        Long Description: xxxxx! v1.2 web server utility
                          Does various things to your web server
                          which are useful.  Can be configured with
                          a variety of options.  Can do things to
                          both HTML and images, as well as any
                          other MIME type your server supports.
                          Can be used offline and with proxies.
                          Automated command-line, with (optional)
                          PM interface.

      Proposed directory
           for placement: /pub/os2/apps/internet/www/util

               Your name: Sam O. Meone
           Email address: someone@somewhere.net
    Program contact name: (same)
   Program contact email: (same)
             Program URL: http://somewhere.net/~someone/xxxxx

      Would you like the
   contact email address
    included in listings? yes

Operating System/Version: OS/2 Warp 3 and up
 Additional requirements: TCP/IP

                Replaces: xxxxx11.zip

This one follows all the rules, it has about the right size of a long description (remember, the description is just that - a description), it gives all the information as needed and requested, and is concise. Notice that the URL points to a webpage (or the like) regarding the zip file, not the zip file itself; what is the point of Hobbes storing files if it will only end up storing links to files? And homepages go down all the time.

One other thing to mention: many uploaders have been confused regarding what OS to put when they are uploading, say, a Java application. In that case, Java is the OS. If that were a Java 1.1.2 application above, besides being in /pub/java/apps/internet/www/util, its operating system would be Java 1.1.2.

If the uploader above didn't want his email address listed, he would say 'no' for whether he wanted the contact email address included. Adding a 'DO NOT INCLUDE!' message is rather pointless and redundant. If he also didn't want to have his real name included, then he'd put (none) and (none) for contact name and contact email.

Also notice how 'Replaces' gives the filename, not saying 'previous version.' I know that it's replacing a previous version. Otherwise it wouldn't be replacing it.

The only exception to the rule that every file have a TXT file is with a large group of files with the same filename but different extensions (most notably of which being IBM fixpacks). Because they all have the same filename, it would be impossible to assign each one a separate TXT file.

With multiple-file distributions, we would prefer that the description in the TXT file pertain to the program in general, with the specifics of that file appended to the end in parenthesis. For example:

If you cannot take the time to make a proper TXT file for your archive -- and it doesn't take very long -- then please remember that having your file stored on Hobbes is a privlege, not a right, and that Hobbes is maintained as a free service by New Mexico State University.

Outdated Versions

If you upload an old/outdated version of a program, it will be delayed for processing until I can get clarification from you as to why it should be included. If your reasoning is good enough, I will retain the newer version as well as archiving the older one. Both versions will be retained until an updated version is uploaded, at which point both will be deleted. If the updated version is still bad, this entire process will be repeated.

Newer versions always take precedence. Whenever a new version is archived, all old versions are deleted. The benefit of the doubt will always be given to the new version.

Delayed Processing

As mentioned above, if certain rules are not followed a file will be delayed for processing. In general, if a file is delayed in its processing, you will be sent an email notice (unless your email address is missing from the TXT file) and it will not be moved into the /pub/incoming/delayed directory. Any unprocessed files sitting in there for more than seven days will be deleted on the next archival sweep -- no exceptions.

Archive integrity

If an attempt at uploading a file is unsuccessful, before attempting to upload again you should rename the bad file to

or the like. You can do this with all FTP clients [AFAIK, though there are some pretty stupid clients out there :) - JAS]. If you decide to go by your own convention it is quite possible that the archiver will get confused and delete the wrong file. In general, just rename it to something which contains the word 'delete'; it makes it easy to find and eliminate. Also, if you upload a new version of a program and an older version is still in /pub/incoming (e.g. when the archiver is on vacation), please take the time to rename the old versions to contain 'delete' in them as well.

If an archive is bad, it will be deleted and you will be notified to re-upload it. You may have to re-upload the TXT file along with it, depending on the mood I was in at the time.

If an archive contains a virus (and we do check), it will be immediately deleted and a notice will be sent to you and your ISP. And don't think that not including an email address in your TXT file will keep this from happening; even if you do your best to hide your email address, the FTP logs still contain your ISP's address.

Pirated Commercial Material ("warez" et al)

If you are found uploading pirated material to Hobbes, it will be immediately deleted and a message will be sent to your ISP. If you see that someone else has uploaded pirated material, do not touch it or rename it - notify me immediately. And PLEASE, whatever you do, do not rename it until after you have emailed me the original names of the files (as uploaded, that is). I cannot emphasize that point enough. It makes it difficult to track down whoever uploaded it without the original upload filenames.

As with virus-containing archives, don't think that lack of email address in the TXT file will keep me from figuring out and mailing your ISP.

Contacting the Archiver

If you are unclear on a point in this policy text, would like to make a suggestion, or are feeling lonely and need someone to talk to, feel free to email me. I just might respond. :)


archiver@hobbes.nmsu.edu



@Macarlo, Inc.
@Macarlo's Shareware & Web
OS/2
Java Lobby Member
Java Site Accredited

[TOP] [HOME] [INDEX]