Làm thế nào để ghi lại các hàm bash và bí danh tùy chỉnh của tôi?

Vấn đề:

Tôi có nhiều hàm bash và bí danh. Tôi không thể nhớ tất cả chúng ở trên đỉnh đầu của mình, vì vậy tôi thường mở các tệp .bash_functionsvà .bash_aliasestệp của mình để tìm thứ tôi cần.

Câu hỏi:

Làm cách nào tôi có thể liệt kê các hàm / bí danh có sẵn từ dấu nhắc bash?

Tôi có thể ghi lại các hàm / bí danh bash của mình bằng cách sử dụng các nhận xét (giống như PHPDoc) không?

Tôi chỉ muốn một cách đơn giản / tốt đẹp để xuất ra những gì có sẵn mà không cần phải mở các tệp. Sẽ thật tuyệt khi chạy một lệnh và yêu cầu nó đưa ra một danh sách động các chức năng / bí danh của tôi (ví dụ sử dụng sẽ là một điểm cộng). :)

Để liệt kê các bí danh hoạt động, hãy chạy:

alias

Để xem tên của tất cả các chức năng hoạt động, hãy chạy:

declare -F

Để xem tên và định nghĩa của tất cả các chức năng hoạt động, hãy chạy:

declare -f

Hơn

Thông tin về bí danh cũng có sẵn ở định dạng thân thiện với tập lệnh với:

declare -p BASH_ALIASES

man bashcung cấp thêm thông tin về aliasnội dung:

   alias [-p] [name[=value] ...]
          Alias with  no  arguments  or  with  the  -p
          option  prints  the  list  of aliases in the
          form alias name=value  on  standard  output.
          When  arguments  are  supplied,  an alias is
          defined for each name whose value is  given.
          A  trailing  space in  value causes the next
          word to be checked  for  alias  substitution
          when  the  alias is expanded.  For each name
          in the argument list for which no  value  is
          supplied, the name and value of the alias is
          printed.  Alias returns true unless  a  name
          is   given  for  which  no  alias  has  been
          defined.

Về các chức năng, man bashgiải thích rằng declarecó thể cung cấp thêm thông tin có sẵn nếu extdebugtùy chọn được đặt:

   Function  names  and definitions may be listed with
   the -f option to the  declare  or  typeset  builtin
   commands.  The -F option to declare or typeset will
   list the function names only  (and  optionally  the
   source  file and line number, if the extdebug shell
   option is enabled).

Liên kết

1. http://ss64.com/bash/alias.html
2. http://linfo.org/alias.html

Tôi sử dụng chức năng sau đây và javadoc như bình luận để tạo tùy chọn --help cho tập lệnh của mình:

PROG=$0 #The program name, used within doHelp

# Print a help message
# doHelp uses lines starting with ## to create the output
# the tags {@param ...} and {@code ...} colorize words
doHelp() {
grep '^##' "${PROG}" |
sed -e 's/^##[[:space:]]*//' |
while read line; do
    if ( echo "${line}" | grep -q '{@param [^}]*}' ); then
        # color parameter and echo evaulated value
        eval echo -e $(echo ${line} | sed \
            -e 's/^\(.*\){@param \([^}]*\)}\(.*\)$/\
            \"\1\\\\E[32;40m\2\\\\E[37;40m\\t(value: \"$\2\")\3\"/');
    else
        # other color commands
        echo -e $(echo ${line} | sed \
            -e 's/{@code \([^}]*\)}/\\E[36;40m\1\\E[37;40m/g');
    fi
done;
}

Tại https://github.com/kaspervandenberg/aida/blob/master/Search/zylabPatisClient/src/main/scripts/generateReport.sh bạn có thể thấy nó được sử dụng như thế nào trong một tập lệnh thực tế.