TracNav

Command Reference

In progress, previous version can be found at: http://www.helgaproject.org/docs/Helga_Command_Reference.pdf

This is the Helga Shell v1.0 Command Reference. All commands implemented in the Shell should be listed here.

Though this documentation should be kept up to date, you can always generate on-the-fly documentation for any Shell command by running the Shell command "husage <command name>".

Library definition files for Shell Commands are located in <helga root>/global/wc/scripts/lib/.

Global Commands

Code for global commands is located in global.tcl.

Namespace Commands ("Helper Procs")

Code for each subnamespace is in a file of the same name, e.g. for ::helga::assets it is located in assets.tcl.

  • ::helga
    • ::assets
      • getAssetIdAndName
      • getAssetIdAndBaseName
      • expandAssetPath
      • getAssetIdFromName
      • getBaseNameFromId
      • getTypeIdFromName
      • assetExists
      • getTypeChain
      • isAnAssetType
      • listCheck
      • getListAndBase
      • fixListPositions
      • splitPath
      • getClosestPath
      • getAssetNameAndSuffix
      • getThingIdAndType
    • ::command
      • parseArgs
      • mergeArgs
      • formatTextForWeb
      • tcpEval
    • ::db
      • init/initialize
      • select
      • insert
      • update
      • delete
      • batch
      • checkConnection
      • getTableFields
      • fieldExists
      • buildFieldString
      • databaseExists
    • ::log
      • getEntryIdFromName
      • isALogEntry
    • ::tasks
      • getTaskIdFromNAme
      • isATask
      • areLinked
    • ::user
      • checkPermissions
      • getUserIdFromName
      • getSessionUserId
      • getSessionPort
      • isWebUser
      • denyWebUser