summaryrefslogtreecommitdiff
path: root/Master/tlpkg
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2024-04-25 22:15:30 +0000
committerKarl Berry <karl@freefriends.org>2024-04-25 22:15:30 +0000
commit55c293a267ce95c8f319b59354e86e523245b774 (patch)
treeca4aaac2c5f56b7520382af3790c76f9bfd7827a /Master/tlpkg
parentcf99d1ac0b2c66dc815ddafad26b80515ba802e8 (diff)
json doc
git-svn-id: svn://tug.org/texlive/trunk@71079 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg')
-rw-r--r--Master/tlpkg/doc/json-formats.txt20
1 files changed, 10 insertions, 10 deletions
diff --git a/Master/tlpkg/doc/json-formats.txt b/Master/tlpkg/doc/json-formats.txt
index 9db666eabfb..b0bca6a7364 100644
--- a/Master/tlpkg/doc/json-formats.txt
+++ b/Master/tlpkg/doc/json-formats.txt
@@ -4,7 +4,7 @@ $Id$
JSON formats for the various outputs of tlmgr
=============================================
-Fields guaranteed to be present are marked with a *
+Fields guaranteed to be present are marked with a *.
TLPOBJ
------
@@ -40,7 +40,6 @@ exception (docfiles and docfiledata are merged). Details:
- cataloguedata: keys are topics, version, license, ctan, date, related (all strings)
Example: { "topics": "graphic", "version": "1.23" }
-
Note: A minimal TLPOBJ might look like
{
"name": "minimal",
@@ -49,7 +48,6 @@ Note: A minimal TLPOBJ might look like
}
-
TLPOBJINFO
----------
This JSON format is dumped on tlmgr info --data json and is slightly different
@@ -78,8 +76,8 @@ JSON object with the following fields:
TLPDB
-----
This format is used when dumping tlpdb, local or remote
-JSON object with the following fields:
-keys are tags, values are tlpdb in TLPDBSINGLE format
+JSON object with the following fields.
+Keys are tags, values are tlpdb in TLPDBSINGLE format.
Example:
{
"main": {
@@ -92,6 +90,7 @@ Example:
}
}
+
TLBACKUP
--------
This format is used when dumping available backups via the
@@ -115,7 +114,7 @@ Example:
TLPAPER
-------
-array of objects, each one having three keys: program, file, options.
+An array of objects, each one having three keys: program, file, options.
`program' gives the program name, `file' the place where the configuration
has been found, and `options' is an array of strings with the first
one being the currently selected paper.
@@ -132,8 +131,8 @@ Example for one element of the array:
TLOPTION / TLSETTING
--------------------
-each option/setting is an object with the following keys, values
-are all strings(!)
+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:
@@ -147,7 +146,7 @@ Example TLOPTIONS:
"default" : "1",
"name" : "install_srcfiles"
},
-Example TLSETTING
+Example TLSETTING:
{
"type" : "b",
"description" : "This tree acts as user tree",
@@ -155,4 +154,5 @@ Example TLSETTING
},
-
+TLSEARCH
+--------