Utilitário

bashsrc (Utilitário)

Desenvolvido em shell script, o utilitário para consulta rápida de documentações via linha de comando, cuja opções podem ser facilmente acessadas através do comando:

$ bashsrc --help
bashsrc: ferramenta para consulta de documentação e ambiente.
Uso: bashsrc [OPÇÕES]

Argumentos obrigatórios para opções longas também são para opções curtas.

-l, --list                    - Lista os sources disponíveis em '$BASHSRC_PATH'
-e, --env                     - Exibe o ambiente configurado em '$BASHSRC_PATH'.
-d, --doc <src>[.funcname]    - Exibe a documentação do source ou função.
                                'src' refere-se ao nome da biblioteca a ser
                                consultada, omitindo a extensão '.sh' do arquivo.
                                Se '.funcname' for omitido é retornado o protótipo
                                de todas as funções disponíveis em 'src'.
-c, --check-conflicts           Verifica se há conflito de tipos em bibliotecas.
-h, --help                      Exibe ajuda e sai.
-v, --version                   Exibe a versão e sai.

Utilize o parâmetro [-d, --doc] para listar a documentação de uma função específica cuja informações descrevem o protótipo de declaração, argumentos, tipos e retorno da função.

Exemplos práticos também estão presentes para melhor entendimento.

Sintaxe:

bashsrc --doc <srcname>.<funcname>

Exemplo:

Exibindo a documentação da função ‘ismatch’ na biblioteca ‘regex’.

$ bashsrc --doc regex.ismatch
func regex.ismatch <[str]pattern> <[str]exp> <[uint]flag> => [bool]

Retorna 'true' se o padrão coincidir em 'exp', caso contrário retorna 'false'.

Se funcname for omitida, é exibido o protótipo de todas as funções e variáveis disponíveis.

Exemplo:

$ bashsrc --doc regex
readonly REG_ICASE=2 # [flag] - considera a diferença entre caracteres  maiúsuculos  e
minúsculos.
readonly REG_CASE=0 # [flag] - ignora a diferença entre caracteres maiúsculos e
minúsculos.
func regex.findall <[str]pattern> <[str]exp> <[uint]flag> => [str]
func regex.fullmatch <[str]pattern> <[str]exp> <[uint]flag> => [uint|uint|str]
func regex.match <[str]pattern> <[str]exp> [uint]flag => [str]
func regex.search <[str]pattern> <[str]exp> <[uint]flag> => [uint|uint|str]
func regex.split <[str]pattern> <[str]exp> <[uint]flag> => [str]
func regex.ismatch <[str]pattern> <[str]exp> <[uint]flag> => [bool]
func regex.groups <[str]pattern> <[str]exp> <[uint]flag> => [str]
func regex.savegroups <[str]pattern> <[str]exp> <[uint]flag> <[array]name>
func regex.replace <[str]pattern> <[str]exp> <[str]new>  <[int]count>  <[uint]flag>  =>
[str]
func regex.nreplace <[str]pattern> <[str]exp> <[str]new> <[uint]match> <[uint]flag> =>
[str]
func regex.fnreplace <[str]pattern> <[str]exp> <[func]funcname> <[int]count>
<[uint]flag> => [str]
func regex.fnnreplace <[str]pattern> <[str]exp> <[func]funcname> <[uint]match> <[uint]flag> => [str]

Exibindo os métodos de implementação de um tipo.

$ bashsrc --doc regex.regex_t
type regex_t

Implementa o(s) método(s) do objeto 'regex_t'.

Métodos:

S.findall
S.fullmatch
S.match
S.search
S.split
S.ismatch
S.groups
S.fngroups
S.fnngroups
S.savegroups
S.replace
S.nreplace
S.fnreplace
S.fnnreplace

'S' é o identificador da variável implementada.