summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latexindent/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-10-30 20:55:11 +0000
committerKarl Berry <karl@freefriends.org>2022-10-30 20:55:11 +0000
commit61064bf719cf92ef51d33afec7d7527e5f090b5f (patch)
treef365d581237132a0da1fcb12d8b3256370b74000 /Master/texmf-dist/doc/support/latexindent/README
parent6a866a6823f130092bc2190bc07bde90b20bae42 (diff)
latexindent, I mean (30oct22)
git-svn-id: svn://tug.org/texlive/trunk@64874 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/latexindent/README')
-rw-r--r--Master/texmf-dist/doc/support/latexindent/README26
1 files changed, 15 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/support/latexindent/README b/Master/texmf-dist/doc/support/latexindent/README
index 7a48e5607f8..44ef79a17e7 100644
--- a/Master/texmf-dist/doc/support/latexindent/README
+++ b/Master/texmf-dist/doc/support/latexindent/README
@@ -1,5 +1,5 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- latexindent.pl, version 3.18, 2022-06-12
+ latexindent.pl, version 3.19, 2022-10-30
PERL script to indent code within environments, and align delimited
environments in .tex files.
@@ -24,9 +24,14 @@
FOR COMPLETE DETAILS, PLEASE SEE documentation/latexindent.pdf
-Note: latexindent.exe was created using
+Note: The standalone executable files (in the bin directory) are created using commands
+ such as the following:
- perl ppp.pl -u -o latexindent.exe latexindent.pl
+ pp
+ --addfile="defaultSettings.yaml;lib/LatexIndent/defaultSettings.yaml"
+ --cachedeps=scancache
+ --output latexindent-linux
+ latexindent.pl
using the Par::Packer perl module.
@@ -43,15 +48,14 @@ USAGE
* IMPORTANT *
-This script may not work for your style of formatting; I highly
-recommend comparing the outputfile.tex to make sure that
+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.
-I recommend both using the following:
- - a visual check, at the very least, make sure that
- each file has the same number of lines
- - a check using latexdiff inputfile.tex outputfile.tex
- - git status myfile.tex
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%