diff options
Diffstat (limited to 'support/latexindent/LatexIndent/LogFile.pm')
-rw-r--r-- | support/latexindent/LatexIndent/LogFile.pm | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/support/latexindent/LatexIndent/LogFile.pm b/support/latexindent/LatexIndent/LogFile.pm index 8a35c3c2a2..ca8376daa9 100644 --- a/support/latexindent/LatexIndent/LogFile.pm +++ b/support/latexindent/LatexIndent/LogFile.pm @@ -34,7 +34,7 @@ sub processSwitches{ if(scalar(@ARGV) < 1 or $switches{showhelp}) { print <<ENDQUOTE latexindent.pl version $versionNumber, $versionDate -usage: latexindent.pl [options] [file][.tex|.sty|.cls|.bib|...] +usage: latexindent.pl [options] [file] -v, --version displays the version number and date of release -h, --help @@ -43,8 +43,8 @@ usage: latexindent.pl [options] [file][.tex|.sty|.cls|.bib|...] log file will also be output to the screen -o, --outputfile=<name-of-output-file> output to another file; sample usage: - latexindent.pl -o outputfile.tex myfile.tex - latexindent.pl -o=outputfile.tex myfile.tex + latexindent.pl -o outputfile.tex myfile.tex + latexindent.pl -o=outputfile.tex myfile.tex -w, --overwrite overwrite the current file; a backup will be made, but still be careful -s, --silent @@ -52,12 +52,13 @@ usage: latexindent.pl [options] [file][.tex|.sty|.cls|.bib|...] -t, --trace tracing mode: verbose information given to the log file -l, --local[=myyaml.yaml] - use localSettings.yaml (assuming it exists in the directory of your file, - or in the current working directory); alternatively, use myyaml.yaml, if it exists; + use `localSettings.yaml`, `.localSettings.yaml`, `latexindent.yaml`, + or `.latexindent.yaml` (assuming one of them exists in the directory of your file or in + the current working directory); alternatively, use `myyaml.yaml`, if it exists; sample usage: - latexindent.pl -l some.yaml myfile.tex - latexindent.pl -l=another.yaml myfile.tex - latexindent.pl -l=some.yaml,another.yaml myfile.tex + latexindent.pl -l some.yaml myfile.tex + latexindent.pl -l=another.yaml myfile.tex + latexindent.pl -l=some.yaml,another.yaml myfile.tex -y, --yaml=<yaml settings> specify YAML settings; sample usage: latexindent.pl -y="defaultIndent:' '" myfile.tex @@ -66,19 +67,19 @@ usage: latexindent.pl [options] [file][.tex|.sty|.cls|.bib|...] ONLY use defaultSettings.yaml, ignore ALL (yaml) user files -g, --logfile=<name of log file> used to specify the name of logfile (default is indent.log) - -c, --cruft=<cruft directory> + -c, --cruft=<cruft directory> used to specify the location of backup files and indent.log -m, --modifylinebreaks - modify linebreaks before, during, and at the end of code blocks; + modify linebreaks before, during, and at the end of code blocks; trailing comments and blank lines can also be added using this feature - -r,--replacement + -r, --replacement replacement mode, allows you to replace strings and regular expressions verbatim blocks not respected - -rv,--replacementrespectverb + -rv, --replacementrespectverb replacement mode, allows you to replace strings and regular expressions while respecting verbatim code blocks - -rr,--onlyreplacement - *only* replacement mode, no indentation + -rr, --onlyreplacement + *only* replacement mode, no indentation; verbatim blocks not respected ENDQUOTE ; |