Imported Upstream version 0.19.7
[platform/upstream/gettext.git] / gettext-tools / doc / autopoint.texi
1 @pindex autopoint
2 @cindex @code{autopoint} program, usage
3 @example
4 autopoint [@var{option}]...
5 @end example
6
7 The @code{autopoint} program copies standard gettext infrastructure files
8 into a source package.  It extracts from a macro call of the form
9 @code{AM_GNU_GETTEXT_VERSION(@var{version})}, found in the package's
10 @file{configure.in} or @file{configure.ac} file, the gettext version
11 used by the package, and copies the infrastructure files belonging to
12 this version into the package.
13
14 To extract the latest available infrastructure which satisfies a version
15 requirement, then you can use the form
16 @code{AM_GNU_GETTEXT_REQUIRE_VERSION(@var{version})} instead.  For
17 example, if gettext @value{ARCHIVE-VERSION} is installed on your system
18 and @code{0.19.1} is requested, then the infrastructure files of version
19 @value{ARCHIVE-VERSION} will be copied into a source package.
20
21 @subsubsection Options
22
23 @table @samp
24 @item -f
25 @itemx --force
26 @opindex -f@r{, @code{autopoint} option}
27 @opindex --force@r{, @code{autopoint} option}
28 Force overwriting of files that already exist.
29
30 @item -n
31 @itemx --dry-run
32 @opindex -d@r{, @code{autopoint} option}
33 @opindex --dry-run@r{, @code{autopoint} option}
34 Print modifications but don't perform them.  All file copying actions that
35 @code{autopoint} would normally execute are inhibited and instead only
36 listed on standard output.
37
38 @end table
39
40 @subsubsection Informative output
41
42 @table @samp
43 @item --help
44 @opindex --help@r{, @code{autopoint} option}
45 Display this help and exit.
46
47 @item --version
48 @opindex --version@r{, @code{autopoint} option}
49 Output version information and exit.
50
51 @end table
52
53 @code{autopoint} supports the GNU @code{gettext} versions from 0.10.35
54 to the current one, @value{ARCHIVE-VERSION}.  In order to apply
55 @code{autopoint} to a package using a @code{gettext} version newer than
56 @value{ARCHIVE-VERSION}, you need to install this same version of GNU
57 @code{gettext} at least.
58
59 In packages using GNU @code{automake}, an invocation of @code{autopoint}
60 should be followed by invocations of @code{aclocal} and then @code{autoconf}
61 and @code{autoheader}.  The reason is that @code{autopoint} installs some
62 autoconf macro files, which are used by @code{aclocal} to create
63 @file{aclocal.m4}, and the latter is used by @code{autoconf} to create the
64 package's @file{configure} script and by @code{autoheader} to create the
65 package's @file{config.h.in} include file template.
66
67 The name @samp{autopoint} is an abbreviation of @samp{auto-po-intl-m4};
68 the tool copies or updates mostly files in the @file{po}, @file{intl},
69 @file{m4} directories.