example(): bash function to create a nicely formatted example of a shell command and its output #bash #tutorial #document

README.md

example(): bash function to create a nicely formatted example of a shell command and its output.

example() { echo "EXAMPLE:"; echo; echo " $@"; echo; echo "OUTPUT:"; echo ; eval "$@" | sed 's/^/ /'; }

Sample Output:

EXAMPLE:

    example ls -l

OUTPUT:

    EXAMPLE:
    
        ls -l
    
    OUTPUT:
    
        total 0
        -rw-rw-r-- 1 bartonc bartonc 0 Nov 10 13:58 a
        -rw-rw-r-- 1 bartonc bartonc 0 Nov 10 13:58 b
        -rw-rw-r-- 1 bartonc bartonc 0 Nov 10 13:58 c

First seen: https://www.commandlinefu.com/commands/view/24726/create-a-nicely-formatted-example-of-a-shell-command-and-its-output