summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc/historic/Shell-API.txt
blob: b4bae1b6448204dc087b12ef8116035c22d421fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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?