Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"
Fatherhood.Org

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Glossary
MoreInfo
Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
FAQ
Copyright Info
Terms of Use
Privacy Info
Disclaimer
WorkBoard
Thanks
Donations
Advertising
Masthead / Impressum
Your Account

Communication
Feedback
Forums
Private Messages
Surveys

Features
HOWTOs
News Archive
Submit News
Topics
User Articles
Web Links

Google
Google


The Web
linux-tutorial.info

Who's Online
There are currently, 321 guest(s) and 5 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here

  

cscope



SYNOPSIS

       cscope  [  -bCcdehkLlqRTUuV  ]  [-Fsymfile] [-freffile] [-Iincdir]
       [-inamefile] [-numpattern] [-pn] [-sdir]


DESCRIPTION

       cscope is an interactive, screen-oriented  tool  that  allows  the
       user  to  browse  through C source files for specified elements of
       code.

       By default, cscope examines the C (.c and .h), lex (.l), and  yacc
       (.y)  source  files  in the current directory.  cscope may also be
       invoked for source files named on  the  command  line.  In  either
       case,  cscope searches the standard directories for #include files
       that it does not find in the current  directory.   cscope  uses  a
       symbol  cross-reference,  cscope.out  by  default, to locate func­
       tions, function calls, macros, variables, and preprocessor symbols
       in the files.

       cscope builds the symbol cross-reference the first time it is used
       on the source files for the program being browsed. On a subsequent
       invocation,  cscope  rebuilds the cross-reference only if a source
       file has changed or the list of source files  is  different.  When
       the  cross-reference  is rebuilt, the data for the unchanged files
       are copied from the old cross-reference,  which  makes  rebuilding
       faster than the initial build.


OPTIONS

       The following options can appear in any combination:

       -b     Build the cross-reference only.

       -C     Ignore letter case when searching.

       -c     Use only ASCII characters in the cross-reference file, that
              is, do not compress the data.

       -d     Do not update the cross-reference.

       -e     Suppress the <Ctrl>-e command prompt between files.

       -F symfile
              Read symbol reference lines from symfile. (A symbol  refer­
              ence  file  is  created  by  > and >>, and can also be read
              using the < command, described under  ``Issuing  Subsequent
              Requests,'' below.)

       -f reffile
              Use reffile as the cross-reference file name instead of the
              default cscope.out.

       -h     View the long usage help display.

              Browse through all source files whose names are  listed  in
              namefile  (file  names  separated  by spaces, tabs, or new-
              lines) instead  of  the  default  (cscope.files).  If  this
              option  is specified, cscope ignores any files appearing on
              the command line. The argument namefile can be set to ``-''
              to  accept  a  list  of files from stdio.  Filenames in the
              namefile that contain whitespace have  to  be  enclosed  in
              "double quotes".  Inside such quoted filenames, any double-
              quote and backslash characters have to be escaped by  back­
              slashes.

       -k     ``Kernel  Mode'',  turns off the use of the default include
              dir (usually  /usr/include)  when  building  the  database,
              since kernel source trees generally do not use it.

       -L     Do a single search with line-oriented output when used with
              the -num pattern option.

       -l     Line-oriented interface  (see  ``Line-Oriented  Interface''
              below).

       -num pattern
              Go to input field num (counting from 0) and find pattern.

       -P path
              Prepend  path  to relative file names in a pre-built cross-
              reference file so you do not have to change to  the  direc­
              tory  where the cross-reference file was built. This option
              is only valid with the -d option.

       -p n   Display the last n file  path  components  instead  of  the
              default (1). Use 0 to not display the file name at all.

       -q     Enable  fast  symbol  lookup  via  an  inverted index. This
              option causes cscope to create 2 more files (default  names
              ``cscope.in.out'' and ``cscope.po.out'') in addition to the
              normal database. This allows a faster symbol  search  algo­
              rithm  that  provides  noticeably faster lookup performance
              for large projects.

       -R     Recurse subdirectories for source files.

       -s dir Look in dir for additional source  files.  This  option  is
              ignored if source files are given on the command line.

       -T     Use only the first eight characters to match against C sym­
              bols.  A regular expression containing  special  characters
              other  than  a  period (.) will not match any symbol if its
              minimum length is greater than eight characters.

       -U     Check file time stamps. This option will  update  the  time
              stamp on the database even if no files have changed.

       Find this C symbol:
       Find this function definition:
       Find functions called by this function:
       Find functions calling this function:
       Find this text string:
       Change this text string:
       Find this egrep pattern:
       Find this file:
       Find files #including this file:

       Press  the  <Up>  or <Down> keys repeatedly to move to the desired
       input field, type the text to  search  for,  and  then  press  the
       <Return> key.


