Я не думаю, что есть только один хороший способ сделать это.
Многие функции, сценарии и другие исполняемые файлы предоставляют справочное сообщение, если пользователь предоставляет -h
или - help
в качестве опции:
$ foo() {
[[ "$1" =~ (-h|--help) ]] && { cat <<EOF
Usage: foo [bar]
Foo's a bar into a baz
EOF
return;
}
: ...other stuff...
}
Например:
$ foo -h
Usage: foo [bar]
Foo's a bar into a baz
$ foo --help
Usage: foo [bar]
Foo's a bar into a baz