dpkg-list-commands.sh

#!/bin/bash
# List commands provided by the specified package
# rwb[at]0x19e[dot]net

# Define RegEx for matching system bin directories
export BIN_REGEX="(sbin|bin)\/"

# Supported formats: plain, trac, markdown(?)
# export FORMAT="plain"

# Boolean controlling command usage (synopsis) inclusion
# export INC_SYNOP="true"

if [ -z "$1" ]; then
  echo >&2 "No package specified."
  echo "Usage: $0 <package>"
  exit 1
fi

if ! dpkg -s "$1" > /dev/null 2>&1; then
  echo >&2 "Package '$1' is not installed."
  exit 1
fi

if ! dpkg -L "$1" | grep  --quiet -P "$BIN_REGEX"; then
  echo >&2 "Package '$1' does not appear to install any commands."
  exit 1
fi

# Configure package name
PACKAGE_NAME="$1"

# Colors
export ESC_SEQ="\x1b["
export COL_RESET=$ESC_SEQ"39;49;00m"
export COL_RED=$ESC_SEQ"31;01m"
export COL_GREEN=$ESC_SEQ"32;01m"
export COL_YELLOW=$ESC_SEQ"33;01m"
export COL_BLUE=$ESC_SEQ"34;01m"
export COL_MAGENTA=$ESC_SEQ"35;01m"
export COL_CYAN=$ESC_SEQ"36;01m"

function get_plain() {
        for d in $(dpkg -L "$1" | grep -P "$BIN_REGEX" | sort); do \
                man_header=$(man -P cat "$(basename "$d")" 2>/dev/null | grep NAME -A1 | head -2 | tail -n1 )
                man_synopsis=$(man -P cat "$(basename "$d")" 2>/dev/null | grep SYNOPSIS -A1 | head -2 | tail -1)

                # remove leading whitespace and escape special characters
                # man_synopsis="${man_synopsis//^[ \t]+//}"

                # shellcheck disable=2001
                man_synopsis=$(echo "$man_synopsis" | sed -e 's/^[ \t]*//')

                if [ -n "$man_header" ]; then
                        echo "$man_header" | awk -v inc_synop="$INC_SYNOP" -v synop="$man_synopsis" -v x=0 -v N=2 'BEGIN {RS="\n\n"}; {OFS="\b"}; {FS="\b+(-|—)\b+"};
                                function print_command(string) {  printf ("%s%-38s%s", "\033[1;36m", string, "\033[0m"); }
                                function print_synopsis(string) { printf ("\n\t (%s%s%s)", "\033[1;35m", string, "\033[0m"); }
                                function start_yellow() { printf ("%s", "\033[1;33m"); }
                                function stop_yellow() { printf ("%s", "\033[0m"); }
                                {
                                        print_command($1);
                                        start_yellow();
                                        OFS=" "; sep=""; for (i=N+1; i<=NF; i++) {
                                        printf("%s%s",sep,$i);
                                        sep=OFS
                                        x=x+1
                                };
                                stop_yellow();
                                if(inc_synop=="true")
                                        print_synopsis(synop);
                                printf("\n");
                                x=0;
                        }'; \
                fi
        done
}

function get_report() {
        # print table header
        printf "%s" "$COL_RESET"
        printf '=%.0s' {1..68}
        printf '\n'
        printf "$COL_RED%-37s %s \n$COL_RESET" "Command" "Description"
        printf '=%.0s' {1..68}
        printf '\n'
        printf "%s" "$COL_RESET"

        if ! PLAIN=$(get_plain "$1"); then
                echo >&2 "ERROR: Failed to generate report."
                exit 1
        fi
        echo "${PLAIN}" | sort | uniq
}

function get_trac_cmdtbl() {
        for d in $(dpkg -L "$1" | grep -P "$BIN_REGEX" | sort); do \
                man_header=$(man -P cat "$(basename "$d")" 2>/dev/null | grep NAME -A1 | head -2 | tail -n1 )
                man_synopsis=$(man -P cat "$(basename "$d")" 2>/dev/null | grep SYNOPSIS -A1 | head -2 | tail -1)

                # remove leading whitespace and escape special characters
                # shellcheck disable=2001
                man_synopsis=$(echo "$man_synopsis" | sed -e 's/^[ \t]*//')

                if [ -n "$man_header" ]; then
                        echo "$man_header" | awk -v inc_synop="$INC_SYNOP" -v synop="$man_synopsis" -v x=0 -v N=2 'BEGIN {RS="\n\n"}; {OFS="\b"}; {FS="\b+(-|—)\b+"};
                                function print_command(string) {  printf ("|| %s || ", string); if(inc_synop=="true") print_synopsis(synop); }
                                function print_synopsis(string) { printf ("{{{%s}}} || ", string); }
                                {
                                        print_command($1);
                                        OFS=" "; sep=""; for (i=N+1; i<=NF; i++) {
                                        printf("%s%s",sep,$i);
                                        sep=OFS
                                        x=x+1
                                };
                                printf(" ||\n");
                                x=0;
                        }'; \
                fi
        done
}

function get_trac_table() {
        # print table header
        printf '== {{{%s}}}\n' "$1"

        if [ "$INC_SYNOP" == "true" ]; then
                printf '|| Command || Usage || Description ||\n'
        else
                printf '|| Command || Description ||\n'
        fi

        if ! WIKI=$(get_trac_cmdtbl "$1"); then
                echo >&2 "ERROR: Failed to generate Trac table."
                exit 1
        fi
        echo "${WIKI}" | sort | uniq
}

if [ -z "${FORMAT+set}" ]; then
	export FORMAT="default"
fi
if [ -z "${FORMAT}" ]; then
	echo >&2 "ERROR: Output format not specified."
	exit 1
fi

case "$FORMAT" in
	default|plain)
		if ! REPORT="$(get_report "${PACKAGE_NAME}")"; then
			exit 1
		fi
		echo -e "${REPORT}"
	;;
	trac|trac-table)
		if ! WIKI="$(get_trac_table "${PACKAGE_NAME}")"; then
			exit 1
		fi
                echo "${WIKI}"
	;;
	*)
		echo >&2 "ERROR: Unsupported output format '${FORMAT}'."
		exit 1
	;;
esac

exit 0