This page is part of the Web Communications Guide to Using FTP. It provides information on files people using FTP to distribute files have set up as standard ways of informing visitors to their sites about what is avaiable. None of these files are mandatory, but they provide a convenient, standard way of informing people accessing your account through FTP about the contents of your site.

Recommended files:

".message"

A ".message" file will display a message to everyone entering your directory through FTP.

README

A "README" file typically documents the contents of a directory.

INDEX.txt

An INDEX file typically contains a short description of each file in the directory in which it is located. Some people name this "00INDEX", so that it is first in any alphabetcial directory listing.

Note: All these files must be in ASCII (plain text) format (the type produced by the Notepad in Windows or any standard Unix text editor). Most wordprocessors will give you the option of converting a file to ASCII when you choose the "Save As" option.

This file will be shown everytime someone using FTP enters the directory where it is located. Therefore, it should be short to avoid annoying people.

Typically, this file contains a brief description of the contents of the directory, and mentions which files people should download or read first to find out about what is in the directory.

Place this file in any directory where you expect people to be downloading files through FTP.

This file typicallys contains a description of the contents of the directory it is placed in, and any general information about these files you want people to know. Typically, visitors will transfer this file and read it before doing anything else.

A short message asking people to read it, and informing them when it was last updated will be displayed anytime someone enters your directory. If you also have a .message file, a note at the end of it will be displayed asking people to read the README file and informing them when it was last updated. Also, it is a common practice to have a README file associated with packages of files. Example:

This way, people can find out what is in the two big files without having to waste the time (and expense) of downloading them.

Note: when someone access a directory through the WWW Server, and there is no default "welcome.html" file, the WWW Server will display a list of all the files in the directory. If it exists, the README file will be displayed at the head of this listing. Because of this, if you don't have a "welcome.html" file in a directory accessible through the WWW, you should keep the README file to less than a page, and refer people to other files in the directory with more information.

This file contains a listing of all the files in the directory it is placed in, sometimes it will also contain a list of the files in any subdirectories as well. Often, a phrase describing the contents of each file is placed next to it.