xref: /netbsd-src/external/gpl2/gettext/dist/PACKAGING (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
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 two packages:
7
8   gettext-runtime
9        Contents: Runtime libraries and programs.
10        Audience: Anyone who wants to run internationalized programs.
11
12   gettext-tools
13        Contents: Tools and documentation for developers and translators.
14        Audience: Anyone who wants to develop or localize internationalized
15                  programs, i.e. developers and translators.
16        Dependencies: requires gettext-runtime.
17
18The 'gettext-runtime' binary package is much smaller than the 'gettext-tools'
19binary package (420 KB versus 5.5 MB). I recommend to include it in the default
20installation list, like GNU 'coreutils'; in fact, the runtime programs are
21utilities for sh programs.
22
23The 'gettext-runtime' binary package can be installed by doing
24
25      cd gettext-runtime
26      ./configure
27      make
28      make install
29
30The 'gettext-tools' binary package can be installed by doing
31
32      cd gettext-tools
33      ./configure
34      make
35      make install
36
37If you want to install both at the same time, you simply do at the toplevel
38directory:
39
40      ./configure
41      make
42      make install
43
44The precise split between gettext and gettext-tools is according to the
45following file list.
46
47   gettext-runtime
48
49      $prefix/share/gettext/ABOUT-NLS
50
51      $prefix/bin/gettext
52      $prefix/bin/ngettext
53      $prefix/bin/envsubst
54      $prefix/bin/gettext.sh
55      $prefix/share/man/man1/gettext.1
56      $prefix/share/man/man1/ngettext.1
57      $prefix/share/man/man1/envsubst.1
58      $prefix/share/doc/gettext/gettext.1.html
59      $prefix/share/doc/gettext/ngettext.1.html
60      $prefix/share/doc/gettext/envsubst.1.html
61      $prefix/share/locale/*/LC_MESSAGES/gettext-runtime.mo
62
63      $prefix/lib/libintl.*               (not installed on glibc systems)
64      $prefix/lib/charset.alias           (not installed on glibc systems)
65      $prefix/share/locale/locale.alias   (not installed on glibc systems)
66      $prefix/include/libintl.h           (not installed on glibc systems)
67      $prefix/share/man/man3/*
68      $prefix/share/doc/gettext/*.3.html
69
70      $prefix/share/gettext/libintl.jar
71      $prefix/share/doc/gettext/javadoc1/*
72      $prefix/share/doc/gettext/javadoc2/*
73
74      $prefix/lib/GNU.Gettext.dll
75      $prefix/share/doc/gettext/csharpdoc/*
76
77      $prefix/lib/libasprintf.*
78      $prefix/include/autosprintf.h
79      $prefix/share/doc/libasprintf/autosprintf.html
80      $prefix/info/autosprintf.info
81
82   gettext-tools
83
84      Everything else, i.e. currently:
85
86      $prefix/bin/msg*
87      $prefix/bin/xgettext
88      $prefix/bin/gettextize
89      $prefix/bin/autopoint
90      $prefix/bin/recode*
91      $prefix/share/man/man1/msg*.1
92      $prefix/share/man/man1/xgettext.1
93      $prefix/share/man/man1/gettextize.1
94      $prefix/share/man/man1/autopoint.1
95      $prefix/share/doc/gettext/msg*.1.html
96      $prefix/share/doc/gettext/xgettext.1.html
97      $prefix/share/doc/gettext/gettextize.1.html
98      $prefix/share/doc/gettext/autopoint.1.html
99      $prefix/share/doc/gettext/gettext_*.html
100      $prefix/share/doc/gettext/FAQ.html
101      $prefix/share/doc/gettext/examples/*
102      $prefix/info/gettext.info*
103      $prefix/include/gettext-po.h
104      $prefix/lib/libgettextlib*
105      $prefix/lib/libgettextsrc*
106      $prefix/lib/libgettextpo*
107      $prefix/lib/preloadable_libintl.so  (only installed on glibc systems)
108      $prefix/lib/gettext/*
109      $prefix/share/locale/*/LC_MESSAGES/gettext-tools.mo
110      $prefix/share/gettext/config.rpath
111      $prefix/share/gettext/intl/*
112      $prefix/share/gettext/po/*
113      $prefix/share/gettext/projects/*
114      $prefix/share/gettext/gettext.h
115      $prefix/share/gettext/gettext.jar   (only installed if gcj is not present)
116      $prefix/share/gettext/msgunfmt.tcl
117      $prefix/share/gettext/archive.tar.gz
118      $prefix/share/aclocal/codeset.m4
119      $prefix/share/aclocal/gettext.m4
120      $prefix/share/aclocal/glibc2.m4
121      $prefix/share/aclocal/glibc21.m4
122      $prefix/share/aclocal/iconv.m4
123      $prefix/share/aclocal/intdiv0.m4
124      $prefix/share/aclocal/intl.m4
125      $prefix/share/aclocal/intldir.m4
126      $prefix/share/aclocal/intmax.m4
127      $prefix/share/aclocal/inttypes_h.m4
128      $prefix/share/aclocal/inttypes-pri.m4
129      $prefix/share/aclocal/lcmessage.m4
130      $prefix/share/aclocal/lib-ld.m4
131      $prefix/share/aclocal/lib-link.m4
132      $prefix/share/aclocal/lib-prefix.m4
133      $prefix/share/aclocal/lock.m4
134      $prefix/share/aclocal/longdouble.m4
135      $prefix/share/aclocal/longlong.m4
136      $prefix/share/aclocal/nls.m4
137      $prefix/share/aclocal/po.m4
138      $prefix/share/aclocal/printf-posix.m4
139      $prefix/share/aclocal/progtest.m4
140      $prefix/share/aclocal/size_max.m4
141      $prefix/share/aclocal/stdint_h.m4
142      $prefix/share/aclocal/uintmax_t.m4
143      $prefix/share/aclocal/ulonglong.m4
144      $prefix/share/aclocal/visibility.m4
145      $prefix/share/aclocal/wchar_t.m4
146      $prefix/share/aclocal/wint_t.m4
147      $prefix/share/aclocal/xsize.m4
148      $prefix/share/emacs/site-lisp/po-compat.el
149      $prefix/share/emacs/site-lisp/po-compat.elc
150      $prefix/share/emacs/site-lisp/po-mode.el
151      $prefix/share/emacs/site-lisp/po-mode.elc
152      $prefix/share/emacs/site-lisp/start-po.el
153      $prefix/share/emacs/site-lisp/start-po.elc
154
155
156Java support:
157-------------
158
159If GNU gcj is available at build time, two programs will be built as native
160executables:
161      $prefix/lib/gettext/gnu.gettext.*
162and the gettext-tools package will therefore have a runtime dependency to
163libgcj.so.
164
165If GNU gcj is not available at build time but another Java implementation is
166available instead, the two programs will be compiled to Java bytecode only:
167      $prefix/share/gettext/gettext.jar
168and the gettext-tools package will therefore have a runtime dependency to
169the Java virtual machine (Sun Java2, IBM Java2, GNU libgcj.jar, or other).
170
171
172C# support:
173-----------
174
175For C# support, one of pnet or mono must be available at build time; it must
176also be available at run time. If you have both available, choose the desired
177one through the configure option. Note there is no interoperability currently
178between pnet and mono: Programs compiled with pnet don't run with mono, and
179vice versa.
180