Super User is a question and answer site for computer enthusiasts and power users. It's 100% free, no registration required.

Sign up
Here's how it works:
  1. Anybody can ask a question
  2. Anybody can answer
  3. The best answers are voted up and rise to the top

I work in an environment that has a lot of legacy shell script magic lying around. One thing used heavy from the command line are bash functions that get sourced from some file included from some file included from some file ... included in my .bash_profile. Is there a way to get the definition or even better the location of the definition of these functions without tracking them down through 5 levels of includes?

share|improve this question
up vote 18 down vote accepted

To get the function definition:

type -a function_name
share|improve this answer
1  
Can I buy you a beer!? – iconoclast Jan 22 at 19:26
    
@iconoclast: Yes. – Dennis Williamson Jan 22 at 19:35
    
If you're ever in Grand Rapids I'll buy you one in person... otherwise we can find some other way... – iconoclast Jan 23 at 21:05

Assuming you have a function named foo the commands below will get the location of the function's definition, that is it will get the name of the file in which the function is defined as well as the line number at which the function is defined within that file.

# Turn on extended shell debugging
shopt -s extdebug

# Dump the function's name, line number and fully qualified source file  
declare -F foo

# Turn off extended shell debugging
shopt -u extdebug

In my case the output of these commands is:

foo 32 /source/private/main/developer/cue.pub.sh
share|improve this answer
2  
Perfect. I just made this into a bash function in my bashrc file. whereisfunc() {shopt -s extdebug;declare -F $1;shopt -u extdebug} – Neil Feb 12 '15 at 3:49
    
@Neil: That's handy, thanks: let me suggest using a subshell to localize the effect of shopt without changing the current shell's state: whichfunc () ( shopt -s extdebug; declare -F "$1"; ) (note the use of (...) instead of {...}). – mklement0 Mar 7 at 21:43

To see the definition of the function (as opposed to where it came from), use:

declare -f <functionname>
share|improve this answer
    
I think this one is better than type -a because it doesn't print the annoy locale dependent first line~~ – yuyichao Mar 16 '12 at 1:50
    
but since there's no location given this is an answer to an unasked question—at least unasked here – iconoclast Jan 22 at 19:29

bash -x will dump what bash is running as it starts up, which should let you trace it more easily. Don't forget to exit the newly-opened shell.

share|improve this answer
    
Handy stuff; to capture the trace in a file, use script out.txt bash -x (again, don't forget to exit). – mklement0 Mar 8 at 2:43

another way, that I find even simpler lately:

  which <functionname>

(this will also show whether it's an alias or a script, but will not track down the source of an alias)

share|improve this answer
1  
I don't think which gives information about aliases on BSD or mac. Also, this question is about functions, and which does not give information about functions. – dbw Apr 8 '13 at 20:45
    
Thanks for that note. I see now that "which" only resolves functions in zsh, not bash. – Joshua Goldberg Apr 9 '13 at 1:57
2  
I think this answer is likely to invite downvotes... it doesn't seem to address the question at all, since there's no information on location. – iconoclast Jan 22 at 19:28
    
I've found it useful for the purpose of tracking down the declaration to use this and find out whether it's an alias or function, and to know the syntax with which it was declared. It's true though that only @HairOfTheDog's answer gives the file directly. – Joshua Goldberg Apr 26 at 19:42

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.