Issuing subsequent requests

       If  the  search  is successful, any of these single-character com­
       mands can be used:

       0-9a-zA-Z
              Edit the file referenced by the given line number.

       <Space>
              Display next set of matching lines.

       <Tab>  Alternate between the menu and the list of matching lines

       <Up>   Move to the previous menu item (if the  cursor  is  in  the
              menu)  or move to the previous matching line (if the cursor
              is in the matching line list.)

       <Down> Move to the next menu item (if the cursor is in  the  menu)
              or  move to the next matching line (if the cursor is in the
              matching line list.)

       +      Display next set of matching lines.

       -      Display previous set of matching lines.

       ^e     Edit displayed files in order.

       >      Write the displayed list of lines to a file.

       >>     Append the displayed list of lines to a file.

       <      Read lines from a file that is in symbol  reference  format
              (created by > or >>), just like the -F option.

       ^      Filter  all  lines  through a shell command and display the
              resulting lines, replacing  the  lines  that  were  already
              there.

       ^b     Move to previous input field and search pattern.

       ^f     Move to next input field and search pattern.

       ^c     Toggle ignore/use letter case when searching. (When  ignor­
              ing  letter  case,  search for ``FILE'' will match ``File''
              and ``file''.)

       ^r     Rebuild the cross-reference.

       !      Start an interactive shell (type ^d to return to cscope).

       ^l     Redraw the screen.

       ?      Give help information about cscope commands.

       ^d     Exit cscope.

       NOTE: If the first character  of  the  text  to  be  searched  for
       matches  one  of  the above commands, escape it by typing a (back­
       slash) first.

       Substituting new text for old text

       After the text to be changed has been typed,  cscope  will  prompt
       for  the  new  text, and then it will display the lines containing
       the old text. Select the lines to be changed  with  these  single-
       character commands:

       0-9a-zA-Z
              Mark or unmark the line to be changed.

       *      Mark or unmark all displayed lines to be changed.

       <Space>
              Display next set of lines.

       +      Display next set of lines.

       -      Display previous set of lines.

       a      Mark or unmark all lines to be changed.

       ^d     Change the marked lines and exit.

       <Esc>  Exit without changing the marked lines.

       !      Start an interactive shell (type ^d to return to cscope).

       ^l     Redraw the screen.
       face would not be useful, for example,  from  another  screen-ori­
       ented program.

       cscope  will  prompt  with  >>  when it is ready for an input line
       starting with the field number (counting from 0) immediately  fol­
       lowed by the search pattern, for example, ``lmain'' finds the def­
       inition of the main function.

       If you just want a single search, instead of the -l option use the
       -L and -num pattern options, and you won't get the >> prompt.

       For  -l,  cscope  outputs  the number of reference lines cscope: 2
       lines

       For each reference found, cscope outputs a line consisting of  the
       file name, function name, line number, and line text, separated by
       spaces, for example, main.c main 161 main(argc, argv)

       Note that the editor is not called to display a single  reference,
       unlike the screen-oriented interface.

       You  can  use  the c command to toggle ignore/use letter case when
       searching. (When ignoring letter case, search  for  ``FILE''  will
       match ``File'' and ``file''.)

       You can use the r command to rebuild the database.

       cscope  will  quit  when it detects end-of-file, or when the first
       character of an input line is ``^d'' or ``q''.


