summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latexpand/README
blob: 673177188bd9211fb889d85f01f638ddf173eb23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
NAME
    latexpand - Flatten LaTeX file by expanding \include and \input, ... and
    remove comments

SYNOPSIS
    latexpand [options] FILE...

  Options:
            --verbose        show what's going on
            --keep-comments  don't strip comments (comments are lines
                             starting with %, and anything below
                             \end{document})
            --empty-comments keep empty comments (i.e. % at end of lines) for clarity
            --keep-includes  don't expand \input and \include directives
            --expand-usepackage
                             Expand \usepackage{...} directives if the
                             corresponding .sty file is found in
                             $TEXINPUTS
            --expand-bbl FILE
                             Expand the bibliography by inlining FILE
                             (should be a *.bbl file)
            --help           this help message
            --output <file>, -o <file>
                             generate output in <file>
            --explain        generate explanatory comments in output
            --show-graphics  show included graphics
            --graphics_extensions
                             colon-separated list of possible graphics extensions
                             (used by --show-graphics to find the actual graphics files)

USES
    The most common use of latexpand is to simplify distribution of source
    LaTeX files, typically to satisfy the requirement of editors and
    archival sites (springer, arXiv.org, ...) who force the authors to
    submit sources. One does not necessarily want to submit sources with
    comments, and uploading a document made of several files including each
    other is a bit painful. By default, latexpand answers both problems by
    outputing a single LaTeX file that contain no comment.

GETTING LATEXPAND
    The latest version of latexpand is available here:

      https://gitorious.org/latexpand

    Versions are uploaded to ctan.org from time to time:

      http://www.ctan.org/pkg/latexpand

BUGS
    Please, report bugs to Matthieu Moy <Matthieu.Moy@imag.fr>.

  Known bugs
    latexpand currently ignores \begin{verbatim} ... \end{verbatim}, and
    will therefore process any \include, \input, ... directives that appear
    within verbatim environments (while it shouldn't).

    It would be nice to remove code between \begin{comment} and
    \end{comment} too if \usepackage{comment} is used.

    Code like

            foo%
            \begin{comment}

    will produce the incorrect

            foo\begin{comment}

    A workaround is to use --empty-comments when such tricky usage of the
    comments package is done.