summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-05-06 17:49:23 +0000
committerKarl Berry <karl@freefriends.org>2014-05-06 17:49:23 +0000
commita57033f61d5ca6fd13f148f347bbaba014bc944a (patch)
tree06e264ff430b5d7579a4ae2f39899d2c545bbefb
parentf08fb481aa05b1b5394d94e469e352d44af9555e (diff)
doc tweaks: mention non-make install binaries (texi), remove unnecessary " (pod), etc.
git-svn-id: svn://tug.org/texlive/trunk@33886 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Build/source/doc/tlbuild.info174
-rw-r--r--Build/source/doc/tlbuild.texi53
-rwxr-xr-xMaster/texmf-dist/scripts/texlive/tlmgr.pl38
-rw-r--r--Master/tlpkg/doc/releng.txt2
4 files changed, 143 insertions, 124 deletions
diff --git a/Build/source/doc/tlbuild.info b/Build/source/doc/tlbuild.info
index a8d772a6c70..169300d111c 100644
--- a/Build/source/doc/tlbuild.info
+++ b/Build/source/doc/tlbuild.info
@@ -63,7 +63,7 @@ found in other TL documentation resources, such as:
* The TeX Live web pages: <http://tug.org/texlive>.
* The web page with an overview of how to build the binaries which
- Are distributed with TeX Live: <http://tug.org/texlive/build.html>.
+ are distributed with TeX Live: <http://tug.org/texlive/build.html>.
* The TeX Live user manual: <http://tug.org/texlive/doc.html>, or run
'texdoc texlive'.
@@ -334,7 +334,7 @@ for debugging purposes.
things are working. There are many 'configure' options you can tweak as
desired; check the output from 'configure --help'.
- Finally, the above retrieves the entire TL source tree (some 500mb).
+ Finally, the above retrieves the entire TL source tree (some 300mb).
It is natural to ask if this is really necessary. Strictly speaking,
the answer is no, but it is vastly more convenient to do so. If you cut
down the source tree, you must also give additional 'configure' flags to
@@ -352,10 +352,10 @@ File: tlbuild.info, Node: Installing, Next: Layout and infrastructure, Prev:
This section discusses the results of 'make install' in the source tree.
- The main consideration is that this is not enough to make a usable
-TeX installation. Beyond the binaries that are built from the sources,
-(thousands of) support files are needed; just as a first example
-'plain.tex' is not in the source tree.
+ The main consideration is that 'make install' is not enough to make a
+usable TeX installation. Beyond the compiled binaries, (thousands of)
+support files are needed; just as a first example 'plain.tex' is not in
+the source tree.
These support files are maintained completely independently and are
not present in the source tree. The best basis for dealing with them is
@@ -432,11 +432,17 @@ to 'DATAROOTDIR/texmf-dist/scripts/ps2eps/ps2eps.pl'. For Windows, a
standard wrapper binary (e.g., 'BINDIR/ps2eps.exe') serves the same
purpose. (The source for the wrapper is in 'texk/texlive/w32_wrapper'.)
- One reason for all this is to avoid having many copies of the same
-script, but more importantly this allows invoking the same script on all
-operating systems. Furthermore, we want the 'BINDIR' resulting from the
-build to be exactly what is in the TL distribution; any deviations cause
-considerable extra work.
+ One reason for this is to avoid having many copies of the same
+script; a more important reason is that it guarantees the scripts will
+stay in sync across the different supported operating systems.
+
+ Most important of all, we want the 'BINDIR' resulting from the build
+to be as close as possible to what is in the TL distribution. At
+present, there are a few exceptions--Asymptote, Biber, Xindy--and each
+one creates considerable extra work. We don't want to add more. (See
+<http://tug.org/texlive/build.html> for information about building those
+exceptions, as well as the 'xz' and 'wget' programs that are used in the
+TL infrastructure.)

