{{{  Name
NAME :     refer      a reference utility for origami
}}}

{{{  Synopsis
SYNOPSIS : refer [-f filename] [-r filename] [-e env-var] [-g env-var]
                 [-s] [-v] [-q] [-m lines] [-d define]
}}}

{{{  Version
VERSION : 1.3 January 1992    (c) Thomas Hadig
}}}

{{{  Description
DESCRIPTION :

The refer takes the word, stored in the enviroment-variable
ORIWORD, and generates a reference to this word. The reference will
be stored in the file T:ref and the enviroment-variable
ORIAREA set to T:ref.

Therefor the refer will look for the file S:refer. This file contains
all the reference files, one filename per line.

The reference files will have the following structure :
search_word   reference_lines filename @@seek_position

e.g. :
tm            45 time.h @@0

The two at-signs (@) have to be there, otherwise this line will be ignored !

REMARK : The file format of the reference files is identical to the
files use in dme, so you only have to have one reference file, if you
use both editors !

In addition you can use some special commands :
#define name           : will define the name

#if name
  references/commands
#endif                 : the references/commands will you scaned, if name
                         is defined by #define or the -d-option

If a search_word is referenced more than once, refer will now generate
all references !

This procedure will enable you to get the reference for a structure,
function, etc. directly form origami. You simply position the cursor
on the search_word and call an OCL-Macro, which will execute refer and
call the pager afterwards.
}}}

{{{  Options
OPTIONS :
{{{  f
-f filename : will use filename instead of T:ref as output filename
}}}
{{{  r
-r filename : will use filename instead of S:refer as reference filename
}}}
{{{  e
-e env-var : will store filename in env-var instead of ORIAREA
             (-e without env-var will not store the filename)
}}}
{{{  g
-g env-var : will get the search-string from the enviroment variable
             env-var instead of ORIWORD.
}}}
{{{  s
-s : small; will generate only the reference lines, not the references
            themselves
}}}
{{{  v
-v : verbose; will generate messages for every action refer will do
}}}
{{{  q
-q : quiet; will print no header, no warings and no error messages
}}}
{{{  m
-m lines : if the refernce length is equal or higher than lines,
           refer will only produce the reference lines (see -s)
}}}
{{{  d
-d define : will define the symbol define; only one define is possible
}}}
}}}

{{{  Files
FILES :
There are some files used by refer, for detailed information see decription !
}}}

{{{  See also
SEE ALSO : origami-docs and amiga-docs
}}}