summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc
diff options
context:
space:
mode:
authorNorbert Preining <preining@logic.at>2017-11-14 06:51:51 +0000
committerNorbert Preining <preining@logic.at>2017-11-14 06:51:51 +0000
commit471d3a9f2891620433afd016d281adb38a84ae64 (patch)
tree4030a5a958a52f5be92d438373187eb048fc00b4 /Master/tlpkg/doc
parentcc70d55f269ef72dd3b570318812e77d51c677c1 (diff)
option/setting json: change format, all strings, document format
git-svn-id: svn://tug.org/texlive/trunk@45793 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/doc')
-rw-r--r--Master/tlpkg/doc/JSON-formats.txt81
1 files changed, 26 insertions, 55 deletions
diff --git a/Master/tlpkg/doc/JSON-formats.txt b/Master/tlpkg/doc/JSON-formats.txt
index 3447a819f4d..b44966bacf4 100644
--- a/Master/tlpkg/doc/JSON-formats.txt
+++ b/Master/tlpkg/doc/JSON-formats.txt
@@ -65,34 +65,11 @@ TLPDBSINGLE
-----------
JSON object with the following fields:
* Object type:
- - options: keys are the tlmgr names of %TLConfig::TLPDBOptions, that is
- . Number type: autobackup, fileassocs
- . Boolean type: formats, desktop_integration, generate_updmap, docfiles,
- srcfiles, postcode, w32_multi_user
- . String type: backupdir, location, sys_bin, sys_info, sys_man
- . Object type: repository: keys are tags, values are Strings
- if there is only one location then the tag is "main"
- Example:
- "options": {
- "autobackup": 2,
- "formats": false,
- "postcode": true,
- "backupdir": "/backup/tl",
- "repository": {
- "main": "http://mirror.ctan.org/systems/texlive/tlnet",
- "tlcontrib": "..."
- }
- }
-
- - settings: keys are the names of %TLConfig::TLPDBSettings, that is
- . Boolean type: usertree
- . String type: platform
- . Array type: available_architectures (Strings)
-
+ - options: see TLOPTION below
+ - settings: see TLSETTING below
- configs: keys are the names of %TLConfig::TLPDBConfigs, that is
. Boolean type: container_split_src_files, container_split_doc_files
. String type: container_format, minrelease, release
-
* Array type:
- tlpkgs: JSON array of TLPOBJs in JSON format
@@ -152,35 +129,29 @@ Example for one element of the array:
}
-TLOPTIONS
----------
-one object with keys are the option names and values are as follows:
-- String for options: sys_bin, sys_info, sys_man, backupdir
-- Boolean: install_srcfiles, install_docfiles, generate_updmap,
- w32_multi_user, desktop_integration, create_formats, post_code
-- Number: file_assocs, autobackup
-- Object: location: keys are tags, values are URLs (Strings)
-Example:
-{
- "sys_bin" : "/usr/local/bin",
- "sys_info" : "/usr/local/share/info",
- "sys_man" : "/usr/local/share/man",
- "file_assocs" : 1,
- "location" : {
- "main" : "/home/norbert/public_html/tlnet",
- "tlcritical" : "/home/norbert/public_html/tlcritical",
- },
- "autobackup" : 1,
- "install_srcfiles" : true,
- "post_code" : true,
- "create_formats" : true,
- "backupdir" : "tlpkg/backups",
- "w32_multi_user" : true,
- "desktop_integration" : true,
- "generate_updmap" : false,
- "install_docfiles" : true
-}
+TLOPTION / TLSETTING
+--------------------
+each option/setting is an object with the following keys, values
+are all strings(!)
+for TLOPTIONS:
+ name, tlmgrname, description, format, default, value (optional)
+for TLSETTING:
+ name, description, format, value (optional)
+Example TLOPTIONS:
+ {
+ "format" : "b",
+ "description" : "Install source files",
+ "tlmgrname" : "srcfiles",
+ "value" : "1",
+ "default" : "1",
+ "name" : "install_srcfiles"
+ },
+Example TLSETTING
+ {
+ "type" : "b",
+ "description" : "This tree acts as user tree",
+ "name" : "usertree"
+ },
+
-TODO
- UPDATE JSON format