Run the file by typing "ref", "perl ref" or whatever you usually do to run a Perl program.
A message should flash up saying "Reading case base from
When REF is done reading the bibliography file, it will clear the screen and print the following:
------------ Target Query ------------ Authors = UNSPECIFIED Cited = UNSPECIFIED Course = UNSPECIFIED Date = UNSPECIFIED Degree = UNSPECIFIED Keyword = UNSPECIFIED Status = UNSPECIFIED Title = UNSPECIFIED Type = UNSPECIFIED Please enter a dimension for which you wish to specify a value (e.g. "Type"), otherwise just press Return to do the retrieval. ->
This is where you enter your query, by giving the values for as many fields as you wish (including none at all, which retrieves all the references in the bibliography file). This part of the program is very self-explanatory - just follow the on-screen prompts. REF knows which fields are supposed to be scalars and which are supposed to be lists, and it will prompt you for what it requires.
When you have constructed the query you want, press Return at the prompt. This will cause REF to search the bibliography file for references that match the query. It will tell you how many references (cases) match, and generate a bibliography file "ref-output.html" in REF's working directory, which is best viewed by opening the file in your favourite Web browser.
It is at this stage that REF will notify you of any irregularities in the references - namely missing information that should be included in the bibliography. In each case, it will output the record and state what is wrong with it. REF will still attempt to generate bibliography entries for these records, but you should obviously correct this if possible by modifying the input bibliography file!
This section has described a normal run of the program where all is merry and bright. If you experience problems, you might find some help in the troubleshooting guide.