-.\" Automatically generated by Pod::Man v1.3, Pod::Parser v1.13
+.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ve \" End verbatim text
.ft R
-
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds R" ''
'br\}
.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
-.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+. de IX
+..
+.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
.\" ========================================================================
.\"
.IX Title "PERLTIDY 1"
-.TH PERLTIDY 1 "2003-10-22" "perl v5.6.1" "User Contributed Perl Documentation"
-.UC
+.TH PERLTIDY 1 "2010-12-13" "perl v5.10.0" "User Contributed Perl Documentation"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
.SH "NAME"
perltidy \- a perl script indenter and reformatter
.SH "SYNOPSIS"
.Vb 5
\& perltidy [ options ] file1 file2 file3 ...
\& (output goes to file1.tdy, file2.tdy, file3.tdy, ...)
-\& perltidy [ options ] file1 -o outfile
-\& perltidy [ options ] file1 -st >outfile
+\& perltidy [ options ] file1 \-o outfile
+\& perltidy [ options ] file1 \-st >outfile
\& perltidy [ options ] <infile >outfile
.Ve
.SH "DESCRIPTION"
existence of an \fB\-html\fR flag. Without this flag, the output is passed
through a formatter. The default formatting tries to follow the
recommendations in \fIperlstyle\fR\|(1), but it can be controlled in detail with
-numerous input parameters, which are described in \*(L"\s-1FORMATTING\s0 \s-1OPTIONS\s0\*(R".
+numerous input parameters, which are described in \*(L"\s-1FORMATTING\s0
+\&\s-1OPTIONS\s0\*(R".
.PP
When the \fB\-html\fR flag is given, the output is passed through an \s-1HTML\s0
-formatter which is described in \*(L"\s-1HTML\s0 \s-1OPTIONS\s0\*(R".
+formatter which is described in \*(L"\s-1HTML\s0 \s-1OPTIONS\s0\*(R".
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 1
\& perltidy somefile.pl
.Ve
+.PP
This will produce a file \fIsomefile.pl.tdy\fR containing the script reformatted
using the default options, which approximate the style suggested in
\&\fIperlstyle\fR\|(1). Perltidy never changes the input file.
.Vb 1
\& perltidy *.pl
.Ve
+.PP
Execute perltidy on all \fI.pl\fR files in the current directory with the
default options. The output will be in files with an appended \fI.tdy\fR
extension. For any file with an error, there will be a file with extension
\&\fI.ERR\fR.
.PP
.Vb 1
-\& perltidy -b file1.pl file2.pl
+\& perltidy \-b file1.pl file2.pl
.Ve
-Modify \fIfile1.pl\fR and \fIfile1.pl\fR in place, and backup the originals to
+.PP
+Modify \fIfile1.pl\fR and \fIfile2.pl\fR in place, and backup the originals to
\&\fIfile1.pl.bak\fR and \fIfile2.pl.bak\fR. If \fIfile1.pl.bak\fR and/or \fIfile2.pl.bak\fR
already exist, they will be overwritten.
.PP
.Vb 1
-\& perltidy -gnu somefile.pl
+\& perltidy \-gnu somefile.pl
.Ve
+.PP
Execute perltidy on file \fIsomefile.pl\fR with a style which approximates the
\&\s-1GNU\s0 Coding Standards for C programs. The output will be \fIsomefile.pl.tdy\fR.
.PP
.Vb 1
-\& perltidy -i=3 somefile.pl
+\& perltidy \-i=3 somefile.pl
.Ve
+.PP
Execute perltidy on file \fIsomefile.pl\fR, with 3 columns for each level of
indentation (\fB\-i=3\fR) instead of the default 4 columns. There will not be any
tabs in the reformatted script, except for any which already exist in comments,
-pod documents, quotes, and here documents. Output will be \fIsomefile.pl.tdy\fR.
+pod documents, quotes, and here documents. Output will be \fIsomefile.pl.tdy\fR.
.PP
.Vb 1
-\& perltidy -i=3 -et=8 somefile.pl
+\& perltidy \-i=3 \-et=8 somefile.pl
.Ve
+.PP
Same as the previous example, except that leading whitespace will
be entabbed with one tab character per 8 spaces.
.PP
.Vb 1
-\& perltidy -ce -l=72 somefile.pl
+\& perltidy \-ce \-l=72 somefile.pl
.Ve
+.PP
Execute perltidy on file \fIsomefile.pl\fR with all defaults except use \*(L"cuddled
elses\*(R" (\fB\-ce\fR) and a maximum line length of 72 columns (\fB\-l=72\fR) instead of
-the default 80 columns.
+the default 80 columns.
.PP
.Vb 1
-\& perltidy -g somefile.pl
+\& perltidy \-g somefile.pl
.Ve
+.PP
Execute perltidy on file \fIsomefile.pl\fR and save a log file \fIsomefile.pl.LOG\fR
which shows the nesting of braces, parentheses, and square brackets at
the start of every line.
.PP
.Vb 1
-\& perltidy -html somefile.pl
+\& perltidy \-html somefile.pl
.Ve
+.PP
This will produce a file \fIsomefile.pl.html\fR containing the script with
html markup. The output file will contain an embedded style sheet in
the <\s-1HEAD\s0> section which may be edited to change the appearance.
.PP
.Vb 1
-\& perltidy -html -css=mystyle.css somefile.pl
+\& perltidy \-html \-css=mystyle.css somefile.pl
.Ve
+.PP
This will produce a file \fIsomefile.pl.html\fR containing the script with
html markup. This output file will contain a link to a separate style
sheet file \fImystyle.css\fR. If the file \fImystyle.css\fR does not exist,
it will be created. If it exists, it will not be overwritten.
.PP
.Vb 1
-\& perltidy -html -pre somefile.pl
+\& perltidy \-html \-pre somefile.pl
.Ve
+.PP
Write an html snippet with only the \s-1PRE\s0 section to \fIsomefile.pl.html\fR.
This is useful when code snippets are being formatted for inclusion in a
-larger web page. No style sheet will be written in this case.
+larger web page. No style sheet will be written in this case.
.PP
.Vb 1
-\& perltidy -html -ss >mystyle.css
+\& perltidy \-html \-ss >mystyle.css
.Ve
+.PP
Write a style sheet to \fImystyle.css\fR and exit.
.PP
.Vb 1
-\& perltidy -html -frm mymodule.pm
+\& perltidy \-html \-frm mymodule.pm
.Ve
+.PP
Write html with a frame holding a table of contents and the source code. The
output files will be \fImymodule.pm.html\fR (the frame), \fImymodule.pm.toc.html\fR
(the table of contents), and \fImymodule.pm.src.html\fR (the source code).
\&\fB\-g\fR may \s-1NOT\s0 be entered as \fB\-qg\fR.
.PP
Option names may be terminated early as long as they are uniquely identified.
-For example, instead of \fB\-dump\-token\-types\fR, it would be sufficient to enter
-\&\fB\-dump\-tok\fR, or even \fB\-dump\-t\fR, to uniquely identify this command.
-.Sh "I/O control"
+For example, instead of \fB\-\-dump\-token\-types\fR, it would be sufficient to enter
+\&\fB\-\-dump\-tok\fR, or even \fB\-\-dump\-t\fR, to uniquely identify this command.
+.SS "I/O control"
.IX Subsection "I/O control"
The following parameters concern the files which are read and written.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
request outputting to the standard output. For example,
.Sp
.Vb 1
-\& perltidy somefile.pl -st >somefile.new.pl
+\& perltidy somefile.pl \-st >somefile.new.pl
.Ve
+.Sp
This option may only be used if there is just a single input file.
-The default is \fB\-nst\fR or \fB\-nostandard\-output\fR.
+The default is \fB\-nst\fR or \fB\-\-nostandard\-output\fR.
.IP "\fB\-se\fR, \fB\-\-standard\-error\-output\fR" 4
.IX Item "-se, --standard-error-output"
If perltidy detects an error when processing file \fIsomefile.pl\fR, its
For example
.Sp
.Vb 1
-\& perltidy somefile.pl -opath=/tmp/
+\& perltidy somefile.pl \-opath=/tmp/
.Ve
+.Sp
will produce \fI/tmp/somefile.pl.tdy\fR. Otherwise, \fIsomefile.pl.tdy\fR will
appear in whatever directory contains \fIsomefile.pl\fR.
.Sp
.IX Item "-b, --backup-and-modify-in-place"
Modify the input file or files in-place and save the original with the
extension \fI.bak\fR. Any existing \fI.bak\fR file will be deleted. See next item
-for changing the default backup extension.
+for changing the default backup extension.
.Sp
A \fB\-b\fR flag will be ignored if input is from standard input, or
-if the \fB\-html\fR flag is set.
+if the \fB\-html\fR flag is set.
.IP "\fB\-bext\fR=ext, \fB\-\-backup\-file\-extension\fR=ext" 4
.IX Item "-bext=ext, --backup-file-extension=ext"
Change the extension of the backup file to be something other than the
.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
.IX Item "-q, --quiet"
Deactivate error messages and syntax checking (for running under
-an editor).
+an editor).
.Sp
For example, if you use a vi-style editor, such as vim, you may execute
perltidy as a filter from within the editor using something like
.Sp
.Vb 1
-\& :n1,n2!perltidy -q
+\& :n1,n2!perltidy \-q
.Ve
+.Sp
where \f(CW\*(C`n1,n2\*(C'\fR represents the selected text. Without the \fB\-q\fR flag,
any error message may mess up your screen, so be prepared to use your
\&\*(L"undo\*(R" key.
this flag is to assist in debugging nesting errors. The value of \f(CW\*(C`n\*(C'\fR is
optional. If you set the flag \fB\-g\fR without the value of \f(CW\*(C`n\*(C'\fR, it will be
taken to be 1, meaning that every line will be written to the log file. This
-can be helpful if you are looking for a brace, paren, or bracket nesting error.
+can be helpful if you are looking for a brace, paren, or bracket nesting error.
.Sp
Setting \fB\-g\fR also causes the logfile to be saved, so it is not necessary to
-also include \fB\-log\fR.
+also include \fB\-log\fR.
.Sp
If no \fB\-g\fR flag is given, a value of 50 will be used, meaning that at least
every 50th line will be recorded in the logfile. This helps prevent
-excessively long log files.
+excessively long log files.
.Sp
Setting a negative value of \f(CW\*(C`n\*(C'\fR is the same as not setting \fB\-g\fR at all.
.IP "\fB\-npro\fR \fB\-\-noprofile\fR" 4
\&'=' sign. For example, the line
.Sp
.Vb 1
-\& perltidy -pro=testcfg
+\& perltidy \-pro=testcfg
.Ve
+.Sp
would cause file \fItestcfg\fR to be used instead of the
default \fI.perltidyrc\fR.
+.Sp
+A pathname begins with three dots, e.g. \*(L".../.perltidyrc\*(R", indicates that
+the file should be searched for starting in the current directory and
+working upwards. This makes it easier to have multiple projects each with
+their own .perltidyrc in their root directories.
.IP "\fB\-opt\fR, \fB\-\-show\-options\fR" 4
.IX Item "-opt, --show-options"
Write a list of all options used to the \fI.LOG\fR file.
.IP "\fB\-f\fR, \fB\-\-force\-read\-binary\fR" 4
.IX Item "-f, --force-read-binary"
Force perltidy to process binary files. To avoid producing excessive
-error messages, perltidy skips files identified by the system as non\-text.
+error messages, perltidy skips files identified by the system as non-text.
However, valid perl scripts containing binary data may sometimes be identified
-as non\-text, and this flag forces perltidy to process them.
+as non-text, and this flag forces perltidy to process them.
.SH "FORMATTING OPTIONS"
.IX Header "FORMATTING OPTIONS"
-.Sh "Basic Options"
+.SS "Basic Options"
.IX Subsection "Basic Options"
+.IP "\fB\-\-notidy\fR" 4
+.IX Item "--notidy"
+This flag disables all formatting and causes the input to be copied unchanged
+to the output except for possible changes in line ending characters and any
+pre\- and post-filters. This can be useful in conjunction with a hierarchical
+set of \fI.perltidyrc\fR files to avoid unwanted code tidying. See also
+\&\*(L"Skipping Selected Sections of Code\*(R" for a way to avoid tidying specific
+sections of code.
.IP "\fB\-l=n\fR, \fB\-\-maximum\-line\-length=n\fR" 4
.IX Item "-l=n, --maximum-line-length=n"
The default maximum line length is n=80 characters. Perltidy will try
to find line break points to keep lines below this length. However, long
quotes and side comments may cause lines to exceed this length.
-Setting \fB\-l=0\fR is equivalent to setting \fB\-l=(a large number)\fR.
+Setting \fB\-l=0\fR is equivalent to setting \fB\-l=(a large number)\fR.
.IP "\fB\-i=n\fR, \fB\-\-indent\-columns=n\fR" 4
.IX Item "-i=n, --indent-columns=n"
Use n columns per indentation level (default n=4).
Using tab characters will almost certainly lead to future portability
and maintenance problems, so the default and recommendation is not to
use them. For those who prefer tabs, however, there are two different
-options.
+options.
.Sp
Except for possibly introducing tab indentation characters, as outlined
below, perltidy does not introduce any tab characters into your file,
and it removes any tabs from the code (unless requested not to do so
with \fB\-fws\fR). If you have any tabs in your comments, quotes, or
-here\-documents, they will remain.
+here-documents, they will remain.
.RS 4
.IP "\fB\-et=n\fR, \fB\-\-entab\-leading\-whitespace\fR" 4
.IX Item "-et=n, --entab-leading-whitespace"
opinion\*(R".
.Sp
If perl reports errors in the input file, they will not be reported in
-the error output unless the \fB\-warning\-output\fR flag is given.
+the error output unless the \fB\-\-warning\-output\fR flag is given.
.Sp
The default is \fBnot\fR to do this type of syntax checking (although
perltidy will still do as much self-checking as possible). The reason
passed a \fB\-x\fR flag. It should not normally be necessary to change
these flags, but it can be done with the \fB\-pscf=s\fR flag. For example,
if the taint flag, \f(CW\*(C`\-T\*(C'\fR, is not wanted, the flag could be set to be just
-\&\fB\-pscf=\-c\fR.
+\&\fB\-pscf=\-c\fR.
.Sp
Perltidy will pass your string to perl with the exception that it will
add a \fB\-c\fR and \fB\-x\fR if appropriate. The \fI.LOG\fR file will show
exactly what flags were passed to perl.
.IP "\fB\-io\fR, \fB\-\-indent\-only\fR" 4
.IX Item "-io, --indent-only"
-This flag is used to deactivate all formatting and line break changes.
-When it is in effect, the only change to the script will be indentation.
+This flag is used to deactivate all formatting and line break changes
+within non-blank lines of code.
+When it is in effect, the only change to the script will be
+to the indentation and blank lines.
And any flags controlling whitespace and newlines will be ignored. You
might want to use this if you are perfectly happy with your whitespace
and line breaks, and merely want perltidy to handle the indentation.
.Sp
Setting this flag is equivalent to setting \fB\-\-freeze\-newlines\fR and
\&\fB\-\-freeze\-whitespace\fR.
+.Sp
+If you also want to keep your existing blank lines exactly
+as they are, you can add \fB\-\-freeze\-blank\-lines\fR.
.IP "\fB\-ole=s\fR, \fB\-\-output\-line\-ending=s\fR" 4
.IX Item "-ole=s, --output-line-ending=s"
where s=\f(CW\*(C`win\*(C'\fR, \f(CW\*(C`dos\*(C'\fR, \f(CW\*(C`unix\*(C'\fR, or \f(CW\*(C`mac\*(C'\fR. This flag tells perltidy
to output line endings for a specific system. Normally,
perltidy writes files with the line separator character of the host
system. The \f(CW\*(C`win\*(C'\fR and \f(CW\*(C`dos\*(C'\fR flags have an identical result.
-\&\fB\s-1NOTE\s0\fR: This only works under unix-like systems and is ignored under
-other systems.
.IP "\fB\-ple\fR, \fB\-\-preserve\-line\-endings\fR" 4
.IX Item "-ple, --preserve-line-endings"
This flag tells perltidy to write its output files with the same line
input comes from a filename (rather than stdin, for example). If
perltidy has trouble determining the input file line ending, it will
revert to the default behavior of using the line ending of the host system.
-\&\fB\s-1NOTE\s0\fR: This only works under unix-like systems and is ignored under
-other systems.
-.Sh "Code Indentation Control"
+.IP "\fB\-it=n\fR, \fB\-\-iterations=n\fR" 4
+.IX Item "-it=n, --iterations=n"
+This flag causes perltidy to do \fBn\fR complete iterations. The reason for this
+flag is that code beautification is a somewhat iterative process and in some
+cases the output from perltidy can be different if it is applied a second time.
+For most purposes the default of \fBn=1\fR should be satisfactory. However \fBn=2\fR
+can be useful when a major style change is being made, or when code is being
+beautified on check-in to a source code control system. The run time will be
+approximately proportional to \fBn\fR, and it should seldom be necessary to use a
+value greater than \fBn=2\fR. This flag has no effect when perltidy is used to generate html.
+.SS "Code Indentation Control"
.IX Subsection "Code Indentation Control"
.IP "\fB\-ci=n\fR, \fB\-\-continuation\-indentation=n\fR" 4
.IX Item "-ci=n, --continuation-indentation=n"
a long line is broken. The default is n=2, illustrated here:
.Sp
.Vb 2
-\& my $level = # -ci=2
+\& my $level = # \-ci=2
\& ( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level;
.Ve
+.Sp
The same example, with n=0, is a little harder to read:
.Sp
.Vb 2
-\& my $level = # -ci=0
+\& my $level = # \-ci=0
\& ( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level;
.Ve
+.Sp
The value given to \fB\-ci\fR is also used by some commands when a small
space is required. Examples are commands for outdenting labels,
-\&\fB\-ola\fR, and control keywords, \fB\-okw\fR.
+\&\fB\-ola\fR, and control keywords, \fB\-okw\fR.
.Sp
When default values are not used, it is suggested that the value \fBn\fR
given with \fB\-ci=n\fR be no more than about one-half of the number of
.Vb 5
\& # perltidy (default)
\& @month_of_year = (
-\& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
-\& 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
+\& \*(AqJan\*(Aq, \*(AqFeb\*(Aq, \*(AqMar\*(Aq, \*(AqApr\*(Aq, \*(AqMay\*(Aq, \*(AqJun\*(Aq,
+\& \*(AqJul\*(Aq, \*(AqAug\*(Aq, \*(AqSep\*(Aq, \*(AqOct\*(Aq, \*(AqNov\*(Aq, \*(AqDec\*(Aq
\& );
.Ve
+.Sp
Use the \fB\-lp\fR flag to add extra indentation to cause the data to begin
past the opening parentheses of a sub call or list, or opening square
bracket of an anonymous array, or opening curly brace of an anonymous
hash. With this option, the above list would become:
.Sp
.Vb 5
-\& # perltidy -lp
+\& # perltidy \-lp
\& @month_of_year = (
-\& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
-\& 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
+\& \*(AqJan\*(Aq, \*(AqFeb\*(Aq, \*(AqMar\*(Aq, \*(AqApr\*(Aq, \*(AqMay\*(Aq, \*(AqJun\*(Aq,
+\& \*(AqJul\*(Aq, \*(AqAug\*(Aq, \*(AqSep\*(Aq, \*(AqOct\*(Aq, \*(AqNov\*(Aq, \*(AqDec\*(Aq
\& );
.Ve
+.Sp
If the available line length (see \fB\-l=n\fR ) does not permit this much
space, perltidy will use less. For alternate placement of the
closing paren, see the next section.
The \fB\-cti=n\fR flag controls the indentation of a line beginning with
a \f(CW\*(C`)\*(C'\fR, \f(CW\*(C`]\*(C'\fR, or a non-block \f(CW\*(C`}\*(C'\fR. Such a line receives:
.Sp
-.Vb 5
-\& -cti = 0 no extra indentation (default)
-\& -cti = 1 extra indentation such that the closing token
+.Vb 6
+\& \-cti = 0 no extra indentation (default)
+\& \-cti = 1 extra indentation such that the closing token
\& aligns with its opening token.
-\& -cti = 2 one extra indentation level if the line looks like:
+\& \-cti = 2 one extra indentation level if the line looks like:
\& ); or ]; or };
+\& \-cti = 3 one extra indentation level always
.Ve
+.Sp
The flags \fB\-cti=1\fR and \fB\-cti=2\fR work well with the \fB\-lp\fR flag (previous
section).
.Sp
.Vb 5
-\& # perltidy -lp -cti=1
+\& # perltidy \-lp \-cti=1
\& @month_of_year = (
-\& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
-\& 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
+\& \*(AqJan\*(Aq, \*(AqFeb\*(Aq, \*(AqMar\*(Aq, \*(AqApr\*(Aq, \*(AqMay\*(Aq, \*(AqJun\*(Aq,
+\& \*(AqJul\*(Aq, \*(AqAug\*(Aq, \*(AqSep\*(Aq, \*(AqOct\*(Aq, \*(AqNov\*(Aq, \*(AqDec\*(Aq
\& );
-.Ve
-.Vb 5
-\& # perltidy -lp -cti=2
+\&
+\& # perltidy \-lp \-cti=2
\& @month_of_year = (
-\& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
-\& 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
+\& \*(AqJan\*(Aq, \*(AqFeb\*(Aq, \*(AqMar\*(Aq, \*(AqApr\*(Aq, \*(AqMay\*(Aq, \*(AqJun\*(Aq,
+\& \*(AqJul\*(Aq, \*(AqAug\*(Aq, \*(AqSep\*(Aq, \*(AqOct\*(Aq, \*(AqNov\*(Aq, \*(AqDec\*(Aq
\& );
.Ve
+.Sp
These flags are merely hints to the formatter and they may not always be
followed. In particular, if \-lp is not being used, the indentation for
\&\fBcti=1\fR is constrained to be no more than one indentation level.
If desired, this control can be applied independently to each of the
closing container token types. In fact, \fB\-cti=n\fR is merely an
abbreviation for \fB\-cpi=n \-csbi=n \-cbi=n\fR, where:
-\&\fB\-cpi\fR or \fB\-closing\-paren\-indentation\fR controls \fB)\fR's,
-\&\fB\-csbi\fR or \fB\-closing\-square\-bracket\-indentation\fR controls \fB]\fR's,
-\&\fB\-cbi\fR or \fB\-closing\-brace\-indentation\fR controls non-block \fB}\fR's.
+\&\fB\-cpi\fR or \fB\-\-closing\-paren\-indentation\fR controls \fB)\fR's,
+\&\fB\-csbi\fR or \fB\-\-closing\-square\-bracket\-indentation\fR controls \fB]\fR's,
+\&\fB\-cbi\fR or \fB\-\-closing\-brace\-indentation\fR controls non-block \fB}\fR's.
.IP "\fB\-icp\fR, \fB\-\-indent\-closing\-paren\fR" 4
.IX Item "-icp, --indent-closing-paren"
The \fB\-icp\fR flag is equivalent to
equivalent \fB\-cti=0\fR. They are included for backwards compatability.
.IP "\fB\-icb\fR, \fB\-\-indent\-closing\-brace\fR" 4
.IX Item "-icb, --indent-closing-brace"
-The \fB\-icb\fR option leaves a brace which terminates a code block
-indented with the same indentation as the previous line. For example,
+The \fB\-icb\fR option gives one extra level of indentation to a brace which
+terminates a code block . For example,
.Sp
.Vb 6
\& if ($task) {
\& yyy();
-\& } # -icb
+\& } # \-icb
\& else {
\& zzz();
\& }
.Ve
+.Sp
The default is not to do this, indicated by \fB\-nicb\fR.
.IP "\fB\-olq\fR, \fB\-\-outdent\-long\-quotes\fR" 4
.IX Item "-olq, --outdent-long-quotes"
When \fB\-olq\fR is set, lines which is a quoted string longer than the
value \fBmaximum-line-length\fR will have their indentation removed to make
-them more readable. This is the default. To prevent such out\-denting,
+them more readable. This is the default. To prevent such out-denting,
use \fB\-nolq\fR or \fB\-\-nooutdent\-long\-lines\fR.
.IP "\fB\-oll\fR, \fB\-\-outdent\-long\-lines\fR" 4
.IX Item "-oll, --outdent-long-lines"
\& fixit($i);
\& }
.Ve
-Use \fB\-nola\fR to not outdent labels.
+.Sp
+Use \fB\-nola\fR to not outdent labels.
.IP "Outdenting Keywords" 4
.IX Item "Outdenting Keywords"
.RS 4
\& fixit($i);
\& }
.Ve
-The default is not to do this.
+.Sp
+The default is not to do this.
.IP "Specifying Outdented Keywords: \fB\-okwl=string\fR, \fB\-\-outdent\-keyword\-list=string\fR" 4
.IX Item "Specifying Outdented Keywords: -okwl=string, --outdent-keyword-list=string"
This command can be used to change the keywords which are outdented with
.RE
.RS 4
.RE
-.Sh "Whitespace Control"
+.SS "Whitespace Control"
.IX Subsection "Whitespace Control"
Whitespace refers to the blank space between variables, operators,
and other code tokens.
values, 0, 1, and 2:
.Sp
.Vb 3
-\& if ( ( my $len_tab = length( $tabstr ) ) > 0 ) { # -pt=0
-\& if ( ( my $len_tab = length($tabstr) ) > 0 ) { # -pt=1 (default)
-\& if ((my $len_tab = length($tabstr)) > 0) { # -pt=2
+\& if ( ( my $len_tab = length( $tabstr ) ) > 0 ) { # \-pt=0
+\& if ( ( my $len_tab = length($tabstr) ) > 0 ) { # \-pt=1 (default)
+\& if ((my $len_tab = length($tabstr)) > 0) { # \-pt=2
.Ve
+.Sp
When n is 0, there is always a space to the right of a '(' and to the left
of a ')'. For n=2 there is never a space. For n=1, the default, there
is a space unless the quantity within the parens is a single token, such
-as an identifier or quoted string.
+as an identifier or quoted string.
.Sp
Likewise, the parameter \fB\-sbt=n\fR or \fB\-\-square\-bracket\-tightness=n\fR
controls the space within square brackets, as illustrated below.
.Sp
.Vb 3
-\& $width = $col[ $j + $k ] - $col[ $j ]; # -sbt=0
-\& $width = $col[ $j + $k ] - $col[$j]; # -sbt=1 (default)
-\& $width = $col[$j + $k] - $col[$j]; # -sbt=2
+\& $width = $col[ $j + $k ] \- $col[ $j ]; # \-sbt=0
+\& $width = $col[ $j + $k ] \- $col[$j]; # \-sbt=1 (default)
+\& $width = $col[$j + $k] \- $col[$j]; # \-sbt=2
.Ve
+.Sp
Curly braces which do not contain code blocks are controlled by
-the parameter \fB\-bt=n\fR or \fB\-\-brace\-tightness=n\fR.
+the parameter \fB\-bt=n\fR or \fB\-\-brace\-tightness=n\fR.
.Sp
.Vb 3
-\& $obj->{ $parsed_sql->{ 'table' }[0] }; # -bt=0
-\& $obj->{ $parsed_sql->{'table'}[0] }; # -bt=1 (default)
-\& $obj->{$parsed_sql->{'table'}[0]}; # -bt=2
+\& $obj\->{ $parsed_sql\->{ \*(Aqtable\*(Aq }[0] }; # \-bt=0
+\& $obj\->{ $parsed_sql\->{\*(Aqtable\*(Aq}[0] }; # \-bt=1 (default)
+\& $obj\->{$parsed_sql\->{\*(Aqtable\*(Aq}[0]}; # \-bt=2
.Ve
+.Sp
And finally, curly braces which contain blocks of code are controlled by the
parameter \fB\-bbt=n\fR or \fB\-\-block\-brace\-tightness=n\fR as illustrated in the
-example below.
+example below.
.Sp
.Vb 3
-\& %bf = map { $_ => -M $_ } grep { /\e.deb$/ } dirents '.'; # -bbt=0 (default)
-\& %bf = map { $_ => -M $_ } grep {/\e.deb$/} dirents '.'; # -bbt=1
-\& %bf = map {$_ => -M $_} grep {/\e.deb$/} dirents '.'; # -bbt=2
+\& %bf = map { $_ => \-M $_ } grep { /\e.deb$/ } dirents \*(Aq.\*(Aq; # \-bbt=0 (default)
+\& %bf = map { $_ => \-M $_ } grep {/\e.deb$/} dirents \*(Aq.\*(Aq; # \-bbt=1
+\& %bf = map {$_ => \-M $_} grep {/\e.deb$/} dirents \*(Aq.\*(Aq; # \-bbt=2
.Ve
.IP "\fB\-sts\fR, \fB\-\-space\-terminal\-semicolon\fR" 4
.IX Item "-sts, --space-terminal-semicolon"
\&\fB\-\-nospace\-terminal\-semicolon\fR.
.Sp
.Vb 2
-\& $i = 1 ; # -sts
-\& $i = 1; # -nsts (default)
+\& $i = 1 ; # \-sts
+\& $i = 1; # \-nsts (default)
.Ve
.IP "\fB\-sfs\fR, \fB\-\-space\-for\-semicolon\fR" 4
.IX Item "-sfs, --space-for-semicolon"
\&\fB\-nsfs\fR or \fB\-\-nospace\-for\-semicolon\fR to deactivate it.
.Sp
.Vb 2
-\& for ( @a = @$ap, $u = shift @a ; @a ; $u = $v ) { # -sfs (default)
-\& for ( @a = @$ap, $u = shift @a; @a; $u = $v ) { # -nsfs
+\& for ( @a = @$ap, $u = shift @a ; @a ; $u = $v ) { # \-sfs (default)
+\& for ( @a = @$ap, $u = shift @a; @a; $u = $v ) { # \-nsfs
.Ve
.IP "\fB\-asc\fR, \fB\-\-add\-semicolons\fR" 4
.IX Item "-asc, --add-semicolons"
parameters would specify this desire:
.Sp
.Vb 1
-\& -nwls="= + - / *" -nwrs="= + - / *"
+\& \-nwls="= + \- / *" \-nwrs="= + \- / *"
.Ve
+.Sp
(Note that the token types are in quotes, and that they are separated by
spaces). With these modified whitespace rules, the following line of math:
.Sp
.Vb 1
-\& $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );
+\& $root = \-$b + sqrt( $b * $b \- 4. * $a * $c ) / ( 2. * $a );
.Ve
+.Sp
becomes this:
.Sp
.Vb 1
-\& $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );
+\& $root=\-$b+sqrt( $b*$b\-4.*$a*$c )/( 2.*$a );
.Ve
+.Sp
These parameters should be considered to be hints to perltidy rather
than fixed rules, because perltidy must try to resolve conflicts that
arise between them and all of the other rules that it uses. One
conflict that can arise is if, between two tokens, the left token wants
a space and the right one doesn't. In this case, the token not wanting
-a space takes priority.
+a space takes priority.
.Sp
It is necessary to have a list of all token types in order to create
this type of input. Such a list can be obtained by the command
-\&\fB\-dump\-token\-types\fR.
-.IP "Space between keyword and opening paren" 4
-.IX Item "Space between keyword and opening paren"
-When an opening paren follows a keyword, no space is introduced after the
+\&\fB\-\-dump\-token\-types\fR. Also try the \fB\-D\fR flag on a short snippet of code
+and look at the .DEBUG file to see the tokenization.
+.Sp
+\&\fB\s-1WARNING\s0\fR Be sure to put these tokens in quotes to avoid having them
+misinterpreted by your command shell.
+.IP "Space between specific keywords and opening paren" 4
+.IX Item "Space between specific keywords and opening paren"
+When an opening paren follows a Perl keyword, no space is introduced after the
keyword, unless it is (by default) one of these:
.Sp
.Vb 2
\& my local our and or eq ne if else elsif until unless
\& while for foreach return switch case given when
.Ve
+.Sp
These defaults can be modified with two commands:
.Sp
\&\fB\-sak=s\fR or \fB\-\-space\-after\-keyword=s\fR adds keywords.
.Sp
\&\fB\-nsak=s\fR or \fB\-\-nospace\-after\-keyword=s\fR removes keywords.
.Sp
-where \fBs\fR is a list of keywords (in quotes if necessary). For example,
+where \fBs\fR is a list of keywords (in quotes if necessary). For example,
.Sp
.Vb 2
\& my ( $a, $b, $c ) = @_; # default
-\& my( $a, $b, $c ) = @_; # -nsak="my local our"
+\& my( $a, $b, $c ) = @_; # \-nsak="my local our"
.Ve
+.Sp
+To put a space after all keywords, see the next item.
+.IP "Space between all keywords and opening parens" 4
+.IX Item "Space between all keywords and opening parens"
+When an opening paren follows a function or keyword, no space is introduced
+after the keyword except for the keywords noted in the previous item. To
+always put a space between a function or keyword and its opening paren,
+use the command:
+.Sp
+\&\fB\-skp\fR or \fB\-\-space\-keyword\-paren\fR
+.Sp
+You will probably also want to use the flag \fB\-sfp\fR (next item) too.
+.IP "Space between all function names and opening parens" 4
+.IX Item "Space between all function names and opening parens"
+When an opening paren follows a function the default is not to introduce
+a space. To cause a space to be introduced use:
+.Sp
+\&\fB\-sfp\fR or \fB\-\-space\-function\-paren\fR
+.Sp
+.Vb 2
+\& myfunc( $a, $b, $c ); # default
+\& myfunc ( $a, $b, $c ); # \-sfp
+.Ve
+.Sp
+You will probably also want to use the flag \fB\-skp\fR (previous item) too.
.ie n .IP "Trimming whitespace around ""qw"" quotes" 4
.el .IP "Trimming whitespace around \f(CWqw\fR quotes" 4
.IX Item "Trimming whitespace around qw quotes"
multi-line \f(CW\*(C`qw\*(C'\fR quotes to be left unchanged. This option will not
normally be necessary, but was added for testing purposes, because in
some versions of perl, trimming \f(CW\*(C`qw\*(C'\fR quotes changes the syntax tree.
-.Sh "Comment Controls"
+.SS "Comment Controls"
.IX Subsection "Comment Controls"
Perltidy has a number of ways to control the appearance of both block comments
and side comments. The term \fBblock comment\fR here refers to a full-line
.IX Item "-ibc, --indent-block-comments"
Block comments normally look best when they are indented to the same
level as the code which follows them. This is the default behavior, but
-you may use \fB\-nibc\fR to keep block comments left\-justified. Here is an
+you may use \fB\-nibc\fR to keep block comments left-justified. Here is an
example:
.Sp
.Vb 2
-\& # this comment is indented (-ibc, default)
+\& # this comment is indented (\-ibc, default)
\& if ($task) { yyy(); }
.Ve
+.Sp
The alternative is \fB\-nibc\fR:
.Sp
.Vb 2
-\& # this comment is not indented (-nibc)
+\& # this comment is not indented (\-nibc)
\& if ($task) { yyy(); }
.Ve
+.Sp
See also the next item, \fB\-isbc\fR, as well as \fB\-sbc\fR, for other ways to
have some indented and some outdented block comments.
.IP "\fB\-isbc\fR, \fB\-\-indent\-spaced\-block\-comments\fR" 4
.IX Item "-olc, --outdent-long-comments"
When \fB\-olc\fR is set, lines which are full-line (block) comments longer
than the value \fBmaximum-line-length\fR will have their indentation
-removed. The default is not to do this.
+removed. This is the default; use \fB\-nolc\fR to prevent outdenting.
.IP "\fB\-msc=n\fR, \fB\-\-minimum\-space\-to\-comment=n\fR" 4
.IX Item "-msc=n, --minimum-space-to-comment=n"
Side comments look best when lined up several spaces to the right of
code. Perltidy will try to keep comments at least n spaces to the
right. The default is n=4 spaces.
+.IP "\fB\-fpsc=n\fR, \fB\-\-fixed\-position\-side\-comment=n\fR" 4
+.IX Item "-fpsc=n, --fixed-position-side-comment=n"
+This parameter tells perltidy to line up side comments in column number \fBn\fR
+whenever possible. The default, n=0, is not do do this.
.IP "\fB\-hsc\fR, \fB\-\-hanging\-side\-comments\fR" 4
.IX Item "-hsc, --hanging-side-comments"
By default, perltidy tries to identify and align \*(L"hanging side
\& # This is a hanging side comment
\& # And so is this
.Ve
+.Sp
A comment is considered to be a hanging side comment if (1) it immediately
follows a line with a side comment, or another hanging side comment, and
(2) there is some leading whitespace on the line.
A closing side comment is a special comment which perltidy can
automatically create and place after the closing brace of a code block.
They can be useful for code maintenance and debugging. The command
-\&\fB\-csc\fR (or \fB\-closing\-side\-comments\fR) adds or updates closing side
+\&\fB\-csc\fR (or \fB\-\-closing\-side\-comments\fR) adds or updates closing side
comments. For example, here is a small code snippet
.Sp
.Vb 8
\& }
\& }
.Ve
+.Sp
And here is the result of processing with \f(CW\*(C`perltidy \-csc\*(C'\fR:
.Sp
.Vb 8
\& }
\& } ## end sub message
.Ve
+.Sp
A closing side comment was added for \f(CW\*(C`sub message\*(C'\fR in this case, but not
for the \f(CW\*(C`if\*(C'\fR and \f(CW\*(C`else\*(C'\fR blocks, because they were below the 6 line
cutoff limit for adding closing side comments. This limit may be
Several commands are available to modify the behavior of these two basic
commands, \fB\-csc\fR and \fB\-dcsc\fR:
.RS 4
-.IP "\fB\-csci=n\fR, or \fB\-closing\-side\-comment\-interval=n\fR" 4
-.IX Item "-csci=n, or -closing-side-comment-interval=n"
+.IP "\fB\-csci=n\fR, or \fB\-\-closing\-side\-comment\-interval=n\fR" 4
+.IX Item "-csci=n, or --closing-side-comment-interval=n"
where \f(CW\*(C`n\*(C'\fR is the minimum number of lines that a block must have in
order for a closing side comment to be added. The default value is
\&\f(CW\*(C`n=6\*(C'\fR. To illustrate:
.Sp
.Vb 9
-\& # perltidy -csci=2 -csc
+\& # perltidy \-csci=2 \-csc
\& sub message {
\& if ( !defined( $_[0] ) ) {
\& print("Hello, World\en");
\& } ## end else [ if ( !defined( $_[0] ))
\& } ## end sub message
.Ve
+.Sp
Now the \f(CW\*(C`if\*(C'\fR and \f(CW\*(C`else\*(C'\fR blocks are commented. However, now this has
become very cluttered.
-.IP "\fB\-cscp=string\fR, or \fB\-closing\-side\-comment\-prefix=string\fR" 4
-.IX Item "-cscp=string, or -closing-side-comment-prefix=string"
+.IP "\fB\-cscp=string\fR, or \fB\-\-closing\-side\-comment\-prefix=string\fR" 4
+.IX Item "-cscp=string, or --closing-side-comment-prefix=string"
where string is the prefix used before the name of the block type. The
default prefix, shown above, is \f(CW\*(C`## end\*(C'\fR. This string will be added to
closing side comments, and it will also be used to recognize them in
order to update, delete, and format them. Any comment identified as a
closing side comment will be placed just a single space to the right of
its closing brace.
-.IP "\fB\-cscl=string\fR, or \fB\-closing\-side\-comment\-list\-string\fR" 4
-.IX Item "-cscl=string, or -closing-side-comment-list-string"
+.IP "\fB\-cscl=string\fR, or \fB\-\-closing\-side\-comment\-list\-string\fR" 4
+.IX Item "-cscl=string, or --closing-side-comment-list-string"
where \f(CW\*(C`string\*(C'\fR is a list of block types to be tagged with closing side
comments. By default, all code block types preceded by a keyword or
label (such as \f(CW\*(C`if\*(C'\fR, \f(CW\*(C`sub\*(C'\fR, and so on) will be tagged. The \fB\-cscl\fR
affected by any \fB\-csc\fR or \fB\-dcsc\fR operation:
.Sp
.Vb 1
-\& -cscl="sub : BEGIN END"
+\& \-cscl="sub : BEGIN END"
.Ve
-.IP "\fB\-csct=n\fR, or \fB\-closing\-side\-comment\-maximum\-text=n\fR" 4
-.IX Item "-csct=n, or -closing-side-comment-maximum-text=n"
+.IP "\fB\-csct=n\fR, or \fB\-\-closing\-side\-comment\-maximum\-text=n\fR" 4
+.IX Item "-csct=n, or --closing-side-comment-maximum-text=n"
The text appended to certain block types, such as an \f(CW\*(C`if\*(C'\fR block, is
whatever lies between the keyword introducing the block, such as \f(CW\*(C`if\*(C'\fR,
and the opening brace. Since this might be too much text for a side
comment, there needs to be a limit, and that is the purpose of this
parameter. The default value is \f(CW\*(C`n=20\*(C'\fR, meaning that no additional
tokens will be appended to this text after its length reaches 20
-characters. Omitted text is indicated with \f(CW...\fR. (Tokens, including
+characters. Omitted text is indicated with \f(CW\*(C`...\*(C'\fR. (Tokens, including
sub names, are never truncated, however, so actual lengths may exceed
this). To illustrate, in the above example, the appended text of the
first block is \f(CW\*(C` ( !defined( $_[0] )...\*(C'\fR. The existing limit of
-\&\f(CW\*(C`n=20\*(C'\fR caused this text to be truncated, as indicated by the \f(CW...\fR.
-.IP "\fB\-csce=n\fR, or \fB\-closing\-side\-comment\-else\-flag=n\fR" 4
-.IX Item "-csce=n, or -closing-side-comment-else-flag=n"
+\&\f(CW\*(C`n=20\*(C'\fR caused this text to be truncated, as indicated by the \f(CW\*(C`...\*(C'\fR. See
+the next flag for additional control of the abbreviated text.
+.IP "\fB\-cscb\fR, or \fB\-\-closing\-side\-comments\-balanced\fR" 4
+.IX Item "-cscb, or --closing-side-comments-balanced"
+As discussed in the previous item, when the
+closing-side-comment-maximum-text limit is exceeded the comment text must
+be truncated. Older versions of perltidy terminated with three dots, and this
+can still be achieved with \-ncscb:
+.Sp
+.Vb 2
+\& perltidy \-csc \-ncscb
+\& } ## end foreach my $foo (sort { $b cmp $a ...
+.Ve
+.Sp
+However this causes a problem with editors editors which cannot recognize
+comments or are not configured to do so because they cannot \*(L"bounce\*(R" around in
+the text correctly. The \fB\-cscb\fR flag has been added to
+help them by appending appropriate balancing structure:
+.Sp
+.Vb 2
+\& perltidy \-csc \-cscb
+\& } ## end foreach my $foo (sort { $b cmp $a ... })
+.Ve
+.Sp
+The default is \fB\-cscb\fR.
+.IP "\fB\-csce=n\fR, or \fB\-\-closing\-side\-comment\-else\-flag=n\fR" 4
+.IX Item "-csce=n, or --closing-side-comment-else-flag=n"
The default, \fBn=0\fR, places the text of the opening \f(CW\*(C`if\*(C'\fR statement after any
terminal \f(CW\*(C`else\*(C'\fR.
.Sp
.Sp
If \fBn=1\fR is used, the results will be the same as \fBn=2\fR whenever the
resulting line length is less than the maximum allowed.
-.IP "\fB\-cscw\fR, or \fB\-closing\-side\-comment\-warnings\fR" 4
-.IX Item "-cscw, or -closing-side-comment-warnings"
+=item \fB\-cscb\fR, or \fB\-\-closing\-side\-comments\-balanced\fR
+.Sp
+When using closing-side-comments, and the closing-side-comment-maximum-text
+limit is exceeded, then the comment text must be abbreviated.
+It is terminated with three dots if the \fB\-cscb\fR flag is negated:
+.Sp
+.Vb 2
+\& perltidy \-csc \-ncscb
+\& } ## end foreach my $foo (sort { $b cmp $a ...
+.Ve
+.Sp
+This causes a problem with older editors which do not recognize comments
+because they cannot \*(L"bounce\*(R" around in the text correctly. The \fB\-cscb\fR
+flag tries to help them by appending appropriate terminal balancing structures:
+.Sp
+.Vb 2
+\& perltidy \-csc \-cscb
+\& } ## end foreach my $foo (sort { $b cmp $a ... })
+.Ve
+.Sp
+The default is \fB\-cscb\fR.
+.IP "\fB\-cscw\fR, or \fB\-\-closing\-side\-comment\-warnings\fR" 4
+.IX Item "-cscw, or --closing-side-comment-warnings"
This parameter is intended to help make the initial transition to the use of
closing side comments.
It causes two
things to happen if a closing side comment replaces an existing, different
closing side comment: first, an error message will be issued, and second, the
original side comment will be placed alone on a new specially marked comment
-line for later attention.
+line for later attention.
.Sp
The intent is to avoid clobbering existing hand-written side comments
which happen to match the pattern of closing side comments. This flag
.RE
.RS 4
.Sp
-\&\fBImportant Notes on Closing Side Comments:\fR
+\&\fBImportant Notes on Closing Side Comments:\fR
.IP "\(bu" 4
Closing side comments are only placed on lines terminated with a closing
brace. Certain closing styles, such as the use of cuddled elses
.IP "\(bu" 4
Please note that adding or deleting of closing side comments takes
place only through the commands \fB\-csc\fR or \fB\-dcsc\fR. The other commands,
-if used, merely modify the behavior of these two commands.
+if used, merely modify the behavior of these two commands.
.IP "\(bu" 4
It is recommended that the \fB\-cscw\fR flag be used along with \fB\-csc\fR on
the first use of perltidy on a given file. This will prevent loss of
.IP "\fB\-sbc\fR, \fB\-\-static\-block\-comments\fR" 4
.IX Item "-sbc, --static-block-comments"
When \fB\-sbc\fR is used, a block comment with a special leading pattern, \f(CW\*(C`##\*(C'\fR by
-default, will be treated specially.
+default, will be treated specially.
.Sp
-Comments so identified are treated as follows:
+Comments so identified are treated as follows:
.RS 4
.IP "\(bu" 4
If there is no leading space on the line, then the comment will not
be indented, and otherwise it may be,
.IP "\(bu" 4
no new blank line will be
-inserted before such a comment, and
+inserted before such a comment, and
.IP "\(bu" 4
such a comment will never become
-a hanging side comment.
+a hanging side comment.
.RE
.RS 4
.Sp
For example, assuming \f(CW@month_of_year\fR is
-left\-adjusted:
+left-adjusted:
.Sp
.Vb 4
-\& @month_of_year = ( # -sbc (default)
-\& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
-\& ## 'Dec', 'Nov'
-\& 'Nov', 'Dec');
+\& @month_of_year = ( # \-sbc (default)
+\& \*(AqJan\*(Aq, \*(AqFeb\*(Aq, \*(AqMar\*(Aq, \*(AqApr\*(Aq, \*(AqMay\*(Aq, \*(AqJun\*(Aq, \*(AqJul\*(Aq, \*(AqAug\*(Aq, \*(AqSep\*(Aq, \*(AqOct\*(Aq,
+\& ## \*(AqDec\*(Aq, \*(AqNov\*(Aq
+\& \*(AqNov\*(Aq, \*(AqDec\*(Aq);
.Ve
+.Sp
Without this convention, the above code would become
.Sp
.Vb 2
-\& @month_of_year = ( # -nsbc
-\& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
-.Ve
-.Vb 3
-\& ## 'Dec', 'Nov'
-\& 'Nov', 'Dec'
+\& @month_of_year = ( # \-nsbc
+\& \*(AqJan\*(Aq, \*(AqFeb\*(Aq, \*(AqMar\*(Aq, \*(AqApr\*(Aq, \*(AqMay\*(Aq, \*(AqJun\*(Aq, \*(AqJul\*(Aq, \*(AqAug\*(Aq, \*(AqSep\*(Aq, \*(AqOct\*(Aq,
+\&
+\& ## \*(AqDec\*(Aq, \*(AqNov\*(Aq
+\& \*(AqNov\*(Aq, \*(AqDec\*(Aq
\& );
.Ve
+.Sp
which is not as clear.
The default is to use \fB\-sbc\fR. This may be deactivated with \fB\-nsbc\fR.
.RE
.IX Item "-sbcp=string, --static-block-comment-prefix=string"
This parameter defines the prefix used to identify static block comments
when the \fB\-sbc\fR parameter is set. The default prefix is \f(CW\*(C`##\*(C'\fR,
-corresponding to \f(CW\*(C`\-sbcp=##\*(C'\fR. The first character must be a \f(CW\*(C`#\*(C'\fR
-symbol, since this must only match comments. As a simple example, to
+corresponding to \f(CW\*(C`\-sbcp=##\*(C'\fR. The prefix is actually part of a perl
+pattern used to match lines and it must either begin with \f(CW\*(C`#\*(C'\fR or \f(CW\*(C`^#\*(C'\fR.
+In the first case a prefix ^\es* will be added to match any leading
+whitespace, while in the second case the pattern will match only
+comments with no leading whitespace. For example, to
identify all comments as static block comments, one would use \f(CW\*(C`\-sbcp=#\*(C'\fR.
+To identify all left-adjusted comments as static block comments, use \f(CW\*(C`\-sbcp=\*(Aq^#\*(Aq\*(C'\fR.
.Sp
Please note that \fB\-sbcp\fR merely defines the pattern used to identify static
block comments; it will not be used unless the switch \fB\-sbc\fR is set. Also,
-please be aware that this string is used in a perl regular expression which
-identifies these comments, so it must enable a valid regular expression to be
-formed.
+please be aware that since this string is used in a perl regular expression
+which identifies these comments, it must enable a valid regular expression to
+be formed.
+.Sp
+A pattern which can be useful is:
+.Sp
+.Vb 1
+\& \-sbcp=^#{2,}[^\es#]
+.Ve
+.Sp
+This pattern requires a static block comment to have at least one character
+which is neither a # nor a space. It allows a line containing only '#'
+characters to be rejected as a static block comment. Such lines are often used
+at the start and end of header information in subroutines and should not be
+separated from the intervening comments, which typically begin with just a
+single '#'.
.IP "\fB\-osbc\fR, \fB\-\-outdent\-static\-block\-comments\fR" 4
.IX Item "-osbc, --outdent-static-block-comments"
The command \fB\-osbc\fR will will cause static block comments to be outdented by 2
.IX Item "-sscp=string, --static-side-comment-prefix=string"
This parameter defines the prefix used to identify static side comments
when the \fB\-ssc\fR parameter is set. The default prefix is \f(CW\*(C`##\*(C'\fR,
-corresponding to \f(CW\*(C`\-sscp=##\*(C'\fR.
+corresponding to \f(CW\*(C`\-sscp=##\*(C'\fR.
.Sp
Please note that \fB\-sscp\fR merely defines the pattern used to identify
static side comments; it will not be used unless the switch \fB\-ssc\fR is
.RE
.RS 4
.RE
-.Sh "Line Break Control"
+.SS "Skipping Selected Sections of Code"
+.IX Subsection "Skipping Selected Sections of Code"
+Selected lines of code may be passed verbatim to the output without any
+formatting. This feature is enabled by default but can be disabled with
+the \fB\-\-noformat\-skipping\fR or \fB\-nfs\fR flag. It should be used sparingly to
+avoid littering code with markers, but it might be helpful for working
+around occasional problems. For example it might be useful for keeping
+the indentation of old commented code unchanged, keeping indentation of
+long blocks of aligned comments unchanged, keeping certain list
+formatting unchanged, or working around a glitch in perltidy.
+.IP "\fB\-fs\fR, \fB\-\-format\-skipping\fR" 4
+.IX Item "-fs, --format-skipping"
+This flag, which is enabled by default, causes any code between
+special beginning and ending comment markers to be passed to the
+output without formatting. The default beginning marker is #<<<
+and the default ending marker is #>>> but they
+may be changed (see next items below). Additional text may appear on
+these special comment lines provided that it is separated from the
+marker by at least one space. For example
+.Sp
+.Vb 7
+\& #<<< do not let perltidy touch this
+\& my @list = (1,
+\& 1, 1,
+\& 1, 2, 1,
+\& 1, 3, 3, 1,
+\& 1, 4, 6, 4, 1,);
+\& #>>>
+.Ve
+.Sp
+The comment markers may be placed at any location that a block comment may
+appear. If they do not appear to be working, use the \-log flag and examine the
+\&\fI.LOG\fR file. Use \fB\-nfs\fR to disable this feature.
+.IP "\fB\-fsb=string\fR, \fB\-\-format\-skipping\-begin=string\fR" 4
+.IX Item "-fsb=string, --format-skipping-begin=string"
+The \fB\-fsb=string\fR parameter may be used to change the beginning marker for
+format skipping. The default is equivalent to \-fsb='#<<<'. The string that
+you enter must begin with a # and should be in quotes as necessary to get past
+the command shell of your system. It is actually the leading text of a pattern
+that is constructed by appending a '\es', so you must also include backslashes
+for characters to be taken literally rather than as patterns.
+.Sp
+Some examples show how example strings become patterns:
+.Sp
+.Vb 3
+\& \-fsb=\*(Aq#\e{\e{\e{\*(Aq becomes /^#\e{\e{\e{\es/ which matches #{{{ but not #{{{{
+\& \-fsb=\*(Aq#\e*\e*\*(Aq becomes /^#\e*\e*\es/ which matches #** but not #***
+\& \-fsb=\*(Aq#\e*{2,}\*(Aq becomes /^#\e*{2,}\es/ which matches #** and #*****
+.Ve
+.IP "\fB\-fse=string\fR, \fB\-\-format\-skipping\-end=string\fR" 4
+.IX Item "-fse=string, --format-skipping-end=string"
+The \fB\-fsb=string\fR is the corresponding parameter used to change the
+ending marker for format skipping. The default is equivalent to
+\&\-fse='#<<<'.
+.SS "Line Break Control"
.IX Subsection "Line Break Control"
+The parameters in this section control breaks after
+non-blank lines of code. Blank lines are controlled
+separately by parameters in the section \*(L"Blank Line
+Control\*(R".
.IP "\fB\-fnl\fR, \fB\-\-freeze\-newlines\fR" 4
.IX Item "-fnl, --freeze-newlines"
-If you do not want any changes to the line breaks in your script, set
+If you do not want any changes to the line breaks within
+lines of code in your script, set
\&\fB\-fnl\fR, and they will remain fixed, and the rest of the commands in
this section and sections
\&\*(L"Controlling List Formatting\*(R",
-\&\*(L"Retaining or Ignoring Existing Line Breaks\*(R", and
-\&\*(L"Blank Line Control\*(R" will be ignored. You may want to use \fB\-noll\fR
-with this.
+\&\*(L"Retaining or Ignoring Existing Line Breaks\*(R".
+You may want to use \fB\-noll\fR with this.
+.Sp
+Note: If you also want to keep your blank lines exactly
+as they are, you can use the \fB\-fbl\fR flag which is described
+in the section \*(L"Blank Line Control\*(R".
.IP "\fB\-ce\fR, \fB\-\-cuddled\-else\fR" 4
.IX Item "-ce, --cuddled-else"
Enable the \*(L"cuddled else\*(R" style, in which \f(CW\*(C`else\*(C'\fR and \f(CW\*(C`elsif\*(C'\fR are
.Vb 5
\& if ($task) {
\& yyy();
-\& } else { # -ce
+\& } else { # \-ce
\& zzz();
\& }
-.Ve
-.Vb 6
+\&
\& if ($task) {
\& yyy();
\& }
-\& else { # -nce (default)
+\& else { # \-nce (default)
\& zzz();
\& }
.Ve
Use the flag \fB\-bl\fR to place the opening brace on a new line:
.Sp
.Vb 4
-\& if ( $input_file eq '-' ) # -bl
+\& if ( $input_file eq \*(Aq\-\*(Aq ) # \-bl
\& {
\& important_function();
\& }
.Ve
-This flag applies to all structural blocks, including sub's (unless
+.Sp
+This flag applies to all structural blocks, including named sub's (unless
the \fB\-sbl\fR flag is set \*(-- see next item).
.Sp
The default style, \fB\-nbl\fR, places an opening brace on the same line as
the keyword introducing it. For example,
.Sp
.Vb 1
-\& if ( $input_file eq '-' ) { # -nbl (default)
+\& if ( $input_file eq \*(Aq\-\*(Aq ) { # \-nbl (default)
.Ve
.IP "\fB\-sbl\fR, \fB\-\-opening\-sub\-brace\-on\-new\-line\fR" 4
.IX Item "-sbl, --opening-sub-brace-on-new-line"
The flag \fB\-sbl\fR can be used to override the value of \fB\-bl\fR for
-opening sub braces. For example,
+the opening braces of named sub's. For example,
.Sp
.Vb 1
-\& perltidy -sbl
+\& perltidy \-sbl
.Ve
+.Sp
produces this result:
.Sp
.Vb 9
\& }
\& }
.Ve
+.Sp
This flag is negated with \fB\-nsbl\fR. If \fB\-sbl\fR is not specified,
the value of \fB\-bl\fR is used.
+.IP "\fB\-asbl\fR, \fB\-\-opening\-anonymous\-sub\-brace\-on\-new\-line\fR" 4
+.IX Item "-asbl, --opening-anonymous-sub-brace-on-new-line"
+The flag \fB\-asbl\fR is like the \fB\-sbl\fR flag except that it applies
+to anonymous sub's instead of named subs. For example
+.Sp
+.Vb 1
+\& perltidy \-asbl
+.Ve
+.Sp
+produces this result:
+.Sp
+.Vb 9
+\& $a = sub
+\& {
+\& if ( !defined( $_[0] ) ) {
+\& print("Hello, World\en");
+\& }
+\& else {
+\& print( $_[0], "\en" );
+\& }
+\& };
+.Ve
+.Sp
+This flag is negated with \fB\-nasbl\fR, and the default is \fB\-nasbl\fR.
.IP "\fB\-bli\fR, \fB\-\-brace\-left\-and\-indent\fR" 4
.IX Item "-bli, --brace-left-and-indent"
The flag \fB\-bli\fR is the same as \fB\-bl\fR but in addition it causes one
For example,
.Sp
.Vb 4
-\& if ( $input_file eq '-' ) # -bli
+\& if ( $input_file eq \*(Aq\-\*(Aq ) # \-bli
\& {
\& important_function();
\& }
.Ve
+.Sp
By default, this extra indentation occurs for blocks of type:
\&\fBif\fR, \fBelsif\fR, \fBelse\fR, \fBunless\fR, \fBfor\fR, \fBforeach\fR, \fBsub\fR,
\&\fBwhile\fR, \fBuntil\fR, and also with a preceding label. The next item
\&\fB\-blil='if elsif else'\fR would apply it to only \f(CW\*(C`if/elsif/else\*(C'\fR blocks.
.IP "\fB\-bar\fR, \fB\-\-opening\-brace\-always\-on\-right\fR" 4
.IX Item "-bar, --opening-brace-always-on-right"
-The default style, \fB\-nbl\fR places the opening brace on a new
+The default style, \fB\-nbl\fR places the opening code block brace on a new
line if it does not fit on the same line as the opening keyword, like
this:
.Sp
\& big_waste_of_time();
\& }
.Ve
+.Sp
To force the opening brace to always be on the right, use the \fB\-bar\fR
flag. In this case, the above example becomes
.Sp
\& big_waste_of_time();
\& }
.Ve
+.Sp
A conflict occurs if both \fB\-bl\fR and \fB\-bar\fR are specified.
+.IP "\fB\-otr\fR, \fB\-\-opening\-token\-right\fR and related flags" 4
+.IX Item "-otr, --opening-token-right and related flags"
+The \fB\-otr\fR flag is a hint that perltidy should not place a break between a
+comma and an opening token. For example:
+.Sp
+.Vb 6
+\& # default formatting
+\& push @{ $self\->{$module}{$key} },
+\& {
+\& accno => $ref\->{accno},
+\& description => $ref\->{description}
+\& };
+\&
+\& # perltidy \-otr
+\& push @{ $self\->{$module}{$key} }, {
+\& accno => $ref\->{accno},
+\& description => $ref\->{description}
+\& };
+.Ve
+.Sp
+The flag \fB\-otr\fR is actually a synonym for three other flags
+which can be used to control parens, hash braces, and square brackets
+separately if desired:
+.Sp
+.Vb 3
+\& \-opr or \-\-opening\-paren\-right
+\& \-ohbr or \-\-opening\-hash\-brace\-right
+\& \-osbr or \-\-opening\-square\-bracket\-right
+.Ve
.IP "Vertical tightness of non-block curly braces, parentheses, and square brackets." 4
.IX Item "Vertical tightness of non-block curly braces, parentheses, and square brackets."
These parameters control what shall be called vertical tightness. Here are the
\&\fB\-\-vertical\-tightness=n\fR, where
.Sp
.Vb 4
-\& -vt=0 always break a line after opening token (default).
-\& -vt=1 do not break unless this would produce more than one
+\& \-vt=0 always break a line after opening token (default).
+\& \-vt=1 do not break unless this would produce more than one
\& step in indentation in a line.
-\& -vt=2 never break a line after opening token
+\& \-vt=2 never break a line after opening token
.Ve
.IP "\(bu" 4
You must also use the \fB\-lp\fR flag when you use the \fB\-vt\fR flag; the
\&\fB\-\-vertical\-tightness\-closing=n\fR, where
.Sp
.Vb 5
-\& -vtc=0 always break a line before a closing token (default),
-\& -vtc=1 do not break before a closing token which is followed
+\& \-vtc=0 always break a line before a closing token (default),
+\& \-vtc=1 do not break before a closing token which is followed
\& by a semicolon or another closing token, and is not in
\& a list environment.
-\& -vtc=2 never break before a closing token.
+\& \-vtc=2 never break before a closing token.
.Ve
+.Sp
The rules for \fB\-vtc=1\fR are designed to maintain a reasonable balance
between tightness and readability in complex lists.
.IP "\(bu" 4
.RE
.RS 4
.Sp
-Here are some examples:
+Here are some examples:
.Sp
.Vb 7
-\& # perltidy -lp -vt=0 -vtc=0
+\& # perltidy \-lp \-vt=0 \-vtc=0
\& %romanNumerals = (
-\& one => 'I',
-\& two => 'II',
-\& three => 'III',
-\& four => 'IV',
+\& one => \*(AqI\*(Aq,
+\& two => \*(AqII\*(Aq,
+\& three => \*(AqIII\*(Aq,
+\& four => \*(AqIV\*(Aq,
\& );
-.Ve
-.Vb 6
-\& # perltidy -lp -vt=1 -vtc=0
-\& %romanNumerals = ( one => 'I',
-\& two => 'II',
-\& three => 'III',
-\& four => 'IV',
+\&
+\& # perltidy \-lp \-vt=1 \-vtc=0
+\& %romanNumerals = ( one => \*(AqI\*(Aq,
+\& two => \*(AqII\*(Aq,
+\& three => \*(AqIII\*(Aq,
+\& four => \*(AqIV\*(Aq,
\& );
+\&
+\& # perltidy \-lp \-vt=1 \-vtc=1
+\& %romanNumerals = ( one => \*(AqI\*(Aq,
+\& two => \*(AqII\*(Aq,
+\& three => \*(AqIII\*(Aq,
+\& four => \*(AqIV\*(Aq, );
.Ve
-.Vb 5
-\& # perltidy -lp -vt=1 -vtc=1
-\& %romanNumerals = ( one => 'I',
-\& two => 'II',
-\& three => 'III',
-\& four => 'IV', );
-.Ve
+.Sp
The difference between \fB\-vt=1\fR and \fB\-vt=2\fR is shown here:
.Sp
.Vb 6
-\& # perltidy -lp -vt=1
-\& $init->add(
+\& # perltidy \-lp \-vt=1
+\& $init\->add(
\& mysprintf( "(void)find_threadsv(%s);",
-\& cstring( $threadsv_names[ $op->targ ] )
+\& cstring( $threadsv_names[ $op\->targ ] )
\& )
\& );
-.Ve
-.Vb 5
-\& # perltidy -lp -vt=2
-\& $init->add( mysprintf( "(void)find_threadsv(%s);",
-\& cstring( $threadsv_names[ $op->targ ] )
+\&
+\& # perltidy \-lp \-vt=2
+\& $init\->add( mysprintf( "(void)find_threadsv(%s);",
+\& cstring( $threadsv_names[ $op\->targ ] )
\& )
\& );
.Ve
+.Sp
With \fB\-vt=1\fR, the line ending in \f(CW\*(C`add(\*(C'\fR does not combine with the next
line because the next line is not balanced. This can help with
readability, but \fB\-vt=2\fR can be used to ignore this rule.
\&\f(CW\*(C`\-vtc=2\*(C'\fR:
.Sp
.Vb 3
-\& # perltidy -lp -vt=2 -vtc=2
-\& $init->add( mysprintf( "(void)find_threadsv(%s);",
-\& cstring( $threadsv_names[ $op->targ ] ) ) );
+\& # perltidy \-lp \-vt=2 \-vtc=2
+\& $init\->add( mysprintf( "(void)find_threadsv(%s);",
+\& cstring( $threadsv_names[ $op\->targ ] ) ) );
.Ve
+.Sp
Notice how the code in all of these examples collapses vertically as
\&\fB\-vt\fR increases, but the indentation remains unchanged. This is
because perltidy implements the \fB\-vt\fR parameter by first formatting as
to opening code block braces.
.Sp
.Vb 4
-\& -bbvt=0 break after opening block brace (default).
-\& -bbvt=1 do not break unless this would produce more than one
+\& \-bbvt=0 break after opening block brace (default).
+\& \-bbvt=1 do not break unless this would produce more than one
\& step in indentation in a line.
-\& -bbvt=2 do not break after opening block brace.
+\& \-bbvt=2 do not break after opening block brace.
.Ve
+.Sp
It is necessary to also use either \fB\-bl\fR or \fB\-bli\fR for this to work,
because, as with other vertical tightness controls, it is implemented by
simply overwriting a line ending with an opening block brace with the
subsequent line. For example:
.Sp
.Vb 10
-\& # perltidy -bli -bbvt=0
+\& # perltidy \-bli \-bbvt=0
\& if ( open( FILE, "< $File" ) )
\& {
\& while ( $File = <FILE> )
\& }
\& close(FILE);
\& }
-.Ve
-.Vb 8
-\& # perltidy -bli -bbvt=1
+\&
+\& # perltidy \-bli \-bbvt=1
\& if ( open( FILE, "< $File" ) )
\& { while ( $File = <FILE> )
\& { $In .= $File;
\& close(FILE);
\& }
.Ve
+.Sp
By default this applies to blocks associated with keywords \fBif\fR,
\&\fBelsif\fR, \fBelse\fR, \fBunless\fR, \fBfor\fR, \fBforeach\fR, \fBsub\fR, \fBwhile\fR,
\&\fBuntil\fR, and also with a preceding label. This can be changed with
.Sp
For example, if we want to just apply this style to \f(CW\*(C`if\*(C'\fR,
\&\f(CW\*(C`elsif\*(C'\fR, and \f(CW\*(C`else\*(C'\fR blocks, we could use
-\&\f(CW\*(C`perltidy \-bli \-bbvt \-bbvtl='if elsif else'\*(C'\fR.
+\&\f(CW\*(C`perltidy \-bli \-bbvt=1 \-bbvtl=\*(Aqif elsif else\*(Aq\*(C'\fR.
.Sp
There is no vertical tightness control for closing block braces; with
the exception of one-line blocks, they will normally remain on a
separate line.
+.IP "\fB\-sot\fR, \fB\-\-stack\-opening\-tokens\fR and related flags" 4
+.IX Item "-sot, --stack-opening-tokens and related flags"
+The \fB\-sot\fR flag tells perltidy to \*(L"stack\*(R" opening tokens
+when possible to avoid lines with isolated opening tokens.
+.Sp
+For example:
+.Sp
+.Vb 8
+\& # default
+\& $opt_c = Text::CSV_XS\->new(
+\& {
+\& binary => 1,
+\& sep_char => $opt_c,
+\& always_quote => 1,
+\& }
+\& );
+\&
+\& # \-sot
+\& $opt_c = Text::CSV_XS\->new( {
+\& binary => 1,
+\& sep_char => $opt_c,
+\& always_quote => 1,
+\& }
+\& );
+.Ve
+.Sp
+For detailed control of individual closing tokens the following
+controls can be used:
+.Sp
+.Vb 3
+\& \-sop or \-\-stack\-opening\-paren
+\& \-sohb or \-\-stack\-opening\-hash\-brace
+\& \-sosb or \-\-stack\-opening\-square\-bracket
+.Ve
+.Sp
+The flag \fB\-sot\fR is a synonym for \fB\-sop \-sohb \-sosb\fR.
+.IP "\fB\-sct\fR, \fB\-\-stack\-closing\-tokens\fR and related flags" 4
+.IX Item "-sct, --stack-closing-tokens and related flags"
+The \fB\-sct\fR flag tells perltidy to \*(L"stack\*(R" closing tokens
+when possible to avoid lines with isolated closing tokens.
+.Sp
+For example:
+.Sp
+.Vb 8
+\& # default
+\& $opt_c = Text::CSV_XS\->new(
+\& {
+\& binary => 1,
+\& sep_char => $opt_c,
+\& always_quote => 1,
+\& }
+\& );
+\&
+\& # \-sct
+\& $opt_c = Text::CSV_XS\->new(
+\& {
+\& binary => 1,
+\& sep_char => $opt_c,
+\& always_quote => 1,
+\& } );
+.Ve
+.Sp
+The \fB\-sct\fR flag is somewhat similar to the \fB\-vtc\fR flags, and in some
+cases it can give a similar result. The difference is that the \fB\-vtc\fR
+flags try to avoid lines with leading opening tokens by \*(L"hiding\*(R" them at
+the end of a previous line, whereas the \fB\-sct\fR flag merely tries to
+reduce the number of lines with isolated closing tokens by stacking them
+but does not try to hide them. For example:
+.Sp
+.Vb 6
+\& # \-vtc=2
+\& $opt_c = Text::CSV_XS\->new(
+\& {
+\& binary => 1,
+\& sep_char => $opt_c,
+\& always_quote => 1, } );
+.Ve
+.Sp
+For detailed control of the stacking of individual closing tokens the
+following controls can be used:
+.Sp
+.Vb 3
+\& \-scp or \-\-stack\-closing\-paren
+\& \-schb or \-\-stack\-closing\-hash\-brace
+\& \-scsb or \-\-stack\-closing\-square\-bracket
+.Ve
+.Sp
+The flag \fB\-sct\fR is a synonym for \fB\-scp \-schb \-scsb\fR.
.IP "\fB\-dnl\fR, \fB\-\-delete\-old\-newlines\fR" 4
.IX Item "-dnl, --delete-old-newlines"
By default, perltidy first deletes all old line break locations, and then it
looks for good break points to match the desired line length. Use \fB\-ndnl\fR
or \fB\-\-nodelete\-old\-newlines\fR to force perltidy to retain all old line break
-points.
+points.
.IP "\fB\-anl\fR, \fB\-\-add\-newlines\fR" 4
.IX Item "-anl, --add-newlines"
By default, perltidy will add line breaks when necessary to create
continuations of long lines and to improve the script appearance. Use
-\&\fB\-nanl\fR or \fB\-noadd\-newlines\fR to prevent any new line breaks.
+\&\fB\-nanl\fR or \fB\-\-noadd\-newlines\fR to prevent any new line breaks.
.Sp
This flag does not prevent perltidy from eliminating existing line
-breaks; see \fB\-freeze\-newlines\fR to completely prevent changes to line
+breaks; see \fB\-\-freeze\-newlines\fR to completely prevent changes to line
break points.
.IP "Controlling whether perltidy breaks before or after operators" 4
.IX Item "Controlling whether perltidy breaks before or after operators"
-Two command line parameters provide some control over whether
+Four command line parameters provide some control over whether
a line break should be before or after specific token types.
+Two parameters give detailed control:
.Sp
\&\fB\-wba=s\fR or \fB\-\-want\-break\-after=s\fR, and
.Sp
perltidy ever sees it.
.Sp
By default, perltidy breaks \fBafter\fR these token types:
- % + \- * / x != == >= <= =~ !~ < > | & >= <
- = **= += *= &= <<= &&= \-= /= |= >>= ||= .= %= ^= x=
+ % + \- * / x != == >= <= =~ !~ < > | &
+ = **= += *= &= <<= &&= \-= /= |= >>= ||= //= .= %= ^= x=
.Sp
And perltidy breaks \fBbefore\fR these token types by default:
- . << >> \-> && ||
+ . << >> \-> && || //
.Sp
-To illustrate, to cause a break after a concatenation operator, \f(CW'.'\fR,
+To illustrate, to cause a break after a concatenation operator, \f(CW\*(Aq.\*(Aq\fR,
rather than before it, the command line would be
.Sp
.Vb 1
-\& -wba="."
+\& \-wba="."
.Ve
+.Sp
As another example, the following command would cause a break before
-math operators \f(CW'+'\fR, \f(CW'\-'\fR, \f(CW'/'\fR, and \f(CW'*'\fR:
+math operators \f(CW\*(Aq+\*(Aq\fR, \f(CW\*(Aq\-\*(Aq\fR, \f(CW\*(Aq/\*(Aq\fR, and \f(CW\*(Aq*\*(Aq\fR:
.Sp
.Vb 1
-\& -wbb="+ - / *"
-.Ve
-These commands should work well for most of the token types that
-perltidy uses (use \fB\-\-dump\-token\-types\fR for a list). However, for a
-few token types there may be conflicts with hardwired logic which cause
-unexpected results. One example is curly braces, which should be
-controlled with the parameter \fBbl\fR provided for that purpose.
-.Sh "Controlling List Formatting"
+\& \-wbb="+ \- / *"
+.Ve
+.Sp
+These commands should work well for most of the token types that perltidy uses
+(use \fB\-\-dump\-token\-types\fR for a list). Also try the \fB\-D\fR flag on a short
+snippet of code and look at the .DEBUG file to see the tokenization. However,
+for a few token types there may be conflicts with hardwired logic which cause
+unexpected results. One example is curly braces, which should be controlled
+with the parameter \fBbl\fR provided for that purpose.
+.Sp
+\&\fB\s-1WARNING\s0\fR Be sure to put these tokens in quotes to avoid having them
+misinterpreted by your command shell.
+.Sp
+Two additional parameters are available which, though they provide no further
+capability, can simplify input are:
+.Sp
+\&\fB\-baao\fR or \fB\-\-break\-after\-all\-operators\fR,
+.Sp
+\&\fB\-bbao\fR or \fB\-\-break\-before\-all\-operators\fR.
+.Sp
+The \-baao sets the default to be to break after all of the following operators:
+.Sp
+.Vb 3
+\& % + \- * / x != == >= <= =~ !~ < > | &
+\& = **= += *= &= <<= &&= \-= /= |= >>= ||= //= .= %= ^= x=
+\& . : ? && || and or err xor
+.Ve
+.Sp
+and the \fB\-bbao\fR flag sets the default to break before all of these operators.
+These can be used to define an initial break preference which can be fine-tuned
+with the \fB\-wba\fR and \fB\-wbb\fR flags. For example, to break before all operators
+except an \fB=\fR one could use \-\-bbao \-wba='=' rather than listing every
+single perl operator except \fB=\fR on a \-wbb flag.
+.SS "Controlling List Formatting"
.IX Subsection "Controlling List Formatting"
Perltidy attempts to place comma-separated arrays of values in tables
which look good. Its default algorithms usually work well, and they
\& 1, 3, 3, 1,
\& 1, 4, 6, 4, 1,);
.Ve
+.Sp
The default formatting will flatten this down to one line:
.Sp
.Vb 2
\& # perltidy (default)
\& my @list = ( 1, 1, 1, 1, 2, 1, 1, 3, 3, 1, 1, 4, 6, 4, 1, );
.Ve
+.Sp
which hides the structure. Using \fB\-boc\fR, plus additional flags
to retain the original style, yields
.Sp
.Vb 6
-\& # perltidy -boc -lp -pt=2 -vt=1 -vtc=1
+\& # perltidy \-boc \-lp \-pt=2 \-vt=1 \-vtc=1
\& my @list = (1,
\& 1, 1,
\& 1, 2, 1,
\& 1, 3, 3, 1,
\& 1, 4, 6, 4, 1,);
.Ve
+.Sp
A disadvantage of this flag is that all tables in the file
-must already be nicely formatted.
+must already be nicely formatted. For another possibility see
+the \-fs flag in \*(L"Skipping Selected Sections of Code\*(R".
.IP "\fB\-mft=n\fR, \fB\-\-maximum\-fields\-per\-table=n\fR" 4
.IX Item "-mft=n, --maximum-fields-per-table=n"
If the computed number of fields for any table exceeds \fBn\fR, then it
of perltidy.
.Sp
.Vb 9
-\& # perltidy -mft=2
+\& # perltidy \-mft=2
\& @month_of_year = (
-\& 'Jan', 'Feb',
-\& 'Mar', 'Apr',
-\& 'May', 'Jun',
-\& 'Jul', 'Aug',
-\& 'Sep', 'Oct',
-\& 'Nov', 'Dec'
+\& \*(AqJan\*(Aq, \*(AqFeb\*(Aq,
+\& \*(AqMar\*(Aq, \*(AqApr\*(Aq,
+\& \*(AqMay\*(Aq, \*(AqJun\*(Aq,
+\& \*(AqJul\*(Aq, \*(AqAug\*(Aq,
+\& \*(AqSep\*(Aq, \*(AqOct\*(Aq,
+\& \*(AqNov\*(Aq, \*(AqDec\*(Aq
\& );
.Ve
.IP "\fB\-cab=n\fR, \fB\-\-comma\-arrow\-breakpoints=n\fR" 4
.Vb 6
\& n=0 break at all commas after =>
\& n=1 stable: break at all commas after => unless this would break
-\& an existing one-line container (default)
+\& an existing one\-line container (default)
\& n=2 break at all commas after =>, but try to form the maximum
-\& maximum one-line container lengths
+\& maximum one\-line container lengths
\& n=3 do not treat commas after => specially at all
.Ve
+.Sp
For example, given the following single line, perltidy by default will
not add any line breaks because it would break the existing one-line
container:
.Vb 1
\& bless { B => $B, Root => $Root } => $package;
.Ve
+.Sp
Using \fB\-cab=0\fR will force a break after each comma-arrow item:
.Sp
.Vb 5
-\& # perltidy -cab=0:
+\& # perltidy \-cab=0:
\& bless {
\& B => $B,
\& Root => $Root
\& } => $package;
.Ve
+.Sp
If perltidy is subsequently run with this container broken, then by
default it will break after each '=>' because the container is now
broken. To reform a one-line container, the parameter \fB\-cab=2\fR would
Here is an example.
.Sp
.Vb 6
-\& # perltidy -cab=3
+\& # perltidy \-cab=3
\& my %last_day = (
\& "01" => 31, "02" => 29, "03" => 31, "04" => 30,
\& "05" => 31, "06" => 30, "07" => 31, "08" => 31,
\& "09" => 30, "10" => 31, "11" => 30, "12" => 31
\& );
.Ve
-.Sh "Retaining or Ignoring Existing Line Breaks"
+.SS "Retaining or Ignoring Existing Line Breaks"
.IX Subsection "Retaining or Ignoring Existing Line Breaks"
Several additional parameters are available for controlling the extent
to which line breaks in the input script influence the output script.
return lists, such as \f(CW\*(C`sort\*(C'\fR and <map>. This allows chains of these
operators to be displayed one per line. Use \fB\-nbok\fR to prevent
retaining these breakpoints.
-.IP "\fB\-bot\fR, \fB\-\-break\-at\-old\-trinary\-breakpoints\fR" 4
-.IX Item "-bot, --break-at-old-trinary-breakpoints"
-By default, if a conditional (trinary) operator is broken at a \f(CW\*(C`:\*(C'\fR,
+.IP "\fB\-bot\fR, \fB\-\-break\-at\-old\-ternary\-breakpoints\fR" 4
+.IX Item "-bot, --break-at-old-ternary-breakpoints"
+By default, if a conditional (ternary) operator is broken at a \f(CW\*(C`:\*(C'\fR,
then it will remain broken. To prevent this, and thereby
form longer lines, use \fB\-nbot\fR.
.IP "\fB\-iob\fR, \fB\-\-ignore\-old\-breakpoints\fR" 4
maximum extent possible. This will tend to produce the longest possible
containers, regardless of type, which do not exceed the line length
limit.
-.Sh "Blank Line Control"
+.IP "\fB\-kis\fR, \fB\-\-keep\-interior\-semicolons\fR" 4
+.IX Item "-kis, --keep-interior-semicolons"
+Use the \fB\-kis\fR flag to prevent breaking at a semicolon if
+there was no break there in the input file. Normally
+perltidy places a newline after each semicolon which
+terminates a statement unless several statements are
+contained within a one-line brace block. To illustrate,
+consider the following input lines:
+.Sp
+.Vb 2
+\& dbmclose(%verb_delim); undef %verb_delim;
+\& dbmclose(%expanded); undef %expanded;
+.Ve
+.Sp
+The default is to break after each statement, giving
+.Sp
+.Vb 4
+\& dbmclose(%verb_delim);
+\& undef %verb_delim;
+\& dbmclose(%expanded);
+\& undef %expanded;
+.Ve
+.Sp
+With \fBperltidy \-kis\fR the multiple statements are retained:
+.Sp
+.Vb 2
+\& dbmclose(%verb_delim); undef %verb_delim;
+\& dbmclose(%expanded); undef %expanded;
+.Ve
+.Sp
+The statements are still subject to the specified value
+of \fBmaximum-line-length\fR and will be broken if this
+maximum is exceeed.
+.SS "Blank Line Control"
.IX Subsection "Blank Line Control"
Blank lines can improve the readability of a script if they are carefully
placed. Perltidy has several commands for controlling the insertion,
retention, and removal of blank lines.
+.IP "\fB\-fbl\fR, \fB\-\-freeze\-blank\-lines\fR" 4
+.IX Item "-fbl, --freeze-blank-lines"
+Set \fB\-fbl\fR if you want to the blank lines in your script to
+remain exactly as they are. The rest of the parameters in
+this section may then be ignored. (Note: setting the \fB\-fbl\fR flag
+is equivalent to setting \fB\-mbl=0\fR and \fB\-kbl=2\fR).
.IP "\fB\-bbc\fR, \fB\-\-blanks\-before\-comments\fR" 4
.IX Item "-bbc, --blanks-before-comments"
A blank line will be introduced before a full-line comment. This is the
before a \fBpackage\fR statement and a \fB\s-1BEGIN\s0\fR and \fB\s-1END\s0\fR block. This is the
default. The intention is to help display the structure of a program by
setting off certain key sections of code. This is negated with \fB\-nbbs\fR or
-\&\fB\-\-noblanks\-before\-subs\fR.
+\&\fB\-\-noblanks\-before\-subs\fR.
.IP "\fB\-bbb\fR, \fB\-\-blanks\-before\-blocks\fR" 4
.IX Item "-bbb, --blanks-before-blocks"
A blank line will be introduced before blocks of coding delimited by
a value of \fB0\fR is equivalent to entering a very large number.
.IP "\fB\-mbl=n\fR \fB\-\-maximum\-consecutive\-blank\-lines=n\fR" 4
.IX Item "-mbl=n --maximum-consecutive-blank-lines=n"
-This parameter specifies the maximum number of consecutive blank lines
-in the output script. The default is n=1. If the input file has more
-than n consecutive blank lines, the number will be reduced to n.
-(This obviously does not apply to pod sections, here\-documents, and quotes).
+This parameter specifies the maximum number of consecutive
+blank lines which will be output within code sections of a
+script. The default is n=1. If the input file has more
+than n consecutive blank lines, the number will be reduced
+to n. If \fBn=0\fR then no blank lines will be output (unless
+all old blank lines are retained with the \fB\-kbl=2\fR flag of
+the next section).
+.Sp
+This flag obviously does not apply to pod sections,
+here-documents, and quotes.
+.IP "\fB\-kbl=n\fR, \fB\-\-keep\-old\-blank\-lines=n\fR" 4
+.IX Item "-kbl=n, --keep-old-blank-lines=n"
+The \fB\-kbl=n\fR flag gives you control over how your existing blank lines are
+treated.
+.Sp
+The possible values of \fBn\fR are:
+.Sp
+.Vb 3
+\& n=0 ignore all old blank lines
+\& n=1 stable: keep old blanks, but limited by the value of the B<\-mbl=n> flag
+\& n=2 keep all old blank lines, regardless of the value of the B<\-mbl=n> flag
+.Ve
+.Sp
+The default is \fBn=1\fR.
.IP "\fB\-sob\fR, \fB\-\-swallow\-optional\-blank\-lines\fR" 4
.IX Item "-sob, --swallow-optional-blank-lines"
-All blank lines not required by the above flags, \fB\-bbb\fR, \fB\-bbs\fR, and \fB\-bbc\fR,
-will be deleted. (But essential blank lines above pod documents will be
-retained). This is \s-1NOT\s0 the default.
+This is equivalent to \fBkbl=0\fR and is included for compatability with
+previous versions.
.IP "\fB\-nsob\fR, \fB\-\-noswallow\-optional\-blank\-lines\fR" 4
.IX Item "-nsob, --noswallow-optional-blank-lines"
-Retain blank lines, including those which do not corresponding to flags
-\&\fB\-bbb\fR, \fB\-bbs\fR, and \fB\-bbc\fR. This is the default. The number of
-blanks retained is subject to the limit imposed by
-\&\fB\-\-maximum\-consecutive\-blank\-lines\fR, however.
-.Sh "Styles"
+This is equivalent to \fBkbl=1\fR and is included for compatability with
+previous versions.
+.SS "Styles"
.IX Subsection "Styles"
A style refers to a convenient collection of existing parameters.
.IP "\fB\-gnu\fR, \fB\-\-gnu\-style\fR" 4
style overrides the default style with the following parameters:
.Sp
.Vb 1
-\& -lp -bl -noll -pt=2 -bt=2 -sbt=2 -icp
+\& \-lp \-bl \-noll \-pt=2 \-bt=2 \-sbt=2 \-icp
+.Ve
+.IP "\fB\-pbp\fR, \fB\-\-perl\-best\-practices\fR" 4
+.IX Item "-pbp, --perl-best-practices"
+\&\fB\-pbp\fR is an abbreviation for the parameters in the book \fBPerl Best Practices\fR
+by Damian Conway:
+.Sp
+.Vb 3
+\& \-l=78 \-i=4 \-ci=4 \-st \-se \-vt=2 \-cti=0 \-pt=1 \-bt=1 \-sbt=1 \-bbt=1 \-nsfs \-nolq
+\& \-wbb="% + \- * / x != == >= <= =~ !~ < > | & =
+\& **= += *= &= <<= &&= \-= /= |= >>= ||= //= .= %= ^= x="
.Ve
-.Sh "Other Controls"
+.Sp
+Note that the \-st and \-se flags make perltidy act as a filter on one file only.
+These can be overridden with \-nst and \-nse if necessary.
+.SS "Other Controls"
.IX Subsection "Other Controls"
.IP "Deleting selected text" 4
.IX Item "Deleting selected text"
.IX Item "Writing selected text to a file"
When perltidy writes a formatted text file, it has the ability to also
send selected text to a file with a \fI.TEE\fR extension. This text can
-include comments and pod documentation.
+include comments and pod documentation.
.Sp
The command \fB\-tac\fR or \fB\-\-tee\-all\-comments\fR will write all comments
\&\fBand\fR all pod documentation.
\&\fB\-\-tee\-block\-comments\fR and \fB\-tsc\fR or \fB\-\-tee\-side\-comments\fR.
(Hanging side comments will be written with block comments here.)
.Sp
-The negatives of these commands also work, and are the defaults.
+The negatives of these commands also work, and are the defaults.
.IP "Using a \fI.perltidyrc\fR command file" 4
.IX Item "Using a .perltidyrc command file"
If you use perltidy frequently, you probably won't be happy until you
create a \fI.perltidyrc\fR file to avoid typing commonly-used parameters.
Perltidy will first look in your current directory for a command file
named \fI.perltidyrc\fR. If it does not find one, it will continue looking
-for one in other standard locations.
+for one in other standard locations.
.Sp
-These other locations are system\-dependent, and may be displayed with
-the command \f(CW\*(C`perltidy \-dpro\*(C'\fR. Under Unix systems, it will look for a
+These other locations are system-dependent, and may be displayed with
+the command \f(CW\*(C`perltidy \-dpro\*(C'\fR. Under Unix systems, it will first look
+for an environment variable \fB\s-1PERLTIDY\s0\fR. Then it will look for a
\&\fI.perltidyrc\fR file in the home directory, and then for a system-wide
file \fI/usr/local/etc/perltidyrc\fR, and then it will look for
\&\fI/etc/perltidyrc\fR. Note that these last two system-wide files do not
have a leading dot. Further system-dependent information will be found
in the \s-1INSTALL\s0 file distributed with perltidy.
.Sp
-This file is free format, and simply a list of parameters, just as they
-would be entered on a command line. Any number of lines may be used,
-with any number of parameters per line, although it may be easiest to
-read with one parameter per line. Blank lines are ignored, and text
-after a '#' is ignored to the end of a line.
+Under Windows, perltidy will also search for a configuration file named perltidy.ini since Windows does not allow files with a leading period (.).
+Use \f(CW\*(C`perltidy \-dpro\*(C'\fR to see the possbile locations for your system.
+An example might be \fIC:\eDocuments and Settings\eAll Users\eperltidy.ini\fR.
+.Sp
+Another option is the use of the \s-1PERLTIDY\s0 environment variable.
+The method for setting environment variables depends upon the version of
+Windows that you are using. Instructions for Windows 95 and later versions can
+be found here:
+.Sp
+http://www.netmanage.com/000/20021101_005_tcm21\-6336.pdf
+.Sp
+Under Windows \s-1NT\s0 / 2000 / \s-1XP\s0 the \s-1PERLTIDY\s0 environment variable can be placed in
+either the user section or the system section. The later makes the
+configuration file common to all users on the machine. Be sure to enter the
+full path of the configuration file in the value of the environment variable.
+Ex. PERLTIDY=C:\eDocuments and Settings\eperltidy.ini
+.Sp
+The configuation file is free format, and simply a list of parameters, just as
+they would be entered on a command line. Any number of lines may be used, with
+any number of parameters per line, although it may be easiest to read with one
+parameter per line. Blank lines are ignored, and text after a '#' is ignored
+to the end of a line.
.Sp
Here is an example of a \fI.perltidyrc\fR file:
.Sp
.Vb 8
\& # This is a simple of a .perltidyrc configuration file
\& # This implements a highly spaced style
-\& -se # errors to standard error output
-\& -w # show all warnings
-\& -bl # braces on new lines
-\& -pt=0 # parens not tight at all
-\& -bt=0 # braces not tight
-\& -sbt=0 # square brackets not tight
+\& \-se # errors to standard error output
+\& \-w # show all warnings
+\& \-bl # braces on new lines
+\& \-pt=0 # parens not tight at all
+\& \-bt=0 # braces not tight
+\& \-sbt=0 # square brackets not tight
.Ve
+.Sp
The parameters in the \fI.perltidyrc\fR file are installed first, so any
-parameters given on the command line will have priority over them.
+parameters given on the command line will have priority over them.
.Sp
To avoid confusion, perltidy ignores any command in the .perltidyrc
file which would cause some kind of dump and an exit. These are:
.Sp
.Vb 1
-\& -h -v -ddf -dln -dop -dsn -dtt -dwls -dwrs -ss
+\& \-h \-v \-ddf \-dln \-dop \-dsn \-dtt \-dwls \-dwrs \-ss
.Ve
+.Sp
There are several options may be helpful in debugging a \fI.perltidyrc\fR
-file:
+file:
.RS 4
.IP "\(bu" 4
A very helpful command is \fB\-\-dump\-profile\fR or \fB\-dpro\fR. It writes a
list of all configuration filenames tested to standard output, and
if a file is found, it dumps the content to standard output before
exiting. So, to find out where perltidy looks for its configuration
-files, and which one if any it selects, just enter
+files, and which one if any it selects, just enter
.Sp
.Vb 1
-\& perltidy -dpro
+\& perltidy \-dpro
.Ve
.IP "\(bu" 4
It may be simplest to develop and test configuration files with
The parameters in the \fI.perltidyrc\fR file can be switched off with
the \fB\-npro\fR option.
.IP "\(bu" 4
-The commands \fB\-dump\-options\fR, \fB\-dump\-defaults\fR, \fB\-dump\-long\-names\fR,
-and \fB\-dump\-short\-names\fR, all described below, may all be helpful.
+The commands \fB\-\-dump\-options\fR, \fB\-\-dump\-defaults\fR, \fB\-\-dump\-long\-names\fR,
+and \fB\-\-dump\-short\-names\fR, all described below, may all be helpful.
.RE
.RS 4
.RE
.Sp
.Vb 4
\& newword {
-\& -opt1
-\& -opt2
+\& \-opt1
+\& \-opt2
\& }
.Ve
+.Sp
where \fBnewword\fR is the abbreviation, and \fBopt1\fR, etc, are existing parameters
\&\fIor other abbreviations\fR. The main syntax requirement is that
the new abbreviation must begin on a new line.
specific example, the following line
.Sp
.Vb 1
-\& airy {-bl -pt=0 -bt=0 -sbt=0}
+\& airy {\-bl \-pt=0 \-bt=0 \-sbt=0}
.Ve
+.Sp
could be placed in a \fI.perltidyrc\fR file, and then invoked at will with
.Sp
.Vb 1
-\& perltidy -airy somefile.pl
+\& perltidy \-airy somefile.pl
.Ve
+.Sp
(Either \f(CW\*(C`\-airy\*(C'\fR or \f(CW\*(C`\-\-airy\*(C'\fR may be used).
.IP "Skipping leading non-perl commands with \fB\-x\fR or \fB\-\-look\-for\-hash\-bang\fR" 4
.IX Item "Skipping leading non-perl commands with -x or --look-for-hash-bang"
If your script has leading lines of system commands or other text which
are not valid perl code, and which are separated from the start of the
-perl code by a \*(L"hash\-bang\*(R" line, ( a line of the form \f(CW\*(C`#!...perl\*(C'\fR ),
+perl code by a \*(L"hash-bang\*(R" line, ( a line of the form \f(CW\*(C`#!...perl\*(C'\fR ),
you must use the \fB\-x\fR flag to tell perltidy not to parse and format any
-lines before the \*(L"hash\-bang\*(R" line. This option also invokes perl with a
+lines before the \*(L"hash-bang\*(R" line. This option also invokes perl with a
\&\-x flag when checking the syntax. This option was originally added to
allow perltidy to parse interactive \s-1VMS\s0 scripts, but it should be used
for any script which is normally invoked with \f(CW\*(C`perl \-x\*(C'\fR.
One use for \fB\-\-mangle\fR is the following:
.Sp
.Vb 1
-\& perltidy --mangle myfile.pl -st | perltidy -o myfile.pl.new
+\& perltidy \-\-mangle myfile.pl \-st | perltidy \-o myfile.pl.new
.Ve
+.Sp
This will form the maximum possible number of one-line blocks (see next
section), and can sometimes help clean up a badly formatted script.
.Sp
.Vb 1
\& if ($x > 0) { $y = 1 / $x }
.Ve
+.Sp
where the contents within the curly braces is short enough to fit
on a single line.
.Sp
If an existing one-line block is longer than the maximum line length,
however, it will be broken into multiple lines. When this happens, perltidy
checks for and adds any optional terminating semicolon (unless the \fB\-nasc\fR
-option is used) if the block is a code block.
+option is used) if the block is a code block.
.Sp
The main exception is that perltidy will attempt to form new one-line
blocks following the keywords \f(CW\*(C`map\*(C'\fR, \f(CW\*(C`eval\*(C'\fR, and \f(CW\*(C`sort\*(C'\fR, because
configuration file and its contents to standard output and quit.
.Sp
\&\fB\-\-dump\-options\fR or \fB\-dop\fR will write current option set to standard
-output and quit.
+output and quit.
.Sp
\&\fB\-\-dump\-long\-names\fR or \fB\-dln\fR will write all command line long names (passed
to Get_options) to standard output and quit.
\&\fI.html\fR. So, for example, the following command
.Sp
.Vb 1
-\& perltidy -html somefile.pl
+\& perltidy \-html somefile.pl
.Ve
+.Sp
will produce a syntax-colored html file named \fIsomefile.pl.html\fR
which may be viewed with a browser.
.Sp
\&\fBPlease Note\fR: In this case, perltidy does not do any formatting to the
input file, and it does not write a formatted file with extension
\&\fI.tdy\fR. This means that two perltidy runs are required to create a
-fully reformatted, html copy of a script.
+fully reformatted, html copy of a script.
.IP "The \fB\-pre\fR flag for code snippets" 4
.IX Item "The -pre flag for code snippets"
When the \fB\-pre\fR flag is given, only the pre-formatted section, within
pod2html. The flags which have the additional \f(CW\*(C`pod\*(C'\fR prefix are:
.Sp
.Vb 2
-\& --[no]podheader --[no]podindex --[no]podrecurse --[no]podquiet
-\& --[no]podverbose --podflush
+\& \-\-[no]podheader \-\-[no]podindex \-\-[no]podrecurse \-\-[no]podquiet
+\& \-\-[no]podverbose \-\-podflush
.Ve
+.Sp
The flags which are unchanged from their use in pod2html are:
.Sp
.Vb 2
-\& --backlink=s --cachedir=s --htmlroot=s --libpods=s --title=s
-\& --podpath=s --podroot=s
+\& \-\-backlink=s \-\-cachedir=s \-\-htmlroot=s \-\-libpods=s \-\-title=s
+\& \-\-podpath=s \-\-podroot=s
.Ve
+.Sp
where 's' is an appropriate character string. Not all of these flags are
available in older versions of Pod::Html. See your Pod::Html documentation for
more information.
files will be created:
.Sp
.Vb 3
-\& MyModule.pm.html - the frame
-\& MyModule.pm.toc.html - the table of contents
-\& MyModule.pm.src.html - the formatted source code
+\& MyModule.pm.html \- the frame
+\& MyModule.pm.toc.html \- the table of contents
+\& MyModule.pm.src.html \- the formatted source code
.Ve
+.Sp
Obviously this file naming scheme requires that output be directed to a real
file (as opposed to, say, standard output). If this is not the
case, or if the file extension is unknown, the \fB\-frm\fR option will be
was used. Thus, for example,
.Sp
.Vb 1
-\& perltidy -html -ss >mystyle.css
+\& perltidy \-html \-ss >mystyle.css
.Ve
+.Sp
will write a style sheet with the default properties to file
\&\fImystyle.css\fR.
.Sp
\&\fB\-hcx=n\fR, where \fBxxxxxx\fR is one of the following words, and \fBx\fR is the
corresponding abbreviation:
.Sp
-.Vb 19
+.Vb 10
\& Token Type xxxxxx x
-\& ---------- -------- --
+\& \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\- \-\-
\& comment comment c
\& number numeric n
\& identifier identifier i
\& bareword, function bareword w
\& keyword keyword k
\& quite, pattern quote q
-\& here doc text here-doc-text h
-\& here doc target here-doc-target hh
+\& here doc text here\-doc\-text h
+\& here doc target here\-doc\-target hh
\& punctuation punctuation pu
\& parentheses paren p
\& structural braces structure s
\& comma comma cm
\& label label j
\& sub definition name subroutine m
-\& pod text pod-text pd
+\& pod text pod\-text pd
.Ve
+.Sp
A default set of colors has been defined, but they may be changed by providing
values to any of the following parameters, where \fBn\fR is either a 6 digit
hex \s-1RGB\s0 color value or an ascii name for a color, such as 'red'.
file \fIsomefile.pl.html\fR with \*(L"aqua\*(R" keywords:
.Sp
.Vb 1
-\& perltidy -html -hck=00ffff somefile.pl
+\& perltidy \-html \-hck=00ffff somefile.pl
.Ve
+.Sp
and this should be equivalent for most browsers:
.Sp
.Vb 1
-\& perltidy -html -hck=aqua somefile.pl
+\& perltidy \-html \-hck=aqua somefile.pl
.Ve
+.Sp
Perltidy merely writes any non-hex names that it sees in the html file.
The following 16 color names are defined in the \s-1HTML\s0 3.2 standard:
.Sp
-.Vb 16
+.Vb 10
\& black => 000000,
\& silver => c0c0c0,
\& gray => 808080,
\& teal => 008080,
\& aqua => 00ffff,
.Ve
+.Sp
Many more names are supported in specific browsers, but it is safest
to use the hex codes for other colors. Helpful color tables can be
-located with an internet search for \*(L"\s-1HTML\s0 color tables\*(R".
+located with an internet search for \*(L"\s-1HTML\s0 color tables\*(R".
.Sp
Besides color, two other character attributes may be set: bold, and italics.
To set a token type to use bold, use the flag
-\&\fB\-html\-bold\-xxxxxx\fR or \fB\-hbx\fR, where \fBxxxxxx\fR or \fBx\fR are the long
+\&\fB\-\-html\-bold\-xxxxxx\fR or \fB\-hbx\fR, where \fBxxxxxx\fR or \fBx\fR are the long
or short names from the above table. Conversely, to set a token type to
-\&\s-1NOT\s0 use bold, use \fB\-nohtml\-bold\-xxxxxx\fR or \fB\-nhbx\fR.
+\&\s-1NOT\s0 use bold, use \fB\-\-nohtml\-bold\-xxxxxx\fR or \fB\-nhbx\fR.
.Sp
Likewise, to set a token type to use an italic font, use the flag
-\&\fB\-html\-italic\-xxxxxx\fR or \fB\-hix\fR, where again \fBxxxxxx\fR or \fBx\fR are the
+\&\fB\-\-html\-italic\-xxxxxx\fR or \fB\-hix\fR, where again \fBxxxxxx\fR or \fBx\fR are the
long or short names from the above table. And to set a token type to
-\&\s-1NOT\s0 use italics, use \fB\-nohtml\-italic\-xxxxxx\fR or \fB\-nhix\fR.
+\&\s-1NOT\s0 use italics, use \fB\-\-nohtml\-italic\-xxxxxx\fR or \fB\-nhix\fR.
.Sp
-For example, to use bold braces and lime color, non\-bold, italics keywords the
+For example, to use bold braces and lime color, non-bold, italics keywords the
following command would be used:
.Sp
.Vb 1
-\& perltidy -html -hbs -hck=00FF00 -nhbk -hik somefile.pl
+\& perltidy \-html \-hbs \-hck=00FF00 \-nhbk \-hik somefile.pl
.Ve
-The background color can be specified with \fB\-html\-color\-background=n\fR,
+.Sp
+The background color can be specified with \fB\-\-html\-color\-background=n\fR,
or \fB\-hcbg=n\fR for short, where n is a 6 character hex \s-1RGB\s0 value. The
default color of text is the value given to \fBpunctuation\fR, which is
black as a default.
split large files into smaller pieces to improve download times.
.SH "SOME COMMON INPUT CONVENTIONS"
.IX Header "SOME COMMON INPUT CONVENTIONS"
-.Sh "Specifying Block Types"
+.SS "Specifying Block Types"
.IX Subsection "Specifying Block Types"
Several parameters which refer to code block types may be customized by also
specifying an associated list of block types. The type of a block is the name
\&\f(CW\*(C`END\*(C'\fR blocks:
.PP
.Vb 1
-\& -cscl="sub : BEGIN END"
+\& \-cscl="sub : BEGIN END"
.Ve
+.PP
(the meaning of the \-cscl parameter is described above.) Note that
quotes are required around the list of block types because of the
spaces.
-.Sh "Specifying File Extensions"
+.SS "Specifying File Extensions"
.IX Subsection "Specifying File Extensions"
Several parameters allow default file extensions to be overridden. For
example, a backup file extension may be specified with \fB\-bext=ext\fR,
a leading '.' should be used. If the extension \f(CW\*(C`ext\*(C'\fR begins with
\&\f(CW\*(C`A\-Z\*(C'\fR, \f(CW\*(C`a\-z\*(C'\fR, or \f(CW\*(C`0\-9\*(C'\fR, then it will be appended to the filename with
an intermediate '.' (or perhaps an '_' on \s-1VMS\s0 systems). Otherwise, it
-will be appended directly.
+will be appended directly.
.PP
For example, suppose the file is \fIsomefile.pl\fR. For \f(CW\*(C`\-bext=old\*(C'\fR, a '.' is
added to give \fIsomefile.pl.old\fR. For \f(CW\*(C`\-bext=.old\*(C'\fR, no additional '.' is
added, so again the backup file is \fIsomefile.pl.old\fR. For \f(CW\*(C`\-bext=~\*(C'\fR, then no
-dot is added, and the backup file will be \fIsomefile.pl~\fR .
+dot is added, and the backup file will be \fIsomefile.pl~\fR .
.SH "SWITCHES WHICH MAY BE NEGATED"
.IX Header "SWITCHES WHICH MAY BE NEGATED"
The following list shows all short parameter names which allow a prefix
\&'n' to produce the negated form:
.PP
-.Vb 5
-\& D anl asc aws b bbb bbc bbs bli boc bok bol bot syn ce csc
-\& dac dbc dcsc dnl dws dp dpro dsm dsc ddf dln dop dsn dtt dwls dwrs
-\& f fll frm hsc html ibc icb icp iob isbc lp log lal x lsl ple pod bl
-\& sbl okw ola oll ple pvl q opt sbc sfs ssc sts se st sob
-\& t tac tbc toc tp tsc tqw w
+.Vb 6
+\& D anl asc aws b bbb bbc bbs bl bli boc bok bol bot ce
+\& csc dac dbc dcsc ddf dln dnl dop dp dpro dsc dsm dsn dtt dwls
+\& dwrs dws f fll frm fs hsc html ibc icb icp iob isbc lal log
+\& lp lsl ohbr okw ola oll opr opt osbr otr ple ple pod pvl q
+\& sbc sbl schb scp scsb sct se sfp sfs skp sob sohb sop sosb sot
+\& ssc st sts syn t tac tbc toc tp tqw tsc w x bar kis
.Ve
+.PP
Equivalently, the prefix 'no' or 'no\-' on the corresponding long names may be
used.
.SH "LIMITATIONS"
.IP "Parsing Limitations" 4
.IX Item "Parsing Limitations"
Perltidy should work properly on most perl scripts. It does a lot of
-self\-checking, but still, it is possible that an error could be
+self-checking, but still, it is possible that an error could be
introduced and go undetected. Therefore, it is essential to make
careful backups and to test reformatted scripts.
.Sp
.IX Item "Special files when standard input is used"
When standard input is used, the log file, if saved, is \fIperltidy.LOG\fR,
and any errors are written to \fIperltidy.ERR\fR unless the \fB\-se\fR flag is
-set. These are saved in the current working directory.
+set. These are saved in the current working directory.
.IP "Files overwritten" 4
.IX Item "Files overwritten"
The following file extensions are used by perltidy, and files with these
\&\fIperlstyle\fR\|(1), \fIPerl::Tidy\fR\|(3)
.SH "VERSION"
.IX Header "VERSION"
-This man page documents perltidy version 20031021.
+This man page documents perltidy version 20101217.
.SH "CREDITS"
.IX Header "CREDITS"
Michael Cartmell supplied code for adaptation to \s-1VMS\s0 and helped with
v\-strings.
.PP
Yves Orton supplied code for adaptation to the various versions
-of Windows.
+of Windows.
.PP
Axel Rose supplied a patch for MacPerl.
.PP
-Hugh S. Myers designed and implemented the initial Perl::Tidy module interface.
+Hugh S. Myers designed and implemented the initial Perl::Tidy module interface.
.PP
Many others have supplied key ideas, suggestions, and bug reports;
see the \s-1CHANGES\s0 file.
.Ve
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
-Copyright (c) 2000\-2003 by Steve Hancock
+Copyright (c) 2000\-2010 by Steve Hancock
.SH "LICENSE"
.IX Header "LICENSE"
This package is free software; you can redistribute it and/or modify it
projects / perltidy.git / blobdiff