Debian Codegraph @

texmf-dist/doc/man/man1/texdirflatten.1

raw
1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 . if \nF \{
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "TEXDIRFLATTEN 1"
136 .TH TEXDIRFLATTEN 1 "2017-07-03" "texdirflatten-v1.3" "User Contributed Perl Documentation"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 texdirflatten \- Collects all components of a (La)TeX file in a
143 single output directory \-\- i.e., flattens its hierarchy.
144 .SH "SYNOPSIS"
145 .IX Header "SYNOPSIS"
146 texdirflatten [\-1|\-\-onetex] [\-f|\-\-file input.tex] [\-o outputdir]
147 [\-\-imgexts .ext1,.ext2,...] [\-\-debug] [\-V|\-\-version] [\-?|\-\-help]
148 .SH "DESCRIPTION"
149 .IX Header "DESCRIPTION"
150 This Perl script parses a LaTeX file recursively, scanning all child
151 files, and collects details of any included and other data files, such
152 as graphics and BiBTeX bibliography files. These component files, are
153 then all put into a single directory (thus \*(L"flattening\*(R" the document's
154 directory tree). This is useful in distributing manuscripts to
155 collaborators or in submitting to journals.
156 .SH "OPTIONS"
157 .IX Header "OPTIONS"
158 .IP "\fB\-\-file\fR, \fB\-f\fR \fIinput.tex\fR" 4
159 .IX Item "--file, -f input.tex"
160 Specifies input (La)TeX file.
161 .IP "\fB\-\-onetex\fR, \fB\-1\fR" 4
162 .IX Item "--onetex, -1"
163 If specified, produces a single TeX file by expanding all \einput and
164 \&\einclude commands in place.
165 .IP "\fB\-\-output\fR, \fB\-o\fR \fIoutputdir\fR" 4
166 .IX Item "--output, -o outputdir"
167 Directory to collect all files. \fBtexdirflatten\fR will copy each source
168 file, graphics and bibliography file to this directory. It will be
169 created if it is unexistent. If unspecified, it defaults to \f(CW\*(C`flat/\*(C'\fR.
170 .IP "\fB\-\-imgexts\fR \fI.ext1,.ext2[,...]\fR" 4
171 .IX Item "--imgexts .ext1,.ext2[,...]"
172 Prepends to the prioritized list of image extensions to search when
173 trying to find the image to copy to output folder. The first file with
174 the extension found will be copied and search stopped. Default order
175 is \f(CW"", ".eps", ".pdf", ".pstex"\fR (note that it includes files with
176 no extension). If using pdflatex, one may want to add \s-1PDF\s0 before \s-1EPS\s0
177 with \f(CW\*(C`\-\-imgexts .pdf\*(C'\fR. Don't forget the dot before the extension!
178 .IP "\fB\-\-debug\fR" 4
179 .IX Item "--debug"
180 Enables copious amounts of debugging output \- useful if something is going wrong.
181 .IP "\fB\-\-version\fR, \fB\-V\fR" 4
182 .IX Item "--version, -V"
183 Displays the current version number and the usage and exits.
184 .IP "\fB\-\-help\fR, \fB\-?\fR" 4
185 .IX Item "--help, -?"
186 Show this manual page.
187 .SH "EXAMPLES"
188 .IX Header "EXAMPLES"
189 The following example scans \f(CW\*(C`manuscript.tex\*(C'\fR in the current directory
190 and gathers it and all its components in the \f(CW\*(C`submit_01/\*(C'\fR directory:
191 .PP
192 .Vb 1
193 \& $ texdirflatten \-f manuscript.tex \-o submit_01
194 .Ve
195 .SH "CAVEATS"
196 .IX Header "CAVEATS"
197 Please take backups before running this command. No warranties
198 whatsoever provided.
199 .PP
200 You may need to run \f(CW\*(C`epstopdf\*(C'\fR on \s-1EPS\s0 files if you are using \f(CW\*(C`pdflatex\*(C'\fR:
201 .PP
202 .Vb 1
203 \& $ for i in *.eps; do epstopdf $i; done
204 .Ve
205 .SH "BUGS"
206 .IX Header "BUGS"
207 Bug reports and patches are welcome.
208 .SH "AUTHOR"
209 .IX Header "AUTHOR"
210 Cengiz Gunay <cengique<\s-1AT\s0>users.sf.net>
211 .SH "COPYRIGHT AND LICENSE"
212 .IX Header "COPYRIGHT AND LICENSE"
213 Copyleft 2003\-2017, Cengiz Gunay
214 .PP
215 This library is free software; you may redistribute it and/or modify
216 it under the same terms as Perl itself.