/ program / 2.0 / bashcompletion.html

Table of content

Parameters

Variables

Templates

Details

Parameters

prg.bash.completion.programFileExtension

Variables

prg.bash.completion.completionFunctionName="__ _bashcompletion"

Default value: __ _bashcompletion
prg.bash.completion.getArgOptionFunctionName="__ _getoptionname"

Default value: __ _getoptionname
prg.bash.completion.appendFileSystemItemsFunctionName="__ _appendfsitems"

Default value: __ _appendfsitems
programGetFindPermissionOptionsFunctionName="__ _getfindpermoptions"

Default value: __ _getfindpermoptions

Templates

prg.bash.completion.itemList(path, prepend, separator, quoted="false()")

Chunks
  1. path
  2. prepend
  3. separator
  4. quoted
    Default value: false()
prg.bash.completion.compreplyAddFoldersSlashes(variableName="COMPREPLY")

Add trailing folder / to all folder results
  1. variableName
    Default value: COMPREPLY
prg.bash.completion.compreplyAddSpaces()
prg.bash.completion.shellFunctionName(name)
  1. name
prg.bash.completion.subCommandCompletionFunctionName(subcommand=".", name)
  1. subcommand
    Default value: .
  2. name
prg.bash.completion.appendFileSystemItemFunction()
prg.bash.completion.getArgOptionNameFunction()

"" <=> not an argument
prg.bash.completion.getFindPermissionsOptionsFunction()
prg.bash.completion.argumentCompletion(optionName="option", path, todo)
  1. optionName
    Default value: option
  2. path
  3. todo
prg.bash.completion.argumentCompletionByTypeBlock(path, optionName="option", currentVarName="current")
  1. path
  2. optionName
    Default value: option
  3. currentVarName
    Default value: current
prg.bash.completion.argumentCompletionString(optionName="option", currentVarName="current")
  1. optionName
    Default value: option
  2. currentVarName
    Default value: current
prg.bash.completion.argumentCompletionEnum(optionName="option", currentVarName="current", root=".")
  1. optionName
    Default value: option
  2. currentVarName
    Default value: current
  3. root
    Default value: .
prg.bash.completion.argumentCompletionCompgenBased(optionName="option", currentVarName="current", compgenOptions, postProcess)
  1. optionName
    Default value: option
  2. currentVarName
    Default value: current
  3. compgenOptions
  4. postProcess
prg.bash.completion.argumentCompletionCommand(optionName="option", currentVarName="current", root)
  1. optionName
    Default value: option
  2. currentVarName
    Default value: current
  3. root
prg.bash.completion.argumentCompletionHostname(optionName="option", currentVarName="current", root)
  1. optionName
    Default value: option
  2. currentVarName
    Default value: current
  3. root
prg.bash.completion.argumentCompletionPath(optionName="'option'", currentVarName="'current'", root)

Add path type related restrictions
  1. optionName
    Default value: 'option'
  2. currentVarName
    Default value: 'current'
  3. root
prg.bash.completion.argumentCompletionOther(optionName="option", currentVarName="current", root)
  1. optionName
    Default value: option
  2. currentVarName
    Default value: current
  3. root
prg.bash.completion.subcommandCompletionFunction(subcommand=".")

declare a subcommand option completion function
  1. subcommand
    Default value: .
prg.bash.completion.main(program="..")

The main template Called only if prg:program/prg:name exists
  1. program
    Default value: ..