Documentation for tl-portable

git-svn-id: svn://tug.org/texlive/trunk@7077 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 44 insertions, 0 deletions

diff --git a/Master/tlpkg/doc/tl-portable.txt b/Master/tlpkg/doc/tl-portable.txt
new file mode 100644
index 00000000000..5ed43b977e6
--- /dev/null
+++ b/Master/tlpkg/doc/tl-portable.txt
@@ -0,0 +1,44 @@
+Running the TeX Live dvd without installation
+---------------------------------------------
+
+Unix/Linux: in a terminal, run tl-portable.sh, which is in the root
+directory of the dvd. This starts up a secondary shell with the
+necessary environment settings. When the script runs for the first
+time, some files will be generated in a directory .texlive2008 under
+the user's home directory. On subsequent runs, the secondary shell
+will start almost instantaneously.
+
+Windows: either double-click tl-portable.bat in the root of the dvd,
+or run it from a command prompt. As under Unix, the first time some
+files have to be generated, this time under c:\Documents and
+Settings\<username>\.texlive2008. Subsequent times, the batchfile
+finishes almost instanteneously.
+
+On either platform, you can run several parallel TeXLive
+terminals/command prompts.
+
+TeX Live on a usb stick
+-----------------------
+
+Copy the bin, texmf, texmf-dist and tlpkg directories to your usb
+stick. Also copy all the files in the root. If you place a
+texmf-local directory in the root it will also be found and used. In
+this case, tl-portable will notice that the usb stick is writable
+and use it for generated files. You can burn the contents of the usb
+stick back to dvd.
+
+Customization
+-------------
+
+Instead of a secondary shell or command prompt, you can make
+variations of tl-portable which start a TeX-aware editor instead of
+a secondary shell or command prompt.
+
+.texlua filetype
+----------------
+
+Under Windows, registry entries are created to associate .texlua
+files with texlua.exe. These are per-user entries, but there is no
+way to restrict the effect to a particular session. So this is a
+definite lapse in perfect portability and may even interfere with a
+properly installed TeXLive.