texlive[74315] branches/branch2024.final: bundledoc (branch)
commits+karl at tug.org
commits+karl at tug.org
Wed Feb 26 22:15:23 CET 2025
Revision: 74315
https://tug.org/svn/texlive?view=revision&revision=74315
Author: karl
Date: 2025-02-26 22:15:23 +0100 (Wed, 26 Feb 2025)
Log Message:
-----------
bundledoc (branch) (26feb25)
Modified Paths:
--------------
branches/branch2024.final/Build/source/texk/texlive/linked_scripts/bundledoc/arlatex
branches/branch2024.final/Build/source/texk/texlive/linked_scripts/bundledoc/bundledoc
branches/branch2024.final/Master/texmf-dist/doc/man/man1/arlatex.1
branches/branch2024.final/Master/texmf-dist/doc/man/man1/arlatex.man1.pdf
branches/branch2024.final/Master/texmf-dist/doc/man/man1/bundledoc.1
branches/branch2024.final/Master/texmf-dist/doc/man/man1/bundledoc.man1.pdf
branches/branch2024.final/Master/texmf-dist/doc/support/bundledoc/README
branches/branch2024.final/Master/texmf-dist/scripts/bundledoc/arlatex
branches/branch2024.final/Master/texmf-dist/scripts/bundledoc/bundledoc
Modified: branches/branch2024.final/Build/source/texk/texlive/linked_scripts/bundledoc/arlatex
===================================================================
--- branches/branch2024.final/Build/source/texk/texlive/linked_scripts/bundledoc/arlatex 2025-02-26 21:15:11 UTC (rev 74314)
+++ branches/branch2024.final/Build/source/texk/texlive/linked_scripts/bundledoc/arlatex 2025-02-26 21:15:23 UTC (rev 74315)
@@ -9,7 +9,7 @@
########################################################################
# arlatex #
-# Copyright (C) 2018-2022 Scott Pakin #
+# Copyright (C) 2018-2025 Scott Pakin #
# #
# This program may be distributed and/or modified under the conditions #
# of the LaTeX Project Public License, either version 1.3c of this #
Modified: branches/branch2024.final/Build/source/texk/texlive/linked_scripts/bundledoc/bundledoc
===================================================================
--- branches/branch2024.final/Build/source/texk/texlive/linked_scripts/bundledoc/bundledoc 2025-02-26 21:15:11 UTC (rev 74314)
+++ branches/branch2024.final/Build/source/texk/texlive/linked_scripts/bundledoc/bundledoc 2025-02-26 21:15:23 UTC (rev 74315)
@@ -7,7 +7,7 @@
########################################################################
# bundledoc #
-# Copyright (C) 2018-2019 Scott Pakin #
+# Copyright (C) 2018-2025 Scott Pakin #
# #
# This program may be distributed and/or modified under the conditions #
# of the LaTeX Project Public License, either version 1.3c of this #
@@ -25,7 +25,7 @@
########################################################################
use 5.006; # Fail gracefully if we're not using Perl v5.6.0+.
-our $VERSION = "3.4"; # Specify the version of bundledoc.
+our $VERSION = "3.5"; # Specify the version of bundledoc.
use File::Basename;
use File::Copy;
use File::Spec::Functions qw(abs2rel catfile devnull rel2abs rootdir updir);
@@ -33,6 +33,7 @@
use File::Temp qw(tempdir);
use Getopt::Long;
use Pod::Usage;
+use String::ShellQuote;
use warnings;
use strict;
@@ -66,8 +67,7 @@
# or abort if we can't.
sub qualifyname ($)
{
- my $filename = $_[0];
- $filename = "\"$filename\"" if $filename =~ /\s/ && substr($filename, 0, 1) ne '"';
+ my $filename = shell_quote $_[0];
my $command = $uservariable{find};
$command =~ s/[\$\%]BDINPUTS\%?/$filename/g;
$command =~ s/[\$\%]BDBASE\%?/$ENV{"BDBASE"}/g;
@@ -151,12 +151,12 @@
printf("CONFIGURATION FILE: %s\n", rel2abs($configfile)) if $verbose;
my $prevline = "";
open (CONFIGFILE, "<", $configfile) || do {
- my $configlist = $configfile;
- if (! -e $configfile) {
- # Error is "file not found". List the files we considered.
- $configlist .= "; also considered ${configfile}.cfg" if $configfile !~ /\.cfg$/;
- }
- die "${progname}: $! ($configlist)\n";
+ my $configlist = $configfile;
+ if (! -e $configfile) {
+ # Error is "file not found". List the files we considered.
+ $configlist .= "; also considered ${configfile}.cfg" if $configfile !~ /\.cfg$/;
+ }
+ die "${progname}: $! ($configlist)\n";
};
while (my $oneline=<CONFIGFILE>) {
# Read a line and trim it.
@@ -378,7 +378,7 @@
mkpath($targetdir, 0, 0777) || die "${progname}: $! ($targetdir)\n";
}
}
- copy ($dep, $targetdir) || die "${progname}: $! ($targetdir)\n";
+ copy ($dep, $targetdir) || die "${progname}: $! ($dep --> $targetdir)\n";
}
if ($manifest ne "") {
my $manifest = catfile $tempdir2, $manifest;
Modified: branches/branch2024.final/Master/texmf-dist/doc/man/man1/arlatex.1
===================================================================
--- branches/branch2024.final/Master/texmf-dist/doc/man/man1/arlatex.1 2025-02-26 21:15:11 UTC (rev 74314)
+++ branches/branch2024.final/Master/texmf-dist/doc/man/man1/arlatex.1 2025-02-26 21:15:23 UTC (rev 74315)
@@ -1,4 +1,5 @@
-.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -15,29 +16,12 @@
.ft R
.fi
..
-.\" Set up some character translations and predefined strings. \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. \*(C+ will
-.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
-. ds -- \(*W-
-. ds PI pi
-. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-. ds L" ""
-. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
-. ds -- \|\(em\|
-. ds PI \(*p
-. ds L" ``
-. ds R" ''
. ds C`
. ds C'
'br\}
@@ -68,80 +52,18 @@
. \}
.\}
.rr rF
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear. Run. Save yourself. No user-serviceable parts.
-. \" fudge factors for nroff and troff
-.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
-.\}
-.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
-.\}
-. \" simple accents for nroff and troff
-.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds /
-.\}
-.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-. \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-. \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-. ds : e
-. ds 8 ss
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ARLATEX 1"
-.TH ARLATEX 1 "2022-10-04" "v1.1" "User Commands"
+.TH ARLATEX 1 2025-02-26 v1.1 "User Commands"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
-.SH "NAME"
+.SH NAME
arlatex \- archive a number of ancillary LaTeX files into a master
\&.tex file
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.IX Header "SYNOPSIS"
arlatex
[\fB\-\-outfile\fR=\fIfilename\fR\fI.tex\fR]
@@ -154,7 +76,7 @@
.PP
arlatex
\&\fB\-\-help\fR
-.SH "DESCRIPTION"
+.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBarlatex\fR is an archiving program like \fBshar\fR, \fBtar\fR, \fBzip\fR, etc.
Unlike those other archivers, however, \fBarlatex\fR is designed
@@ -166,14 +88,14 @@
the document into a \fI.dvi\fR file.
.PP
\&\fBarlatex\fR has a few advantages over other archiving programs:
-.IP "\(bu" 4
+.IP \(bu 4
The \fI.tex\fR files produced by \fBarlatex\fR are in a plain-text format.
They are therefore perfectly portable and trivial to e\-mail to
colleagues.
-.IP "\(bu" 4
+.IP \(bu 4
\&\fBarlatex\fR needs only LaTeX to run. There is no dependence on any
external tools.
-.IP "\(bu" 4
+.IP \(bu 4
There is no explicit extraction step. As the generated document is
run through \fBlatex\fR, it extracts the ancillary files and builds the
document in the same step. The user running \fBlatex\fR may not even
@@ -187,12 +109,12 @@
the fact that ancillary files will be generated.) The
\&\f(CW\*(C`filecontents*\*(C'\fR environment, part of standard LaTeX2e, writes its
contents verbatim to a specified file.
-.SH "OPTIONS"
+.SH OPTIONS
.IX Header "OPTIONS"
-.IP "\fB\-\-version\fR" 4
+.IP \fB\-\-version\fR 4
.IX Item "--version"
Output the \fBarlatex\fR script's version number.
-.IP "\fB\-\-help\fR" 4
+.IP \fB\-\-help\fR 4
.IX Item "--help"
Output brief \fBarlatex\fR usage information.
.IP "\fB\-\-document\fR=\fI.tex file\fR" 4
@@ -207,7 +129,7 @@
document, but with a number of \f(CW\*(C`filecontents*\*(C'\fR environments preceding
the \f(CW\*(C`\edocumentclass\*(C'\fR line. If \f(CW\*(C`\-\-outfile\*(C'\fR is not specified, output
will be written to the standard output device.
-.SH "EXAMPLES"
+.SH EXAMPLES
.IX Header "EXAMPLES"
Suppose you have a paper called \fIpaper.tex\fR that loads a custom
package with \f(CW\*(C`\eusepackage{mypackage}\*(C'\fR. You want to submit the paper
@@ -256,13 +178,13 @@
files needed to build the document, and \fBarlatex\fR combines them into
a single file. The following are examples of the \f(CW\*(C`bundle:\*(C'\fR line you
might use in a \fBbundledoc\fR configuration file:
-.IP "Unix:" 1
+.IP Unix: 1
.IX Item "Unix:"
.Vb 2
\& bundle: (arlatex \-\-document=$BDBASE.tex $BDINPUTS \e
\& \-\-outfile=$BDBASE\-all.tex)
.Ve
-.IP "Windows:" 1
+.IP Windows: 1
.IX Item "Windows:"
.Vb 2
\& bundle: arlatex \-\-document=%BDBASE%.tex %BDINPUTS% \e
@@ -270,7 +192,7 @@
.Ve
.PP
See the \fBbundledoc\fR documentation for more information.
-.SH "CAVEATS"
+.SH CAVEATS
.IX Header "CAVEATS"
\&\fBarlatex\fR makes use of LaTeX's \f(CW\*(C`filecontents*\*(C'\fR environment. It
passes \f(CW\*(C`filecontents*\*(C'\fR the \f(CW\*(C`overwrite\*(C'\fR option to indicate that
@@ -283,6 +205,6 @@
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBbundledoc\fR\|(1), \fBlatex\fR\|(1), \fBshar\fR\|(1), \fBtar\fR\|(1), \fBzip\fR\|(1)
-.SH "AUTHOR"
+.SH AUTHOR
.IX Header "AUTHOR"
Scott Pakin, \fIscott+bdoc at pakin.org\fR
Modified: branches/branch2024.final/Master/texmf-dist/doc/man/man1/arlatex.man1.pdf
===================================================================
(Binary files differ)
Modified: branches/branch2024.final/Master/texmf-dist/doc/man/man1/bundledoc.1
===================================================================
--- branches/branch2024.final/Master/texmf-dist/doc/man/man1/bundledoc.1 2025-02-26 21:15:11 UTC (rev 74314)
+++ branches/branch2024.final/Master/texmf-dist/doc/man/man1/bundledoc.1 2025-02-26 21:15:23 UTC (rev 74315)
@@ -1,4 +1,5 @@
-.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -15,29 +16,12 @@
.ft R
.fi
..
-.\" Set up some character translations and predefined strings. \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. \*(C+ will
-.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
-. ds -- \(*W-
-. ds PI pi
-. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-. ds L" ""
-. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
-. ds -- \|\(em\|
-. ds PI \(*p
-. ds L" ``
-. ds R" ''
. ds C`
. ds C'
'br\}
@@ -68,79 +52,17 @@
. \}
.\}
.rr rF
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear. Run. Save yourself. No user-serviceable parts.
-. \" fudge factors for nroff and troff
-.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
-.\}
-.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
-.\}
-. \" simple accents for nroff and troff
-.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds /
-.\}
-.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-. \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-. \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-. ds : e
-. ds 8 ss
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "BUNDLEDOC 1"
-.TH BUNDLEDOC 1 "2019-09-08" "v3.4" "User Commands"
+.TH BUNDLEDOC 1 2025-02-26 v3.5 "User Commands"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
-.SH "NAME"
+.SH NAME
bundledoc \- bundle all the files needed by a LaTeX document
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.IX Header "SYNOPSIS"
bundledoc
[\fB\-\-version\fR]
@@ -156,7 +78,7 @@
[\fB\-\-\fR[\fBno\fR]\fBkeepdirs\fR]
[\fB\-\-config\fR=\fIfile.cfg\fR]
\&\fIfile.dep\fR
-.SH "DESCRIPTION"
+.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBbundledoc\fR is a post-processor for the \fBsnapshot\fR package that
bundles together all the classes, packages, and files needed to build
@@ -179,10 +101,10 @@
.PP
The \f(CW\*(C`\eRequirePackage{snapshot}\*(C'\fR causes a \fIhello.dep\fR file to be produced.
When \fBbundledoc\fR is then given \f(CW\*(C`hello.dep\*(C'\fR as an argument, it locates the
-dependent files \*(-- \fIsnapshot.sty\fR, \fIarticle.cls\fR, and \fIsize11.clo\fR \*(--
+dependent files \-\- \fIsnapshot.sty\fR, \fIarticle.cls\fR, and \fIsize11.clo\fR \-\-
and bundles them into a single archive file, along with \fIhello.tex\fR and a
-\&\fI\s-1MANIFEST\s0\fR file (described in \*(L"\s-1OPTIONS\*(R"\s0, below).
-.SH "OPTIONS"
+\&\fIMANIFEST\fR file (described in "OPTIONS", below).
+.SH OPTIONS
.IX Header "OPTIONS"
In the following descriptions, \fIsomefile\fR refers to the name of your
main LaTeX document (no extension).
@@ -191,11 +113,11 @@
\&\fBsnapshot\fR, normally \fIsomefile\fR\fI.dep\fR). (For convenience, the file
can be specified without its \fI.dep\fR extension.) The following
options may also be given:
-.IP "\fB\-\-version\fR" 4
+.IP \fB\-\-version\fR 4
.IX Item "--version"
Output the \fBbundledoc\fR script's version number. This overrides all
of the remaining options.
-.IP "\fB\-\-help\fR" 4
+.IP \fB\-\-help\fR 4
.IX Item "--help"
Give a brief usage message. This overrides all of the remaining options.
.ie n .IP "\fB\-\-\fR[\fBno\fR]\fBverbose\fR (default: ""noverbose"")" 4
@@ -240,12 +162,12 @@
command line, instructs \fBbundledoc\fR to include in the archive all of
the files matching \fIfilespec\fR, even if they're not referenced in the
\&\fI.dep\fR file.
-.IP "\fB\-\-manifest\fR=\fImanifest file\fR (default: \fI\s-1MANIFEST\s0\fR)" 4
+.IP "\fB\-\-manifest\fR=\fImanifest file\fR (default: \fIMANIFEST\fR)" 4
.IX Item "--manifest=manifest file (default: MANIFEST)"
In addition to the dependent files, \fBbundledoc\fR includes in the
-archive file one extra file called, by default, ``\fI\s-1MANIFEST\s0\fR''.
-\&\fI\s-1MANIFEST\s0\fR is a text file that lists the original filenames of all
-the dependencies. To change the filename from ``\fI\s-1MANIFEST\s0\fR'' to
+archive file one extra file called, by default, ``\fIMANIFEST\fR''.
+\&\fIMANIFEST\fR is a text file that lists the original filenames of all
+the dependencies. To change the filename from ``\fIMANIFEST\fR'' to
something else, use the \f(CW\*(C`\-\-manifest\*(C'\fR option. As a special case,
\&\f(CW\*(C`\-\-manifest=""\*(C'\fR tells \fBbundledoc\fR not to include a manifest file at
all.
@@ -263,22 +185,22 @@
.el .IP "\fB\-\-\fR[\fBno\fR]\fBkeepdirs\fR (default: \f(CWnokeepdirs\fR)" 4
.IX Item "--[no]keepdirs (default: nokeepdirs)"
Normally, the archive file that \fBbundledoc\fR produces contains a
-single directory \*(-- and subdirectories, if the document refers
-explicitly to them \*(-- in which all the dependent files lie. If
+single directory \-\- and subdirectories, if the document refers
+explicitly to them \-\- in which all the dependent files lie. If
\&\f(CW\*(C`\-\-keepdirs\*(C'\fR is specified, all the dependent files are stored with
their original pathnames. For example, if \fIsomefile.tex\fR depends on
\&\fIfigures/somefigure.eps\fR, \fIarticle.cls\fR, and \fIsnapshot.sty\fR, then
the \fIsomefile\fR archive will normally contain the following files:
.RS 4
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIsomefile/somefile.tex\fR
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIsomefile/figures/somefigure.eps\fR
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIsomefile/article.cls\fR
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIsomefile/snapshot.sty\fR
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIsomefile/MANIFEST\fR
.RE
.RS 4
@@ -285,13 +207,13 @@
.Sp
However, \f(CW\*(C`\-\-keepdirs\*(C'\fR will cause the \fIsomefile\fR archive to contain
the following sorts of filenames instead:
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIhome/me/mydocs/somefile.tex\fR
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIhome/me/mydocs/figures/somefigure.eps\fR
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIusr/share/texmf/tex/latex/base/article.cls\fR
-.IP "\(bu" 4
+.IP \(bu 4
\&\fIusr/share/texmf/tex/latex/snapshot/snapshot.sty\fR
.RE
.RS 4
@@ -305,12 +227,12 @@
The \f(CW\*(C`\-\-config\*(C'\fR option is used to point \fBbundledoc\fR to the
appropriate configuration (\fI.cfg\fR) file for your TeX distribution and
operating system. \fBbundledoc\fR comes with a few configuration files
-and it's easy to write more. See \*(L"\s-1CONFIGURATION FILES\*(R"\s0 (below) for
+and it's easy to write more. See "CONFIGURATION FILES" (below) for
a description of the configuration file format. For convenience, the
file can be specified without its \fI.cfg\fR extension.
.SH "CONFIGURATION FILES"
.IX Header "CONFIGURATION FILES"
-.SS "Format"
+.SS Format
.IX Subsection "Format"
Configuration files follow a fairly simple format. Lines beginning with
\&\f(CW\*(C`#\*(C'\fR are comments. Blank lines are ignored. All other lines are of the
@@ -321,13 +243,13 @@
.Ve
.PP
The current version of \fBbundledoc\fR recognizes the following variables:
-.IP "\fBbundle\fR" 4
+.IP \fBbundle\fR 4
.IX Item "bundle"
The command to use to bundle a set of files into a single archive file
-.IP "\fBsink\fR" 4
+.IP \fBsink\fR 4
.IX Item "sink"
The affix to a command to discard its output
-.IP "\fBfind\fR" 4
+.IP \fBfind\fR 4
.IX Item "find"
The command to find a file within the TeX tree(s).
.PP
@@ -336,19 +258,19 @@
.PP
There are two environment variables that \fBbundledoc\fR makes available
for use by configuration-file commands: \f(CW\*(C`BDBASE\*(C'\fR, which is set to
-\&\fIsomefile\fR (as in \*(L"\s-1OPTIONS\*(R"\s0), and \f(CW\*(C`BDINPUTS\*(C'\fR, which is set to a
+\&\fIsomefile\fR (as in "OPTIONS"), and \f(CW\*(C`BDINPUTS\*(C'\fR, which is set to a
space-separated list of files that a command is to operate upon. That
is, when the command associated with \f(CW\*(C`bundle\*(C'\fR is running, \f(CW\*(C`BDINPUTS\*(C'\fR
contains the list of all the files that are to be archived. In
contrast, when the command associated with \f(CW\*(C`find\*(C'\fR is running,
\&\f(CW\*(C`BDINPUTS\*(C'\fR contains the name of the file to search for.
-.SS "Examples"
+.SS Examples
.IX Subsection "Examples"
The following configuration file parallels \fBbundledoc\fR's default
values of the various configuration-file variables, which represents a
kpathsea-based TeX distribution running on a generic Unix system,
-which doesn't necessarily have any of the \s-1GNU\s0 tools, such as \fBgzip\fR
-or \s-1GNU\s0 \fBtar\fR:
+which doesn't necessarily have any of the GNU tools, such as \fBgzip\fR
+or GNU \fBtar\fR:
.PP
.Vb 2
\& # "Default" configuration file
@@ -380,12 +302,12 @@
\& bundle: (shar \-\-archive\-name="$BDBASE" $BDINPUTS > $BDBASE.sh)
.Ve
.PP
-or a \s-1CAB\s0 file on Microsoft Windows with something like:
+or a CAB file on Microsoft Windows with something like:
.PP
.Vb 1
\& bundle: cabarc \-r \-p N %BDBASE%.cab %BDINPUTS%
.Ve
-.SH "EXAMPLES"
+.SH EXAMPLES
.IX Header "EXAMPLES"
Assume that \fImyfile.dep\fR was produced from \fImyfile.tex\fR by following
the instructions in the Description section. The
@@ -406,10 +328,10 @@
distribution running on a Unix-like operating system. \fBbundledoc\fR
will produce verbose output describing its operations. All files not
in the same directory tree as \fImyfile.tex\fR and all files containing
-\&\*(L".fd\*(R" or \*(L".sty\*(R" in their names are omitted. However, all \fI.bib\fR
+".fd" or ".sty" in their names are omitted. However, all \fI.bib\fR
files in the current directory will be included in the archive even
though none of them are referenced by \fImyfile.dep\fR. Finally, no
-\&\fI\s-1MANIFEST\s0\fR file will be produced.
+\&\fIMANIFEST\fR file will be produced.
.PP
.Vb 3
\& bundledoc \-\-config=texlive\-unix.cfg \-\-verbose \-\-localonly \e
@@ -416,15 +338,15 @@
\& \-\-exclude=.fd \-\-exclude=.cfg \-\-include="*.bib" \-\-manifest="" \e
\& myfile.dep
.Ve
-.SH "FILES"
+.SH FILES
.IX Header "FILES"
The user must have previously installed \fIsnapshot.sty\fR and used it to
produce a dependency file for his document. Besides that, the set of
external files needed by \fBbundledoc\fR is system-specific and depends on the
-configuration file used. (See \*(L"\s-1CONFIGURATION FILES\*(R"\s0, above.)
+configuration file used. (See "CONFIGURATION FILES", above.)
.PP
\&\fBbundledoc\fR currently comes with two configuration files:
-.IP "\fItexlive\-unix.cfg\fR" 4
+.IP \fItexlive\-unix.cfg\fR 4
.IX Item "texlive-unix.cfg"
Configuration file for TeX Live installations on Unix or Linux. TeX
Live is a kpathsea-based TeX distribution that runs on various flavors
@@ -432,7 +354,7 @@
\&\fBgzip\fR and uses it to produce a \fI.tar.gz\fR archive file. The
configuration file has \fBbundledoc\fR use \fBkpsewhich\fR to find LaTeX
files.
-.IP "\fImiktex.cfg\fR" 4
+.IP \fImiktex.cfg\fR 4
.IX Item "miktex.cfg"
Configuration file for MikTeX installations. MikTeX is a popular TeX
distribution for Microsoft Windows. \fImiktex.cfg\fR assumes you have
@@ -440,13 +362,13 @@
configuration file now has \fBbundledoc\fR use \fBkpsewhich\fR to find LaTeX
files; older version of MikTeX required the rather nonstandard
\&\fBinitexmf\fR for this purpose.
-.IP "\fItexlive\-unix\-arlatex.cfg\fR" 4
+.IP \fItexlive\-unix\-arlatex.cfg\fR 4
.IX Item "texlive-unix-arlatex.cfg"
This is a variant of \fItexlive\-unix.cfg\fR that uses \fBarlatex\fR instead
of \fBgzip\fR to archive files. \fBarlatex\fR is a script included in the
\&\fBbundledoc\fR distribution that generates a self-extracting \fI.tex\fR
file based on LaTeX's \f(CW\*(C`filecontents\*(C'\fR environment.
-.SH "NOTES"
+.SH NOTES
.IX Header "NOTES"
.SS "Including and excluding files"
.IX Subsection "Including and excluding files"
@@ -455,16 +377,16 @@
can be specified repeatedly on the command line. The order in which
these options are specified is immaterial; \fBbundledoc\fR processes file
inclusions and exclusions in the following order:
-.IP "1." 4
+.IP 1. 4
All files referenced by the \fI.dep\fR file are added to the list of
files to archive.
-.IP "2." 4
+.IP 2. 4
If \f(CW\*(C`\-\-localonly\*(C'\fR is specified, all files not found in the \fI.tex\fR
file's directory are removed from the list.
-.IP "3." 4
+.IP 3. 4
For each \f(CW\*(C`\-\-exclude\*(C'\fR string specified, all files containing that
string are removed from the list.
-.IP "4." 4
+.IP 4. 4
For each \f(CW\*(C`\-\-include\*(C'\fR file specification, the set of files designated
by its expansion are added to the list.
.SS "Issues When Running Under Microsoft Windows"
@@ -471,12 +393,12 @@
.IX Subsection "Issues When Running Under Microsoft Windows"
First, because \fBbundledoc\fR is a Perl script, you should do one of the
following to run it under Windows:
-.IP "\(bu" 4
+.IP \(bu 4
\&\f(CW\*(C`perl bundledoc\*(C'\fR
-.IP "\(bu" 4
+.IP \(bu 4
Rename \fIbundledoc\fR to \fIbundledoc.pl\fR and run \f(CW\*(C`bundledoc.pl\*(C'\fR. (This
is assuming you have a file association set up for \fI.pl\fR.)
-.IP "\(bu" 4
+.IP \(bu 4
Run the \fBpl2bat\fR script (if you have it) to convert \fIbundledoc\fR to
\&\fIbundledoc.bat\fR, then run \f(CW\*(C`bundledoc\*(C'\fR.
.PP
@@ -483,20 +405,20 @@
Second, Windows uses a multi-rooted filesystem (i.e., multiple drive
letters). I wouldn't be surprised if bad things were to happen if the
files to be bundled are scattered across drives. In addition, Windows
-supports ``\s-1UNC\s0'' filenames, which have no drive letter at all, just a
-machine and share name. \s-1UNC\s0 filenames are also untested waters for
+supports ``UNC'' filenames, which have no drive letter at all, just a
+machine and share name. UNC filenames are also untested waters for
\&\fBbundledoc\fR. Be careful!
.SS "Testing Status"
.IX Subsection "Testing Status"
I have tested \fBbundledoc\fR only with Perl v5.6.0 and later and only on
the following platforms:
-.IP "\(bu" 4
+.IP \(bu 4
Linux + TeX Live
-.IP "\(bu" 4
+.IP \(bu 4
Linux + teTeX
-.IP "\(bu" 4
-Windows \s-1NT +\s0 MiKTeX
-.IP "\(bu" 4
+.IP \(bu 4
+Windows NT + MiKTeX
+.IP \(bu 4
Solaris + ??? (something kpathsea-based)
.PP
It is my hope that \fBbundledoc\fR works on many more platforms than
@@ -507,10 +429,10 @@
.IX Subsection "Future Work"
I'd like \fBbundledoc\fR to work on as wide a variety of TeX
distributions as possible. If your platform is significantly
-different from the ones listed in \*(L"Testing Status\*(R" (e.g., if you're
-running \s-1OS\s0\ X) and you need to create a substantially different
+different from the ones listed in "Testing Status" (e.g., if you're
+running OS\ X) and you need to create a substantially different
configuration file from \fItexlive\-unix.cfg\fR and \fImiktex.cfg\fR, please
-send it to me at the address listed in \*(L"\s-1AUTHOR\*(R"\s0 so I can include it
+send it to me at the address listed in "AUTHOR" so I can include it
in a future version of \fBbundledoc\fR. (I make no promises, though).
.PP
Once \fBbundledoc\fR works on all the major operating systems and TeX
@@ -522,7 +444,7 @@
archive file. At a minimum, it should include \fI.tfm\fR files, but it
would be even better if it included \fI.mf\fR, \fI.pfb\fR, \fI.ttf\fR, and
other common font formats, as well.
-.SS "Acknowledgments"
+.SS Acknowledgments
.IX Subsection "Acknowledgments"
Thanks to Fabien Vignes-Tourneret for suggesting what became the
\&\f(CW\*(C`\-\-localonly\*(C'\fR option and for a discussion that led to the
@@ -535,6 +457,6 @@
.IX Header "SEE ALSO"
\&\fBarlatex\fR\|(1), \fBgzip\fR\|(1), \fBkpsewhich\fR\|(1), \fBlatex\fR\|(1), \fBperl\fR\|(1), \fBzip\fR\|(1),
the \fBsnapshot\fR documentation
-.SH "AUTHOR"
+.SH AUTHOR
.IX Header "AUTHOR"
Scott Pakin, \fIscott+bdoc at pakin.org\fR
Modified: branches/branch2024.final/Master/texmf-dist/doc/man/man1/bundledoc.man1.pdf
===================================================================
(Binary files differ)
Modified: branches/branch2024.final/Master/texmf-dist/doc/support/bundledoc/README
===================================================================
--- branches/branch2024.final/Master/texmf-dist/doc/support/bundledoc/README 2025-02-26 21:15:11 UTC (rev 74314)
+++ branches/branch2024.final/Master/texmf-dist/doc/support/bundledoc/README 2025-02-26 21:15:23 UTC (rev 74315)
@@ -25,14 +25,14 @@
Files
-----
--rwxr-xr-x 1 pakin users 9850 Oct 3 21:24 arlatex
--rw-r--r-- 1 pakin users 10187 Oct 3 21:24 arlatex.1
--rw-r--r-- 1 pakin users 32073 Oct 3 21:24 arlatex.pdf
--rwxr-xr-x 1 pakin users 31263 Sep 7 2019 bundledoc
--rw-r--r-- 1 pakin users 23351 Sep 7 2019 bundledoc.1
--rw-r--r-- 1 pakin users 49713 Sep 7 2019 bundledoc.pdf
+-rwxr-xr-x 1 pakin users 9850 Feb 25 22:28 arlatex
+-rw-r--r-- 1 pakin users 7714 Feb 25 22:29 arlatex.1
+-rw-r--r-- 1 pakin users 32842 Feb 25 22:29 arlatex.pdf
+-rwxr-xr-x 1 pakin users 31262 Feb 25 22:24 bundledoc
+-rw-r--r-- 1 pakin users 20632 Feb 25 22:26 bundledoc.1
+-rw-r--r-- 1 pakin users 49080 Feb 25 22:26 bundledoc.pdf
-rw-r--r-- 1 pakin users 342 Jan 22 2014 miktex.cfg
--rw-r--r-- 1 pakin users 4435 Oct 3 21:27 README
+-rw-r--r-- 1 pakin users 4476 Feb 25 22:29 README
-rw-r--r-- 1 pakin users 248 Aug 24 2014 texlive-unix-arlatex.cfg
-rw-r--r-- 1 pakin users 230 Apr 9 2010 texlive-unix.cfg
@@ -42,12 +42,13 @@
bundledoc and arlatex are both Perl scripts, so you naturally need
Perl installed on your system. bundledoc relies on the snapshot
-package, which is available from CTAN (http://www.ctan.org). Before
-running bundledoc, you must have used snapshot to produce a dependency
-list for your document. Finally, bundledoc requires that you have
-some program for archiving a bunch of files into a single file
-(e.g. tar, shar, zip, or arlatex) and some program that can search
-your TeX tree(s) for a given file (e.g., kpsewhich or initexmf).
+package, which is available from CTAN (https://www.ctan.org/) and
+included in most TeX distributions. Before running bundledoc, you
+must have used snapshot to produce a dependency list for your
+document. Finally, bundledoc requires that you have some program for
+archiving a bunch of files into a single file (e.g. tar, shar, zip, or
+arlatex) and some program that can search your TeX tree(s) for a given
+file (e.g., kpsewhich or initexmf).
Installation
@@ -84,7 +85,7 @@
---------------------
bundledoc
- Copyright (C) 2018-2019 Scott Pakin
+ Copyright (C) 2018-2025 Scott Pakin
This program may be distributed and/or modified under the conditions
of the LaTeX Project Public License, either version 1.3c of this
Modified: branches/branch2024.final/Master/texmf-dist/scripts/bundledoc/arlatex
===================================================================
--- branches/branch2024.final/Master/texmf-dist/scripts/bundledoc/arlatex 2025-02-26 21:15:11 UTC (rev 74314)
+++ branches/branch2024.final/Master/texmf-dist/scripts/bundledoc/arlatex 2025-02-26 21:15:23 UTC (rev 74315)
@@ -9,7 +9,7 @@
########################################################################
# arlatex #
-# Copyright (C) 2018-2022 Scott Pakin #
+# Copyright (C) 2018-2025 Scott Pakin #
# #
# This program may be distributed and/or modified under the conditions #
# of the LaTeX Project Public License, either version 1.3c of this #
Modified: branches/branch2024.final/Master/texmf-dist/scripts/bundledoc/bundledoc
===================================================================
--- branches/branch2024.final/Master/texmf-dist/scripts/bundledoc/bundledoc 2025-02-26 21:15:11 UTC (rev 74314)
+++ branches/branch2024.final/Master/texmf-dist/scripts/bundledoc/bundledoc 2025-02-26 21:15:23 UTC (rev 74315)
@@ -7,7 +7,7 @@
########################################################################
# bundledoc #
-# Copyright (C) 2018-2019 Scott Pakin #
+# Copyright (C) 2018-2025 Scott Pakin #
# #
# This program may be distributed and/or modified under the conditions #
# of the LaTeX Project Public License, either version 1.3c of this #
@@ -25,7 +25,7 @@
########################################################################
use 5.006; # Fail gracefully if we're not using Perl v5.6.0+.
-our $VERSION = "3.4"; # Specify the version of bundledoc.
+our $VERSION = "3.5"; # Specify the version of bundledoc.
use File::Basename;
use File::Copy;
use File::Spec::Functions qw(abs2rel catfile devnull rel2abs rootdir updir);
@@ -33,6 +33,7 @@
use File::Temp qw(tempdir);
use Getopt::Long;
use Pod::Usage;
+use String::ShellQuote;
use warnings;
use strict;
@@ -66,8 +67,7 @@
# or abort if we can't.
sub qualifyname ($)
{
- my $filename = $_[0];
- $filename = "\"$filename\"" if $filename =~ /\s/ && substr($filename, 0, 1) ne '"';
+ my $filename = shell_quote $_[0];
my $command = $uservariable{find};
$command =~ s/[\$\%]BDINPUTS\%?/$filename/g;
$command =~ s/[\$\%]BDBASE\%?/$ENV{"BDBASE"}/g;
@@ -151,12 +151,12 @@
printf("CONFIGURATION FILE: %s\n", rel2abs($configfile)) if $verbose;
my $prevline = "";
open (CONFIGFILE, "<", $configfile) || do {
- my $configlist = $configfile;
- if (! -e $configfile) {
- # Error is "file not found". List the files we considered.
- $configlist .= "; also considered ${configfile}.cfg" if $configfile !~ /\.cfg$/;
- }
- die "${progname}: $! ($configlist)\n";
+ my $configlist = $configfile;
+ if (! -e $configfile) {
+ # Error is "file not found". List the files we considered.
+ $configlist .= "; also considered ${configfile}.cfg" if $configfile !~ /\.cfg$/;
+ }
+ die "${progname}: $! ($configlist)\n";
};
while (my $oneline=<CONFIGFILE>) {
# Read a line and trim it.
@@ -378,7 +378,7 @@
mkpath($targetdir, 0, 0777) || die "${progname}: $! ($targetdir)\n";
}
}
- copy ($dep, $targetdir) || die "${progname}: $! ($targetdir)\n";
+ copy ($dep, $targetdir) || die "${progname}: $! ($dep --> $targetdir)\n";
}
if ($manifest ne "") {
my $manifest = catfile $tempdir2, $manifest;
More information about the tex-live-commits
mailing list.