texdirflatten (27jun17)

git-svn-id: svn://tug.org/texlive/trunk@44713 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 55 insertions, 0 deletions

diff --git a/Master/texmf-dist/doc/support/texdirflatten/README b/Master/texmf-dist/doc/support/texdirflatten/README
new file mode 100644
index 00000000000..5705aa21a91
--- /dev/null
+++ b/Master/texmf-dist/doc/support/texdirflatten/README
@@ -0,0 +1,55 @@
+NAME
+    texdirflatten - Collects all components of a (La)TeX file in a single
+    output directory -- i.e., flattens its hierarchy.
+
+SYNOPSIS
+    texdirflatten [-1|--onetex] [-f|--file input.tex] [-o outputdir]
+    [-?|--help]
+
+DESCRIPTION
+    It parses the source file, following its included children (La)TeX files
+    recursively, to collect together its components, such as graphics and
+    BiBTeX bibliography files in different directories.
+
+OPTIONS
+    --file, -f *input.tex*
+        Specifies input (La)TeX file.
+
+    --onetex, -1
+        If specified, produces a single TeX file by expanding all \input and
+        \include commands in place.
+
+    --output, -o *outputdir*
+        Directory to collect all files. texdirflatten will copy each source
+        file, graphics and bibliography file to this directory. It will be
+        created if it is unexistent. If unspecified, it defaults to "flat/".
+
+    --help, -?
+        Show this manual page.
+
+EXAMPLES
+    The following example scans "manuscript.tex" in the current directory
+    and gathers it and all its components in the "submit_01/" directory:
+
+     $ texdirflatten -f manuscript.tex -o submit_01
+
+CAVEATS
+    Please take backups before running this command. No warranties
+    whatsoever provided.
+
+    You may need to run "epstopdf" on EPS files if you are using "pdflatex":
+
+     $ for i in *.eps; do epstopdf $i; done
+
+BUGS
+    Bug reports and patches are welcome.
+
+AUTHOR
+    Cengiz Gunay <cengique<AT>users.sf.net>
+
+COPYRIGHT AND LICENSE
+    Copyleft 2003-2017, Cengiz Gunay
+
+    This library is free software; you may redistribute it and/or modify it
+    under the same terms as Perl itself.
+