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

操作系统开发

开发平台:

C/C++

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