summaryrefslogtreecommitdiff
path: root/support/latexindent/README
blob: df74dc160cbdc5d790d8ba205538d4d783781004 (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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    latexindent.pl, version 3.22, 2023-06-01

    PERL script to indent code within environments, and align delimited 
    environments in .tex files.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    See http://www.gnu.org/licenses/

    C. M. Hughes

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+

FOR COMPLETE DETAILS, PLEASE SEE documentation/latexindent.pdf

Note: The standalone executable files (in the bin directory) are created using commands
      such as the following:

      pp 
      --addfile="defaultSettings.yaml;lib/LatexIndent/defaultSettings.yaml"
      --cachedeps=scancache
      --output latexindent-linux
      latexindent.pl

      using the Par::Packer perl module.

*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+*+

USAGE
    You'll need

        latexindent.pl
        LatexIndent/*.pm
        defaultSettings.yaml

    in the same directory. Windows users might prefer to grab latexindent.exe

* IMPORTANT *

This script may not work for your style of formatting; I highly
recommend that when you first use the script you use the `-o` switch
to output to a separate file; something like

    latexindent.pl myfile.tex -o myfile-output.tex

and then check `myfile-output.tex` carefully to make sure that
nothing has been changed (or removed) in a way that will damage
your file.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%