summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc
diff options
context:
space:
mode:
Diffstat (limited to 'Master/tlpkg/doc')
-rw-r--r--Master/tlpkg/doc/repository-setup.txt36
1 files changed, 27 insertions, 9 deletions
diff --git a/Master/tlpkg/doc/repository-setup.txt b/Master/tlpkg/doc/repository-setup.txt
index 85f8d96fc6e..74e7f1570cb 100644
--- a/Master/tlpkg/doc/repository-setup.txt
+++ b/Master/tlpkg/doc/repository-setup.txt
@@ -13,7 +13,7 @@ can use it. Possible applications include distribution of company-internal
packages or non-free stuff not included in TeX Live.
The current document is based on the status of the TeX Live repository
-scripts as of 2018-02-12.
+scripts as of 2018-02-13.
Please write tex-live@tug.org if questions or suggestions.
@@ -80,8 +80,18 @@ from there. See Section 9 for an example management script.
2. Preparing your repository
----------------------------
-Create a root folder which will mirror our directory layout. We will call
-that root folder ROOT from now on.
+You will have to deal with two different folders on your system:
+* The preparation place, where you collect the files of the packages
+ and create the necessary configuration files.
+ We will refer to this folder as
+ ROOT
+ In TeX Live this would be the subversion repository.
+* The generated repository which will be synced to some web server
+ and accessed via tlmgr. This folder will be generated and maintained
+ by the scripts mentioned in this document.
+ We will refer to this folder as
+ NETROOT
+ In TeX Live this would be the 'tlnet' folder.
Put all of YOUR files in a TDS compliant way into the texmf-dist folder:
ROOT/texmf-dist
@@ -170,6 +180,9 @@ want to understand that, read the section on auto-generated patterns in
the TLPSRC.pm documentation (and don't forget to copy
00texlive.autopatterns.tlpsrc).
+For more documentation concerning patterns and autopatterns, see the
+POD documentation in TLPSRC.pm.
+
4. Creating the TeX Live Database
---------------------------------
@@ -203,6 +216,11 @@ Normally if there is an old tlpdb the packages in the new one are compared
with the packages in the old one and checked that the revisions are
increasing.
+Passing in
+ -master ROOT
+should allow you to run the script from an arbitrary directory, but
+we recommend running it from within the ROOT folder.
+
As usual, please read the documentation of tl-update-tlpdb (again in POD)
for further information.
@@ -252,7 +270,7 @@ can create or update your web distribution with
perl PATH-TO/tl-update-containers OPTIONS
OPTIONS:
--location DEST
+-location NETROOT
The -location gives the place where your former distribution was or where
it should be created. In the former case only those containers with larger
revision numbers are recreated. In the latter case all containers are
@@ -277,12 +295,12 @@ tl-update-containers.
----------------------------
Having completed all these steps, you can test your distribution by calling
the TeX Live Manager with the location argument. Continuing the above
-example we use DEST:
- tlmgr -location DEST update --list
+example we use NETROOT:
+ tlmgr -location NETROOT update --list
or
- tlmgr -location DEST update --all
+ tlmgr -location NETROOT update --all
or
- tlmgr -location DEST list
+ tlmgr -location NETROOT list
etc. Please see the documentation of tlmgr (POD again) for details.
@@ -292,7 +310,7 @@ Since 2016 tlmgr is able to check cryptographic signatures and thus
verify that the downloaded packages are what is distributed by the
author/maintainer (you reading this document).
-If you don't to sign, please pass
+If you don't want to sign, please pass
-no-sign
to tl-update-containers above.