summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/ucs/INSTALL
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-04-20 23:22:18 +0000
committerKarl Berry <karl@freefriends.org>2012-04-20 23:22:18 +0000
commit5ade70efc58e89e317d3d339d625690086652043 (patch)
tree0047ddd27c3514a3037d90da7ed7c52ea98f4811 /Master/texmf-dist/doc/latex/ucs/INSTALL
parente036c78ef5115ea7d839a35e596601e48ea41c5c (diff)
ucs 2.0 (20apr12)
git-svn-id: svn://tug.org/texlive/trunk@26074 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/ucs/INSTALL')
-rw-r--r--Master/texmf-dist/doc/latex/ucs/INSTALL62
1 files changed, 40 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/ucs/INSTALL b/Master/texmf-dist/doc/latex/ucs/INSTALL
index 48af7a12277..d9e4571f416 100644
--- a/Master/texmf-dist/doc/latex/ucs/INSTALL
+++ b/Master/texmf-dist/doc/latex/ucs/INSTALL
@@ -1,35 +1,53 @@
+1. INSTALLATION
-To install this LaTeX UTF-8 support, simply put the files ucs.sty,
-utf8x.def, ucsencs.def and data/* somewhere in your TeX-path. If you
-want CJK characters, you need the c??enc.def files, too. For Klingon
-you need lklenc.def and lklkli.fd.
+To install, simply put the files ucs.sty, utf8x.def, ucsencs.def and
+data/* somewhere in your TeX-path. If you want CJK characters, you need
+the c??enc.def files, too. For Klingon you need lklenc.def and
+lklkli.fd.
-You may have to run some command like mktexlsr, lest the files will
-not be found by TeX. What to do, however, is distribution dependent.
+You may have to run some command like mktexlsr, lest the files will not
+be found by TeX. What to do, however, is distribution dependent.
Warning: If you install the files into some directory, where TeX does
-not search recursively (usually the current directory and your
-personal TeX directory are of that kind), you have to put the contents
-of data directly into that directory.
+not search recursively (usually the current directory and your personal
+TeX directory are of that kind), you have to put the contents of data
+directly into that directory.
-If you don't install data/uninames.dat, you will save abount 300 KB,
-but you won't get the full names of the characters in error messages.
+If you don't install data/uninames.dat, you will save about 300 KB, but
+you won't get the full names of the characters in error messages.
If you have added glyphs macros in one of the files in config (see
perldoc makeunidef.pl for information on the config file format), you
-have to recreate the files in data.
+have to recreate the files in data by running "make datafiles". This
+uses makeunidef.pl internally.
+
+You can also run the makeunidef.pl directly. When doing this, you may
+supply another target directory instead of data, e.g. some directory in
+your TeX-path. makeunidef.pl will not delete or overwrite any files it
+has not created itself. If you add "--exclude
+cjkbg5,cjkgb,cjkjis,cjkhangul", CJK characters will not be included,
+saving more than 1 MB of disk space.
-First you need UnicodeData.txt from
+2. GETTING THE SOURCE CODE REPOSITORY
- http://www.unicode.org/Public/UNIDATA/UnicodeData.txt
+Install darcs from <http://darcs.net/>, if you do not have done this
+yet. Then check out the ucs repository with the following command:
-(you may gzip it after downloading) and then you can recreate the files
-using
+ darcs get http://darcs.wolfgang.jeltsch.info/tex/ucs
- perl makeunidef.pl -t data --nocomments config/*.ucf config/*.ucf.gz
+3. BUILDING
-You may supply another target directory instead of data, e.g. some
-directory in your TeX-path. makeunidef.pl will not delete or overwrite
-any files it has not created itself. If you add "--exclude
-cjkbg5,cjkgb,cjkjis,cjkhangul", no CJK characters will not be included,
-saving more than 1 MB of disk space.
+If you are working with the source code repository, you will probably
+want to build the autogenerated files at some point. To do this, run
+(GNU) make in the root directory of the repository.
+
+4. CREATING A DISTRIBUTION BUNDLE
+
+Running
+
+ make dist
+
+in the root directory of the repository gives you a file ucs.tar.gz.
+This file contains all source files and all autogenerated files, and has
+the "executable" bit set for all scripts. It is intended for uploading
+to CTAN.