Get a list of function names in a shell script [duplicate]

by

You can get a list of functions in your script by using the grep command on your own script. In order for this approach to work, you will need to structure your functions a certain way so grep can find them. Here is a sample:

$ cat my.sh
#!/bin/sh

function func1() # Short description
{
    echo func1 parameters: $1 $2
}

function func2() # Short description
{
    echo func2 parameters: $1 $2
}

function help() # Show a list of functions
{
    grep "^function" $0
}

if [ "_$1" = "_" ]; then
    help
else
    "$@"
fi

Here is an interactive demo: 

$ my.sh 
function func1() # Short description
function func2() # Short description
function help() # Show a list of functions


$ my.sh help
function func1() # Short description
function func2() # Short description
function help() # Show a list of functions


$ my.sh func1 a b
func1 parameters: a b

$ my.sh func2 x y
func2 parameters: x y

If you have “private” function that you don’t want to show up in the help, then omit the “function” part:

my_private_function()
{
    # Do something
}

More Related Contents:

  1. What does set -e mean in a bash script?
  2. What does $@ mean in a shell script?
  3. Shell script: Run function from script over ssh
  4. Why does /bin/sh behave differently to /bin/bash even if one points to the other?
  5. Randomly shuffling lines in Linux / Bash
  6. What’s the point of eval/bash -c as opposed to just evaluating a variable?
  7. How do I prompt for Yes/No/Cancel input in a Linux shell script?
  8. ./configure : /bin/sh^M : bad interpreter [duplicate]
  9. What does “&” at the end of a linux command mean?
  10. The ‘eval’ command in Bash and its typical uses
  11. How to join multiple lines of file names into one with custom delimiter?
  12. Is there a way to ‘uniq’ by column?
  13. Linux: copy and create destination dir if it does not exist
  14. Why is a tilde in a path not expanded in a shell script?
  15. How to handle more than 10 parameters in shell
  16. Edit shell script while it’s running
  17. Linux bash: Multiple variable assignment
  18. Finding contents of one file in another file
  19. Changing default shell in Linux [closed]
  20. How to run a process with a timeout in Bash? [duplicate]
  21. Example of using named pipes in Linux shell (Bash)
  22. Passing variables in remote ssh command
  23. what does “-sh: executable_path:not found” mean
  24. Execute command after every command in bash
  25. How to join multiple lines of filenames into one with custom delimiter
  26. What is the difference between “./somescript.sh” and “. ./somescript.sh”
  27. Doesn’t sh support process substitution
  28. Linux shell script to add leading zeros to file names
  29. How to pass argument with exclamation mark on Linux?
  30. Need to remove the count from the output when using “uniq -c” command

Leave a Comment