1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "PERLTIDY 1"
132 .TH PERLTIDY 1 "2007-04-24" "perl v5.8.8" "User Contributed Perl Documentation"
134 perltidy \- a perl script indenter and reformatter
136 .IX Header "SYNOPSIS"
138 \& perltidy [ options ] file1 file2 file3 ...
139 \& (output goes to file1.tdy, file2.tdy, file3.tdy, ...)
140 \& perltidy [ options ] file1 \-o outfile
141 \& perltidy [ options ] file1 \-st >outfile
142 \& perltidy [ options ] <infile >outfile
145 .IX Header "DESCRIPTION"
146 Perltidy reads a perl script and writes an indented, reformatted script.
148 Many users will find enough information in \*(L"\s-1EXAMPLES\s0\*(R" to get
149 started. New users may benefit from the short tutorial
150 which can be found at
151 http://perltidy.sourceforge.net/tutorial.html
153 A convenient aid to systematically defining a set of style parameters
155 http://perltidy.sourceforge.net/stylekey.html
157 Perltidy can produce output on either of two modes, depending on the
158 existence of an \fB\-html\fR flag. Without this flag, the output is passed
159 through a formatter. The default formatting tries to follow the
160 recommendations in \fIperlstyle\fR\|(1), but it can be controlled in detail with
161 numerous input parameters, which are described in \*(L"\s-1FORMATTING\s0 \s-1OPTIONS\s0\*(R".
163 When the \fB\-html\fR flag is given, the output is passed through an \s-1HTML\s0
164 formatter which is described in \*(L"\s-1HTML\s0 \s-1OPTIONS\s0\*(R".
166 .IX Header "EXAMPLES"
168 \& perltidy somefile.pl
171 This will produce a file \fIsomefile.pl.tdy\fR containing the script reformatted
172 using the default options, which approximate the style suggested in
173 \&\fIperlstyle\fR\|(1). Perltidy never changes the input file.
179 Execute perltidy on all \fI.pl\fR files in the current directory with the
180 default options. The output will be in files with an appended \fI.tdy\fR
181 extension. For any file with an error, there will be a file with extension
185 \& perltidy \-b file1.pl file2.pl
188 Modify \fIfile1.pl\fR and \fIfile1.pl\fR in place, and backup the originals to
189 \&\fIfile1.pl.bak\fR and \fIfile2.pl.bak\fR. If \fIfile1.pl.bak\fR and/or \fIfile2.pl.bak\fR
190 already exist, they will be overwritten.
193 \& perltidy \-gnu somefile.pl
196 Execute perltidy on file \fIsomefile.pl\fR with a style which approximates the
197 \&\s-1GNU\s0 Coding Standards for C programs. The output will be \fIsomefile.pl.tdy\fR.
200 \& perltidy \-i=3 somefile.pl
203 Execute perltidy on file \fIsomefile.pl\fR, with 3 columns for each level of
204 indentation (\fB\-i=3\fR) instead of the default 4 columns. There will not be any
205 tabs in the reformatted script, except for any which already exist in comments,
206 pod documents, quotes, and here documents. Output will be \fIsomefile.pl.tdy\fR.
209 \& perltidy \-i=3 \-et=8 somefile.pl
212 Same as the previous example, except that leading whitespace will
213 be entabbed with one tab character per 8 spaces.
216 \& perltidy \-ce \-l=72 somefile.pl
219 Execute perltidy on file \fIsomefile.pl\fR with all defaults except use \*(L"cuddled
220 elses\*(R" (\fB\-ce\fR) and a maximum line length of 72 columns (\fB\-l=72\fR) instead of
221 the default 80 columns.
224 \& perltidy \-g somefile.pl
227 Execute perltidy on file \fIsomefile.pl\fR and save a log file \fIsomefile.pl.LOG\fR
228 which shows the nesting of braces, parentheses, and square brackets at
229 the start of every line.
232 \& perltidy \-html somefile.pl
235 This will produce a file \fIsomefile.pl.html\fR containing the script with
236 html markup. The output file will contain an embedded style sheet in
237 the <\s-1HEAD\s0> section which may be edited to change the appearance.
240 \& perltidy \-html \-css=mystyle.css somefile.pl
243 This will produce a file \fIsomefile.pl.html\fR containing the script with
244 html markup. This output file will contain a link to a separate style
245 sheet file \fImystyle.css\fR. If the file \fImystyle.css\fR does not exist,
246 it will be created. If it exists, it will not be overwritten.
249 \& perltidy \-html \-pre somefile.pl
252 Write an html snippet with only the \s-1PRE\s0 section to \fIsomefile.pl.html\fR.
253 This is useful when code snippets are being formatted for inclusion in a
254 larger web page. No style sheet will be written in this case.
257 \& perltidy \-html \-ss >mystyle.css
260 Write a style sheet to \fImystyle.css\fR and exit.
263 \& perltidy \-html \-frm mymodule.pm
266 Write html with a frame holding a table of contents and the source code. The
267 output files will be \fImymodule.pm.html\fR (the frame), \fImymodule.pm.toc.html\fR
268 (the table of contents), and \fImymodule.pm.src.html\fR (the source code).
269 .SH "OPTIONS \- OVERVIEW"
270 .IX Header "OPTIONS - OVERVIEW"
271 The entire command line is scanned for options, and they are processed
272 before any files are processed. As a result, it does not matter
273 whether flags are before or after any filenames. However, the relative
274 order of parameters is important, with later parameters overriding the
275 values of earlier parameters.
277 For each parameter, there is a long name and a short name. The short
278 names are convenient for keyboard input, while the long names are
279 self-documenting and therefore useful in scripts. It is customary to
280 use two leading dashes for long names, but one may be used.
282 Most parameters which serve as on/off flags can be negated with a
283 leading \*(L"n\*(R" (for the short name) or a leading \*(L"no\*(R" or \*(L"no\-\*(R" (for the
284 long name). For example, the flag to outdent long quotes is is \fB\-olq\fR
285 or \fB\-\-outdent\-long\-quotes\fR. The flag to skip this is \fB\-nolq\fR
286 or \fB\-\-nooutdent\-long\-quotes\fR or \fB\-\-no\-outdent\-long\-quotes\fR.
288 Options may not be bundled together. In other words, options \fB\-q\fR and
289 \&\fB\-g\fR may \s-1NOT\s0 be entered as \fB\-qg\fR.
291 Option names may be terminated early as long as they are uniquely identified.
292 For example, instead of \fB\-\-dump\-token\-types\fR, it would be sufficient to enter
293 \&\fB\-\-dump\-tok\fR, or even \fB\-\-dump\-t\fR, to uniquely identify this command.
295 .IX Subsection "I/O control"
296 The following parameters concern the files which are read and written.
297 .IP "\fB\-h\fR, \fB\-\-help\fR" 4
298 .IX Item "-h, --help"
299 Show summary of usage and exit.
300 .IP "\fB\-o\fR=filename, \fB\-\-outfile\fR=filename" 4
301 .IX Item "-o=filename, --outfile=filename"
302 Name of the output file (only if a single input file is being
303 processed). If no output file is specified, and output is not
304 redirected to the standard output, the output will go to \fIfilename.tdy\fR.
305 .IP "\fB\-st\fR, \fB\-\-standard\-output\fR" 4
306 .IX Item "-st, --standard-output"
307 Perltidy must be able to operate on an arbitrarily large number of files
308 in a single run, with each output being directed to a different output
309 file. Obviously this would conflict with outputting to the single
310 standard output device, so a special flag, \fB\-st\fR, is required to
311 request outputting to the standard output. For example,
314 \& perltidy somefile.pl \-st >somefile.new.pl
317 This option may only be used if there is just a single input file.
318 The default is \fB\-nst\fR or \fB\-\-nostandard\-output\fR.
319 .IP "\fB\-se\fR, \fB\-\-standard\-error\-output\fR" 4
320 .IX Item "-se, --standard-error-output"
321 If perltidy detects an error when processing file \fIsomefile.pl\fR, its
322 default behavior is to write error messages to file \fIsomefile.pl.ERR\fR.
323 Use \fB\-se\fR to cause all error messages to be sent to the standard error
324 output stream instead. This directive may be negated with \fB\-nse\fR.
325 Thus, you may place \fB\-se\fR in a \fI.perltidyrc\fR and override it when
326 desired with \fB\-nse\fR on the command line.
327 .IP "\fB\-oext\fR=ext, \fB\-\-output\-file\-extension\fR=ext" 4
328 .IX Item "-oext=ext, --output-file-extension=ext"
329 Change the extension of the output file to be \fIext\fR instead of the
330 default \fItdy\fR (or \fIhtml\fR in case the \-\fB\-html\fR option is used).
331 See \*(L"Specifying File Extensions\*(R".
332 .IP "\fB\-opath\fR=path, \fB\-\-output\-path\fR=path" 4
333 .IX Item "-opath=path, --output-path=path"
334 When perltidy creates a filename for an output file, by default it merely
335 appends an extension to the path and basename of the input file. This
336 parameter causes the path to be changed to \fIpath\fR instead.
338 The path should end in a valid path separator character, but perltidy will try
339 to add one if it is missing.
344 \& perltidy somefile.pl \-opath=/tmp/
347 will produce \fI/tmp/somefile.pl.tdy\fR. Otherwise, \fIsomefile.pl.tdy\fR will
348 appear in whatever directory contains \fIsomefile.pl\fR.
350 If the path contains spaces, it should be placed in quotes.
352 This parameter will be ignored if output is being directed to standard output,
353 or if it is being specified explicitly with the \fB\-o=s\fR parameter.
354 .IP "\fB\-b\fR, \fB\-\-backup\-and\-modify\-in\-place\fR" 4
355 .IX Item "-b, --backup-and-modify-in-place"
356 Modify the input file or files in-place and save the original with the
357 extension \fI.bak\fR. Any existing \fI.bak\fR file will be deleted. See next item
358 for changing the default backup extension.
360 A \fB\-b\fR flag will be ignored if input is from standard input, or
361 if the \fB\-html\fR flag is set.
362 .IP "\fB\-bext\fR=ext, \fB\-\-backup\-file\-extension\fR=ext" 4
363 .IX Item "-bext=ext, --backup-file-extension=ext"
364 Change the extension of the backup file to be something other than the
365 default \fI.bak\fR. See \*(L"Specifying File Extensions\*(R".
366 .IP "\fB\-w\fR, \fB\-\-warning\-output\fR" 4
367 .IX Item "-w, --warning-output"
368 Setting \fB\-w\fR causes any non-critical warning
369 messages to be reported as errors. These include messages
370 about possible pod problems, possibly bad starting indentation level,
371 and cautions about indirect object usage. The default, \fB\-nw\fR or
372 \&\fB\-\-nowarning\-output\fR, is not to include these warnings.
373 .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
374 .IX Item "-q, --quiet"
375 Deactivate error messages and syntax checking (for running under
378 For example, if you use a vi-style editor, such as vim, you may execute
379 perltidy as a filter from within the editor using something like
382 \& :n1,n2!perltidy \-q
385 where \f(CW\*(C`n1,n2\*(C'\fR represents the selected text. Without the \fB\-q\fR flag,
386 any error message may mess up your screen, so be prepared to use your
387 \&\*(L"undo\*(R" key.
388 .IP "\fB\-log\fR, \fB\-\-logfile\fR" 4
389 .IX Item "-log, --logfile"
390 Save the \fI.LOG\fR file, which has many useful diagnostics. Perltidy always
391 creates a \fI.LOG\fR file, but by default it is deleted unless a program bug is
392 suspected. Setting the \fB\-log\fR flag forces the log file to be saved.
393 .IP "\fB\-g=n\fR, \fB\-\-logfile\-gap=n\fR" 4
394 .IX Item "-g=n, --logfile-gap=n"
395 Set maximum interval between input code lines in the logfile. This purpose of
396 this flag is to assist in debugging nesting errors. The value of \f(CW\*(C`n\*(C'\fR is
397 optional. If you set the flag \fB\-g\fR without the value of \f(CW\*(C`n\*(C'\fR, it will be
398 taken to be 1, meaning that every line will be written to the log file. This
399 can be helpful if you are looking for a brace, paren, or bracket nesting error.
401 Setting \fB\-g\fR also causes the logfile to be saved, so it is not necessary to
402 also include \fB\-log\fR.
404 If no \fB\-g\fR flag is given, a value of 50 will be used, meaning that at least
405 every 50th line will be recorded in the logfile. This helps prevent
406 excessively long log files.
408 Setting a negative value of \f(CW\*(C`n\*(C'\fR is the same as not setting \fB\-g\fR at all.
409 .IP "\fB\-npro\fR \fB\-\-noprofile\fR" 4
410 .IX Item "-npro --noprofile"
411 Ignore any \fI.perltidyrc\fR command file. Normally, perltidy looks first in
412 your current directory for a \fI.perltidyrc\fR file of parameters. (The format
413 is described below). If it finds one, it applies those options to the
414 initial default values, and then it applies any that have been defined
415 on the command line. If no \fI.perltidyrc\fR file is found, it looks for one
416 in your home directory.
418 If you set the \fB\-npro\fR flag, perltidy will not look for this file.
419 .IP "\fB\-pro=filename\fR or \fB\-\-profile=filename\fR" 4
420 .IX Item "-pro=filename or --profile=filename"
421 To simplify testing and switching .perltidyrc files, this command may be
422 used to specify a configuration file which will override the default
423 name of .perltidyrc. There must not be a space on either side of the
424 \&'=' sign. For example, the line
427 \& perltidy \-pro=testcfg
430 would cause file \fItestcfg\fR to be used instead of the
431 default \fI.perltidyrc\fR.
432 .IP "\fB\-opt\fR, \fB\-\-show\-options\fR" 4
433 .IX Item "-opt, --show-options"
434 Write a list of all options used to the \fI.LOG\fR file.
435 Please see \fB\-\-dump\-options\fR for a simpler way to do this.
436 .IP "\fB\-f\fR, \fB\-\-force\-read\-binary\fR" 4
437 .IX Item "-f, --force-read-binary"
438 Force perltidy to process binary files. To avoid producing excessive
439 error messages, perltidy skips files identified by the system as non\-text.
440 However, valid perl scripts containing binary data may sometimes be identified
441 as non\-text, and this flag forces perltidy to process them.
442 .SH "FORMATTING OPTIONS"
443 .IX Header "FORMATTING OPTIONS"
445 .IX Subsection "Basic Options"
446 .IP "\fB\-l=n\fR, \fB\-\-maximum\-line\-length=n\fR" 4
447 .IX Item "-l=n, --maximum-line-length=n"
448 The default maximum line length is n=80 characters. Perltidy will try
449 to find line break points to keep lines below this length. However, long
450 quotes and side comments may cause lines to exceed this length.
451 Setting \fB\-l=0\fR is equivalent to setting \fB\-l=(a large number)\fR.
452 .IP "\fB\-i=n\fR, \fB\-\-indent\-columns=n\fR" 4
453 .IX Item "-i=n, --indent-columns=n"
454 Use n columns per indentation level (default n=4).
457 Using tab characters will almost certainly lead to future portability
458 and maintenance problems, so the default and recommendation is not to
459 use them. For those who prefer tabs, however, there are two different
462 Except for possibly introducing tab indentation characters, as outlined
463 below, perltidy does not introduce any tab characters into your file,
464 and it removes any tabs from the code (unless requested not to do so
465 with \fB\-fws\fR). If you have any tabs in your comments, quotes, or
466 here\-documents, they will remain.
468 .IP "\fB\-et=n\fR, \fB\-\-entab\-leading\-whitespace\fR" 4
469 .IX Item "-et=n, --entab-leading-whitespace"
470 This flag causes each \fBn\fR initial space characters to be replaced by
471 one tab character. Note that the integer \fBn\fR is completely independent
472 of the integer specified for indentation parameter, \fB\-i=n\fR.
473 .IP "\fB\-t\fR, \fB\-\-tabs\fR" 4
474 .IX Item "-t, --tabs"
475 This flag causes one leading tab character to be inserted for each level
476 of indentation. Certain other features are incompatible with this
477 option, and if these options are also given, then a warning message will
478 be issued and this flag will be unset. One example is the \fB\-lp\fR
483 .IP "\fB\-syn\fR, \fB\-\-check\-syntax\fR" 4
484 .IX Item "-syn, --check-syntax"
485 This flag causes perltidy to run \f(CW\*(C`perl \-c \-T\*(C'\fR to check syntax of input
486 and output. (To change the flags passed to perl, see the next
487 item, \fB\-pscf\fR). The results are written to the \fI.LOG\fR file, which
488 will be saved if an error is detected in the output script. The output
489 script is not checked if the input script has a syntax error. Perltidy
490 does its own checking, but this option employs perl to get a \*(L"second
493 If perl reports errors in the input file, they will not be reported in
494 the error output unless the \fB\-\-warning\-output\fR flag is given.
496 The default is \fBnot\fR to do this type of syntax checking (although
497 perltidy will still do as much self-checking as possible). The reason
498 is that it causes all code in \s-1BEGIN\s0 blocks to be executed, for all
499 modules being used, and this opens the door to security issues and
500 infinite loops when running perltidy.
501 .IP "\fB\-pscf=s\fR, \fB\-perl\-syntax\-check\-flags=s\fR" 4
502 .IX Item "-pscf=s, -perl-syntax-check-flags=s"
503 When perl is invoked to check syntax, the normal flags are \f(CW\*(C`\-c \-T\*(C'\fR. In
504 addition, if the \fB\-x\fR flag is given to perltidy, then perl will also be
505 passed a \fB\-x\fR flag. It should not normally be necessary to change
506 these flags, but it can be done with the \fB\-pscf=s\fR flag. For example,
507 if the taint flag, \f(CW\*(C`\-T\*(C'\fR, is not wanted, the flag could be set to be just
510 Perltidy will pass your string to perl with the exception that it will
511 add a \fB\-c\fR and \fB\-x\fR if appropriate. The \fI.LOG\fR file will show
512 exactly what flags were passed to perl.
513 .IP "\fB\-io\fR, \fB\-\-indent\-only\fR" 4
514 .IX Item "-io, --indent-only"
515 This flag is used to deactivate all formatting and line break changes.
516 When it is in effect, the only change to the script will be indentation.
517 And any flags controlling whitespace and newlines will be ignored. You
518 might want to use this if you are perfectly happy with your whitespace
519 and line breaks, and merely want perltidy to handle the indentation.
520 (This also speeds up perltidy by well over a factor of two, so it might be
521 useful when perltidy is merely being used to help find a brace error in
524 Setting this flag is equivalent to setting \fB\-\-freeze\-newlines\fR and
525 \&\fB\-\-freeze\-whitespace\fR.
526 .IP "\fB\-ole=s\fR, \fB\-\-output\-line\-ending=s\fR" 4
527 .IX Item "-ole=s, --output-line-ending=s"
528 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
529 to output line endings for a specific system. Normally,
530 perltidy writes files with the line separator character of the host
531 system. The \f(CW\*(C`win\*(C'\fR and \f(CW\*(C`dos\*(C'\fR flags have an identical result.
532 .IP "\fB\-ple\fR, \fB\-\-preserve\-line\-endings\fR" 4
533 .IX Item "-ple, --preserve-line-endings"
534 This flag tells perltidy to write its output files with the same line
535 endings as the input file, if possible. It should work for
536 \&\fBdos\fR, \fBunix\fR, and \fBmac\fR line endings. It will only work if perltidy
537 input comes from a filename (rather than stdin, for example). If
538 perltidy has trouble determining the input file line ending, it will
539 revert to the default behavior of using the line ending of the host system.
540 .Sh "Code Indentation Control"
541 .IX Subsection "Code Indentation Control"
542 .IP "\fB\-ci=n\fR, \fB\-\-continuation\-indentation=n\fR" 4
543 .IX Item "-ci=n, --continuation-indentation=n"
544 Continuation indentation is extra indentation spaces applied when
545 a long line is broken. The default is n=2, illustrated here:
548 \& my $level = # \-ci=2
549 \& ( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level;
552 The same example, with n=0, is a little harder to read:
555 \& my $level = # \-ci=0
556 \& ( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level;
559 The value given to \fB\-ci\fR is also used by some commands when a small
560 space is required. Examples are commands for outdenting labels,
561 \&\fB\-ola\fR, and control keywords, \fB\-okw\fR.
563 When default values are not used, it is suggested that the value \fBn\fR
564 given with \fB\-ci=n\fR be no more than about one-half of the number of
565 spaces assigned to a full indentation level on the \fB\-i=n\fR command.
566 .IP "\fB\-sil=n\fR \fB\-\-starting\-indentation\-level=n\fR" 4
567 .IX Item "-sil=n --starting-indentation-level=n"
568 By default, perltidy examines the input file and tries to determine the
569 starting indentation level. While it is often zero, it may not be
570 zero for a code snippet being sent from an editing session. If the
571 default method does not work correctly, or you want to change the
572 starting level, use \fB\-sil=n\fR, to force the starting level to be n.
573 .IP "List indentation using \fB\-lp\fR, \fB\-\-line\-up\-parentheses\fR" 4
574 .IX Item "List indentation using -lp, --line-up-parentheses"
575 By default, perltidy indents lists with 4 spaces, or whatever value
576 is specified with \fB\-i=n\fR. Here is a small list formatted in this way:
579 \& # perltidy (default)
580 \& @month_of_year = (
581 \& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
582 \& 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
586 Use the \fB\-lp\fR flag to add extra indentation to cause the data to begin
587 past the opening parentheses of a sub call or list, or opening square
588 bracket of an anonymous array, or opening curly brace of an anonymous
589 hash. With this option, the above list would become:
593 \& @month_of_year = (
594 \& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
595 \& 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
599 If the available line length (see \fB\-l=n\fR ) does not permit this much
600 space, perltidy will use less. For alternate placement of the
601 closing paren, see the next section.
603 This option has no effect on code \s-1BLOCKS\s0, such as if/then/else blocks,
604 which always use whatever is specified with \fB\-i=n\fR. Also, the
605 existence of line breaks and/or block comments between the opening and
606 closing parens may cause perltidy to temporarily revert to its default
609 Note: The \fB\-lp\fR option may not be used together with the \fB\-t\fR tabs option.
610 It may, however, be used with the \fB\-et=n\fR tab method.
612 In addition, any parameter which significantly restricts the ability of
613 perltidy to choose newlines will conflict with \fB\-lp\fR and will cause
614 \&\fB\-lp\fR to be deactivated. These include \fB\-io\fR, \fB\-fnl\fR, \fB\-nanl\fR, and
615 \&\fB\-ndnl\fR. The reason is that the \fB\-lp\fR indentation style can require
616 the careful coordination of an arbitrary number of break points in
617 hierarchical lists, and these flags may prevent that.
618 .IP "\fB\-cti=n\fR, \fB\-\-closing\-token\-indentation\fR" 4
619 .IX Item "-cti=n, --closing-token-indentation"
620 The \fB\-cti=n\fR flag controls the indentation of a line beginning with
621 a \f(CW\*(C`)\*(C'\fR, \f(CW\*(C`]\*(C'\fR, or a non-block \f(CW\*(C`}\*(C'\fR. Such a line receives:
624 \& \-cti = 0 no extra indentation (default)
625 \& \-cti = 1 extra indentation such that the closing token
626 \& aligns with its opening token.
627 \& \-cti = 2 one extra indentation level if the line looks like:
629 \& \-cti = 3 one extra indentation level always
632 The flags \fB\-cti=1\fR and \fB\-cti=2\fR work well with the \fB\-lp\fR flag (previous
636 \& # perltidy \-lp \-cti=1
637 \& @month_of_year = (
638 \& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
639 \& 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
644 \& # perltidy \-lp \-cti=2
645 \& @month_of_year = (
646 \& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
647 \& 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
651 These flags are merely hints to the formatter and they may not always be
652 followed. In particular, if \-lp is not being used, the indentation for
653 \&\fBcti=1\fR is constrained to be no more than one indentation level.
655 If desired, this control can be applied independently to each of the
656 closing container token types. In fact, \fB\-cti=n\fR is merely an
657 abbreviation for \fB\-cpi=n \-csbi=n \-cbi=n\fR, where:
658 \&\fB\-cpi\fR or \fB\-\-closing\-paren\-indentation\fR controls \fB)\fR's,
659 \&\fB\-csbi\fR or \fB\-\-closing\-square\-bracket\-indentation\fR controls \fB]\fR's,
660 \&\fB\-cbi\fR or \fB\-\-closing\-brace\-indentation\fR controls non-block \fB}\fR's.
661 .IP "\fB\-icp\fR, \fB\-\-indent\-closing\-paren\fR" 4
662 .IX Item "-icp, --indent-closing-paren"
663 The \fB\-icp\fR flag is equivalent to
664 \&\fB\-cti=2\fR, described in the previous section. The \fB\-nicp\fR flag is
665 equivalent \fB\-cti=0\fR. They are included for backwards compatability.
666 .IP "\fB\-icb\fR, \fB\-\-indent\-closing\-brace\fR" 4
667 .IX Item "-icb, --indent-closing-brace"
668 The \fB\-icb\fR option gives one extra level of indentation to a brace which
669 terminates a code block . For example,
680 The default is not to do this, indicated by \fB\-nicb\fR.
681 .IP "\fB\-olq\fR, \fB\-\-outdent\-long\-quotes\fR" 4
682 .IX Item "-olq, --outdent-long-quotes"
683 When \fB\-olq\fR is set, lines which is a quoted string longer than the
684 value \fBmaximum-line-length\fR will have their indentation removed to make
685 them more readable. This is the default. To prevent such out\-denting,
686 use \fB\-nolq\fR or \fB\-\-nooutdent\-long\-lines\fR.
687 .IP "\fB\-oll\fR, \fB\-\-outdent\-long\-lines\fR" 4
688 .IX Item "-oll, --outdent-long-lines"
689 This command is equivalent to \fB\-\-outdent\-long\-quotes\fR and
690 \&\fB\-\-outdent\-long\-comments\fR, and it is included for compatibility with previous
691 versions of perltidy. The negation of this also works, \fB\-noll\fR or
692 \&\fB\-\-nooutdent\-long\-lines\fR, and is equivalent to setting \fB\-nolq\fR and \fB\-nolc\fR.
693 .IP "Outdenting Labels: \fB\-ola\fR, \fB\-\-outdent\-labels\fR" 4
694 .IX Item "Outdenting Labels: -ola, --outdent-labels"
695 This command will cause labels to be outdented by 2 spaces (or whatever \fB\-ci\fR
696 has been set to), if possible. This is the default. For example:
700 \& LOOP: while ( $i = <FOTOS> ) {
707 Use \fB\-nola\fR to not outdent labels.
708 .IP "Outdenting Keywords" 4
709 .IX Item "Outdenting Keywords"
712 .IP "\fB\-okw\fR, \fB\-\-outdent\-keywords\fR" 4
713 .IX Item "-okw, --outdent-keywords"
715 The command \fB\-okw\fR will will cause certain leading control keywords to
716 be outdented by 2 spaces (or whatever \fB\-ci\fR has been set to), if
717 possible. By default, these keywords are \f(CW\*(C`redo\*(C'\fR, \f(CW\*(C`next\*(C'\fR, \f(CW\*(C`last\*(C'\fR,
718 \&\f(CW\*(C`goto\*(C'\fR, and \f(CW\*(C`return\*(C'\fR. The intention is to make these control keywords
719 easier to see. To change this list of keywords being outdented, see
722 For example, using \f(CW\*(C`perltidy \-okw\*(C'\fR on the previous example gives:
726 \& LOOP: while ( $i = <FOTOS> ) {
733 The default is not to do this.
734 .IP "Specifying Outdented Keywords: \fB\-okwl=string\fR, \fB\-\-outdent\-keyword\-list=string\fR" 4
735 .IX Item "Specifying Outdented Keywords: -okwl=string, --outdent-keyword-list=string"
736 This command can be used to change the keywords which are outdented with
737 the \fB\-okw\fR command. The parameter \fBstring\fR is a required list of perl
738 keywords, which should be placed in quotes if there are more than one.
739 By itself, it does not cause any outdenting to occur, so the \fB\-okw\fR
740 command is still required.
742 For example, the commands \f(CW\*(C`\-okwl="next last redo goto" \-okw\*(C'\fR will cause
743 those four keywords to be outdented. It is probably simplest to place
744 any \fB\-okwl\fR command in a \fI.perltidyrc\fR file.
748 .Sh "Whitespace Control"
749 .IX Subsection "Whitespace Control"
750 Whitespace refers to the blank space between variables, operators,
751 and other code tokens.
752 .IP "\fB\-fws\fR, \fB\-\-freeze\-whitespace\fR" 4
753 .IX Item "-fws, --freeze-whitespace"
754 This flag causes your original whitespace to remain unchanged, and
755 causes the rest of the whitespace commands in this section, the
756 Code Indentation section, and
757 the Comment Control section to be ignored.
758 .IP "Tightness of curly braces, parentheses, and square brackets." 4
759 .IX Item "Tightness of curly braces, parentheses, and square brackets."
760 Here the term \*(L"tightness\*(R" will mean the closeness with which
761 pairs of enclosing tokens, such as parentheses, contain the quantities
762 within. A numerical value of 0, 1, or 2 defines the tightness, with
763 0 being least tight and 2 being most tight. Spaces within containers
764 are always symmetric, so if there is a space after a \f(CW\*(C`(\*(C'\fR then there
765 will be a space before the corresponding \f(CW\*(C`)\*(C'\fR.
767 The \fB\-pt=n\fR or \fB\-\-paren\-tightness=n\fR parameter controls the space within
768 parens. The example below shows the effect of the three possible
772 \& if ( ( my $len_tab = length( $tabstr ) ) > 0 ) { # \-pt=0
773 \& if ( ( my $len_tab = length($tabstr) ) > 0 ) { # \-pt=1 (default)
774 \& if ((my $len_tab = length($tabstr)) > 0) { # \-pt=2
777 When n is 0, there is always a space to the right of a '(' and to the left
778 of a ')'. For n=2 there is never a space. For n=1, the default, there
779 is a space unless the quantity within the parens is a single token, such
780 as an identifier or quoted string.
782 Likewise, the parameter \fB\-sbt=n\fR or \fB\-\-square\-bracket\-tightness=n\fR
783 controls the space within square brackets, as illustrated below.
786 \& $width = $col[ $j + $k ] \- $col[ $j ]; # \-sbt=0
787 \& $width = $col[ $j + $k ] \- $col[$j]; # \-sbt=1 (default)
788 \& $width = $col[$j + $k] \- $col[$j]; # \-sbt=2
791 Curly braces which do not contain code blocks are controlled by
792 the parameter \fB\-bt=n\fR or \fB\-\-brace\-tightness=n\fR.
795 \& $obj\->{ $parsed_sql\->{ 'table' }[0] }; # \-bt=0
796 \& $obj\->{ $parsed_sql\->{'table'}[0] }; # \-bt=1 (default)
797 \& $obj\->{$parsed_sql\->{'table'}[0]}; # \-bt=2
800 And finally, curly braces which contain blocks of code are controlled by the
801 parameter \fB\-bbt=n\fR or \fB\-\-block\-brace\-tightness=n\fR as illustrated in the
805 \& %bf = map { $_ => \-M $_ } grep { /\e.deb$/ } dirents '.'; # \-bbt=0 (default)
806 \& %bf = map { $_ => \-M $_ } grep {/\e.deb$/} dirents '.'; # \-bbt=1
807 \& %bf = map {$_ => \-M $_} grep {/\e.deb$/} dirents '.'; # \-bbt=2
809 .IP "\fB\-sts\fR, \fB\-\-space\-terminal\-semicolon\fR" 4
810 .IX Item "-sts, --space-terminal-semicolon"
811 Some programmers prefer a space before all terminal semicolons. The
812 default is for no such space, and is indicated with \fB\-nsts\fR or
813 \&\fB\-\-nospace\-terminal\-semicolon\fR.
817 \& $i = 1; # \-nsts (default)
819 .IP "\fB\-sfs\fR, \fB\-\-space\-for\-semicolon\fR" 4
820 .IX Item "-sfs, --space-for-semicolon"
821 Semicolons within \fBfor\fR loops may sometimes be hard to see,
822 particularly when commas are also present. This option places spaces on
823 both sides of these special semicolons, and is the default. Use
824 \&\fB\-nsfs\fR or \fB\-\-nospace\-for\-semicolon\fR to deactivate it.
827 \& for ( @a = @$ap, $u = shift @a ; @a ; $u = $v ) { # \-sfs (default)
828 \& for ( @a = @$ap, $u = shift @a; @a; $u = $v ) { # \-nsfs
830 .IP "\fB\-asc\fR, \fB\-\-add\-semicolons\fR" 4
831 .IX Item "-asc, --add-semicolons"
832 Setting \fB\-asc\fR allows perltidy to add any missing optional semicolon at the end
833 of a line which is followed by a closing curly brace on the next line. This
834 is the default, and may be deactivated with \fB\-nasc\fR or \fB\-\-noadd\-semicolons\fR.
835 .IP "\fB\-dsm\fR, \fB\-\-delete\-semicolons\fR" 4
836 .IX Item "-dsm, --delete-semicolons"
837 Setting \fB\-dsm\fR allows perltidy to delete extra semicolons which are
838 simply empty statements. This is the default, and may be deactivated
839 with \fB\-ndsm\fR or \fB\-\-nodelete\-semicolons\fR. (Such semicolons are not
840 deleted, however, if they would promote a side comment to a block
842 .IP "\fB\-aws\fR, \fB\-\-add\-whitespace\fR" 4
843 .IX Item "-aws, --add-whitespace"
844 Setting this option allows perltidy to add certain whitespace improve
845 code readability. This is the default. If you do not want any
846 whitespace added, but are willing to have some whitespace deleted, use
847 \&\fB\-naws\fR. (Use \fB\-fws\fR to leave whitespace completely unchanged).
848 .IP "\fB\-dws\fR, \fB\-\-delete\-old\-whitespace\fR" 4
849 .IX Item "-dws, --delete-old-whitespace"
850 Setting this option allows perltidy to remove some old whitespace
851 between characters, if necessary. This is the default. If you
852 do not want any old whitespace removed, use \fB\-ndws\fR or
853 \&\fB\-\-nodelete\-old\-whitespace\fR.
854 .IP "Detailed whitespace controls around tokens" 4
855 .IX Item "Detailed whitespace controls around tokens"
856 For those who want more detailed control over the whitespace around
857 tokens, there are four parameters which can directly modify the default
858 whitespace rules built into perltidy for any token. They are:
860 \&\fB\-wls=s\fR or \fB\-\-want\-left\-space=s\fR,
862 \&\fB\-nwls=s\fR or \fB\-\-nowant\-left\-space=s\fR,
864 \&\fB\-wrs=s\fR or \fB\-\-want\-right\-space=s\fR,
866 \&\fB\-nwrs=s\fR or \fB\-\-nowant\-right\-space=s\fR.
868 These parameters are each followed by a quoted string, \fBs\fR, containing a
869 list of token types. No more than one of each of these parameters
870 should be specified, because repeating a command-line parameter
871 always overwrites the previous one before perltidy ever sees it.
873 To illustrate how these are used, suppose it is desired that there be no
874 space on either side of the token types \fB= + \- / *\fR. The following two
875 parameters would specify this desire:
878 \& \-nwls="= + \- / *" \-nwrs="= + \- / *"
881 (Note that the token types are in quotes, and that they are separated by
882 spaces). With these modified whitespace rules, the following line of math:
885 \& $root = \-$b + sqrt( $b * $b \- 4. * $a * $c ) / ( 2. * $a );
891 \& $root=\-$b+sqrt( $b*$b\-4.*$a*$c )/( 2.*$a );
894 These parameters should be considered to be hints to perltidy rather
895 than fixed rules, because perltidy must try to resolve conflicts that
896 arise between them and all of the other rules that it uses. One
897 conflict that can arise is if, between two tokens, the left token wants
898 a space and the right one doesn't. In this case, the token not wanting
899 a space takes priority.
901 It is necessary to have a list of all token types in order to create
902 this type of input. Such a list can be obtained by the command
903 \&\fB\-\-dump\-token\-types\fR. Also try the \fB\-D\fR flag on a short snippet of code
904 and look at the .DEBUG file to see the tokenization.
906 \&\fB\s-1WARNING\s0\fR Be sure to put these tokens in quotes to avoid having them
907 misinterpreted by your command shell.
908 .IP "Space between specific keywords and opening paren" 4
909 .IX Item "Space between specific keywords and opening paren"
910 When an opening paren follows a Perl keyword, no space is introduced after the
911 keyword, unless it is (by default) one of these:
914 \& my local our and or eq ne if else elsif until unless
915 \& while for foreach return switch case given when
918 These defaults can be modified with two commands:
920 \&\fB\-sak=s\fR or \fB\-\-space\-after\-keyword=s\fR adds keywords.
922 \&\fB\-nsak=s\fR or \fB\-\-nospace\-after\-keyword=s\fR removes keywords.
924 where \fBs\fR is a list of keywords (in quotes if necessary). For example,
927 \& my ( $a, $b, $c ) = @_; # default
928 \& my( $a, $b, $c ) = @_; # \-nsak="my local our"
931 To put a space after all keywords, see the next item.
932 .IP "Space between all keywords and opening parens" 4
933 .IX Item "Space between all keywords and opening parens"
934 When an opening paren follows a function or keyword, no space is introduced
935 after the keyword except for the keywords noted in the previous item. To
936 always put a space between a function or keyword and its opening paren,
939 \&\fB\-skp\fR or \fB\-\-space\-keyword\-paren\fR
941 You will probably also want to use the flag \fB\-sfp\fR (next item) too.
942 .IP "Space between all function names and opening parens" 4
943 .IX Item "Space between all function names and opening parens"
944 When an opening paren follows a function the default is not to introduce
945 a space. To cause a space to be introduced use:
947 \&\fB\-sfp\fR or \fB\-\-space\-function\-paren\fR
950 \& myfunc( $a, $b, $c ); # default
951 \& myfunc ( $a, $b, $c ); # \-sfp
954 You will probably also want to use the flag \fB\-skp\fR (previous item) too.
955 .ie n .IP "Trimming whitespace around ""qw"" quotes" 4
956 .el .IP "Trimming whitespace around \f(CWqw\fR quotes" 4
957 .IX Item "Trimming whitespace around qw quotes"
958 \&\fB\-tqw\fR or \fB\-\-trim\-qw\fR provide the default behavior of trimming
959 spaces around multi-line \f(CW\*(C`qw\*(C'\fR quotes and indenting them appropriately.
961 \&\fB\-ntqw\fR or \fB\-\-notrim\-qw\fR cause leading and trailing whitespace around
962 multi-line \f(CW\*(C`qw\*(C'\fR quotes to be left unchanged. This option will not
963 normally be necessary, but was added for testing purposes, because in
964 some versions of perl, trimming \f(CW\*(C`qw\*(C'\fR quotes changes the syntax tree.
965 .Sh "Comment Controls"
966 .IX Subsection "Comment Controls"
967 Perltidy has a number of ways to control the appearance of both block comments
968 and side comments. The term \fBblock comment\fR here refers to a full-line
969 comment, whereas \fBside comment\fR will refer to a comment which appears on a
970 line to the right of some code.
971 .IP "\fB\-ibc\fR, \fB\-\-indent\-block\-comments\fR" 4
972 .IX Item "-ibc, --indent-block-comments"
973 Block comments normally look best when they are indented to the same
974 level as the code which follows them. This is the default behavior, but
975 you may use \fB\-nibc\fR to keep block comments left\-justified. Here is an
979 \& # this comment is indented (\-ibc, default)
980 \& if ($task) { yyy(); }
983 The alternative is \fB\-nibc\fR:
986 \& # this comment is not indented (\-nibc)
987 \& if ($task) { yyy(); }
990 See also the next item, \fB\-isbc\fR, as well as \fB\-sbc\fR, for other ways to
991 have some indented and some outdented block comments.
992 .IP "\fB\-isbc\fR, \fB\-\-indent\-spaced\-block\-comments\fR" 4
993 .IX Item "-isbc, --indent-spaced-block-comments"
994 If there is no leading space on the line, then the comment will not be
995 indented, and otherwise it may be.
997 If both \fB\-ibc\fR and \fB\-isbc\fR are set, then \fB\-isbc\fR takes priority.
998 .IP "\fB\-olc\fR, \fB\-\-outdent\-long\-comments\fR" 4
999 .IX Item "-olc, --outdent-long-comments"
1000 When \fB\-olc\fR is set, lines which are full-line (block) comments longer
1001 than the value \fBmaximum-line-length\fR will have their indentation
1002 removed. This is the default; use \fB\-nolc\fR to prevent outdenting.
1003 .IP "\fB\-msc=n\fR, \fB\-\-minimum\-space\-to\-comment=n\fR" 4
1004 .IX Item "-msc=n, --minimum-space-to-comment=n"
1005 Side comments look best when lined up several spaces to the right of
1006 code. Perltidy will try to keep comments at least n spaces to the
1007 right. The default is n=4 spaces.
1008 .IP "\fB\-hsc\fR, \fB\-\-hanging\-side\-comments\fR" 4
1009 .IX Item "-hsc, --hanging-side-comments"
1010 By default, perltidy tries to identify and align \*(L"hanging side
1011 comments\*(R", which are something like this:
1014 \& my $IGNORE = 0; # This is a side comment
1015 \& # This is a hanging side comment
1019 A comment is considered to be a hanging side comment if (1) it immediately
1020 follows a line with a side comment, or another hanging side comment, and
1021 (2) there is some leading whitespace on the line.
1022 To deactivate this feature, use \fB\-nhsc\fR or \fB\-\-nohanging\-side\-comments\fR.
1023 If block comments are preceded by a blank line, or have no leading
1024 whitespace, they will not be mistaken as hanging side comments.
1025 .IP "Closing Side Comments" 4
1026 .IX Item "Closing Side Comments"
1027 A closing side comment is a special comment which perltidy can
1028 automatically create and place after the closing brace of a code block.
1029 They can be useful for code maintenance and debugging. The command
1030 \&\fB\-csc\fR (or \fB\-\-closing\-side\-comments\fR) adds or updates closing side
1031 comments. For example, here is a small code snippet
1035 \& if ( !defined( $_[0] ) ) {
1036 \& print("Hello, World\en");
1039 \& print( $_[0], "\en" );
1044 And here is the result of processing with \f(CW\*(C`perltidy \-csc\*(C'\fR:
1048 \& if ( !defined( $_[0] ) ) {
1049 \& print("Hello, World\en");
1052 \& print( $_[0], "\en" );
1054 \& } ## end sub message
1057 A closing side comment was added for \f(CW\*(C`sub message\*(C'\fR in this case, but not
1058 for the \f(CW\*(C`if\*(C'\fR and \f(CW\*(C`else\*(C'\fR blocks, because they were below the 6 line
1059 cutoff limit for adding closing side comments. This limit may be
1060 changed with the \fB\-csci\fR command, described below.
1062 The command \fB\-dcsc\fR (or \fB\-\-delete\-closing\-side\-comments\fR) reverses this
1063 process and removes these comments.
1065 Several commands are available to modify the behavior of these two basic
1066 commands, \fB\-csc\fR and \fB\-dcsc\fR:
1068 .IP "\fB\-csci=n\fR, or \fB\-\-closing\-side\-comment\-interval=n\fR" 4
1069 .IX Item "-csci=n, or --closing-side-comment-interval=n"
1070 where \f(CW\*(C`n\*(C'\fR is the minimum number of lines that a block must have in
1071 order for a closing side comment to be added. The default value is
1072 \&\f(CW\*(C`n=6\*(C'\fR. To illustrate:
1075 \& # perltidy \-csci=2 \-csc
1077 \& if ( !defined( $_[0] ) ) {
1078 \& print("Hello, World\en");
1079 \& } ## end if ( !defined( $_[0] ))
1081 \& print( $_[0], "\en" );
1082 \& } ## end else [ if ( !defined( $_[0] ))
1083 \& } ## end sub message
1086 Now the \f(CW\*(C`if\*(C'\fR and \f(CW\*(C`else\*(C'\fR blocks are commented. However, now this has
1087 become very cluttered.
1088 .IP "\fB\-cscp=string\fR, or \fB\-\-closing\-side\-comment\-prefix=string\fR" 4
1089 .IX Item "-cscp=string, or --closing-side-comment-prefix=string"
1090 where string is the prefix used before the name of the block type. The
1091 default prefix, shown above, is \f(CW\*(C`## end\*(C'\fR. This string will be added to
1092 closing side comments, and it will also be used to recognize them in
1093 order to update, delete, and format them. Any comment identified as a
1094 closing side comment will be placed just a single space to the right of
1096 .IP "\fB\-cscl=string\fR, or \fB\-\-closing\-side\-comment\-list\-string\fR" 4
1097 .IX Item "-cscl=string, or --closing-side-comment-list-string"
1098 where \f(CW\*(C`string\*(C'\fR is a list of block types to be tagged with closing side
1099 comments. By default, all code block types preceded by a keyword or
1100 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
1101 command changes the default list to be any selected block types; see
1102 \&\*(L"Specifying Block Types\*(R".
1103 For example, the following command
1104 requests that only \f(CW\*(C`sub\*(C'\fR's, labels, \f(CW\*(C`BEGIN\*(C'\fR, and \f(CW\*(C`END\*(C'\fR blocks be
1105 affected by any \fB\-csc\fR or \fB\-dcsc\fR operation:
1108 \& \-cscl="sub : BEGIN END"
1110 .IP "\fB\-csct=n\fR, or \fB\-\-closing\-side\-comment\-maximum\-text=n\fR" 4
1111 .IX Item "-csct=n, or --closing-side-comment-maximum-text=n"
1112 The text appended to certain block types, such as an \f(CW\*(C`if\*(C'\fR block, is
1113 whatever lies between the keyword introducing the block, such as \f(CW\*(C`if\*(C'\fR,
1114 and the opening brace. Since this might be too much text for a side
1115 comment, there needs to be a limit, and that is the purpose of this
1116 parameter. The default value is \f(CW\*(C`n=20\*(C'\fR, meaning that no additional
1117 tokens will be appended to this text after its length reaches 20
1118 characters. Omitted text is indicated with \f(CW\*(C`...\*(C'\fR. (Tokens, including
1119 sub names, are never truncated, however, so actual lengths may exceed
1120 this). To illustrate, in the above example, the appended text of the
1121 first block is \f(CW\*(C` ( !defined( $_[0] )...\*(C'\fR. The existing limit of
1122 \&\f(CW\*(C`n=20\*(C'\fR caused this text to be truncated, as indicated by the \f(CW\*(C`...\*(C'\fR.
1123 .IP "\fB\-csce=n\fR, or \fB\-\-closing\-side\-comment\-else\-flag=n\fR" 4
1124 .IX Item "-csce=n, or --closing-side-comment-else-flag=n"
1125 The default, \fBn=0\fR, places the text of the opening \f(CW\*(C`if\*(C'\fR statement after any
1126 terminal \f(CW\*(C`else\*(C'\fR.
1128 If \fBn=2\fR is used, then each \f(CW\*(C`elsif\*(C'\fR is also given the text of the opening
1129 \&\f(CW\*(C`if\*(C'\fR statement. Also, an \f(CW\*(C`else\*(C'\fR will include the text of a preceding
1130 \&\f(CW\*(C`elsif\*(C'\fR statement. Note that this may result some long closing
1133 If \fBn=1\fR is used, the results will be the same as \fBn=2\fR whenever the
1134 resulting line length is less than the maximum allowed.
1135 .IP "\fB\-cscw\fR, or \fB\-\-closing\-side\-comment\-warnings\fR" 4
1136 .IX Item "-cscw, or --closing-side-comment-warnings"
1137 This parameter is intended to help make the initial transition to the use of
1138 closing side comments.
1140 things to happen if a closing side comment replaces an existing, different
1141 closing side comment: first, an error message will be issued, and second, the
1142 original side comment will be placed alone on a new specially marked comment
1143 line for later attention.
1145 The intent is to avoid clobbering existing hand-written side comments
1146 which happen to match the pattern of closing side comments. This flag
1147 should only be needed on the first run with \fB\-csc\fR.
1151 \&\fBImportant Notes on Closing Side Comments:\fR
1153 Closing side comments are only placed on lines terminated with a closing
1154 brace. Certain closing styles, such as the use of cuddled elses
1155 (\fB\-ce\fR), preclude the generation of some closing side comments.
1157 Please note that adding or deleting of closing side comments takes
1158 place only through the commands \fB\-csc\fR or \fB\-dcsc\fR. The other commands,
1159 if used, merely modify the behavior of these two commands.
1161 It is recommended that the \fB\-cscw\fR flag be used along with \fB\-csc\fR on
1162 the first use of perltidy on a given file. This will prevent loss of
1163 any existing side comment data which happens to have the csc prefix.
1165 Once you use \fB\-csc\fR, you should continue to use it so that any
1166 closing side comments remain correct as code changes. Otherwise, these
1167 comments will become incorrect as the code is updated.
1169 If you edit the closing side comments generated by perltidy, you must also
1170 change the prefix to be different from the closing side comment prefix.
1171 Otherwise, your edits will be lost when you rerun perltidy with \fB\-csc\fR. For
1172 example, you could simply change \f(CW\*(C`## end\*(C'\fR to be \f(CW\*(C`## End\*(C'\fR, since the test is
1173 case sensitive. You may also want to use the \fB\-ssc\fR flag to keep these
1174 modified closing side comments spaced the same as actual closing side comments.
1176 Temporarily generating closing side comments is a useful technique for
1177 exploring and/or debugging a perl script, especially one written by someone
1178 else. You can always remove them with \fB\-dcsc\fR.
1182 .IP "Static Block Comments" 4
1183 .IX Item "Static Block Comments"
1184 Static block comments are block comments with a special leading pattern,
1185 \&\f(CW\*(C`##\*(C'\fR by default, which will be treated slightly differently from other
1186 block comments. They effectively behave as if they had glue along their
1187 left and top edges, because they stick to the left edge and previous line
1188 when there is no blank spaces in those places. This option is
1189 particularly useful for controlling how commented code is displayed.
1191 .IP "\fB\-sbc\fR, \fB\-\-static\-block\-comments\fR" 4
1192 .IX Item "-sbc, --static-block-comments"
1193 When \fB\-sbc\fR is used, a block comment with a special leading pattern, \f(CW\*(C`##\*(C'\fR by
1194 default, will be treated specially.
1196 Comments so identified are treated as follows:
1199 If there is no leading space on the line, then the comment will not
1200 be indented, and otherwise it may be,
1202 no new blank line will be
1203 inserted before such a comment, and
1205 such a comment will never become
1206 a hanging side comment.
1210 For example, assuming \f(CW@month_of_year\fR is
1214 \& @month_of_year = ( # \-sbc (default)
1215 \& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
1220 Without this convention, the above code would become
1223 \& @month_of_year = ( # \-nsbc
1224 \& 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
1233 which is not as clear.
1234 The default is to use \fB\-sbc\fR. This may be deactivated with \fB\-nsbc\fR.
1236 .IP "\fB\-sbcp=string\fR, \fB\-\-static\-block\-comment\-prefix=string\fR" 4
1237 .IX Item "-sbcp=string, --static-block-comment-prefix=string"
1238 This parameter defines the prefix used to identify static block comments
1239 when the \fB\-sbc\fR parameter is set. The default prefix is \f(CW\*(C`##\*(C'\fR,
1240 corresponding to \f(CW\*(C`\-sbcp=##\*(C'\fR. The prefix is actually part of a perl
1241 pattern used to match lines and it must either begin with \f(CW\*(C`#\*(C'\fR or \f(CW\*(C`^#\*(C'\fR.
1242 In the first case a prefix ^\es* will be added to match any leading
1243 whitespace, while in the second case the pattern will match only
1244 comments with no leading whitespace. For example, to
1245 identify all comments as static block comments, one would use \f(CW\*(C`\-sbcp=#\*(C'\fR.
1246 To identify all left-adjusted comments as static block comments, use \f(CW\*(C`\-sbcp='^#'\*(C'\fR.
1248 Please note that \fB\-sbcp\fR merely defines the pattern used to identify static
1249 block comments; it will not be used unless the switch \fB\-sbc\fR is set. Also,
1250 please be aware that since this string is used in a perl regular expression
1251 which identifies these comments, it must enable a valid regular expression to
1253 .IP "\fB\-osbc\fR, \fB\-\-outdent\-static\-block\-comments\fR" 4
1254 .IX Item "-osbc, --outdent-static-block-comments"
1255 The command \fB\-osbc\fR will will cause static block comments to be outdented by 2
1256 spaces (or whatever \fB\-ci=n\fR has been set to), if possible.
1260 .IP "Static Side Comments" 4
1261 .IX Item "Static Side Comments"
1262 Static side comments are side comments with a special leading pattern.
1263 This option can be useful for controlling how commented code is displayed
1264 when it is a side comment.
1266 .IP "\fB\-ssc\fR, \fB\-\-static\-side\-comments\fR" 4
1267 .IX Item "-ssc, --static-side-comments"
1268 When \fB\-ssc\fR is used, a side comment with a static leading pattern, which is
1269 \&\f(CW\*(C`##\*(C'\fR by default, will be be spaced only a single space from previous
1270 character, and it will not be vertically aligned with other side comments.
1272 The default is \fB\-nssc\fR.
1273 .IP "\fB\-sscp=string\fR, \fB\-\-static\-side\-comment\-prefix=string\fR" 4
1274 .IX Item "-sscp=string, --static-side-comment-prefix=string"
1275 This parameter defines the prefix used to identify static side comments
1276 when the \fB\-ssc\fR parameter is set. The default prefix is \f(CW\*(C`##\*(C'\fR,
1277 corresponding to \f(CW\*(C`\-sscp=##\*(C'\fR.
1279 Please note that \fB\-sscp\fR merely defines the pattern used to identify
1280 static side comments; it will not be used unless the switch \fB\-ssc\fR is
1281 set. Also, note that this string is used in a perl regular expression
1282 which identifies these comments, so it must enable a valid regular
1283 expression to be formed.
1287 .Sh "Skipping Selected Sections of Code"
1288 .IX Subsection "Skipping Selected Sections of Code"
1289 Selected lines of code may be passed verbatim to the output without any
1290 formatting. This feature is enabled by default but can be disabled with
1291 the \fB\-\-noformat\-skipping\fR or \fB\-nfs\fR flag. It should be used sparingly to
1292 avoid littering code with markers, but it might be helpful for working
1293 around occasional problems. For example it might be useful for keeping
1294 the indentation of old commented code unchanged, keeping indentation of
1295 long blocks of aligned comments unchanged, keeping certain list
1296 formatting unchanged, or working around a glitch in perltidy.
1297 .IP "\fB\-fs\fR, \fB\-\-format\-skipping\fR" 4
1298 .IX Item "-fs, --format-skipping"
1299 This flag, which is enabled by default, causes any code between
1300 special beginning and ending comment markers to be passed to the
1301 output without formatting. The default beginning marker is #<<<
1302 and the default ending marker is #>>> but they
1303 may be changed (see next items below). Additional text may appear on
1304 these special comment lines provided that it is separated from the
1305 marker by at least one space. For example
1308 \& #<<< do not let perltidy touch this
1317 The comment markers may be placed at any location that a block comment may
1318 appear. If they do not appear to be working, use the \-log flag and examine the
1319 \&\fI.LOG\fR file. Use \fB\-nfs\fR to disable this feature.
1320 .IP "\fB\-fsb=string\fR, \fB\-\-format\-skipping\-begin=string\fR" 4
1321 .IX Item "-fsb=string, --format-skipping-begin=string"
1322 The \fB\-fsb=string\fR parameter may be used to change the beginning marker for
1323 format skipping. The default is equivalent to \-fsb='#<<<'. The string that
1324 you enter must begin with a # and should be in quotes as necessary to get past
1325 the command shell of your system. It is actually the leading text of a pattern
1326 that is constructed by appending a '\es', so you must also include backslashes
1327 for characters to be taken literally rather than as patterns.
1329 Some examples show how example strings become patterns:
1332 \& \-fsb='#\e{\e{\e{' becomes /^#\e{\e{\e{\es/ which matches #{{{ but not #{{{{
1333 \& \-fsb='#\e*\e*' becomes /^#\e*\e*\es/ which matches #** but not #***
1334 \& \-fsb='#\e*{2,}' becomes /^#\e*{2,}\es/ which matches #** and #*****
1336 .IP "\fB\-fse=string\fR, \fB\-\-format\-skipping\-end=string\fR" 4
1337 .IX Item "-fse=string, --format-skipping-end=string"
1338 The \fB\-fsb=string\fR is the corresponding parameter used to change the
1339 ending marker for format skipping. The default is equivalent to
1341 .Sh "Line Break Control"
1342 .IX Subsection "Line Break Control"
1343 .IP "\fB\-fnl\fR, \fB\-\-freeze\-newlines\fR" 4
1344 .IX Item "-fnl, --freeze-newlines"
1345 If you do not want any changes to the line breaks in your script, set
1346 \&\fB\-fnl\fR, and they will remain fixed, and the rest of the commands in
1347 this section and sections
1348 \&\*(L"Controlling List Formatting\*(R",
1349 \&\*(L"Retaining or Ignoring Existing Line Breaks\*(R", and
1350 \&\*(L"Blank Line Control\*(R" will be ignored. You may want to use \fB\-noll\fR
1352 .IP "\fB\-ce\fR, \fB\-\-cuddled\-else\fR" 4
1353 .IX Item "-ce, --cuddled-else"
1354 Enable the \*(L"cuddled else\*(R" style, in which \f(CW\*(C`else\*(C'\fR and \f(CW\*(C`elsif\*(C'\fR are
1355 follow immediately after the curly brace closing the previous block.
1356 The default is not to use cuddled elses, and is indicated with the flag
1357 \&\fB\-nce\fR or \fB\-\-nocuddled\-else\fR. Here is a comparison of the
1372 \& else { # \-nce (default)
1376 .IP "\fB\-bl\fR, \fB\-\-opening\-brace\-on\-new\-line\fR" 4
1377 .IX Item "-bl, --opening-brace-on-new-line"
1378 Use the flag \fB\-bl\fR to place the opening brace on a new line:
1381 \& if ( $input_file eq '\-' ) # \-bl
1383 \& important_function();
1387 This flag applies to all structural blocks, including sub's (unless
1388 the \fB\-sbl\fR flag is set \*(-- see next item).
1390 The default style, \fB\-nbl\fR, places an opening brace on the same line as
1391 the keyword introducing it. For example,
1394 \& if ( $input_file eq '\-' ) { # \-nbl (default)
1396 .IP "\fB\-sbl\fR, \fB\-\-opening\-sub\-brace\-on\-new\-line\fR" 4
1397 .IX Item "-sbl, --opening-sub-brace-on-new-line"
1398 The flag \fB\-sbl\fR can be used to override the value of \fB\-bl\fR for
1399 opening sub braces. For example,
1405 produces this result:
1410 \& if (!defined($_[0])) {
1411 \& print("Hello, World\en");
1414 \& print($_[0], "\en");
1419 This flag is negated with \fB\-nsbl\fR. If \fB\-sbl\fR is not specified,
1420 the value of \fB\-bl\fR is used.
1421 .IP "\fB\-bli\fR, \fB\-\-brace\-left\-and\-indent\fR" 4
1422 .IX Item "-bli, --brace-left-and-indent"
1423 The flag \fB\-bli\fR is the same as \fB\-bl\fR but in addition it causes one
1424 unit of continuation indentation ( see \fB\-ci\fR ) to be placed before
1425 an opening and closing block braces.
1430 \& if ( $input_file eq '\-' ) # \-bli
1432 \& important_function();
1436 By default, this extra indentation occurs for blocks of type:
1437 \&\fBif\fR, \fBelsif\fR, \fBelse\fR, \fBunless\fR, \fBfor\fR, \fBforeach\fR, \fBsub\fR,
1438 \&\fBwhile\fR, \fBuntil\fR, and also with a preceding label. The next item
1439 shows how to change this.
1440 .IP "\fB\-blil=s\fR, \fB\-\-brace\-left\-and\-indent\-list=s\fR" 4
1441 .IX Item "-blil=s, --brace-left-and-indent-list=s"
1442 Use this parameter to change the types of block braces for which the
1443 \&\fB\-bli\fR flag applies; see \*(L"Specifying Block Types\*(R". For example,
1444 \&\fB\-blil='if elsif else'\fR would apply it to only \f(CW\*(C`if/elsif/else\*(C'\fR blocks.
1445 .IP "\fB\-bar\fR, \fB\-\-opening\-brace\-always\-on\-right\fR" 4
1446 .IX Item "-bar, --opening-brace-always-on-right"
1447 The default style, \fB\-nbl\fR places the opening code block brace on a new
1448 line if it does not fit on the same line as the opening keyword, like
1452 \& if ( $bigwasteofspace1 && $bigwasteofspace2
1453 \& || $bigwasteofspace3 && $bigwasteofspace4 )
1455 \& big_waste_of_time();
1459 To force the opening brace to always be on the right, use the \fB\-bar\fR
1460 flag. In this case, the above example becomes
1463 \& if ( $bigwasteofspace1 && $bigwasteofspace2
1464 \& || $bigwasteofspace3 && $bigwasteofspace4 ) {
1465 \& big_waste_of_time();
1469 A conflict occurs if both \fB\-bl\fR and \fB\-bar\fR are specified.
1470 .IP "\fB\-otr\fR, \fB\-\-opening\-token\-right\fR and related flags" 4
1471 .IX Item "-otr, --opening-token-right and related flags"
1472 The \fB\-otr\fR flag is a hint that perltidy should not place a break between a
1473 comma and an opening token. For example:
1476 \& # default formatting
1477 \& push @{ $self\->{$module}{$key} },
1479 \& accno => $ref\->{accno},
1480 \& description => $ref\->{description}
1486 \& push @{ $self\->{$module}{$key} }, {
1487 \& accno => $ref\->{accno},
1488 \& description => $ref\->{description}
1492 The flag \fB\-otr\fR is actually a synonym for three other flags
1493 which can be used to control parens, hash braces, and square brackets
1494 separately if desired:
1497 \& \-opr or \-\-opening\-paren\-right
1498 \& \-ohbr or \-\-opening\-hash\-brace\-right
1499 \& \-osbr or \-\-opening\-square\-bracket\-right
1501 .IP "Vertical tightness of non-block curly braces, parentheses, and square brackets." 4
1502 .IX Item "Vertical tightness of non-block curly braces, parentheses, and square brackets."
1503 These parameters control what shall be called vertical tightness. Here are the
1507 Opening tokens (except for block braces) are controlled by \fB\-vt=n\fR, or
1508 \&\fB\-\-vertical\-tightness=n\fR, where
1511 \& \-vt=0 always break a line after opening token (default).
1512 \& \-vt=1 do not break unless this would produce more than one
1513 \& step in indentation in a line.
1514 \& \-vt=2 never break a line after opening token
1517 You must also use the \fB\-lp\fR flag when you use the \fB\-vt\fR flag; the
1518 reason is explained below.
1520 Closing tokens (except for block braces) are controlled by \fB\-vtc=n\fR, or
1521 \&\fB\-\-vertical\-tightness\-closing=n\fR, where
1524 \& \-vtc=0 always break a line before a closing token (default),
1525 \& \-vtc=1 do not break before a closing token which is followed
1526 \& by a semicolon or another closing token, and is not in
1527 \& a list environment.
1528 \& \-vtc=2 never break before a closing token.
1531 The rules for \fB\-vtc=1\fR are designed to maintain a reasonable balance
1532 between tightness and readability in complex lists.
1534 Different controls may be applied to to different token types,
1535 and it is also possible to control block braces; see below.
1537 Finally, please note that these vertical tightness flags are merely
1538 hints to the formatter, and it cannot always follow them. Things which
1539 make it difficult or impossible include comments, blank lines, blocks of
1540 code within a list, and possibly the lack of the \fB\-lp\fR parameter.
1541 Also, these flags may be ignored for very small lists (2 or 3 lines in
1546 Here are some examples:
1549 \& # perltidy \-lp \-vt=0 \-vtc=0
1550 \& %romanNumerals = (
1559 \& # perltidy \-lp \-vt=1 \-vtc=0
1560 \& %romanNumerals = ( one => 'I',
1568 \& # perltidy \-lp \-vt=1 \-vtc=1
1569 \& %romanNumerals = ( one => 'I',
1575 The difference between \fB\-vt=1\fR and \fB\-vt=2\fR is shown here:
1578 \& # perltidy \-lp \-vt=1
1580 \& mysprintf( "(void)find_threadsv(%s);",
1581 \& cstring( $threadsv_names[ $op\->targ ] )
1587 \& # perltidy \-lp \-vt=2
1588 \& $init\->add( mysprintf( "(void)find_threadsv(%s);",
1589 \& cstring( $threadsv_names[ $op\->targ ] )
1594 With \fB\-vt=1\fR, the line ending in \f(CW\*(C`add(\*(C'\fR does not combine with the next
1595 line because the next line is not balanced. This can help with
1596 readability, but \fB\-vt=2\fR can be used to ignore this rule.
1598 The tightest, and least readable, code is produced with both \f(CW\*(C`\-vt=2\*(C'\fR and
1599 \&\f(CW\*(C`\-vtc=2\*(C'\fR:
1602 \& # perltidy \-lp \-vt=2 \-vtc=2
1603 \& $init\->add( mysprintf( "(void)find_threadsv(%s);",
1604 \& cstring( $threadsv_names[ $op\->targ ] ) ) );
1607 Notice how the code in all of these examples collapses vertically as
1608 \&\fB\-vt\fR increases, but the indentation remains unchanged. This is
1609 because perltidy implements the \fB\-vt\fR parameter by first formatting as
1610 if \fB\-vt=0\fR, and then simply overwriting one output line on top of the
1611 next, if possible, to achieve the desired vertical tightness. The
1612 \&\fB\-lp\fR indentation style has been designed to allow this vertical
1613 collapse to occur, which is why it is required for the \fB\-vt\fR parameter.
1615 The \fB\-vt=n\fR and \fB\-vtc=n\fR parameters apply to each type of container
1616 token. If desired, vertical tightness controls can be applied
1617 independently to each of the closing container token types.
1619 The parameters for controlling parentheses are \fB\-pvt=n\fR or
1620 \&\fB\-\-paren\-vertical\-tightness=n\fR, and \fB\-pcvt=n\fR or
1621 \&\fB\-\-paren\-vertical\-tightness\-closing=n\fR.
1623 Likewise, the parameters for square brackets are \fB\-sbvt=n\fR or
1624 \&\fB\-\-square\-bracket\-vertical\-tightness=n\fR, and \fB\-sbcvt=n\fR or
1625 \&\fB\-\-square\-bracket\-vertical\-tightness\-closing=n\fR.
1627 Finally, the parameters for controlling non-code block braces are
1628 \&\fB\-bvt=n\fR or \fB\-\-brace\-vertical\-tightness=n\fR, and \fB\-bcvt=n\fR or
1629 \&\fB\-\-brace\-vertical\-tightness\-closing=n\fR.
1631 In fact, the parameter \fB\-vt=n\fR is actually just an abbreviation for
1632 \&\fB\-pvt=n \-bvt=n sbvt=n\fR, and likewise \fB\-vtc=n\fR is an abbreviation
1633 for \fB\-pvtc=n \-bvtc=n sbvtc=n\fR.
1635 .IP "\fB\-bbvt=n\fR or \fB\-\-block\-brace\-vertical\-tightness=n\fR" 4
1636 .IX Item "-bbvt=n or --block-brace-vertical-tightness=n"
1637 The \fB\-bbvt=n\fR flag is just like the \fB\-vt=n\fR flag but applies
1638 to opening code block braces.
1641 \& \-bbvt=0 break after opening block brace (default).
1642 \& \-bbvt=1 do not break unless this would produce more than one
1643 \& step in indentation in a line.
1644 \& \-bbvt=2 do not break after opening block brace.
1647 It is necessary to also use either \fB\-bl\fR or \fB\-bli\fR for this to work,
1648 because, as with other vertical tightness controls, it is implemented by
1649 simply overwriting a line ending with an opening block brace with the
1650 subsequent line. For example:
1653 \& # perltidy \-bli \-bbvt=0
1654 \& if ( open( FILE, "< $File" ) )
1656 \& while ( $File = <FILE> )
1666 \& # perltidy \-bli \-bbvt=1
1667 \& if ( open( FILE, "< $File" ) )
1668 \& { while ( $File = <FILE> )
1676 By default this applies to blocks associated with keywords \fBif\fR,
1677 \&\fBelsif\fR, \fBelse\fR, \fBunless\fR, \fBfor\fR, \fBforeach\fR, \fBsub\fR, \fBwhile\fR,
1678 \&\fBuntil\fR, and also with a preceding label. This can be changed with
1679 the parameter \fB\-bbvtl=string\fR, or
1680 \&\fB\-\-block\-brace\-vertical\-tightness\-list=string\fR, where \fBstring\fR is a
1681 space-separated list of block types. For more information on the
1682 possible values of this string, see \*(L"Specifying Block Types\*(R"
1684 For example, if we want to just apply this style to \f(CW\*(C`if\*(C'\fR,
1685 \&\f(CW\*(C`elsif\*(C'\fR, and \f(CW\*(C`else\*(C'\fR blocks, we could use
1686 \&\f(CW\*(C`perltidy \-bli \-bbvt=1 \-bbvtl='if elsif else'\*(C'\fR.
1688 There is no vertical tightness control for closing block braces; with
1689 the exception of one-line blocks, they will normally remain on a
1691 .IP "\fB\-sot\fR, \fB\-\-stack\-opening\-token\fR and related flags" 4
1692 .IX Item "-sot, --stack-opening-token and related flags"
1693 The \fB\-sot\fR flag tells perltidy to \*(L"stack\*(R" opening tokens
1694 when possible to avoid lines with isolated opening tokens.
1700 \& $opt_c = Text::CSV_XS\->new(
1703 \& sep_char => $opt_c,
1704 \& always_quote => 1,
1711 \& $opt_c = Text::CSV_XS\->new( {
1713 \& sep_char => $opt_c,
1714 \& always_quote => 1,
1719 For detailed control of individual closing tokens the following
1720 controls can be used:
1723 \& \-sop or \-\-stack\-opening\-paren
1724 \& \-sohb or \-\-stack\-opening\-hash\-brace
1725 \& \-sosb or \-\-stack\-opening\-square\-bracket
1728 The flag \fB\-sot\fR is a synonym for \fB\-sop \-sohb \-sosb\fR.
1729 .IP "\fB\-sct\fR, \fB\-\-stack\-closing\-token\fR and related flags" 4
1730 .IX Item "-sct, --stack-closing-token and related flags"
1731 The \fB\-sct\fR flag tells perltidy to \*(L"stack\*(R" closing tokens
1732 when possible to avoid lines with isolated closing tokens.
1738 \& $opt_c = Text::CSV_XS\->new(
1741 \& sep_char => $opt_c,
1742 \& always_quote => 1,
1749 \& $opt_c = Text::CSV_XS\->new(
1752 \& sep_char => $opt_c,
1753 \& always_quote => 1,
1757 The \fB\-sct\fR flag is somewhat similar to the \fB\-vtc\fR flags, and in some
1758 cases it can give a similar result. The difference is that the \fB\-vtc\fR
1759 flags try to avoid lines with leading opening tokens by \*(L"hiding\*(R" them at
1760 the end of a previous line, whereas the \fB\-sct\fR flag merely tries to
1761 reduce the number of lines with isolated closing tokens by stacking them
1762 but does not try to hide them. For example:
1766 \& $opt_c = Text::CSV_XS\->new(
1769 \& sep_char => $opt_c,
1770 \& always_quote => 1, } );
1773 For detailed control of the stacking of individual closing tokens the
1774 following controls can be used:
1777 \& \-scp or \-\-stack\-closing\-paren
1778 \& \-schb or \-\-stack\-closing\-hash\-brace
1779 \& \-scsb or \-\-stack\-closing\-square\-bracket
1782 The flag \fB\-sct\fR is a synonym for \fB\-scp \-schb \-scsb\fR.
1783 .IP "\fB\-dnl\fR, \fB\-\-delete\-old\-newlines\fR" 4
1784 .IX Item "-dnl, --delete-old-newlines"
1785 By default, perltidy first deletes all old line break locations, and then it
1786 looks for good break points to match the desired line length. Use \fB\-ndnl\fR
1787 or \fB\-\-nodelete\-old\-newlines\fR to force perltidy to retain all old line break
1789 .IP "\fB\-anl\fR, \fB\-\-add\-newlines\fR" 4
1790 .IX Item "-anl, --add-newlines"
1791 By default, perltidy will add line breaks when necessary to create
1792 continuations of long lines and to improve the script appearance. Use
1793 \&\fB\-nanl\fR or \fB\-\-noadd\-newlines\fR to prevent any new line breaks.
1795 This flag does not prevent perltidy from eliminating existing line
1796 breaks; see \fB\-\-freeze\-newlines\fR to completely prevent changes to line
1798 .IP "Controlling whether perltidy breaks before or after operators" 4
1799 .IX Item "Controlling whether perltidy breaks before or after operators"
1800 Two command line parameters provide some control over whether
1801 a line break should be before or after specific token types.
1803 \&\fB\-wba=s\fR or \fB\-\-want\-break\-after=s\fR, and
1805 \&\fB\-wbb=s\fR or \fB\-\-want\-break\-before=s\fR.
1807 These parameters are each followed by a quoted string, \fBs\fR, containing
1808 a list of token types (separated only by spaces). No more than one of each
1809 of these parameters should be specified, because repeating a
1810 command-line parameter always overwrites the previous one before
1811 perltidy ever sees it.
1813 By default, perltidy breaks \fBafter\fR these token types:
1814 % + \- * / x != == >= <= =~ !~ < > | &
1815 = **= += *= &= <<= &&= \-= /= |= >>= ||= //= .= %= ^= x=
1817 And perltidy breaks \fBbefore\fR these token types by default:
1818 . << >> \-> && || //
1820 To illustrate, to cause a break after a concatenation operator, \f(CW'.'\fR,
1821 rather than before it, the command line would be
1827 As another example, the following command would cause a break before
1828 math operators \f(CW'+'\fR, \f(CW'\-'\fR, \f(CW'/'\fR, and \f(CW'*'\fR:
1834 These commands should work well for most of the token types that perltidy uses
1835 (use \fB\-\-dump\-token\-types\fR for a list). Also try the \fB\-D\fR flag on a short
1836 snippet of code and look at the .DEBUG file to see the tokenization. However,
1837 for a few token types there may be conflicts with hardwired logic which cause
1838 unexpected results. One example is curly braces, which should be controlled
1839 with the parameter \fBbl\fR provided for that purpose.
1841 \&\fB\s-1WARNING\s0\fR Be sure to put these tokens in quotes to avoid having them
1842 misinterpreted by your command shell.
1843 .Sh "Controlling List Formatting"
1844 .IX Subsection "Controlling List Formatting"
1845 Perltidy attempts to place comma-separated arrays of values in tables
1846 which look good. Its default algorithms usually work well, and they
1847 have been improving with each release, but several parameters are
1848 available to control list formatting.
1849 .IP "\fB\-boc\fR, \fB\-\-break\-at\-old\-comma\-breakpoints\fR" 4
1850 .IX Item "-boc, --break-at-old-comma-breakpoints"
1851 This flag tells perltidy to try to break at all old commas. This is not
1852 the default. Normally, perltidy makes a best guess at list formatting,
1853 and seldom uses old comma breakpoints. Usually this works well,
1864 The default formatting will flatten this down to one line:
1867 \& # perltidy (default)
1868 \& my @list = ( 1, 1, 1, 1, 2, 1, 1, 3, 3, 1, 1, 4, 6, 4, 1, );
1871 which hides the structure. Using \fB\-boc\fR, plus additional flags
1872 to retain the original style, yields
1875 \& # perltidy \-boc \-lp \-pt=2 \-vt=1 \-vtc=1
1883 A disadvantage of this flag is that all tables in the file
1884 must already be nicely formatted. For another possibility see
1885 the \-fs flag in \*(L"Skipping Selected Sections of Code\*(R".
1886 .IP "\fB\-mft=n\fR, \fB\-\-maximum\-fields\-per\-table=n\fR" 4
1887 .IX Item "-mft=n, --maximum-fields-per-table=n"
1888 If the computed number of fields for any table exceeds \fBn\fR, then it
1889 will be reduced to \fBn\fR. The default value for \fBn\fR is a large number,
1890 40. While this value should probably be left unchanged as a general
1891 rule, it might be used on a small section of code to force a list to
1892 have a particular number of fields per line, and then either the \fB\-boc\fR
1893 flag could be used to retain this formatting, or a single comment could
1894 be introduced somewhere to freeze the formatting in future applications
1898 \& # perltidy \-mft=2
1899 \& @month_of_year = (
1908 .IP "\fB\-cab=n\fR, \fB\-\-comma\-arrow\-breakpoints=n\fR" 4
1909 .IX Item "-cab=n, --comma-arrow-breakpoints=n"
1910 A comma which follows a comma arrow, '=>', requires special
1911 consideration. In a long list, it is common to break at all such
1912 commas. This parameter can be used to control how perltidy breaks at
1913 these commas. (However, it will have no effect if old comma breaks are
1914 being forced because \fB\-boc\fR is used). The possible values of \fBn\fR are:
1917 \& n=0 break at all commas after =>
1918 \& n=1 stable: break at all commas after => unless this would break
1919 \& an existing one\-line container (default)
1920 \& n=2 break at all commas after =>, but try to form the maximum
1921 \& maximum one\-line container lengths
1922 \& n=3 do not treat commas after => specially at all
1925 For example, given the following single line, perltidy by default will
1926 not add any line breaks because it would break the existing one-line
1930 \& bless { B => $B, Root => $Root } => $package;
1933 Using \fB\-cab=0\fR will force a break after each comma-arrow item:
1936 \& # perltidy \-cab=0:
1943 If perltidy is subsequently run with this container broken, then by
1944 default it will break after each '=>' because the container is now
1945 broken. To reform a one-line container, the parameter \fB\-cab=2\fR would
1948 The flag \fB\-cab=3\fR can be used to prevent these commas from being
1949 treated specially. In this case, an item such as \*(L"01\*(R" => 31 is
1950 treated as a single item in a table. The number of fields in this table
1951 will be determined by the same rules that are used for any other table.
1955 \& # perltidy \-cab=3
1957 \& "01" => 31, "02" => 29, "03" => 31, "04" => 30,
1958 \& "05" => 31, "06" => 30, "07" => 31, "08" => 31,
1959 \& "09" => 30, "10" => 31, "11" => 30, "12" => 31
1962 .Sh "Retaining or Ignoring Existing Line Breaks"
1963 .IX Subsection "Retaining or Ignoring Existing Line Breaks"
1964 Several additional parameters are available for controlling the extent
1965 to which line breaks in the input script influence the output script.
1966 In most cases, the default parameter values are set so that, if a choice
1967 is possible, the output style follows the input style. For example, if
1968 a short logical container is broken in the input script, then the
1969 default behavior is for it to remain broken in the output script.
1971 Most of the parameters in this section would only be required for a
1972 one-time conversion of a script from short container lengths to longer
1973 container lengths. The opposite effect, of converting long container
1974 lengths to shorter lengths, can be obtained by temporarily using a short
1975 maximum line length.
1976 .IP "\fB\-bol\fR, \fB\-\-break\-at\-old\-logical\-breakpoints\fR" 4
1977 .IX Item "-bol, --break-at-old-logical-breakpoints"
1978 By default, if a logical expression is broken at a \f(CW\*(C`&&\*(C'\fR, \f(CW\*(C`||\*(C'\fR, \f(CW\*(C`and\*(C'\fR,
1979 or \f(CW\*(C`or\*(C'\fR, then the container will remain broken. Also, breaks
1980 at internal keywords \f(CW\*(C`if\*(C'\fR and \f(CW\*(C`unless\*(C'\fR will normally be retained.
1981 To prevent this, and thus form longer lines, use \fB\-nbol\fR.
1982 .IP "\fB\-bok\fR, \fB\-\-break\-at\-old\-keyword\-breakpoints\fR" 4
1983 .IX Item "-bok, --break-at-old-keyword-breakpoints"
1984 By default, perltidy will retain a breakpoint before keywords which may
1985 return lists, such as \f(CW\*(C`sort\*(C'\fR and <map>. This allows chains of these
1986 operators to be displayed one per line. Use \fB\-nbok\fR to prevent
1987 retaining these breakpoints.
1988 .IP "\fB\-bot\fR, \fB\-\-break\-at\-old\-ternary\-breakpoints\fR" 4
1989 .IX Item "-bot, --break-at-old-ternary-breakpoints"
1990 By default, if a conditional (ternary) operator is broken at a \f(CW\*(C`:\*(C'\fR,
1991 then it will remain broken. To prevent this, and thereby
1992 form longer lines, use \fB\-nbot\fR.
1993 .IP "\fB\-iob\fR, \fB\-\-ignore\-old\-breakpoints\fR" 4
1994 .IX Item "-iob, --ignore-old-breakpoints"
1995 Use this flag to tell perltidy to ignore existing line breaks to the
1996 maximum extent possible. This will tend to produce the longest possible
1997 containers, regardless of type, which do not exceed the line length
1999 .Sh "Blank Line Control"
2000 .IX Subsection "Blank Line Control"
2001 Blank lines can improve the readability of a script if they are carefully
2002 placed. Perltidy has several commands for controlling the insertion,
2003 retention, and removal of blank lines.
2004 .IP "\fB\-bbc\fR, \fB\-\-blanks\-before\-comments\fR" 4
2005 .IX Item "-bbc, --blanks-before-comments"
2006 A blank line will be introduced before a full-line comment. This is the
2007 default. Use \fB\-nbbc\fR or \fB\-\-noblanks\-before\-comments\fR to prevent
2008 such blank lines from being introduced.
2009 .IP "\fB\-bbs\fR, \fB\-\-blanks\-before\-subs\fR" 4
2010 .IX Item "-bbs, --blanks-before-subs"
2011 A blank line will be introduced before a \fBsub\fR definition, unless it is a
2012 one-liner or preceded by a comment. A blank line will also be introduced
2013 before a \fBpackage\fR statement and a \fB\s-1BEGIN\s0\fR and \fB\s-1END\s0\fR block. This is the
2014 default. The intention is to help display the structure of a program by
2015 setting off certain key sections of code. This is negated with \fB\-nbbs\fR or
2016 \&\fB\-\-noblanks\-before\-subs\fR.
2017 .IP "\fB\-bbb\fR, \fB\-\-blanks\-before\-blocks\fR" 4
2018 .IX Item "-bbb, --blanks-before-blocks"
2019 A blank line will be introduced before blocks of coding delimited by
2020 \&\fBfor\fR, \fBforeach\fR, \fBwhile\fR, \fBuntil\fR, and \fBif\fR, \fBunless\fR, in the following
2024 The block is not preceded by a comment.
2026 The block is not a one-line block.
2028 The number of consecutive non-blank lines at the current indentation depth is at least \fB\-lbl\fR
2033 This is the default. The intention of this option is to introduce
2034 some space within dense coding.
2035 This is negated with \fB\-nbbb\fR or \fB\-\-noblanks\-before\-blocks\fR.
2037 .IP "\fB\-lbl=n\fR \fB\-\-long\-block\-line\-count=n\fR" 4
2038 .IX Item "-lbl=n --long-block-line-count=n"
2039 This controls how often perltidy is allowed to add blank lines before
2040 certain block types (see previous section). The default is 8. Entering
2041 a value of \fB0\fR is equivalent to entering a very large number.
2042 .IP "\fB\-mbl=n\fR \fB\-\-maximum\-consecutive\-blank\-lines=n\fR" 4
2043 .IX Item "-mbl=n --maximum-consecutive-blank-lines=n"
2044 This parameter specifies the maximum number of consecutive blank lines
2045 in the output script. The default is n=1. If the input file has more
2046 than n consecutive blank lines, the number will be reduced to n.
2047 (This obviously does not apply to pod sections, here\-documents, and quotes).
2048 .IP "\fB\-sob\fR, \fB\-\-swallow\-optional\-blank\-lines\fR" 4
2049 .IX Item "-sob, --swallow-optional-blank-lines"
2050 All blank lines not required by the above flags, \fB\-bbb\fR, \fB\-bbs\fR, and \fB\-bbc\fR,
2051 will be deleted. (But essential blank lines above pod documents will be
2052 retained). This is \s-1NOT\s0 the default.
2053 .IP "\fB\-nsob\fR, \fB\-\-noswallow\-optional\-blank\-lines\fR" 4
2054 .IX Item "-nsob, --noswallow-optional-blank-lines"
2055 Retain blank lines, including those which do not corresponding to flags
2056 \&\fB\-bbb\fR, \fB\-bbs\fR, and \fB\-bbc\fR. This is the default. The number of
2057 blanks retained is subject to the limit imposed by
2058 \&\fB\-\-maximum\-consecutive\-blank\-lines\fR, however.
2060 .IX Subsection "Styles"
2061 A style refers to a convenient collection of existing parameters.
2062 .IP "\fB\-gnu\fR, \fB\-\-gnu\-style\fR" 4
2063 .IX Item "-gnu, --gnu-style"
2064 \&\fB\-gnu\fR gives an approximation to the \s-1GNU\s0 Coding Standards (which do
2065 not apply to perl) as they are sometimes implemented. At present, this
2066 style overrides the default style with the following parameters:
2069 \& \-lp \-bl \-noll \-pt=2 \-bt=2 \-sbt=2 \-icp
2071 .IP "\fB\-pbp\fR, \fB\-\-perl\-best\-practices\fR" 4
2072 .IX Item "-pbp, --perl-best-practices"
2073 \&\fB\-pbp\fR is an abbreviation for the parameters in the book \fBPerl Best Practices\fR
2077 \& \-l=78 \-i=4 \-ci=4 \-st \-se \-vt=2 \-cti=0 \-pt=1 \-bt=1 \-sbt=1 \-bbt=1 \-nsfs \-nolq
2078 \& \-wbb="% + \- * / x != == >= <= =~ !~ < > | & =
2079 \& **= += *= &= <<= &&= \-= /= |= >>= ||= //= .= %= ^= x="
2082 Note that the \-st and \-se flags make perltidy act as a filter on one file only.
2083 These can be overridden with \-nst and \-nse if necessary.
2084 .Sh "Other Controls"
2085 .IX Subsection "Other Controls"
2086 .IP "Deleting selected text" 4
2087 .IX Item "Deleting selected text"
2088 Perltidy can selectively delete comments and/or pod documentation. The
2089 command \fB\-dac\fR or \fB\-\-delete\-all\-comments\fR will delete all comments
2090 \&\fBand\fR all pod documentation, leaving just code and any leading system
2093 The command \fB\-dp\fR or \fB\-\-delete\-pod\fR will remove all pod documentation
2096 Two commands which remove comments (but not pod) are: \fB\-dbc\fR or
2097 \&\fB\-\-delete\-block\-comments\fR and \fB\-dsc\fR or \fB\-\-delete\-side\-comments\fR.
2098 (Hanging side comments will be deleted with block comments here.)
2100 The negatives of these commands also work, and are the defaults. When
2101 block comments are deleted, any leading 'hash\-bang' will be retained.
2102 Also, if the \fB\-x\fR flag is used, any system commands before a leading
2103 hash-bang will be retained (even if they are in the form of comments).
2104 .IP "Writing selected text to a file" 4
2105 .IX Item "Writing selected text to a file"
2106 When perltidy writes a formatted text file, it has the ability to also
2107 send selected text to a file with a \fI.TEE\fR extension. This text can
2108 include comments and pod documentation.
2110 The command \fB\-tac\fR or \fB\-\-tee\-all\-comments\fR will write all comments
2111 \&\fBand\fR all pod documentation.
2113 The command \fB\-tp\fR or \fB\-\-tee\-pod\fR will write all pod documentation (but
2116 The commands which write comments (but not pod) are: \fB\-tbc\fR or
2117 \&\fB\-\-tee\-block\-comments\fR and \fB\-tsc\fR or \fB\-\-tee\-side\-comments\fR.
2118 (Hanging side comments will be written with block comments here.)
2120 The negatives of these commands also work, and are the defaults.
2121 .IP "Using a \fI.perltidyrc\fR command file" 4
2122 .IX Item "Using a .perltidyrc command file"
2123 If you use perltidy frequently, you probably won't be happy until you
2124 create a \fI.perltidyrc\fR file to avoid typing commonly-used parameters.
2125 Perltidy will first look in your current directory for a command file
2126 named \fI.perltidyrc\fR. If it does not find one, it will continue looking
2127 for one in other standard locations.
2129 These other locations are system\-dependent, and may be displayed with
2130 the command \f(CW\*(C`perltidy \-dpro\*(C'\fR. Under Unix systems, it will look for a
2131 \&\fI.perltidyrc\fR file in the home directory, and then for a system-wide
2132 file \fI/usr/local/etc/perltidyrc\fR, and then it will look for
2133 \&\fI/etc/perltidyrc\fR. Note that these last two system-wide files do not
2134 have a leading dot. Further system-dependent information will be found
2135 in the \s-1INSTALL\s0 file distributed with perltidy.
2137 This file is free format, and simply a list of parameters, just as they
2138 would be entered on a command line. Any number of lines may be used,
2139 with any number of parameters per line, although it may be easiest to
2140 read with one parameter per line. Blank lines are ignored, and text
2141 after a '#' is ignored to the end of a line.
2143 Here is an example of a \fI.perltidyrc\fR file:
2146 \& # This is a simple of a .perltidyrc configuration file
2147 \& # This implements a highly spaced style
2148 \& \-se # errors to standard error output
2149 \& \-w # show all warnings
2150 \& \-bl # braces on new lines
2151 \& \-pt=0 # parens not tight at all
2152 \& \-bt=0 # braces not tight
2153 \& \-sbt=0 # square brackets not tight
2156 The parameters in the \fI.perltidyrc\fR file are installed first, so any
2157 parameters given on the command line will have priority over them.
2159 To avoid confusion, perltidy ignores any command in the .perltidyrc
2160 file which would cause some kind of dump and an exit. These are:
2163 \& \-h \-v \-ddf \-dln \-dop \-dsn \-dtt \-dwls \-dwrs \-ss
2166 There are several options may be helpful in debugging a \fI.perltidyrc\fR
2170 A very helpful command is \fB\-\-dump\-profile\fR or \fB\-dpro\fR. It writes a
2171 list of all configuration filenames tested to standard output, and
2172 if a file is found, it dumps the content to standard output before
2173 exiting. So, to find out where perltidy looks for its configuration
2174 files, and which one if any it selects, just enter
2180 It may be simplest to develop and test configuration files with
2181 alternative names, and invoke them with \fB\-pro=filename\fR on the command
2182 line. Then rename the desired file to \fI.perltidyrc\fR when finished.
2184 The parameters in the \fI.perltidyrc\fR file can be switched off with
2185 the \fB\-npro\fR option.
2187 The commands \fB\-\-dump\-options\fR, \fB\-\-dump\-defaults\fR, \fB\-\-dump\-long\-names\fR,
2188 and \fB\-\-dump\-short\-names\fR, all described below, may all be helpful.
2192 .IP "Creating a new abbreviation" 4
2193 .IX Item "Creating a new abbreviation"
2194 A special notation is available for use in a \fI.perltidyrc\fR file
2195 for creating an abbreviation for a group
2196 of options. This can be used to create a
2197 shorthand for one or more styles which are frequently, but not always,
2198 used. The notation is to group the options within curly braces which
2199 are preceded by the name of the alias (without leading dashes), like this:
2208 where \fBnewword\fR is the abbreviation, and \fBopt1\fR, etc, are existing parameters
2209 \&\fIor other abbreviations\fR. The main syntax requirement is that
2210 the new abbreviation must begin on a new line.
2211 Space before and after the curly braces is optional.
2213 specific example, the following line
2216 \& airy {\-bl \-pt=0 \-bt=0 \-sbt=0}
2219 could be placed in a \fI.perltidyrc\fR file, and then invoked at will with
2222 \& perltidy \-airy somefile.pl
2225 (Either \f(CW\*(C`\-airy\*(C'\fR or \f(CW\*(C`\-\-airy\*(C'\fR may be used).
2226 .IP "Skipping leading non-perl commands with \fB\-x\fR or \fB\-\-look\-for\-hash\-bang\fR" 4
2227 .IX Item "Skipping leading non-perl commands with -x or --look-for-hash-bang"
2228 If your script has leading lines of system commands or other text which
2229 are not valid perl code, and which are separated from the start of the
2230 perl code by a \*(L"hash\-bang\*(R" line, ( a line of the form \f(CW\*(C`#!...perl\*(C'\fR ),
2231 you must use the \fB\-x\fR flag to tell perltidy not to parse and format any
2232 lines before the \*(L"hash\-bang\*(R" line. This option also invokes perl with a
2233 \&\-x flag when checking the syntax. This option was originally added to
2234 allow perltidy to parse interactive \s-1VMS\s0 scripts, but it should be used
2235 for any script which is normally invoked with \f(CW\*(C`perl \-x\*(C'\fR.
2236 .IP "Making a file unreadable" 4
2237 .IX Item "Making a file unreadable"
2238 The goal of perltidy is to improve the readability of files, but there
2239 are two commands which have the opposite effect, \fB\-\-mangle\fR and
2240 \&\fB\-\-extrude\fR. They are actually
2241 merely aliases for combinations of other parameters. Both of these
2242 strip all possible whitespace, but leave comments and pod documents,
2243 so that they are essentially reversible. The
2244 difference between these is that \fB\-\-mangle\fR puts the fewest possible
2245 line breaks in a script while \fB\-\-extrude\fR puts the maximum possible.
2246 Note that these options do not provided any meaningful obfuscation, because
2247 perltidy can be used to reformat the files. They were originally
2248 developed to help test the tokenization logic of perltidy, but they
2250 One use for \fB\-\-mangle\fR is the following:
2253 \& perltidy \-\-mangle myfile.pl \-st | perltidy \-o myfile.pl.new
2256 This will form the maximum possible number of one-line blocks (see next
2257 section), and can sometimes help clean up a badly formatted script.
2259 A similar technique can be used with \fB\-\-extrude\fR instead of \fB\-\-mangle\fR
2260 to make the minimum number of one-line blocks.
2262 Another use for \fB\-\-mangle\fR is to combine it with \fB\-dac\fR to reduce
2263 the file size of a perl script.
2264 .IP "One-line blocks" 4
2265 .IX Item "One-line blocks"
2266 There are a few points to note regarding one-line blocks. A one-line
2267 block is something like this,
2270 \& if ($x > 0) { $y = 1 / $x }
2273 where the contents within the curly braces is short enough to fit
2276 With few exceptions, perltidy retains existing one-line blocks, if it
2277 is possible within the line-length constraint, but it does not attempt
2278 to form new ones. In other words, perltidy will try to follow the
2279 one-line block style of the input file.
2281 If an existing one-line block is longer than the maximum line length,
2282 however, it will be broken into multiple lines. When this happens, perltidy
2283 checks for and adds any optional terminating semicolon (unless the \fB\-nasc\fR
2284 option is used) if the block is a code block.
2286 The main exception is that perltidy will attempt to form new one-line
2287 blocks following the keywords \f(CW\*(C`map\*(C'\fR, \f(CW\*(C`eval\*(C'\fR, and \f(CW\*(C`sort\*(C'\fR, because
2288 these code blocks are often small and most clearly displayed in a single
2291 One-line block rules can conflict with the cuddled-else option. When
2292 the cuddled-else option is used, perltidy retains existing one-line
2293 blocks, even if they do not obey cuddled-else formatting.
2295 Occasionally, when one-line blocks get broken because they exceed the
2296 available line length, the formatting will violate the requested brace style.
2297 If this happens, reformatting the script a second time should correct
2300 .IX Item "Debugging"
2301 The following flags are available for debugging:
2303 \&\fB\-\-dump\-defaults\fR or \fB\-ddf\fR will write the default option set to standard output and quit
2305 \&\fB\-\-dump\-profile\fR or \fB\-dpro\fR will write the name of the current
2306 configuration file and its contents to standard output and quit.
2308 \&\fB\-\-dump\-options\fR or \fB\-dop\fR will write current option set to standard
2311 \&\fB\-\-dump\-long\-names\fR or \fB\-dln\fR will write all command line long names (passed
2312 to Get_options) to standard output and quit.
2314 \&\fB\-\-dump\-short\-names\fR or \fB\-dsn\fR will write all command line short names
2315 to standard output and quit.
2317 \&\fB\-\-dump\-token\-types\fR or \fB\-dtt\fR will write a list of all token types
2318 to standard output and quit.
2320 \&\fB\-\-dump\-want\-left\-space\fR or \fB\-dwls\fR will write the hash \f(CW%want_left_space\fR
2321 to standard output and quit. See the section on controlling whitespace
2324 \&\fB\-\-dump\-want\-right\-space\fR or \fB\-dwrs\fR will write the hash \f(CW%want_right_space\fR
2325 to standard output and quit. See the section on controlling whitespace
2328 \&\fB\-DEBUG\fR will write a file with extension \fI.DEBUG\fR for each input file
2329 showing the tokenization of all lines of code.
2330 .IP "Working with MakeMaker, AutoLoader and SelfLoader" 4
2331 .IX Item "Working with MakeMaker, AutoLoader and SelfLoader"
2332 The first \f(CW$VERSION\fR line of a file which might be eval'd by MakeMaker
2333 is passed through unchanged except for indentation.
2334 Use \fB\-\-nopass\-version\-line\fR, or \fB\-npvl\fR, to deactivate this feature.
2336 If the AutoLoader module is used, perltidy will continue formatting
2337 code after seeing an _\|_END_\|_ line.
2338 Use \fB\-\-nolook\-for\-autoloader\fR, or \fB\-nlal\fR, to deactivate this feature.
2340 Likewise, if the SelfLoader module is used, perltidy will continue formatting
2341 code after seeing a _\|_DATA_\|_ line.
2342 Use \fB\-\-nolook\-for\-selfloader\fR, or \fB\-nlsl\fR, to deactivate this feature.
2343 .IP "Working around problems with older version of Perl" 4
2344 .IX Item "Working around problems with older version of Perl"
2345 Perltidy contains a number of rules which help avoid known subtleties
2346 and problems with older versions of perl, and these rules always
2347 take priority over whatever formatting flags have been set. For example,
2348 perltidy will usually avoid starting a new line with a bareword, because
2349 this might cause problems if \f(CW\*(C`use strict\*(C'\fR is active.
2351 There is no way to override these rules.
2353 .IX Header "HTML OPTIONS"
2354 .IP "The \fB\-html\fR master switch" 4
2355 .IX Item "The -html master switch"
2356 The flag \fB\-html\fR causes perltidy to write an html file with extension
2357 \&\fI.html\fR. So, for example, the following command
2360 \& perltidy \-html somefile.pl
2363 will produce a syntax-colored html file named \fIsomefile.pl.html\fR
2364 which may be viewed with a browser.
2366 \&\fBPlease Note\fR: In this case, perltidy does not do any formatting to the
2367 input file, and it does not write a formatted file with extension
2368 \&\fI.tdy\fR. This means that two perltidy runs are required to create a
2369 fully reformatted, html copy of a script.
2370 .IP "The \fB\-pre\fR flag for code snippets" 4
2371 .IX Item "The -pre flag for code snippets"
2372 When the \fB\-pre\fR flag is given, only the pre-formatted section, within
2373 the <\s-1PRE\s0> and </PRE> tags, will be output. This simplifies inclusion
2374 of the output in other files. The default is to output a complete
2376 .IP "The \fB\-nnn\fR flag for line numbering" 4
2377 .IX Item "The -nnn flag for line numbering"
2378 When the \fB\-nnn\fR flag is given, the output lines will be numbered.
2379 .IP "The \fB\-toc\fR, or \fB\-\-html\-table\-of\-contents\fR flag" 4
2380 .IX Item "The -toc, or --html-table-of-contents flag"
2381 By default, a table of contents to packages and subroutines will be
2382 written at the start of html output. Use \fB\-ntoc\fR to prevent this.
2383 This might be useful, for example, for a pod document which contains a
2384 number of unrelated code snippets. This flag only influences the code
2385 table of contents; it has no effect on any table of contents produced by
2386 pod2html (see next item).
2387 .IP "The \fB\-pod\fR, or \fB\-\-pod2html\fR flag" 4
2388 .IX Item "The -pod, or --pod2html flag"
2389 There are two options for formatting pod documentation. The default is
2390 to pass the pod through the Pod::Html module (which forms the basis of
2391 the pod2html utility). Any code sections are formatted by perltidy, and
2392 the results then merged. Note: perltidy creates a temporary file when
2393 Pod::Html is used; see \*(L"\s-1FILES\s0\*(R". Also, Pod::Html creates temporary
2394 files for its cache.
2396 \&\s-1NOTE:\s0 Perltidy counts the number of \f(CW\*(C`=cut\*(C'\fR lines, and either moves the
2397 pod text to the top of the html file if there is one \f(CW\*(C`=cut\*(C'\fR, or leaves
2398 the pod text in its original order (interleaved with code) otherwise.
2400 Most of the flags accepted by pod2html may be included in the perltidy
2401 command line, and they will be passed to pod2html. In some cases,
2402 the flags have a prefix \f(CW\*(C`pod\*(C'\fR to emphasize that they are for the
2403 pod2html, and this prefix will be removed before they are passed to
2404 pod2html. The flags which have the additional \f(CW\*(C`pod\*(C'\fR prefix are:
2407 \& \-\-[no]podheader \-\-[no]podindex \-\-[no]podrecurse \-\-[no]podquiet
2408 \& \-\-[no]podverbose \-\-podflush
2411 The flags which are unchanged from their use in pod2html are:
2414 \& \-\-backlink=s \-\-cachedir=s \-\-htmlroot=s \-\-libpods=s \-\-title=s
2415 \& \-\-podpath=s \-\-podroot=s
2418 where 's' is an appropriate character string. Not all of these flags are
2419 available in older versions of Pod::Html. See your Pod::Html documentation for
2422 The alternative, indicated with \fB\-npod\fR, is not to use Pod::Html, but
2423 rather to format pod text in italics (or whatever the stylesheet
2424 indicates), without special html markup. This is useful, for example,
2425 if pod is being used as an alternative way to write comments.
2426 .IP "The \fB\-frm\fR, or \fB\-\-frames\fR flag" 4
2427 .IX Item "The -frm, or --frames flag"
2428 By default, a single html output file is produced. This can be changed
2429 with the \fB\-frm\fR option, which creates a frame holding a table of
2430 contents in the left panel and the source code in the right side. This
2431 simplifies code browsing. Assume, for example, that the input file is
2432 \&\fIMyModule.pm\fR. Then, for default file extension choices, these three
2433 files will be created:
2436 \& MyModule.pm.html \- the frame
2437 \& MyModule.pm.toc.html \- the table of contents
2438 \& MyModule.pm.src.html \- the formatted source code
2441 Obviously this file naming scheme requires that output be directed to a real
2442 file (as opposed to, say, standard output). If this is not the
2443 case, or if the file extension is unknown, the \fB\-frm\fR option will be
2445 .IP "The \fB\-text=s\fR, or \fB\-\-html\-toc\-extension\fR flag" 4
2446 .IX Item "The -text=s, or --html-toc-extension flag"
2447 Use this flag to specify the extra file extension of the table of contents file
2448 when html frames are used. The default is \*(L"toc\*(R".
2449 See \*(L"Specifying File Extensions\*(R".
2450 .IP "The \fB\-sext=s\fR, or \fB\-\-html\-src\-extension\fR flag" 4
2451 .IX Item "The -sext=s, or --html-src-extension flag"
2452 Use this flag to specify the extra file extension of the content file when html
2453 frames are used. The default is \*(L"src\*(R".
2454 See \*(L"Specifying File Extensions\*(R".
2455 .IP "The \fB\-hent\fR, or \fB\-\-html\-entities\fR flag" 4
2456 .IX Item "The -hent, or --html-entities flag"
2457 This flag controls the use of Html::Entities for html formatting. By
2458 default, the module Html::Entities is used to encode special symbols.
2459 This may not be the right thing for some browser/language
2460 combinations. Use \-\-nohtml\-entities or \-nhent to prevent this.
2461 .IP "Style Sheets" 4
2462 .IX Item "Style Sheets"
2463 Style sheets make it very convenient to control and adjust the
2464 appearance of html pages. The default behavior is to write a page of
2465 html with an embedded style sheet.
2467 An alternative to an embedded style sheet is to create a page with a
2468 link to an external style sheet. This is indicated with the
2469 \&\fB\-css=filename\fR, where the external style sheet is \fIfilename\fR. The
2470 external style sheet \fIfilename\fR will be created if and only if it does
2471 not exist. This option is useful for controlling multiple pages from a
2474 To cause perltidy to write a style sheet to standard output and exit,
2475 use the \fB\-ss\fR, or \fB\-\-stylesheet\fR, flag. This is useful if the style
2476 sheet could not be written for some reason, such as if the \fB\-pre\fR flag
2477 was used. Thus, for example,
2480 \& perltidy \-html \-ss >mystyle.css
2483 will write a style sheet with the default properties to file
2484 \&\fImystyle.css\fR.
2486 The use of style sheets is encouraged, but a web page without a style
2487 sheets can be created with the flag \fB\-nss\fR. Use this option if you
2488 must to be sure that older browsers (roughly speaking, versions prior to
2489 4.0 of Netscape Navigator and Internet Explorer) can display the
2490 syntax-coloring of the html files.
2491 .IP "Controlling \s-1HTML\s0 properties" 4
2492 .IX Item "Controlling HTML properties"
2493 Note: It is usually more convenient to accept the default properties
2494 and then edit the stylesheet which is produced. However, this section
2495 shows how to control the properties with flags to perltidy.
2497 Syntax colors may be changed from their default values by flags of the either
2498 the long form, \fB\-html\-color\-xxxxxx=n\fR, or more conveniently the short form,
2499 \&\fB\-hcx=n\fR, where \fBxxxxxx\fR is one of the following words, and \fBx\fR is the
2500 corresponding abbreviation:
2503 \& Token Type xxxxxx x
2504 \& \-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\- \-\-
2505 \& comment comment c
2507 \& identifier identifier i
2508 \& bareword, function bareword w
2509 \& keyword keyword k
2510 \& quite, pattern quote q
2511 \& here doc text here\-doc\-text h
2512 \& here doc target here\-doc\-target hh
2513 \& punctuation punctuation pu
2514 \& parentheses paren p
2515 \& structural braces structure s
2516 \& semicolon semicolon sc
2520 \& sub definition name subroutine m
2521 \& pod text pod\-text pd
2524 A default set of colors has been defined, but they may be changed by providing
2525 values to any of the following parameters, where \fBn\fR is either a 6 digit
2526 hex \s-1RGB\s0 color value or an ascii name for a color, such as 'red'.
2528 To illustrate, the following command will produce an html
2529 file \fIsomefile.pl.html\fR with \*(L"aqua\*(R" keywords:
2532 \& perltidy \-html \-hck=00ffff somefile.pl
2535 and this should be equivalent for most browsers:
2538 \& perltidy \-html \-hck=aqua somefile.pl
2541 Perltidy merely writes any non-hex names that it sees in the html file.
2542 The following 16 color names are defined in the \s-1HTML\s0 3.2 standard:
2546 \& silver => c0c0c0,
2549 \& maroon => 800000,
2551 \& purple => 800080,
2552 \& fuchsia => ff00ff,
2563 Many more names are supported in specific browsers, but it is safest
2564 to use the hex codes for other colors. Helpful color tables can be
2565 located with an internet search for \*(L"\s-1HTML\s0 color tables\*(R".
2567 Besides color, two other character attributes may be set: bold, and italics.
2568 To set a token type to use bold, use the flag
2569 \&\fB\-\-html\-bold\-xxxxxx\fR or \fB\-hbx\fR, where \fBxxxxxx\fR or \fBx\fR are the long
2570 or short names from the above table. Conversely, to set a token type to
2571 \&\s-1NOT\s0 use bold, use \fB\-\-nohtml\-bold\-xxxxxx\fR or \fB\-nhbx\fR.
2573 Likewise, to set a token type to use an italic font, use the flag
2574 \&\fB\-\-html\-italic\-xxxxxx\fR or \fB\-hix\fR, where again \fBxxxxxx\fR or \fBx\fR are the
2575 long or short names from the above table. And to set a token type to
2576 \&\s-1NOT\s0 use italics, use \fB\-\-nohtml\-italic\-xxxxxx\fR or \fB\-nhix\fR.
2578 For example, to use bold braces and lime color, non\-bold, italics keywords the
2579 following command would be used:
2582 \& perltidy \-html \-hbs \-hck=00FF00 \-nhbk \-hik somefile.pl
2585 The background color can be specified with \fB\-\-html\-color\-background=n\fR,
2586 or \fB\-hcbg=n\fR for short, where n is a 6 character hex \s-1RGB\s0 value. The
2587 default color of text is the value given to \fBpunctuation\fR, which is
2590 Here are some notes and hints:
2592 1. If you find a preferred set of these parameters, you may want
2593 to create a \fI.perltidyrc\fR file containing them. See the perltidy man
2594 page for an explanation.
2596 2. Rather than specifying values for these parameters, it is probably
2597 easier to accept the defaults and then edit a style sheet. The style
2598 sheet contains comments which should make this easy.
2600 3. The syntax-colored html files can be very large, so it may be best to
2601 split large files into smaller pieces to improve download times.
2602 .SH "SOME COMMON INPUT CONVENTIONS"
2603 .IX Header "SOME COMMON INPUT CONVENTIONS"
2604 .Sh "Specifying Block Types"
2605 .IX Subsection "Specifying Block Types"
2606 Several parameters which refer to code block types may be customized by also
2607 specifying an associated list of block types. The type of a block is the name
2608 of the keyword which introduces that block, such as \fBif\fR, \fBelse\fR, or \fBsub\fR.
2609 An exception is a labeled block, which has no keyword, and should be specified
2612 For example, the following parameter specifies \f(CW\*(C`sub\*(C'\fR, labels, \f(CW\*(C`BEGIN\*(C'\fR, and
2613 \&\f(CW\*(C`END\*(C'\fR blocks:
2616 \& \-cscl="sub : BEGIN END"
2619 (the meaning of the \-cscl parameter is described above.) Note that
2620 quotes are required around the list of block types because of the
2622 .Sh "Specifying File Extensions"
2623 .IX Subsection "Specifying File Extensions"
2624 Several parameters allow default file extensions to be overridden. For
2625 example, a backup file extension may be specified with \fB\-bext=ext\fR,
2626 where \fBext\fR is some new extension. In order to provides the user some
2627 flexibility, the following convention is used in all cases to decide if
2628 a leading '.' should be used. If the extension \f(CW\*(C`ext\*(C'\fR begins with
2629 \&\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
2630 an intermediate '.' (or perhaps an '_' on \s-1VMS\s0 systems). Otherwise, it
2631 will be appended directly.
2633 For example, suppose the file is \fIsomefile.pl\fR. For \f(CW\*(C`\-bext=old\*(C'\fR, a '.' is
2634 added to give \fIsomefile.pl.old\fR. For \f(CW\*(C`\-bext=.old\*(C'\fR, no additional '.' is
2635 added, so again the backup file is \fIsomefile.pl.old\fR. For \f(CW\*(C`\-bext=~\*(C'\fR, then no
2636 dot is added, and the backup file will be \fIsomefile.pl~\fR .
2637 .SH "SWITCHES WHICH MAY BE NEGATED"
2638 .IX Header "SWITCHES WHICH MAY BE NEGATED"
2639 The following list shows all short parameter names which allow a prefix
2640 \&'n' to produce the negated form:
2643 \& D anl asc aws b bbb bbc bbs bl bli boc bok bol bot ce
2644 \& csc dac dbc dcsc ddf dln dnl dop dp dpro dsc dsm dsn dtt dwls
2645 \& dwrs dws f fll frm fs hsc html ibc icb icp iob isbc lal log
2646 \& lp lsl ohbr okw ola oll opr opt osbr otr ple ple pod pvl q
2647 \& sbc sbl schb scp scsb sct se sfp sfs skp sob sohb sop sosb sot
2648 \& ssc st sts syn t tac tbc toc tp tqw tsc w x bar
2651 Equivalently, the prefix 'no' or 'no\-' on the corresponding long names may be
2654 .IX Header "LIMITATIONS"
2655 .IP "Parsing Limitations" 4
2656 .IX Item "Parsing Limitations"
2657 Perltidy should work properly on most perl scripts. It does a lot of
2658 self\-checking, but still, it is possible that an error could be
2659 introduced and go undetected. Therefore, it is essential to make
2660 careful backups and to test reformatted scripts.
2662 The main current limitation is that perltidy does not scan modules
2663 included with 'use' statements. This makes it necessary to guess the
2664 context of any bare words introduced by such modules. Perltidy has good
2665 guessing algorithms, but they are not infallible. When it must guess,
2666 it leaves a message in the log file.
2668 If you encounter a bug, please report it.
2669 .IP "What perltidy does not parse and format" 4
2670 .IX Item "What perltidy does not parse and format"
2671 Perltidy indents but does not reformat comments and \f(CW\*(C`qw\*(C'\fR quotes.
2672 Perltidy does not in any way modify the contents of here documents or
2673 quoted text, even if they contain source code. (You could, however,
2674 reformat them separately). Perltidy does not format 'format' sections
2675 in any way. And, of course, it does not modify pod documents.
2678 .IP "Temporary files" 4
2679 .IX Item "Temporary files"
2680 Under the \-html option with the default \-\-pod2html flag, a temporary file is
2681 required to pass text to Pod::Html. Unix systems will try to use the \s-1POSIX\s0
2682 \&\fItmpnam()\fR function. Otherwise the file \fIperltidy.TMP\fR will be temporarily
2683 created in the current working directory.
2684 .IP "Special files when standard input is used" 4
2685 .IX Item "Special files when standard input is used"
2686 When standard input is used, the log file, if saved, is \fIperltidy.LOG\fR,
2687 and any errors are written to \fIperltidy.ERR\fR unless the \fB\-se\fR flag is
2688 set. These are saved in the current working directory.
2689 .IP "Files overwritten" 4
2690 .IX Item "Files overwritten"
2691 The following file extensions are used by perltidy, and files with these
2692 extensions may be overwritten or deleted: \fI.ERR\fR, \fI.LOG\fR, \fI.TEE\fR,
2693 and/or \fI.tdy\fR, \fI.html\fR, and \fI.bak\fR, depending on the run type and
2695 .IP "Files extensions limitations" 4
2696 .IX Item "Files extensions limitations"
2697 Perltidy does not operate on files for which the run could produce a file with
2698 a duplicated file extension. These extensions include \fI.LOG\fR, \fI.ERR\fR,
2699 \&\fI.TEE\fR, and perhaps \fI.tdy\fR and \fI.bak\fR, depending on the run type. The
2700 purpose of this rule is to prevent generating confusing filenames such as
2701 \&\fIsomefile.tdy.tdy.tdy\fR.
2703 .IX Header "SEE ALSO"
2704 \&\fIperlstyle\fR\|(1), \fIPerl::Tidy\fR\|(3)
2706 .IX Header "VERSION"
2707 This man page documents perltidy version 20070424.
2709 .IX Header "CREDITS"
2710 Michael Cartmell supplied code for adaptation to \s-1VMS\s0 and helped with
2713 Yves Orton supplied code for adaptation to the various versions
2716 Axel Rose supplied a patch for MacPerl.
2718 Hugh S. Myers designed and implemented the initial Perl::Tidy module interface.
2720 Many others have supplied key ideas, suggestions, and bug reports;
2721 see the \s-1CHANGES\s0 file.
2726 \& email: perltidy at users.sourceforge.net
2727 \& http://perltidy.sourceforge.net
2730 .IX Header "COPYRIGHT"
2731 Copyright (c) 2000\-2006 by Steve Hancock
2733 .IX Header "LICENSE"
2734 This package is free software; you can redistribute it and/or modify it
2735 under the terms of the \*(L"\s-1GNU\s0 General Public License\*(R".
2737 Please refer to the file \*(L"\s-1COPYING\s0\*(R" for details.
2739 .IX Header "DISCLAIMER"
2740 This package is distributed in the hope that it will be useful,
2741 but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
2742 \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.
2744 See the \*(L"\s-1GNU\s0 General Public License\*(R" for more details.
projects / perltidy.git / blob