-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" 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
. 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 "2007-12-05" "perl v5.8.8" "User Contributed Perl Documentation"
+.TH PERLTIDY 1 "2009-06-16" "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"
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 \-b file1.pl file2.pl
.Ve
.PP
-Modify \fIfile1.pl\fR and \fIfile1.pl\fR in place, and backup the originals to
+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
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
.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
.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
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"
+.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
.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
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
.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\-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
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.
-.Sh "Code Indentation Control"
+.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"
.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
.Vb 5
\& # 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
.Vb 5
\& # 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
-.Sp
-.Vb 5
+\&
\& # 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
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\-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
.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"
\& }
.Ve
.Sp
-Use \fB\-nola\fR to not outdent labels.
+Use \fB\-nola\fR to not outdent labels.
.IP "Outdenting Keywords" 4
.IX Item "Outdenting Keywords"
.RS 4
\& }
.Ve
.Sp
-The default is not to do this.
+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.
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.
.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"
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. Also try the \fB\-D\fR flag on a short snippet of code
-and look at the .DEBUG file to see the tokenization.
+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.
.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
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
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\*(C`...\*(C'\fR.
+\&\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
.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.
+=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
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
-.IP "*" 4
+\&\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
(\fB\-ce\fR), preclude the generation of some closing side comments.
-.IP "*" 4
+.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.
-.IP "*" 4
+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
any existing side comment data which happens to have the csc prefix.
-.IP "*" 4
+.IP "\(bu" 4
Once you use \fB\-csc\fR, you should continue to use it so that any
closing side comments remain correct as code changes. Otherwise, these
comments will become incorrect as the code is updated.
-.IP "*" 4
+.IP "\(bu" 4
If you edit the closing side comments generated by perltidy, you must also
change the prefix to be different from the closing side comment prefix.
Otherwise, your edits will be lost when you rerun perltidy with \fB\-csc\fR. For
example, you could simply change \f(CW\*(C`## end\*(C'\fR to be \f(CW\*(C`## End\*(C'\fR, since the test is
case sensitive. You may also want to use the \fB\-ssc\fR flag to keep these
modified closing side comments spaced the same as actual closing side comments.
-.IP "*" 4
+.IP "\(bu" 4
Temporarily generating closing side comments is a useful technique for
exploring and/or debugging a perl script, especially one written by someone
else. You can always remove them with \fB\-dcsc\fR.
.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 "*" 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 "*" 4
+.IP "\(bu" 4
no new blank line will be
-inserted before such a comment, and
-.IP "*" 4
+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');
+\& \*(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
-.Sp
-.Vb 3
-\& ## 'Dec', 'Nov'
-\& 'Nov', 'Dec'
+\& \*(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
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='^#'\*(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,
.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 "Skipping Selected Sections of Code"
+.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
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.
+for characters to be taken literally rather than as patterns.
.Sp
Some examples show how example strings become patterns:
.Sp
.Vb 3
-\& \-fsb='#\e{\e{\e{' becomes /^#\e{\e{\e{\es/ which matches #{{{ but not #{{{{
-\& \-fsb='#\e*\e*' becomes /^#\e*\e*\es/ which matches #** but not #***
-\& \-fsb='#\e*{2,}' becomes /^#\e*{2,}\es/ which matches #** and #*****
+\& \-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='#<<<'.
-.Sh "Line Break Control"
+\&\-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
\& } else { # \-ce
\& zzz();
\& }
-.Ve
-.Sp
-.Vb 6
+\&
\& if ($task) {
\& yyy();
\& }
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
.Sp
-This flag applies to all structural blocks, including sub's (unless
+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
.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();
\& }
\& accno => $ref\->{accno},
\& description => $ref\->{description}
\& };
-.Ve
-.Sp
-.Vb 5
+\&
\& # perltidy \-otr
\& push @{ $self\->{$module}{$key} }, {
\& accno => $ref\->{accno},
These parameters control what shall be called vertical tightness. Here are the
main points:
.RS 4
-.IP "*" 4
+.IP "\(bu" 4
Opening tokens (except for block braces) are controlled by \fB\-vt=n\fR, or
\&\fB\-\-vertical\-tightness=n\fR, where
.Sp
\& step in indentation in a line.
\& \-vt=2 never break a line after opening token
.Ve
-.IP "*" 4
+.IP "\(bu" 4
You must also use the \fB\-lp\fR flag when you use the \fB\-vt\fR flag; the
reason is explained below.
-.IP "*" 4
+.IP "\(bu" 4
Closing tokens (except for block braces) are controlled by \fB\-vtc=n\fR, or
\&\fB\-\-vertical\-tightness\-closing=n\fR, where
.Sp
.Sp
The rules for \fB\-vtc=1\fR are designed to maintain a reasonable balance
between tightness and readability in complex lists.
-.IP "*" 4
+.IP "\(bu" 4
Different controls may be applied to to different token types,
and it is also possible to control block braces; see below.
-.IP "*" 4
+.IP "\(bu" 4
Finally, please note that these vertical tightness flags are merely
hints to the formatter, and it cannot always follow them. Things which
make it difficult or impossible include comments, blank lines, blocks of
.RE
.RS 4
.Sp
-Here are some examples:
+Here are some examples:
.Sp
.Vb 7
\& # 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
-.Sp
-.Vb 6
+\&
\& # perltidy \-lp \-vt=1 \-vtc=0
-\& %romanNumerals = ( one => 'I',
-\& two => 'II',
-\& three => 'III',
-\& four => 'IV',
+\& %romanNumerals = ( one => \*(AqI\*(Aq,
+\& two => \*(AqII\*(Aq,
+\& three => \*(AqIII\*(Aq,
+\& four => \*(AqIV\*(Aq,
\& );
-.Ve
-.Sp
-.Vb 5
+\&
\& # perltidy \-lp \-vt=1 \-vtc=1
-\& %romanNumerals = ( one => 'I',
-\& two => 'II',
-\& three => 'III',
-\& four => 'IV', );
+\& %romanNumerals = ( one => \*(AqI\*(Aq,
+\& two => \*(AqII\*(Aq,
+\& three => \*(AqIII\*(Aq,
+\& four => \*(AqIV\*(Aq, );
.Ve
.Sp
The difference between \fB\-vt=1\fR and \fB\-vt=2\fR is shown here:
\& cstring( $threadsv_names[ $op\->targ ] )
\& )
\& );
-.Ve
-.Sp
-.Vb 5
+\&
\& # perltidy \-lp \-vt=2
\& $init\->add( mysprintf( "(void)find_threadsv(%s);",
\& cstring( $threadsv_names[ $op\->targ ] )
\& }
\& close(FILE);
\& }
-.Ve
-.Sp
-.Vb 8
+\&
\& # perltidy \-bli \-bbvt=1
\& if ( open( FILE, "< $File" ) )
\& { while ( $File = <FILE> )
.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=1 \-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
\& always_quote => 1,
\& }
\& );
-.Ve
-.Sp
-.Vb 7
+\&
\& # \-sot
\& $opt_c = Text::CSV_XS\->new( {
\& binary => 1,
\& always_quote => 1,
\& }
\& );
-.Ve
-.Sp
-.Vb 7
+\&
\& # \-sct
\& $opt_c = Text::CSV_XS\->new(
\& {
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
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
.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="+ \- / *"
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.
-.Sh "Controlling List Formatting"
+.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
.Vb 9
\& # 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
\& "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.
The statements are still subject to the specified value
of \fBmaximum-line-length\fR and will be broken if this
maximum is exceeed.
-.Sh "Blank Line Control"
+.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
\&\fBfor\fR, \fBforeach\fR, \fBwhile\fR, \fBuntil\fR, and \fBif\fR, \fBunless\fR, in the following
circumstances:
.RS 4
-.IP "*" 4
+.IP "\(bu" 4
The block is not preceded by a comment.
-.IP "*" 4
+.IP "\(bu" 4
The block is not a one-line block.
-.IP "*" 4
+.IP "\(bu" 4
The number of consecutive non-blank lines at the current indentation depth is at least \fB\-lbl\fR
(see next section).
.RE
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
.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.
-.Sh "Other Controls"
+.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
+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
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
.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:
.Ve
.Sp
There are several options may be helpful in debugging a \fI.perltidyrc\fR
-file:
+file:
.RS 4
-.IP "*" 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
.Ve
-.IP "*" 4
+.IP "\(bu" 4
It may be simplest to develop and test configuration files with
alternative names, and invoke them with \fB\-pro=filename\fR on the command
line. Then rename the desired file to \fI.perltidyrc\fR when finished.
-.IP "*" 4
+.IP "\(bu" 4
The parameters in the \fI.perltidyrc\fR file can be switched off with
the \fB\-npro\fR option.
-.IP "*" 4
+.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.
.RE
.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.
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.
\&\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
\&\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
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,
.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
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.
.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
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
(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
.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 20071205.
+This man page documents perltidy version 20090616.
.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\-2006 by Steve Hancock
+Copyright (c) 2000\-2008 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