home *** CD-ROM | disk | FTP | other *** search
/ vis-ftp.cs.umass.edu / vis-ftp.cs.umass.edu.tar / vis-ftp.cs.umass.edu / pub / imdb / image-db.hlp < prev    next >
Text File  |  1990-12-11  |  6KB  |  179 lines
  1. 1 Add-Image
  2.  
  3.   Format:
  4.   IMDB> Add-Image image-name description-file keyword1 ... keywordN
  5.  
  6. Adds a new image description record.  The image name must be unique and not
  7. allready in use in the image DB file.  The description file is just an
  8. ordinary text file.  The keywords should be brief descriptive words.
  9.  
  10. 1 Close-IMDB-Libr
  11.  
  12.   Format:
  13.   IMDB> Close-IMDB-Libr
  14.  
  15. Closes the currently opened image db file. If the file is still open upon
  16. exiting, it is automatically closed.
  17.  
  18. 1 Command-Structure
  19.  
  20.     The commands to IMAGEDB program fall into several groups:
  21.  
  22.   o File open and close commands:
  23.     Create-IMDB-Libr, Open-IMDB-Libr, and Close-IMDB-Libr.
  24.  
  25.   o Update commands:
  26.     Add-Image, Delete-Image, and Replace-Image.
  27.  
  28.   o Interagation commands:
  29.     Directory, List-Keywords, Describe-Image, Extract-Image, 
  30.     Search-Image-DB, Show-Select, File-Select, and Kill-Select.
  31.  
  32.   o Other commands:
  33.     Help and Exit.
  34. 1 Command-Syntax
  35.  
  36.    The IMAGEDB command line consists of one or more "words".  Words are
  37. separated by whitespace characters (space, tab, etc.).  Commands can be
  38. abbrivated to the minimum characters needed to resolve ambiguity.
  39.  
  40. 2 Escape characters
  41.  
  42.     Words normally cannot contain whitespace characters. There are two ways
  43. to handle "exotic" characters. One way is to prefix the exotic character
  44. with a backslash character (\). The other way is to put double quote marks
  45. (") around the word. Examples:
  46.  
  47.    Image-with-a\\-backslash
  48.    Image\ name\ with\ spaces
  49.    "Keyword 1"
  50.  
  51. While these sorts of keywords and image names are posible, they are hard to
  52. type and probably shouldn't be used unless necessary.
  53.  
  54. 2 Line continuation.  
  55.  
  56.     Commands can be continued over 2 or more lines with the use of the line
  57. continuation. This is done by placing a backslash as the last character
  58. before the newline character at the end of the line. Both this backslash and
  59. the newline character are discarded and the next line is tacked onto the end
  60. of the current line. Line continuation can occur in the midst of a word not
  61. in quote marks.
  62.  
  63. 2 Name processing.
  64.  
  65.    Image names are limited to 31 characters and keywords to 15 characters.
  66. Neither can contain commas. IMAGEDB program will truncate a longer image
  67. names to 31 characters and keywords to 15 characters as well as replace
  68. commas with semicolons without complaining.  Also, image names and keywords
  69. are converted to uppercase for internal storage.
  70. 1 Create-IMDB-Libr
  71.  
  72.   Format:
  73.   IMDB> Create-IMDB-Libr library-file-name
  74.  
  75. Creates a new, empty image db file.  File is opened for update access.
  76. The file gets a default type of ".ilb".
  77. 1 Delete-Image
  78.  
  79.   Format:
  80.   IMDB> Delete-Image image-name
  81.  
  82. Deletes an image description record.
  83. 1 Describe-Image
  84.  
  85.   Format:
  86.   IMDB> Describe-Image image-name
  87.  
  88. Describes a specified image.  The keywords and the description record for
  89. the specified image is displayed on standard output.
  90. 1 Directory
  91.  
  92.   Format:
  93.   IMDB> Directory [wildcarded-image-name]
  94.  
  95. Does a directory of the image records.  If no argument is given, then "*" is
  96. used (all image names are listed).  The image name can have the standard UNIX
  97. wildcard characters: * and ?.
  98. 1 Exit
  99.  
  100.   Format:
  101.   IMDB> Exit
  102.  
  103. The exit command exits the program.
  104. 1 Extract-Image
  105.  
  106.   Format:
  107.   IMDB> Extract-Image image-name description-out-file keyword-out-file
  108.  
  109. Copies the description and keywords for a specified image to the specified
  110. output files.
  111. 1 File-Select
  112.  
  113.   Format:
  114.   IMDB> File-Select output-file-name
  115.  
  116. The images on the select list are described to the specified output file.
  117. 1 HELP
  118.  
  119.     The IMAGEDB program accesses and maintains image description data-bases.
  120. These data-bases can be interagated with keyword searches. Each data record
  121. contains two parts: a list of keywords and a body of descriptive text. Each
  122. record has a name (usually the name of the image or image set).
  123.  
  124.     Image names are limited to 31 characters and keywords are limited to 15
  125. characters.  The keyword list must fit in a space of 255 characters, which
  126. includes a comma between keywords and a null character at the end.  The
  127. descriptive text is limited only by the available disk space.
  128.  
  129. 1 Kill-Select
  130.  
  131.   Format:
  132.   IMDB> Kill-Select
  133.  
  134. The current select list is cleared.
  135. 1 List-Keywords
  136.  
  137.   Format:
  138.   IMDB> List-Keywords [wildcarded-keyword]
  139.  
  140. Generates a list of know keywords.  If no argument is given, then "*" is
  141. used (all keywords are listed).  The keyword can have the standard UNIX
  142. wildcard characters: * and ?.
  143. 1 Open-IMDB-Libr
  144.  
  145.   Format:
  146.   IMDB> Open-IMDB-Libr library-file-name [Update]
  147.  
  148. Opens an old image db file. File can be opened for readonly access (the
  149. default) or for update access (if the word "Update" is appended to the
  150. command line.  The file gets a default type of ".ilb".
  151.     
  152.  
  153. 1 Replace-Image
  154.  
  155.   Format:
  156.   IMDB> Replace-Image image-name description-file keyword1 ... keywordN
  157.  
  158. Replaces an image description record.  This command actually just does a
  159. Delete-Image followed by an Add-Image.
  160. 1 Search-Image-DB
  161.  
  162.   Format:
  163.   IMDB> Search-Image-DB wildcarded-keyword1 ... wildcarded-keywordN
  164.  
  165. The image DB file is searched for all images which have one or more of the
  166. specified keywords.  The keywords can have the UNIX wild card characters *
  167. and ?.  The image names are accumulated on an internal list.  If the search
  168. command is given repeatedly, the additional images names found are added to
  169. this list. (See the Kill-Select command).  The list can be viewed with the
  170. Show-Select command.  (See also the File-Select command.)
  171. 1 Show-Select
  172.  
  173.   Format:
  174.   IMDB> Show-Select
  175.  
  176. The images on the select list are described to standard output.  If
  177. operating from a terminal, the IMAGEDB program will pause after each image
  178. description, giving the user the option of quiting
  179.