1Packaging hints for binary package distributors
2===============================================
3
4Although the source of the gettext package comes as a single package,
5I recommend that in distributions of binary packages the installed files
6be split into three packages:
7
8   gettext-runtime
9        Contents: Runtime libraries and programs.
10        Audience: Anyone who wants to run internationalized programs.
11
12   libtextstyle
13        Contents: Text styling library.
14        Audience: Anyone who wants to run or develop programs that produce
15                  styled text, to be displayed in a terminal emulator.
16
17   gettext-tools
18        Contents: Tools and documentation for developers and translators.
19        Audience: Anyone who wants to develop or localize internationalized
20                  programs, i.e. developers and translators.
21        Dependencies: requires gettext-runtime.
22
23The 'gettext-runtime' binary package is much smaller than the 'gettext-tools'
24binary package (420 KB versus 5.5 MB). I recommend to include it in the default
25installation list, like GNU 'coreutils'; in fact, the runtime programs are
26utilities for sh programs.
27
28The 'gettext-runtime' binary package can be installed by doing
29
30      cd gettext-runtime
31      ./configure
32      make
33      make install
34
35The 'libtextstyle' binary package can be installed by doing
36
37      cd libtextstyle
38      ./configure
39      make
40      make install
41
42The 'gettext-tools' binary package can be installed by doing
43
44      cd gettext-tools
45      ./configure --with-installed-libtextstyle --with-installed-csharp-dll
46      make
47      make install
48
49If you want to install all three at the same time, you simply do at the
50top-level directory:
51
52      ./configure
53      make
54      make install
55
56The precise split between gettext-runtime, libtextstyle, and gettext-tools
57is according to the following file list.
58
59   gettext-runtime
60
61      $prefix/share/gettext/ABOUT-NLS
62
63      $prefix/bin/gettext
64      $prefix/bin/ngettext
65      $prefix/bin/envsubst
66      $prefix/bin/gettext.sh
67      $prefix/share/man/man1/gettext.1
68      $prefix/share/man/man1/ngettext.1
69      $prefix/share/man/man1/envsubst.1
70      $prefix/share/doc/gettext/gettext.1.html
71      $prefix/share/doc/gettext/ngettext.1.html
72      $prefix/share/doc/gettext/envsubst.1.html
73      $prefix/share/locale/*/LC_MESSAGES/gettext-runtime.mo
74
75      $prefix/lib/libintl.*               (not installed on glibc and Solaris 11 systems)
76      $prefix/share/locale/locale.alias   (not installed on glibc and Solaris 11 systems)
77      $prefix/include/libintl.h           (not installed on glibc and Solaris 11 systems)
78      $prefix/share/man/man3/*
79      $prefix/share/doc/gettext/*.3.html
80
81      $prefix/share/gettext/libintl.jar
82      $prefix/share/doc/gettext/javadoc2/*
83
84      $prefix/lib/GNU.Gettext.dll
85      $prefix/share/doc/gettext/csharpdoc/*
86
87      $prefix/lib/libasprintf.*
88      $prefix/include/autosprintf.h
89      $prefix/share/doc/libasprintf/autosprintf*.html
90      $prefix/share/info/autosprintf.info
91
92   libtextstyle
93
94      $prefix/lib/libtextstyle.*
95      $prefix/include/textstyle.h
96      $prefix/include/textstyle/*
97      $prefix/share/doc/libtextstyle/libtextstyle*.html
98      $prefix/share/info/libtextstyle.info
99
100   gettext-tools
101
102      Everything else, i.e. currently:
103
104      $prefix/bin/msg*
105      $prefix/bin/xgettext
106      $prefix/bin/gettextize
107      $prefix/bin/autopoint
108      $prefix/bin/recode*
109      $prefix/share/man/man1/msg*.1
110      $prefix/share/man/man1/xgettext.1
111      $prefix/share/man/man1/gettextize.1
112      $prefix/share/man/man1/autopoint.1
113      $prefix/share/man/man1/recode*.1
114      $prefix/share/doc/gettext/msg*.1.html
115      $prefix/share/doc/gettext/xgettext.1.html
116      $prefix/share/doc/gettext/gettextize.1.html
117      $prefix/share/doc/gettext/autopoint.1.html
118      $prefix/share/doc/gettext/recode*.1.html
119      $prefix/share/doc/gettext/gettext_*.html
120      $prefix/share/doc/gettext/FAQ.html
121      $prefix/share/doc/gettext/tutorial.html
122      $prefix/share/doc/gettext/examples/*
123      $prefix/share/info/gettext.info*
124      $prefix/include/gettext-po.h
125      $prefix/lib/libgettextlib*
126      $prefix/lib/libgettextsrc*
127      $prefix/lib/libgettextpo*
128      $prefix/lib/preloadable_libintl.so  (only installed on glibc systems)
129      $prefix/lib/gettext/*
130      $prefix/share/locale/*/LC_MESSAGES/gettext-tools.mo
131      $prefix/share/gettext/config.rpath
132      $prefix/share/gettext/po/*
133      $prefix/share/gettext/projects/*
134      $prefix/share/gettext/styles/*
135      $prefix/share/gettext/gettext.h
136      $prefix/share/gettext/gettext.jar
137      $prefix/share/gettext/javaversion.class
138      $prefix/share/gettext/msgunfmt.tcl
139      $prefix/share/gettext/archive.git.tar.*
140      $prefix/share/gettext/archive.dir.tar.*   (only installed if --without-git specified)
141      $prefix/share/gettext/archive.cvs.tar.*   (only installed if --with-cvs specified)
142      $prefix/share/gettext-$VERSION/its/*
143      $prefix/share/aclocal/gettext.m4
144      $prefix/share/aclocal/host-cpu-c-abi.m4
145      $prefix/share/aclocal/iconv.m4
146      $prefix/share/aclocal/intlmacosx.m4
147      $prefix/share/aclocal/lib-ld.m4
148      $prefix/share/aclocal/lib-link.m4
149      $prefix/share/aclocal/lib-prefix.m4
150      $prefix/share/aclocal/nls.m4
151      $prefix/share/aclocal/po.m4
152      $prefix/share/aclocal/progtest.m4
153      $prefix/share/emacs/site-lisp/po-compat.el
154      $prefix/share/emacs/site-lisp/po-compat.elc
155      $prefix/share/emacs/site-lisp/po-mode.el
156      $prefix/share/emacs/site-lisp/po-mode.elc
157      $prefix/share/emacs/site-lisp/start-po.el
158      $prefix/share/emacs/site-lisp/start-po.elc
159
160
161Java support:
162-------------
163
164If some Java implementation is available, two programs will be compiled to
165Java bytecode:
166      $prefix/share/gettext/gettext.jar
167and the gettext-tools package will therefore have a runtime dependency to
168the Java virtual machine (OpenJDK, Oracle Java, IBM Java, or other).
169
170
171C# support:
172-----------
173
174For C# support, mono must be available at build time and at run time.
175