REF.1
上传用户:datang2001
上传日期:2007-02-01
资源大小:53269k
文件大小:4k
源码类别:

操作系统开发

开发平台:

C/C++

  1. REF(1)                    Minix Programmer's Manual                     REF(1)
  2. NAME
  3.      ref - Display a C function header
  4. SYNOPSIS
  5.      ref [-t] [-c class]... [-f file]... tag
  6. DESCRIPTION
  7.      ref quickly locates and displays the header of a function.  To  do  this,
  8.      ref  looks  in  the "tags" file for the line that describes the function,
  9.      and then scans the source file for the function.   When  it  locates  the
  10.      function,  it  displays  an  introductory  comment (if there is one), the
  11.      function's declaration, and the declarations of all arguments.
  12. SEARCH METHOD
  13.      ref uses a fairly sophisticated tag look-up algorithm.  If you  supply  a
  14.      filename  via  -f file, then elvis first scans the tags file for a static
  15.      tag from that file.  This search is limited  to  the  tags  file  in  the
  16.      current directory.
  17.      If you supply a classname via -c class, then elvis  searches  for  a  tag
  18.      from  that  class.   This search is not limited to the current directory;
  19.      You can supply a list of directories in the environment variable TAGPATH,
  20.      and  ref  will  search through the "tags" file in each directory until it
  21.      finds a tag in the desired class.
  22.      If that fails, ref will then try to look up an ordinary global tag.  This
  23.      search checks all of the directories listed in TAGPATH, too.
  24.      If you've given the -t flag, then ref will simply  output  the  tag  line
  25.      that  it  found,  and then exit.  Without -t, though, ref will search for
  26.      the tag line.  It will try to open the source file, which  should  be  in
  27.      the same directory as the tags file where the tag was discovered.  If the
  28.      source file doesn't exist, or is unreadable, then ref will try to open  a
  29.      file called "refs" in that directory.  Either way, ref will try to locate
  30.      the tag, and display whatever it finds.
  31. INTERACTION WITH ELVIS
  32.      ref is used by elvis' shift-K command.  If the cursor  is  located  on  a
  33.      word  such  as  "splat",  in the file "foo.c", then elvis will invoke ref
  34.      with the command "ref -f foo.c splat".
  35.      If elvis has been compiled with the -DEXTERNAL_TAGS flag, then elvis will
  36.      use  ref  to  scan  the tags files.  This is slower than the built-in tag
  37.      searching, but it allows elvis  to  access  the  more  sophisticated  tag
  38.      lookup  provided  by  ref.   Other  than  that,  external tags should act
  39.      exactly like internal tags.
  40.                                                                              1
  41. REF(1)                    Minix Programmer's Manual                     REF(1)
  42. OPTIONS
  43.      -t   Output tag info, instead of the function header.
  44.      -f file
  45.           The tag might be a static function in file.  You can use several  -f
  46.           flags to have ref consider static tags from more than one file.
  47.      -c class
  48.           The tag might be a member of class class.  You can  use  several  -c
  49.           flags to have ref consider tags from more than one class.
  50. FILES
  51.      tags List of function names and their locations, generated by ctags.
  52.      refs Function headers extracted from source files (optional).
  53. ENVIRONMENT
  54.      TAGPATH
  55.           List of directories to be searched.  The elements in  the  list  are
  56.           separated   by   either  semicolons  (for  MS-DOS,  Atari  TOS,  and
  57.           AmigaDos), or by colons (every other operating  system).   For  each
  58.           operating  system,  ref  has  a  built-in  default which is probably
  59.           adequate.
  60. NOTES
  61.      You might want to generate a "tags" file the directory that contains  the
  62.      source  code  for  standard  C  library  on  your  system.   If licensing
  63.      restrictions prevent you from  making  the  library  source  readable  by
  64.      everybody,  then  you  can  have  ctags  generate a "refs" file, and make
  65.      "refs" readable by everybody.
  66.      If your system doesn't come with the library source  code,  then  perhaps
  67.      you can produce something workable from the lint libraries.
  68. SEE ALSO
  69.      elvis(1), ctags(1)
  70. AUTHOR
  71.      Steve Kirkendall
  72.      kirkenda@cs.pdx.edu
  73.                                                                              2