ENVIRONMENT VARIABLES

       CSCOPE_EDITOR
              Overrides the EDITOR and VIEWER variables. Use this if  you
              wish to use a different editor with cscope than that speci­
              fied by your EDITOR/VIEWER variables.

       CSCOPE_LINEFLAG
              Format of the line number flag for your editor. By default,
              cscope  invokes  your editor via the equivalent of ``editor
              +N file'', where ``N'' is the line number that  the  editor
              should  jump  to. This format is used by both emacs and vi.
              If your editor needs something  different,  specify  it  in
              this  variable,  with  ``%s'' as a placeholder for the line
              number.  Ex: if your editor needs to be invoked as ``editor
              -#103  file''  to  go  to  line  103,  set this variable to
              ``-#%s''.

       CSCOPE_LINEFLAG_AFTER_FILE
              Set this variable to ``yes'' if your  editor  needs  to  be
              invoked  with  the line number option after the filename to
              be edited. To continue the  example  from  CSCOPE_LINEFLAG,

       SOURCEDIRS
              Colon-separated  list  of  directories  to search for addi­
              tional source files.

       TERM   Terminal type, which must be a screen terminal.

       TERMINFO
              Terminal information directory full path name. If your ter­
              minal is not in the standard terminfo directory, see curses
              and terminfo for how to make your own terminal description.

       TMPDIR Temporary file directory, which defaults to /var/tmp.

       VIEWER Preferred  file display program (such as less), which over­
              rides EDITOR (see above).

       VPATH  A colon-separated list of directories, each  of  which  has
              the  same  directory  structure  below it. If VPATH is set,
              cscope searches for source files in the directories  speci­
              fied; if it is not set, cscope searches only in the current
              directory.


FILES

       cscope.files
              Default files containing -I, -p, -q, and -T options and the
              list of source files (overridden by the -i option).

       cscope.out
              Symbol  cross-reference file (overridden by the -f option),
              which is put in the home directory if it cannot be  created
              in the current directory.

       cscope.in.out
       cscope.po.out
              Default  files containing the inverted index used for quick
              symbol searching (-q option). If you use the -f  option  to
              rename  the  cross-reference file (so it's not cscope.out),
              the names for these inverted index files will be created by
              adding
               .in  and  .po to the name you supply with -f. For example,
              if you indicated -f xyz, then these files  would  be  named
              xyz.in and xyz.po.

       INCDIR Standard    directory    for    #include   files   (usually
              /usr/include).


Notices

       cscope recognizes function definitions of the form:
       fname blank ( args ) white arg_decs white {

       where: fname is the function name
       nitions that deviate from this form  will  not  be  recognized  by
       cscope.

       The  ``Function''  column of the search output for the menu option
       Find functions called by this function: input field will only dis­
       play  the  first  function  called  in the line, that is, for this
       function

        e()
        {
                return (f() + g());
        }

       the display would be

          Functions called by this function: e
          File Function Line
          a.c f 3 return(f() + g());

       Occasionally, a function definition or call may not be  recognized
       because  of  braces inside #if statements. Similarly, the use of a
       variable may be incorrectly recognized as a definition.

       A typedef name preceding a preprocessor statement will  be  incor­
       rectly recognized as a global definition, for example,

        LDFILE  *
        #if AR16WR

       Preprocessor  statements  can  also  prevent  the recognition of a
       global definition, for example,

        char flag
        #ifdef ALLOCATE_STORAGE
             = -1
        #endif
        ;

       A function declaration inside a function is incorrectly recognized
       as a function call, for example,

        f()
        {
                void g();
        }

       is incorrectly recognized as a call to g.

       cscope  recognizes  C++  classes by looking for the class keyword,
       but doesn't recognize that a struct is also a class, so it doesn't
       recognize  inline  member  function definitions in a structure. It
       also doesn't expect the class keyword in a typedef , so it  incor­
        ParseTable::Recognize(int startState, char *pattern,
          int finishState, void (*FinalAction)(char *))
        {
          ...
        }

The Santa Cruz Operation  November 2000                 CSCOPE(1)

An undefined database error occurred. SELECT distinct pages.pagepath,pages.pageid FROM pages, page2command WHERE pages.pageid = page2command.pageid AND commandid =


  
Help us cut cost by not downloading the whole site!
Use of automated download sofware ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and therefore is expressedly prohibited. For more details on this, take a look here

Login
Nickname

Password

Security Code
Security Code
Type Security Code


Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!


Amazon Wish List

Did You Know?
The Linux Tutorial welcomes your suggestions and ideas.


Friends



Tell a Friend About Us

Bookmark and Share



Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.07 Seconds