doc_guide.txt = a guide to files that document the JHUAPL IDL libraries. Available directly from the JHUAPL anonymous ftp site ----------------------------------------------------- Uncompressed files ------------------ README = the overall guide to aquiring files from the ftp site. doc_guide.txt = the file you are reading. cat.one = one line descriptions of all the library routines. Compressed files: Release notes ------------------------------- usr_rn.txt.Z = release notes for the library idlusr. usr2_rn.txt.Z = release notes for the library idlusr2. doc_rn.txt.Z = release notes for the library idldoc. If you find a bug in a library routine, check the latest corresponding release notes file to see if it is known before reporting it. Compressed files: Library documentation guides ---------------------------------------------- idl_time.ps.Z = Documents routines related to working with time. Files found in each library --------------------------- The following files are found in each library (after uncompressing). cat.one = one line descriptions of routines in the library, classified by category. The ftp site cat.one includes all the cat.one files concatenated together. alph.one = one line descriptions of routines in the library in alphabetical order. The alph.one files are searched by the liner utility. release_notes.txt = the release notes up to the time when the library was placed in the ftp site. These will be the same as the compressed release notes found directly in the ftp site. disclaimer.txt = this is the file referred to in the copyright notice found in the header of each routine. The purpose of the copyright notice, together with this file, is to allow us to put these routines in the public domain without worrying about law suits or somebody trying to take possesion and then charging us for our own software. Files found in the idldoc library --------------------------------- The following files are found in the library idldoc (after uncompressing). General documentation --------------------- setup.doc = This is the main documentation of how to set up and use the JHUAPL libraries. It describes how to get the most out of these libraries. A number of environmental variables are needed, these are documented. A number of useful utilities are also described. Other documentation files are referenced. idl_psprinters.doc = referenced in setup.doc. Describes how to set up a file and an environmental variable that allows the routine psinit to be used. psinit makes it easy to redirect graphics to any of the PostScript printers on your system. Documentation related to the libr librarian utility --------------------------------------------------- These files are used by the librarian, libr.pro. They are ordinary text files but have certain commands interpreted by the help text display routine, helpfile, which is called by libr. libr.hlp = the top level help file displayed by the librarian utility, libr. It describes libr briefly and links to the following help files: doc_stand.hlp = describes the format to use for built-in help in your own routines. If this format is used then a number of provided utilities can work with the built-in help. This allows the built-in help to be converted to standard frontend templates, and one line descriptions to be automatically extracted (to be used by liner). The main advantage of built-in help is that it makes it very easy to obtain the calling syntax for a routine. dot_idl_files.hlp = describes some files needed by libr to maintain your own set of local IDL libraries. details.hlp = gives more details on what libr does.