SBROWSER(1) — USER COMMANDS
NAME
sbrowser — SunView and OpenWindows interface to Sun SourceBrowser
SYNOPSIS
sbrowser
AVAILABILITY
Available with Sun FORTRAN 1.4, Modula-2 2.3, Pascal 2.1, C 1.1, C++ 2.1
DESCRIPTION
sbrowser is the SunView and OpenWindows interface to Sun SourceBrowser, a source-level code browser. sbrowser starts the program sbrowser_sv if you are running SunView, or sbrowser_ow if you are running OpenWindows.
To collect data for SourceBrowser, add the -sb option to the compiler command line.
To use SourceBrowser, you issue queries which instruct SourceBrowser to find all occurrences of the symbol you have identified. These occurrences are called matches. After you have issued the query, you use SourceBrowser menu commands to display different matches found by the query and to move between queries.
SourceBrowser includes two commands for narrowing a search. The Filter command is used to search for symbols based on how they are used in a program. For example, you could limit your search to declarations of variables. The Focus command limits your search to instances of specific classes of code, such as particular programs, functions, or libraries.
SUNVIEW ENVIRONMENT
The following description of menu commands and buttons apply to SourceBrowser in the SunView window environment.
SHOW menu commands
Selected Match
Makes the selected match in the match subwindow the current match and displays the appropriate sections of code in the source window.
Current Match
Displays the current match in the source window.
Version
Displays SourceBrowser’s current version number.
ERASE menu commands
This Query
Erases the current query.
This Match
Erases the current match.
All Queries
Erases all active queries.
PREVIOUS menu commands
Previous Match: This Query
Makes the previous match found by the active query the current match.
Previous File
For the current query, makes the last match that occurs in the previous file that contains a match the current match.
Previous Function
For the current query, makes the last match that occurs in the previous function that contains a match the current match.
Previous Match: Any Query
Makes the previous match in the source window the current match.
NEXT menu commands
Next Match: This Query
Makes the next match found by the active query the current match.
Next File
For the current query, makes the first match that occurs in the next file that contains a match the current match.
Next Function
For the current query, makes the first match that occurs in the next function that contains a match the current match.
Next Match: Any Query
Makes the next match in the source window the current match.
FOCUS menu and FOCUS panel
The Focus menu contains classes of code appropriate to the language of the source code you are browsing. After you choose an item from the Focus menu, all of the available items from the class of code you have selected are displayed in the Focus panel. Use the Activate and Deactivate menus to activate and deactivate the items you want to use in your focused query.
FILTER button and FILTER panel
Clicking left on the Filter button displays the Filter panel. The Filter panel contains items such as declarations, references, and strings. The content of the Filter panel changes depending on the languages of the source code you are browsing. Select the item you want to use as your filter; then, conduct your query. When you make a different active query the current query, the settings in the Filter panel change to reflect the settings that were used to conduct that query.
QUERY button
Clicking left on the Query button causes SourceBrowser to search for the selected symbol.
UPDATE button
Clicking left on the Update button causes SourceBrowser to update the Index file. This button only appears if you have set the Keep Database Index Updated item in the property sheet to no.
OPENWINDOWS ENVIRONMENT
The following menu commands and buttons apply to SourceBrowser in the OpenWindows window environment.
VIEW menu commands
Selected Match
Makes the selected match in the match pane the current match and displays the appropriate line of code in the source window.
Current Match
Displays the current match in the source window.
Filter...
Activates the Filter pop-up window, which contains items such as declarations, references, and strings. The content of the Filter pop-up window changes depending on the languages of the source code you are browsing. Select the item you want to use as your filter. Then conduct your query. When you make a different active query the current query, the settings in the Filter pop-up window change to reflect the settings that were used to conduct that query.
Focus
Activates a submenu with items representing classes of code appropriate to the language of the source code you are browsing. After you choose an item from the Focus submenu, all of the available items from the class of code you have selected are displayed in the Focus pop-up window. Use the Activate and Deactivate menus to activate and deactivate the items you want to use in your focused query.
Version
Displays SourceBrowser’s current version number.
EDIT menu commands
Query Erase
Erases the current query.
Match Erase
Erases the current match.
All Queries Erase
Erases all active queries.
PROPS... button
Clicking SELECT on the Props... button activates the property sheet. Select the items you want to customize SourceBrowser to your needs. For example, you can tell SourceBrowser to use regular expressions when issuing a query that includes wildcards.
PREV menu commands
Match for this Query
Makes the previous match found by the active query the current match.
File
For the current query, makes the last match that occurs in the previous file that contains a match the current match.
Function
For the current query, makes the last match that occurs in the previous function that contains a match the current match.
Any Query
Makes the previous match in the source pane the current match.
NEXT menu commands
Match for this Query
Makes the next match found by the active query the current match.
File
For the current query, makes the first match that occurs in the next file that contains a match the current match.
Function
For the current query, makes the first match that occurs in the next function that contains a match the current match.
Any Query
Makes the next match in the source pane the current match.
QUERY button
Clicking SELECT on the Query button causes SourceBrowser to search for the selected symbol.
ACTION menu commands
Update DB Index
Causes SourceBrowser to update the database.
Set Directory
Activates the Set Directory pop-up window. To set the current working directory, type the directory name in the Text field and press return.
ENVIRONMENT
Environment variables store information SourceBrowser needs to know to browse the database.
HOME The name of the user’s login directory.
NSE_ENV The name of the activated NSE environment.
PWD The full pathname of the current directory.
SB_ATTEMPTS_MAX
The maximum number of times the index builder will try to access a locked database.
SUN_SOURCE_BROWSER_EX_FILE
The absolute pathname of the file sun_source_browser.ex .
SUN_SOURCE_BROWSER_INIT_FILE
The absolute pathname of the .sbinit file.
SEE ALSO
Sun SourceBrowser Reference Manual for SunView
Sun SourceBrowser Reference Manual for OpenWindows
— Last change: 2 January 1991