diff options
Diffstat (limited to 'Master/tlpkg/doc/Shell-API.txt')
-rw-r--r-- | Master/tlpkg/doc/Shell-API.txt | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/Master/tlpkg/doc/Shell-API.txt b/Master/tlpkg/doc/Shell-API.txt new file mode 100644 index 00000000000..b4bae1b6448 --- /dev/null +++ b/Master/tlpkg/doc/Shell-API.txt @@ -0,0 +1,37 @@ +API for Shell interface for new infra +===================================== + +bash will be used, POSIX maybe later + + +Module TLP +---------- + +Read/Write functions (with argument set, without arg read) + + tlp_get_{name,category,revision,shortdesc,longdesc,catalogue} $tlpfile + gets the respective field of the TLP + tlp_get_{src,doc,run}files $tlpfile + gets the list of {src,doc,run}files + tlp_get_{src,doc,run}size $tlpfile + gets the of the respective group of files + tlp_get_available_archs $tlpfile + returns the list of archs present in $tlpfile for binfiles + tlp_get_binfiles $tlpfle $arch + gets the list of binfiles for $arch + tlp_get_binsize $tlpfile $arch + gets the size of binfiles for $arch + tlp_get_{depends,executes} $tlpfile + returns a list depends/executes + + +Module TLDB +----------- + all function under TLP can be used with a tldb_ prefix: + tldb_tlp_get_{name,category,revision,...} $tldbfile "packagename" + gets the respective field of the TLP + + tldb_list_installed_packages $tldbfile + + what else do we need? + |