From 97c685034b125b5fa73e8af967875d8146c4eae7 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 14 Oct 2007 01:00:38 +0000 Subject: more doc niglets (and not done yet) git-svn-id: svn://tug.org/texlive/trunk@5181 c570f23f-e606-0410-a88d-b1316a301751 --- Master/tlpkg/bin/create-package-list | 14 ++------------ Master/tlpkg/bin/tlpdb2list | 17 ++++++----------- Master/tlpkg/bin/tlpfiles | 30 +++++++++++++++++++++--------- Master/tlpkg/bin/tlprm | 10 +++++----- Master/tlpkg/bin/tlpsrc2tlpdb | 19 +++++++------------ Master/tlpkg/bin/tlpsrc2tlpobj | 30 ++++++++++++------------------ Master/tlpkg/bin/tlpsrc2zip | 12 +++--------- 7 files changed, 56 insertions(+), 76 deletions(-) (limited to 'Master/tlpkg/bin') diff --git a/Master/tlpkg/bin/create-package-list b/Master/tlpkg/bin/create-package-list index f22c6b29b61..820144277c5 100755 --- a/Master/tlpkg/bin/create-package-list +++ b/Master/tlpkg/bin/create-package-list @@ -46,18 +46,8 @@ create-package-list [OPTION]... texlive.tldb =head1 OPTIONS -=over 8 - -=item B<-help> -Print a brief help message and exits. - -=item B<-man> -Prints the manual page and exits. - -=item B<-debug> -Give debug messages from the TeX Live modules - -=back +The standard options C<-help>, C<-debug>, and C<-man> are accepted. +See the tlpfiles documentation for details. =head1 DESCRIPTION diff --git a/Master/tlpkg/bin/tlpdb2list b/Master/tlpkg/bin/tlpdb2list index d510fac2a0e..f6012dc1d55 100755 --- a/Master/tlpkg/bin/tlpdb2list +++ b/Master/tlpkg/bin/tlpdb2list @@ -60,20 +60,15 @@ tlpdb2list [OPTION]... texlive.tlpdb =over 8 -=item B<-help> -Print a brief help message and exits. - -=item B<-man> -Prints the manual page and exits. - -=item B<-outputdir> -Specifies the location where list files are created. Defaults to ./new-list - -=item B<-debug> -Give debug messages from the TeX Live modules +=item B<-outputdir> I +Specifies the location where list files are created. Defaults to +C<./new-list>. =back +The standard options C<-help>, C<-debug>, and C<-man> are also accepted. +See the tlpfiles documentation for details. + =head1 DESCRIPTION B generates list files necessary for the installer from the diff --git a/Master/tlpkg/bin/tlpfiles b/Master/tlpkg/bin/tlpfiles index 14a49e943fb..5bc00fe6ce8 100755 --- a/Master/tlpkg/bin/tlpfiles +++ b/Master/tlpkg/bin/tlpfiles @@ -4,7 +4,8 @@ # This file is licensed under the GNU General Public License version 2 # or any later version. # -# Return all files for a given TeX Live package. +# Return all files for a given TeX Live package, or package name(s) for +# a given set of files. our $mydir; @@ -24,7 +25,8 @@ our $opt_debug = 0; my $man = 0; my $help = 0; -GetOptions("debug!", "help|?" => \$help, "man" => \$man) or pod2usage(2); +GetOptions("pkgof" => \@opt_pkgof, + "debug!", "help|?" => \$help, "man" => \$man) or pod2usage(2); pod2usage(1) if $help; pod2usage(-exitstatus => 0, -verbose => 2) if $man; @@ -57,21 +59,25 @@ exit 0; =head1 NAME -tlpfiles - list files contained in a TeX Live package +tlpfiles - list files contained in a TeX Live package, or vice versa =head1 SYNOPSIS tlpfiles [OPTION]... TLPKG +or: tlpfiles [OPTION]... -pkgof FILE... =head1 OPTIONS =over 8 +=item B<-pkgof> I... +Output the TeX Live packages in which each is contained. + =item B<-help> -Print brief help message and exit. +Print a brief help message and exit. =item B<-man> -Print formatted manual page and exit. +Print this documentation as a formatted manual page and exit. =item B<-debug> Give debug messages from the TeX Live modules. @@ -80,14 +86,20 @@ Give debug messages from the TeX Live modules. =head1 DESCRIPTION -Return all the files contained in the given TeX Live package (as -determined by reading the TeX Live package database). This includes -any executables as well as runtime, documentation, and source files. +In the first form, with just I specified, return all the files +contained in the given TeX Live package (as determined by reading the +TeX Live package database). This includes any executables as well as +runtime, documentation, and source files. It does not include the C<.tlpsrc> file for the package, since that is -necessarily part of the build infrastructure rather than the +necessarily part of the build infrastructure, and not part of the self-contained package. +In the second form, with the C<-pkgof> option, return the TeX Live +package in which each given I is contained, or C<-> if no package +can be found. The files may be given as a single whitespace-separated +argument, or the C<-pkgof> option may be given more than once, or both. + =head1 AUTHORS AND COPYRIGHT This script and its documentation were written for the TeX Live diff --git a/Master/tlpkg/bin/tlprm b/Master/tlpkg/bin/tlprm index cfba032f89e..6604df73a0e 100755 --- a/Master/tlpkg/bin/tlprm +++ b/Master/tlpkg/bin/tlprm @@ -183,9 +183,8 @@ Set up to remove the specified TeX Live packages from the source repository. =over 8 -=item B<-svn> -Print the Subversion commands that will do the actual removal. This is -the default mode of operation. +=item B<-debug> +Give debug messages from the TeX Live modules. =item B<-help> Print brief help message and exit. @@ -193,8 +192,9 @@ Print brief help message and exit. =item B<-man> Print formatted manual page and exit. -=item B<-debug> -Give debug messages from the TeX Live modules. +=item B<-svn> +Print the Subversion commands that will do the actual removal. This is +the default mode of operation. =back diff --git a/Master/tlpkg/bin/tlpsrc2tlpdb b/Master/tlpkg/bin/tlpsrc2tlpdb index a8fadc5bc43..59dfb10f3a3 100755 --- a/Master/tlpkg/bin/tlpsrc2tlpdb +++ b/Master/tlpkg/bin/tlpsrc2tlpdb @@ -85,26 +85,21 @@ tlpsrc2tlpdb [OPTION]... [TLPSRC]... =over 8 -=item B<-help> -Print a brief help message and exits. - -=item B<-man> -Prints the manual page and exits. - -=item B<-master> -The location given by B<-master> must point to a valid svn repository -of TeX Live Master direcory. Defaults to ../.. of C<$0>. - =item B<-catalogue> The location given by B<-catalogue> must point to a valid TeX Catalogue. No default value. If given, the generated tlpobj files will contain information gathered from the TeX Catalogue. -=item B<-debug> -Give debug messages from the TeX Live modules +=item B<-master> +The location given by B<-master> must point to a valid svn repository +of TeX Live Master direcory. Defaults to ../.. of C<$0>. =back +The standard options +C<-help>, C<-debug>, and C<-man> are also accepted. See the tlpfiles +documentation for details. + =head1 DESCRIPTION B converts TeX Live Source Package files (tlpsrc) files into a diff --git a/Master/tlpkg/bin/tlpsrc2tlpobj b/Master/tlpkg/bin/tlpsrc2tlpobj index 40f68494887..509f8a53067 100755 --- a/Master/tlpkg/bin/tlpsrc2tlpobj +++ b/Master/tlpkg/bin/tlpsrc2tlpobj @@ -72,7 +72,6 @@ foreach my $f (@ARGV) { close(FOO); } - __END__ =head1 NAME @@ -87,29 +86,24 @@ tlpsrc2tlpobj [OPTION]... [TLPSRC]... =over 8 -=item B<-help> -Print a brief help message and exits. - -=item B<-man> -Prints the manual page and exits. - -=item B<-master> -The location given by B<-master> must point to a valid svn repository -of TeX Live Master direcory. Defaults to /src/TeX/texlive-svn/Master - -=item B<-catalogue> +=item B<-catalogue> I The location given by B<-catalogue> must point to a valid TeX Catalogue. -No default value. If given, the generated tlpobj files will contain information -gathered from the TeX Catalogue. +No default value. If given, the generated tlpobj files will contain +information gathered from the TeX Catalogue. -=item B<-outputdir> -Specifies the location where tlp files are created. Defaults to ./tlp +=item B<-master> I +The location given by B<-master> must point to a valid svn repository +of TeX Live Master direcory. Defaults to the grandparent directory of +this script's location. -=item B<-debug> -Give debug messages from the TeX Live modules +=item B<-outputdir> I +Specifies the location where tlp files are created. Defaults to C<./tlp>. =back +The standard options C<-help>, C<-debug>, and C<-man> are also accepted. +See the tlpfiles documentation for details. + =head1 DESCRIPTION B converts TeX Live Package Source files (tlpsrc) into diff --git a/Master/tlpkg/bin/tlpsrc2zip b/Master/tlpkg/bin/tlpsrc2zip index b3f562a7f19..6ea4fa0e115 100755 --- a/Master/tlpkg/bin/tlpsrc2zip +++ b/Master/tlpkg/bin/tlpsrc2zip @@ -70,12 +70,6 @@ tlpsrc2zip [options] [tlpsrcfiles ...] =over 8 -=item B<-help> -Print a brief help message and exits. - -=item B<-man> -Prints the manual page and exits. - =item B<-master> The location given by B<-master> must point to a valid svn repository of TeX Live Master direcory. Defaults to /src/TeX/texlive-svn/Master @@ -83,11 +77,11 @@ of TeX Live Master direcory. Defaults to /src/TeX/texlive-svn/Master =item B<-outputdir> Specifies the location where zip files are created. Defaults to ./zip -=item B<-debug> -Give debug messages from the TeX Live modules - =back +The standard options C<-help>, C<-debug>, and C<-man> are also accepted. +See the tlpfiles documentation for details. + =head1 DESCRIPTION B converts TeX Live Package Source files (tlpsrc) into zip -- cgit v1.2.3