code. Perltidy will try to keep comments at least n spaces to the
right. The default is n=4 spaces.
+=item B<-fpsc=n>, B<--fixed-position-side-comment=n>
+
+This parameter tells perltidy to line up side comments in column number B<n>
+whenever possible. The default, n=0, is not do do this.
+
=item B<-hsc>, B<--hanging-side-comments>
By default, perltidy tries to identify and align "hanging side
which identifies these comments, it must enable a valid regular expression to
be formed.
+A pattern which can be useful is:
+
+ -sbcp=^#{2,}[^\s#]
+
+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 '#'.
+
=item B<-osbc>, B<--outdent-static-block-comments>
The command B<-osbc> will will cause static block comments to be outdented by 2
the exception of one-line blocks, they will normally remain on a
separate line.
-=item B<-sot>, B<--stack-opening-token> and related flags
+=item B<-sot>, B<--stack-opening-tokens> and related flags
The B<-sot> flag tells perltidy to "stack" opening tokens
when possible to avoid lines with isolated opening tokens.
The flag B<-sot> is a synonym for B<-sop -sohb -sosb>.
-=item B<-sct>, B<--stack-closing-token> and related flags
+=item B<-sct>, B<--stack-closing-tokens> and related flags
The B<-sct> flag tells perltidy to "stack" closing tokens
when possible to avoid lines with isolated closing tokens.
=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:
B<-wba=s> or B<--want-break-after=s>, and
B<WARNING> Be sure to put these tokens in quotes to avoid having them
misinterpreted by your command shell.
+Two additional parameters are available which, though they provide no further
+capability, can simplify input are:
+
+B<-baao> or B<--break-after-all-operators>,
+
+B<-bbao> or B<--break-before-all-operators>.
+
+The -baao sets the default to be to break after all of the following operators:
+
+ % + - * / x != == >= <= =~ !~ < > | &
+ = **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x=
+ . : ? && || and or err xor
+
+and the B<-bbao> 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 B<-wba> and B<-wbb> flags. For example, to break before all operators
+except an B<=> one could use --bbao -wba='=' rather than listing every
+single perl operator except B<=> on a -wbb flag.
+
=back
=head2 Controlling List Formatting
containers, regardless of type, which do not exceed the line length
limit.
+=item B<-kis>, B<--keep-interior-semicolons>
+
+Use the B<-kis> 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:
+
+ dbmclose(%verb_delim); undef %verb_delim;
+ dbmclose(%expanded); undef %expanded;
+
+The default is to break after each statement, giving
+
+ dbmclose(%verb_delim);
+ undef %verb_delim;
+ dbmclose(%expanded);
+ undef %expanded;
+
+With B<perltidy -kis> the multiple statements are retained:
+
+ dbmclose(%verb_delim); undef %verb_delim;
+ dbmclose(%expanded); undef %expanded;
+
+The statements are still subject to the specified value
+of B<maximum-line-length> and will be broken if this
+maximum is exceeed.
+
=back
=head2 Blank Line Control
for one in other standard locations.
These other locations are system-dependent, and may be displayed with
-the command C<perltidy -dpro>. Under Unix systems, it will look for a
+the command C<perltidy -dpro>. Under Unix systems, it will first look
+for an environment variable B<PERLTIDY>. Then it will look for a
F<.perltidyrc> file in the home directory, and then for a system-wide
file F</usr/local/etc/perltidyrc>, and then it will look for
F</etc/perltidyrc>. Note that these last two system-wide files do not
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
+ ssc st sts syn t tac tbc toc tp tqw tsc w x bar kis
Equivalently, the prefix 'no' or 'no-' on the corresponding long names may be
used.
=head1 VERSION
-This man page documents perltidy version 20070508.
+This man page documents perltidy version 20071205.
=head1 CREDITS
projects / perltidy.git / blobdiff