File: tlbuild.info, Node: Distro builds, Prev: Linked scripts, Up: Installing
@@ -445,7 +451,7 @@ File: tlbuild.info, Node: Distro builds, Prev: Linked scripts, Up: Installing
=================
Although they use the same code base, building for the native TL
-distribution as shipped by the TL user groups is typically quite
+distribution as shipped by the TeX user groups is typically quite
different from a "distro" build needed by, e.g., a full GNU/Linux or BSD
operating system distribution.
@@ -496,8 +502,9 @@ find most relevant:
(*note Installing::), and many other issues, such as font maps,
languages, and formats, independently of the build. Norbert Preining
has written a detailed article on adapting TL for distros:
-<http://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf>. (If it needs
-updating at some point, perhaps we will merge it into this document.)
+<http://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf>. (If the
+article needs updating in the future, perhaps we will merge it into this
+document.)

File: tlbuild.info, Node: Layout and infrastructure, Next: Configure options, Prev: Installing, Up: Top
@@ -604,8 +611,8 @@ and similar places. The 'reautoconf' script does not touch those, but a
TL cron job keeps them in sync (nightly).
The directory 'extra/' contains things which are not part of the TL
-build, but are present for convenience, e.g., 'epstopdf' developed here
-and 'xz/' required by the TL installer.
+build, but are present just for (someone's) convenience, e.g.,
+'epstopdf' which is developed here.

File: tlbuild.info, Node: Autoconf macros, Next: Library modules, Prev: Top-level directories, Up: Layout and infrastructure
@@ -2066,12 +2073,14 @@ Index
(line 14)
* ANSI C: Declarations and definitions.
(line 6)
-* asymptote: 'asymptote'. (line 6)
+* asymptote: Linked scripts. (line 22)
+* asymptote <1>: 'asymptote'. (line 6)
* Autoconf: Overview of build system.
(line 6)
* autoconf macros: Autoconf macros. (line 6)
* Automake: Overview of build system.
(line 6)
+* biber: Linked scripts. (line 22)
* bibtex-x: Configure options for 'texk/bibtex-x'.
(line 6)
* bibtex8: Configure options for 'texk/bibtex-x'.
@@ -2435,6 +2444,7 @@ Index
* web2c program: Cross problems. (line 13)
* web2c.ac: Configure options for 'texk/web2c'.
(line 42)
+* wget: Linked scripts. (line 22)
* WIN32, Automake conditional: Macros for Windows. (line 16)
* WIN32_WRAP, Automake conditional: Macros for Windows. (line 25)
* Windows, invoking scripts on: Linked scripts. (line 6)
@@ -2454,8 +2464,9 @@ Index
(line 6)
* xdvipdfmx: Configure options for 'texk/dvipdfm-x'.
(line 6)
-* xindy: 'xindy' package. (line 6)
-* xindy <1>: Configure options for 'utils/xindy'.
+* xindy: Linked scripts. (line 22)
+* xindy <1>: 'xindy' package. (line 6)
+* xindy <2>: Configure options for 'utils/xindy'.
(line 6)
* 'xindy' cross compiling impossible: Cross problems. (line 38)
* XInput: Configure options for 'texk/xdvik'.
@@ -2464,6 +2475,7 @@ Index
(line 22)
* xpdf as library: Configure options for system 'poppler'.
(line 6)
+* xz: Linked scripts. (line 22)
* zlib library: 'zlib' library. (line 6)
@@ -2480,67 +2492,67 @@ Node: Build in parallel9792
Node: Build distribution10384
Node: Build one package10955
Node: Installing13728
-Node: Installation directories14756
-Node: Linked scripts16576
-Node: Distro builds17724
-Node: Layout and infrastructure20104
-Node: Build system tools20893
-Node: Top-level directories22905
-Node: Autoconf macros24972
-Node: General setup macros25673
-Node: Macros for programs26540
-Node: Macros for compilers27352
-Node: Macros for libraries28786
-Node: Macros for library and header flags29212
-Node: Macros for Windows31081
-Node: Library modules32658
-Node: 'png' library33155
-Node: 'zlib' library35448
-Node: 'freetype' library35969
-Node: 'kpathsea' library36503
-Node: Program modules37927
-Node: 't1utils' package38363
-Node: 'xindy' package38930
-Node: 'xdvik' package40109
-Node: 'asymptote'41188
-Node: Extending TeX Live41643
-Node: Adding a new program module42011
-Node: Adding a new generic library module43530
-Node: Adding a new TeX-specific library module45743
-Node: Configure options46430
-Node: Global configure options47821
-Node: '--disable-native-texlive-build'48389
-Node: '--prefix' '--bindir' ...49385
-Node: '--disable-largefile'49933
-Node: '--disable-missing'50700
-Node: '--enable-compiler-warnings='LEVEL51107
-Node: '--enable-cxx-runtime-hack'51852
-Node: '--enable-maintainer-mode'52285
-Node: '--enable-multiplatform'52820
-Node: '--enable-shared'53381
-Node: '--enable-silent-rules'53758
-Node: '--without-ln-s'54220
-Node: '--without-x'54577
-Node: Program-specific configure options54769
-Node: '--enable-PROG' '--disable-PROG'55432
-Node: '--disable-all-pkgs'55715
-Node: Configure options for 'texk/web2c'56709
-Node: Configure options for 'texk/bibtex-x'59376
-Node: Configure options for 'texk/dvipdfm-x'59952
-Node: Configure options for 'texk/dvisvgm'60791
-Node: Configure options for 'texk/texlive'61681
-Node: Configure options for 'texk/xdvik'62108
-Node: Configure options for 'utils/xindy'62718
-Node: Library-specific configure options63780
-Node: Configure options for 'kpathsea'64794
-Node: Configure options for system 'poppler'65507
-Node: Variables for configure66274
-Node: Cross compilation67702
-Node: Cross configuring68967
-Node: Cross problems70640
-Node: Coding conventions72501
-Node: Declarations and definitions73165
-Node: Const75348
-Node: Index77211
+Node: Installation directories14743
+Node: Linked scripts16563
+Node: Distro builds18044
+Node: Layout and infrastructure20434
+Node: Build system tools21223
+Node: Top-level directories23235
+Node: Autoconf macros25289
+Node: General setup macros25990
+Node: Macros for programs26857
+Node: Macros for compilers27669
+Node: Macros for libraries29103
+Node: Macros for library and header flags29529
+Node: Macros for Windows31398
+Node: Library modules32975
+Node: 'png' library33472
+Node: 'zlib' library35765
+Node: 'freetype' library36286
+Node: 'kpathsea' library36820
+Node: Program modules38244
+Node: 't1utils' package38680
+Node: 'xindy' package39247
+Node: 'xdvik' package40426
+Node: 'asymptote'41505
+Node: Extending TeX Live41960
+Node: Adding a new program module42328
+Node: Adding a new generic library module43847
+Node: Adding a new TeX-specific library module46060
+Node: Configure options46747
+Node: Global configure options48138
+Node: '--disable-native-texlive-build'48706
+Node: '--prefix' '--bindir' ...49702
+Node: '--disable-largefile'50250
+Node: '--disable-missing'51017
+Node: '--enable-compiler-warnings='LEVEL51424
+Node: '--enable-cxx-runtime-hack'52169
+Node: '--enable-maintainer-mode'52602
+Node: '--enable-multiplatform'53137
+Node: '--enable-shared'53698
+Node: '--enable-silent-rules'54075
+Node: '--without-ln-s'54537
+Node: '--without-x'54894
+Node: Program-specific configure options55086
+Node: '--enable-PROG' '--disable-PROG'55749
+Node: '--disable-all-pkgs'56032
+Node: Configure options for 'texk/web2c'57026
+Node: Configure options for 'texk/bibtex-x'59693
+Node: Configure options for 'texk/dvipdfm-x'60269
+Node: Configure options for 'texk/dvisvgm'61108
+Node: Configure options for 'texk/texlive'61998
+Node: Configure options for 'texk/xdvik'62425
+Node: Configure options for 'utils/xindy'63035
+Node: Library-specific configure options64097
+Node: Configure options for 'kpathsea'65111
+Node: Configure options for system 'poppler'65824
+Node: Variables for configure66591
+Node: Cross compilation68019
+Node: Cross configuring69284
+Node: Cross problems70957
+Node: Coding conventions72818
+Node: Declarations and definitions73482
+Node: Const75665
+Node: Index77528

End Tag Table
diff --git a/Build/source/doc/tlbuild.texi b/Build/source/doc/tlbuild.texi
index 5fd16c30784..705fb1e320b 100644
--- a/Build/source/doc/tlbuild.texi
+++ b/Build/source/doc/tlbuild.texi
@@ -107,7 +107,7 @@ found in other TL documentation resources, such as:
@item The @TL{} web pages: @url{http://tug.org/texlive}.
@item The web page with an overview of how to build the binaries which
-Are distributed with @TL{}: @url{http://tug.org/texlive/build.html}.
+are distributed with @TL{}: @url{http://tug.org/texlive/build.html}.
@item The @TL{} user manual: @url{http://tug.org/texlive/doc.html}, or
run @code{texdoc texlive}.
@@ -454,7 +454,7 @@ things are working. There are many @code{configure} options you can
tweak as desired; check the output from @code{configure --help}.
@cindex size of source tree
-Finally, the above retrieves the entire TL source tree (some 500mb).
+Finally, the above retrieves the entire TL source tree (some 300mb).
It is natural to ask if this is really necessary. Strictly speaking,
the answer is no, but it is vastly more convenient to do so. If you
cut down the source tree, you must also give additional
@@ -477,10 +477,10 @@ source tree.
@pindex texlive.tlpdb@r{, @TL{} database}
@pindex install-tl@r{, @TL{} installer}
@pindex plain.tex@r{, not in source tree}
-The main consideration is that this is not enough to make a usable
-@TeX{} installation. Beyond the binaries that are built from the
-sources, (thousands of) support files are needed; just as a first
-example @file{plain.tex} is not in the source tree.
+The main consideration is that @code{make install} is not enough to
+make a usable @TeX{} installation. Beyond the compiled binaries,
+(thousands of) support files are needed; just as a first example
+@file{plain.tex} is not in the source tree.
These support files are maintained completely independently and are
not present in the source tree. The best basis for dealing with them
@@ -546,8 +546,8 @@ directories used in the TL distribution.
@end itemize
-@noindent The top-level @file{configure} script displays all these installation
-paths.
+@noindent The top-level @file{configure} script displays all these
+installation paths.
For the native TL build, the @code{Build} script leaves the binaries
in @file{./inst/bin/@var{std-platform-name}}. The new binaries are
@@ -579,11 +579,22 @@ Windows, a standard wrapper binary (e.g.,
@code{@var{bindir}/ps2eps.exe}) serves the same purpose. (The source
for the wrapper is in @file{texk/texlive/w32_wrapper}.)
-One reason for all this is to avoid having many copies of the same
-script, but more importantly this allows invoking the same script on
-all operating systems. Furthermore, we want the @code{@var{bindir}}
-resulting from the build to be exactly what is in the TL distribution;
-any deviations cause considerable extra work.
+One reason for this is to avoid having many copies of the same
+script; a more important reason is that it guarantees the scripts will
+stay in sync across the different supported operating systems.
+
+@pindex asymptote
+@pindex biber
+@pindex xindy
+@pindex xz
+@pindex wget
+Most important of all, we want the @code{@var{bindir}} resulting from
+the build to be as close as possible to what is in the TL
+distribution. At present, there are a few exceptions---Asymptote,
+Biber, Xindy---and each one creates considerable extra work. We don't
+want to add more. (See @url{http://tug.org/texlive/build.html} for
+information about building those exceptions, as well as the @code{xz}
+and @code{wget} programs that are used in the TL infrastructure.)
@node Distro builds
@@ -596,9 +607,9 @@ any deviations cause considerable extra work.
@cindex GNU/Linux distro
@cindex BSD distro
Although they use the same code base, building for the native TL
-distribution as shipped by the TL user groups is typically quite
-different from a ``distro'' build needed by, e.g., a full GNU/Linux
-or BSD operating system distribution.
+distribution as shipped by the @TeX{} user groups is typically quite
+different from a ``distro'' build needed by, e.g., a full GNU/Linux or
+BSD operating system distribution.
@cindex shared libraries, using vs.@: avoiding
The native TL distribution uses shared libraries only when absolutely
@@ -654,9 +665,9 @@ You will need to take care of the support files mentioned above
(@pxref{Installing}), and many other issues, such as font maps,
languages, and formats, independently of the build. Norbert Preining
has written a detailed article on adapting TL for distros:
-@url{http://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf}. (If it
-needs updating at some point, perhaps we will merge it into this
-document.)
+@url{http://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf}. (If the
+article needs updating in the future, perhaps we will merge it into
+this document.)
@node Layout and infrastructure
@@ -782,8 +793,8 @@ keeps them in sync (nightly).
@cindex @file{extra/} top-level directory
The directory @file{extra/} contains things which are not part of the
-TL build, but are present for convenience, e.g., @file{epstopdf}
-developed here and @file{xz/} required by the TL installer.
+TL build, but are present just for (someone's) convenience, e.g.,
+@file{epstopdf} which is developed here.
@node Autoconf macros
diff --git a/Master/texmf-dist/scripts/texlive/tlmgr.pl b/Master/texmf-dist/scripts/texlive/tlmgr.pl
index 58ff323dc41..518ec7fe277 100755
--- a/Master/texmf-dist/scripts/texlive/tlmgr.pl
+++ b/Master/texmf-dist/scripts/texlive/tlmgr.pl
@@ -6153,7 +6153,7 @@ what remains to be done.
Instead of the normal output intended for human consumption, write (to
standard output) a fixed format more suitable for machine parsing. See
-the L</"MACHINE-READABLE OUTPUT"> section below.
+the L</MACHINE-READABLE OUTPUT> section below.
=item B<--no-execute-actions>
@@ -6278,7 +6278,7 @@ performed are written to the terminal.
=item B<candidates I<pkg>>
Shows the available candidate repositories for package I<pkg>.
-See L</"MULTIPLE REPOSITORIES"> below.
+See L</MULTIPLE REPOSITORIES> below.
=back
@@ -6555,7 +6555,7 @@ are listed.
In addition to the normal data displayed, also display information for
given packages from the corresponding taxonomy (or all of them). See
-L</"TAXONOMIES"> below for details.
+L</TAXONOMIES> below for details.
=back
@@ -6969,8 +6969,8 @@ written to the terminal.
=item B<repository set I<path>[#I<tag>] [I<path>[#I<tag>] ...]>
-This action manages the list of repositories. See L</"MULTIPLE
-REPOSITORIES"> below for detailed explanations.
+This action manages the list of repositories. See L</MULTIPLE
+REPOSITORIES> below for detailed explanations.
The first form (C<list>) lists all configured repositories and the
respective tags if set. If a path, url, or tag is given after the
@@ -7030,7 +7030,7 @@ word C<tables> (unless they also contain the word C<table> on its own).
If a search for any (or all) taxonomies is done, by specifying one of
the taxonomy options below, then instead of searching for packages, list
the entire corresponding taxonomy (or all of them). See
-L</"TAXONOMIES"> below.
+L</TAXONOMIES> below.
=back
@@ -7051,7 +7051,7 @@ List all filenames containing I<what>.
=item B<--characterization>
Search in the corresponding taxonomy (or all) instead of the package
-descriptions. See L</"TAXONOMIES"> below.
+descriptions. See L</TAXONOMIES> below.
=item B<--all>
@@ -7256,7 +7256,6 @@ If the package on the server is older than the package already installed
downgrade. Also, packages for uninstalled platforms are not installed.
-
=head1 USER MODE
C<tlmgr> provides a restricted way, called ``user mode'', to manage
@@ -7310,7 +7309,7 @@ installed into a user tree.
Description of changes of actions in user mode:
-=head3 install
+=head3 user mode install
In user mode, the C<install> action checks that the package and all
dependencies are all either relocated or already installed in the system
@@ -7326,23 +7325,20 @@ collection-context> would install C<collection-basic> and other
collections, while in user mode, I<only> the packages mentioned in
C<collection-context> are installed.
-=head2 backup, restore, remove, update
+=head2 user mode backup; restore; remove; update
In user mode, these actions check that all packages to be acted on are
installed in the user tree before proceeding; otherwise, they behave
just as in normal mode.
-=head2 generate, option, paper
+=head2 user mode generate; option; paper
In user mode, these actions operate only on the user tree's
configuration files and/or C<texlive.tlpdb>.
creates configuration files in user tree
-B<WARNING> repeated: this is still has to be considered experimental!
-Please report bugs to C<tex-live@tug.org> as usual
-
-=head1 TLMGR CONFIGURATION FILE
+=head1 CONFIGURATION FILE FOR TLMGR
A small subset of the command line options can be set in a config file
for C<tlmgr> which resides in C<TEXMFCONFIG/tlmgr/config>. By default, the
@@ -7546,7 +7542,7 @@ only those I<not> installed, or only those with update available.
=item Category
Select which categories are shown: packages, collections, and/or
-schemes. These are briefly explained in the L</"DESCRIPTION"> section
+schemes. These are briefly explained in the L</DESCRIPTION> section
above.
=item Match
@@ -7676,7 +7672,7 @@ Several toggles are also here. The first is C<Expert options>, which is
set by default. If you turn this off, the next time you start the GUI a
simplified screen will be shown that display only the most important
functionality. This setting is saved in the configuration file of
-C<tlmgr>; see L<CONFIGURATION FILE> for details.
+C<tlmgr>; see L<CONFIGURATION FILE FOR TLMGR> for details.
The other toggles are all off by default: for debugging output, to
disable the automatic installation of new packages, and to disable the
@@ -7712,12 +7708,12 @@ written to stdout). The idea is that a program can get all the
information it needs by reading stdout.
Currently this option only applies to the
-L<update|/"update [I<option>]... [I<pkg>]...">, the
-L<install|"install [I<option>]... I<pkg>...">, and the
+L<update|/update [I<option>]... [I<pkg>]...>,
+L<install|/install [I<option>]... I<pkg>...>, and
L</option> actions.
-=head3 update, install
+=head2 Machine-readable C<update> and C<install> output
The output format is as follows:
@@ -7839,7 +7835,7 @@ The estimated total time.
=back
-=head3 option
+=head2 Machine-readable C<option> output
The output format is as follows:
diff --git a/Master/tlpkg/doc/releng.txt b/Master/tlpkg/doc/releng.txt
index 4102c0312e3..394dd6fb1d8 100644
--- a/Master/tlpkg/doc/releng.txt
+++ b/Master/tlpkg/doc/releng.txt
@@ -99,7 +99,7 @@ After tlnet freeze:
http://puszcza.gnu.org.ua/projects/texcollection/
When binary set and docs are stable enough:
- peb + laurens + khaled: no commits.
+ peb, akira, khaled, laurens: no commits.
Update texlive-en.tex (+ .pdf, .html), tell tldoc to translate.
Check for Build-maintained updates to config files, etc.
(and might have to merge back if Master was mistakenly updated):