summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc
diff options
context:
space:
mode:
authorNorbert Preining <preining@logic.at>2007-06-16 16:40:35 +0000
committerNorbert Preining <preining@logic.at>2007-06-16 16:40:35 +0000
commit743cca7613b9a0948fa316f703a5861b4ba4e516 (patch)
treedcf1336c07536754972ef8214e96f7d04d205f6a /Master/tlpkg/doc
parent8e0118f7fbebfae6bab089e5d7b16fb86d3a5deb (diff)
reshuffle and clean up
git-svn-id: svn://tug.org/texlive/trunk@4442 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/doc')
-rw-r--r--Master/tlpkg/doc/Shell-API.txt37
-rw-r--r--Master/tlpkg/doc/list-file-format.txt33
2 files changed, 70 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?
+
diff --git a/Master/tlpkg/doc/list-file-format.txt b/Master/tlpkg/doc/list-file-format.txt
new file mode 100644
index 00000000000..72306b1dc77
--- /dev/null
+++ b/Master/tlpkg/doc/list-file-format.txt
@@ -0,0 +1,33 @@
+for collections:
+================
+first line
+ *Title: title
+second line
+ *Size: size-in-bytes
++name
+ included Packages/TPM
+ depending TLCore/TPM
+[a-zA-A0-9]+
+ included file
+
+for schemes:
+============
+first line
+ *Title: title
+second line
+ *Size: size-in-bytes
++name
+ included Packages/TPM
+-name
+ included TLCore/TPM
+
+
+all
+===
+!addMap name.map
+!addMixedMap name.map
+!BuildFormat name
+!BuildLanguageDat name
+
+
+